Cafu Engine
cf::GuiSys::ComponentBasicsT Class Reference

This component adds the basics of the window (its name and the "is shown?" flag). More...

#include "CompBasics.hpp"

Inheritance diagram for cf::GuiSys::ComponentBasicsT:

Public Member Functions

 ComponentBasicsT ()
 The constructor. More...
 
 ComponentBasicsT (const ComponentBasicsT &Comp)
 The copy constructor. More...
 
const std::string & GetWindowName () const
 Returns the name of the window. More...
 
bool IsShown () const
 Returns true if the window is currently shown. Returns false if the window is currently hidden. More...
 
void SetWindowName (const std::string &Name)
 Sets a new name for the window. More...
 
ComponentBasicsTClone () const
 The virtual copy constructor. More...
 
const char * GetName () const
 Returns the name of this component. More...
 
const cf::TypeSys::TypeInfoTGetType () 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...
 
WindowTGetWindow () const
 Returns the parent window that contains this component, or NULL if this component is currently not a part of any window. More...
 
TypeSys::VarManTGetMemberVars ()
 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 Render () const
 This method implements the graphical output 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::MethsDocT DocCallbacks []
 
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 &)
 
RefCountedToperator= (const RefCountedT &)
 

Detailed Description

This component adds the basics of the window (its name and the "is shown?" flag).

It is one of the components that is "fundamental" to a window (cf::GuiSys::IsFundamental() returns true). Every window must have exactly one.

Constructor & Destructor Documentation

ComponentBasicsT::ComponentBasicsT ( )

The constructor.

ComponentBasicsT::ComponentBasicsT ( const ComponentBasicsT Comp)

The copy constructor.

Parameters
CompThe component to create a copy of.

Member Function Documentation

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

Returns the name of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

const std::string& cf::GuiSys::ComponentBasicsT::GetWindowName ( ) const
inline

Returns the name of the window.

bool cf::GuiSys::ComponentBasicsT::IsShown ( ) const
inline

Returns true if the window is currently shown. Returns false if the window is currently hidden.

void cf::GuiSys::ComponentBasicsT::SetWindowName ( const std::string &  Name)
inline

Sets a new name for the window.

Window names must be valid Lua script identifiers and unique among their siblings, and the method modifies the given string as necessary. As a result, GetWindowName() can return a string that is different from the string given to a preceeding call to SetWindowName().

Member Data Documentation

const cf::TypeSys::MethsDocT ComponentBasicsT::DocCallbacks
staticprotected
Initial value:
=
{
{ "OnShow",
"This method is called when the value of the component's `Show` member has changed.",
"", "" },
{ NULL, NULL, NULL, NULL }
}
const char * ComponentBasicsT::DocClass
staticprotected
Initial value:
=
"This component adds the basics of the window (its name and the \"is shown?\" flag)."
const cf::TypeSys::MethsDocT ComponentBasicsT::DocMethods
staticprotected
Initial value:
=
{
META_toString,
{ NULL, NULL, NULL, NULL }
}
const cf::TypeSys::VarsDocT ComponentBasicsT::DocVars
staticprotected
Initial value:
=
{
{ "Name", "The name of the window. Window names must be valid Lua script identifiers and unique among their siblings." },
{ "Show", "Is this window currently shown?" },
{ NULL, NULL }
}
const luaL_Reg ComponentBasicsT::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: