cf::GuiSys::ComponentTextT Class Reference

This components adds text to its window. More...

#include "CompText.hpp"

Inheritance diagram for cf::GuiSys::ComponentTextT:

Classes
class	VarFontNameT
	A variable of type std::string, specifically for font names. More...
class	VarTextAlignHorT
	A variable of type int, specifically for horizontal alignments of text. More...
class	VarTextAlignVerT
	A variable of type int, specifically for vertical alignments of text. More...

Public Member Functions
	ComponentTextT ()
	The constructor. More...
	ComponentTextT (const ComponentTextT &Comp)
	The copy constructor. More...
void	SetText (const std::string &t)
	This method sets this components text value. More...
void	AppendText (const std::string &t)
	This method appends the given text to the components text value. More...
ComponentTextT *	Clone () const
	The virtual copy constructor. More...
const char *	GetName () const
	Returns the name of this component. More...
void	UpdateDependencies (WindowT *Window)
	This method is called whenever something "external" to this component has changed: More...
void	Render () const
	This method implements the graphical output of this component. More...
const cf::TypeSys::TypeInfoT *	GetType () const
Public Member Functions inherited from cf::GuiSys::ComponentBaseT
	ComponentBaseT ()
	The constructor. More...
	ComponentBaseT (const ComponentBaseT &Comp)
	The copy constructor. More...
virtual	~ComponentBaseT ()
	The virtual destructor. More...
WindowT *	GetWindow () const
	Returns the parent window that contains this component, or NULL if this component is currently not a part of any window. More...
TypeSys::VarManT &	GetMemberVars ()
	Returns the variable manager that keeps generic references to our member variables, providing a simple kind of "reflection" or "type introspection" feature. More...
bool	CallLuaMethod (const char *MethodName, const char *Signature="",...)
	Calls the given Lua method of this component. More...
virtual void	OnPostLoad (bool OnlyStatic)
	This method is called after all windows and their components have been loaded. More...
virtual bool	OnInputEvent (const CaKeyboardEventT &KE)
	This method handles keyboard input events. More...
virtual bool	OnInputEvent (const CaMouseEventT &ME, float PosX, float PosY)
	This method handles mouse input events. More...
virtual void	OnClockTickEvent (float t)
	This method handles clock-tick events. More...
Public Member Functions inherited from RefCountedT
unsigned int	GetRefCount () const

Static Public Member Functions
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)
Static Public Member Functions inherited from cf::GuiSys::ComponentBaseT
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Attributes
static const cf::TypeSys::TypeInfoT	TypeInfo
Static Public Attributes inherited from cf::GuiSys::ComponentBaseT
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Protected Member Functions
static int	toString (lua_State *LuaState)
Static Protected Member Functions inherited from cf::GuiSys::ComponentBaseT
static int	Get (lua_State *LuaState)
static int	Set (lua_State *LuaState)
static int	GetExtraMessage (lua_State *LuaState)
static int	Interpolate (lua_State *LuaState)
static int	toString (lua_State *LuaState)

Static Protected Attributes
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...
static const char *	DocClass
static const cf::TypeSys::MethsDocT	DocMethods []
static const cf::TypeSys::VarsDocT	DocVars []
Static Protected Attributes inherited from cf::GuiSys::ComponentBaseT
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...
static const char *	DocClass
static const cf::TypeSys::MethsDocT	DocMethods []

Friends
class	ComponentListBoxT
class	ComponentTextEditT

Additional Inherited Members
Protected Member Functions inherited from RefCountedT
	RefCountedT (const RefCountedT &)
RefCountedT &	operator= (const RefCountedT &)

Detailed Description

This components adds text to its window.

Constructor & Destructor Documentation

ComponentTextT::ComponentTextT

(

)

The constructor.

ComponentTextT::ComponentTextT

(

const ComponentTextT &

Comp

)

The copy constructor.

Parameters

Comp	The component to create a copy of.

Member Function Documentation

void cf::GuiSys::ComponentTextT::AppendText ( const std::string &  t )

inline

This method appends the given text to the components text value.

ComponentTextT * ComponentTextT::Clone ( ) const

virtual

The virtual copy constructor.

Callers can use this method to create a copy of this component without knowing its concrete type. Overrides in derived classes use a covariant return type to facilitate use when the concrete type is known. The newly cloned component is initially not a part of any window, even if the source component was.

Reimplemented from cf::GuiSys::ComponentBaseT.

const char* cf::GuiSys::ComponentTextT::GetName ( ) const

inlinevirtual

Returns the name of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

void ComponentTextT::Render ( ) const

virtual

This method implements the graphical output of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

void cf::GuiSys::ComponentTextT::SetText ( const std::string &  t )

inline

This method sets this components text value.

Other C++ code (especially other components) would normally have to use GetMemberVars().Find("Text") to set this components text value. This auxiliary method makes the task much easier.

void ComponentTextT::UpdateDependencies ( WindowT *  Window )

virtual

This method is called whenever something "external" to this component has changed:

• if the parent window has changed, because this component was added to or removed from it,
• if other components in the parent window have changed. The component can use the opportunity to search the window for "sibling" components that it depends on, and store direct pointers to them. Note however that dependencies among components must not be cyclic, or else the deletion of a window will leave a memory leak.

  Parameters

  Window

  The parent window that contains this component, or NULL to indicate that this component is removed from the window that it used to be a part of.

Reimplemented from cf::GuiSys::ComponentBaseT.

Member Data Documentation

const char * ComponentTextT::DocClass

staticprotected

Initial value:

=
    "This components adds text to its window."

const cf::TypeSys::MethsDocT ComponentTextT::DocMethods

staticprotected

Initial value:

=
{
    META_toString,
    { NULL, NULL, NULL, NULL }
}

const cf::TypeSys::VarsDocT ComponentTextT::DocVars

staticprotected

Initial value:

=
{
    { "Text",     "The text to show in this window." },
    { "Font",     "The name of the font." },
    { "Scale",    "The scale that is applied for rendering the text." },
    { "Padding",  "Padding between text and window rectangle." },
    { "Color",    "The text color." },
    { "Alpha",    "The alpha component of the color." },
    { "horAlign", "How the text is aligned horizontally (left, center, right)." },
    { "verAlign", "How the text is aligned vertically (top, middle, bottom)." },
    { NULL, NULL }
}

const luaL_Reg ComponentTextT::MethodsList

staticprotected

Initial value:

=
{
    { "__tostring", toString },
    { NULL, NULL }
}

The list of Lua methods for this class.

---

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

• Libs/GuiSys/CompText.hpp
• Libs/GuiSys/CompText.cpp