Contents User Forum Source Index APIs by Task APIs by Level Data


G3D::GuiCaption Class Reference

Text on a GuiControl. More...

#include <GuiCaption.h>

List of all members.

Public Member Functions

const Color4color (const Color4 &_default) const
const GFont::Reffont (const GFont::Ref &_default) const
 GuiCaption (const char *text)
 GuiCaption (const std::string &text="", const GFont::Ref &font=NULL, float size=-1, const Color4 &color=Color4(-1,-1,-1,-1), const Color4 &outlineColor=Color4(-1,-1,-1,-1))
const Color4outlineColor (const Color4 &_default) const
void setDefault (const GFontRef &dfont, float dsize, const Color4 &dcolor, const Color4 &doutline)
float size (float _default) const
const std::string & text () const

Classes

class  Symbol
 Loads standard symbols from the greek.fnt and icon.fnt fonts. More...


Detailed Description

Text on a GuiControl.

These are normally created implicitly by a cast from std::string, but can be created explicitly when more information needs to be specified.

See also:
G3D::GuiLabel


Constructor & Destructor Documentation

G3D::GuiCaption::GuiCaption ( const std::string &  text = "",
const GFont::Ref font = NULL,
float  size = -1,
const Color4 color = Color4(-1,-1,-1,-1),
const Color4 outlineColor = Color4(-1,-1,-1,-1) 
)

Negative alpha values on color and outlineColor mean "use default". Null font and negative size mean "use default".

Defaults are set on the Gui.

G3D::GuiCaption::GuiCaption ( const char *  text  ) 

Uses all default values.


Member Function Documentation

const Color4& G3D::GuiCaption::color ( const Color4 _default  )  const [inline]

const GFont::Ref& G3D::GuiCaption::font ( const GFont::Ref _default  )  const [inline]

If this caption specifies a font, returns that font, otherwise returns the default font.

const Color4& G3D::GuiCaption::outlineColor ( const Color4 _default  )  const [inline]

void G3D::GuiCaption::setDefault ( const GFontRef dfont,
float  dsize,
const Color4 dcolor,
const Color4 doutline 
)

Provides the value of default values.

float G3D::GuiCaption::size ( float  _default  )  const [inline]

const std::string& G3D::GuiCaption::text (  )  const [inline]


The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:46 2007 for G3D by doxygen 1.5.2
Hosted by SourceForge.net Logo