cf::GuiSys::ComponentBorderT Class Reference

This components adds a border to its window. More...

#include "CompBorder.hpp"

Inheritance diagram for cf::GuiSys::ComponentBorderT:

Public Member Functions
	ComponentBorderT ()
	The constructor. More...
	ComponentBorderT (const ComponentBorderT &Comp)
	The copy constructor. More...
ComponentBorderT *	Clone () const
	The virtual copy constructor. More...
const char *	GetName () const
	Returns the name of this component. 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	UpdateDependencies (WindowT *Window)
	This method is called whenever something "external" to this component has changed: 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 []

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

Detailed Description

This components adds a border to its window.

Constructor & Destructor Documentation

ComponentBorderT::ComponentBorderT

(

)

The constructor.

ComponentBorderT::ComponentBorderT

(

const ComponentBorderT &

Comp

)

The copy constructor.

Parameters

Comp	The component to create a copy of.

Member Function Documentation

ComponentBorderT * ComponentBorderT::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::ComponentBorderT::GetName ( ) const

inlinevirtual

Returns the name of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

void ComponentBorderT::Render ( ) const

virtual

This method implements the graphical output of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

Member Data Documentation

const char * ComponentBorderT::DocClass

staticprotected

Initial value:

=
    "This components adds a border to its window."

const cf::TypeSys::MethsDocT ComponentBorderT::DocMethods

staticprotected

Initial value:

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

const cf::TypeSys::VarsDocT ComponentBorderT::DocVars

staticprotected

Initial value:

=
{
    { "Width", "The width of the border." },
    { "Color", "The border color." },
    { "Alpha", "The alpha component of the color." },
    { NULL, NULL }
}

const luaL_Reg ComponentBorderT::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/CompBorder.hpp
• Libs/GuiSys/CompBorder.cpp