gcn::Font Class Reference

#include <font.hpp>

Inheritance diagram for gcn::Font:

List of all members.

---

Detailed Description

Holder of a font.

Fonts should inherit from this class and implements it's functions.

See also:

ImageFont

Definition at line 73 of file font.hpp.

Public Member Functions
virtual	~Font ()
	Destructor.
virtual int	getWidth (const std::string &text) const =0
	Gets the width of a string.
virtual int	getHeight () const =0
	Gets the height of the glyphs in the font.
virtual int	getStringIndexAt (const std::string &text, int x)
	Gets a string index in a string providing an x coordinate.
virtual void	drawString (Graphics *graphics, const std::string &text, int x, int y)=0
	Draws a string.

---

Member Function Documentation

virtual void gcn::Font::drawString	(	Graphics *	graphics,
		const std::string &	text,
		int	x,
		int	y
	)			[pure virtual]

Draws a string.

NOTE: You normally won't use this function to draw text since Graphics contains better functions for drawing text.

Parameters:

	graphics	a Graphics object to use for drawing.
	text	the string to draw.
	x	the x coordinate where to draw the string.
	y	the y coordinate where to draw the string.

Implemented in gcn::DefaultFont, and gcn::ImageFont.

Referenced by gcn::Graphics::drawText().

virtual int gcn::Font::getHeight

(

)

const [pure virtual]

Gets the height of the glyphs in the font.

Returns:

the height of the glyphs int the font.

Implemented in gcn::DefaultFont, and gcn::ImageFont.

Referenced by gcn::DropDown::adjustHeight(), gcn::RadioButton::adjustSize(), gcn::CheckBox::adjustSize(), gcn::Window::draw(), gcn::ListBox::draw(), gcn::Label::draw(), gcn::Button::draw(), gcn::TextBox::keyPress(), gcn::TextBox::mousePress(), gcn::TextBox::scrollToCaret(), and gcn::ListBox::setSelected().

int gcn::Font::getStringIndexAt	(	const std::string &	text,
		int	x
	)			[virtual]

Gets a string index in a string providing an x coordinate.

Used to retrive a string index (for a character in a string) at a certain x position. It is especially useful when a mouse clicks in a TextField and you want to know which character was clicked.

Returns:

a string index in a string providing an x coordinate.

Reimplemented in gcn::DefaultFont, and gcn::ImageFont.

Definition at line 67 of file font.cpp.

References getWidth().

Referenced by gcn::TextField::mousePress(), and gcn::TextBox::mousePress().

virtual int gcn::Font::getWidth

(

const std::string &

text

)

const [pure virtual]

Gets the width of a string.

The width of a string is not necesserily the sum of all the widths of it's glyphs.

Parameters:

text

the string to return the width of.

Returns:

the width of a string.

Implemented in gcn::DefaultFont, and gcn::ImageFont.

Referenced by gcn::TextBox::adjustSize(), gcn::Graphics::drawText(), gcn::TextField::fixScroll(), getStringIndexAt(), and gcn::TextBox::scrollToCaret().

---

The documentation for this class was generated from the following files:

• font.hpp
• font.cpp

---