$treeview $search $mathjax
Stratagus  2.2.7
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

gcn::Font Class Reference

#include <font.h>

Inheritance diagram for gcn::Font:

CFont gcn::DefaultFont gcn::ImageFont

List of all members.


Public Member Functions

virtual ~Font ()
virtual int getWidth (const std::string &text) const =0
virtual int getHeight () const =0
virtual int getStringIndexAt (const std::string &text, int x)
virtual void drawString (Graphics *graphics, const std::string &text, int x, int y)=0

Detailed Description

Holder of a font. Fonts should inherit from this class and implements it's functions.

See also:
ImageFont

Constructor & Destructor Documentation

virtual gcn::Font::~Font (  )  [inline, virtual]

Destructor.


Member Function Documentation

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, gcn::ImageFont, and CFont.

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, gcn::ImageFont, and CFont.

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.

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, gcn::ImageFont, and CFont.


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.