This components turns its window into a list-box control. More...

#include "CompListBox.hpp"

Inheritance diagram for cf::GuiSys::ComponentListBoxT:

Public Member Functions
	ComponentListBoxT ()
	The constructor. More...

	ComponentListBoxT (const ComponentListBoxT &Comp)
	The copy constructor. More...

ComponentListBoxT *	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...

bool	OnInputEvent (const CaKeyboardEventT &KE)
	This method handles keyboard input events. More...

bool	OnInputEvent (const CaMouseEventT &ME, float PosX, float PosY)
	This method handles mouse input events. 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 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	GetSelItem (lua_State *LuaState)

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 &)

RefCountedT &	operator= (const RefCountedT &)

Detailed Description

This components turns its window into a list-box control.

It requires that in the same window a text component is available where the aspects of text rendering are configured (but that normally has empty text contents itself).

Constructor & Destructor Documentation

ComponentListBoxT::ComponentListBoxT ( )

The constructor.

ComponentListBoxT::ComponentListBoxT ( const ComponentListBoxT & Comp )

The copy constructor.

Parameters

Comp	The component to create a copy of.

Member Function Documentation

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

inlinevirtual

Returns the name of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

bool ComponentListBoxT::OnInputEvent ( const CaKeyboardEventT & KE )

virtual

This method handles keyboard input events.

Parameters

KE	Keyboard event instance.

Returns: Whether the component handled ("consumed") the event.

Reimplemented from cf::GuiSys::ComponentBaseT.

bool ComponentListBoxT::OnInputEvent	(	const CaMouseEventT &	ME,
		float	PosX,
		float	PosY
	)

virtual

This method handles mouse input events.

Parameters

ME	Mouse event instance.
PosX	x-coordinate of the mouse cursor position.
PosY	y-coordinate of the mouse cursor position.

Returns: Whether the component handled ("consumed") the event.

Reimplemented from cf::GuiSys::ComponentBaseT.

void ComponentListBoxT::Render ( ) const

virtual

This method implements the graphical output of this component.

Reimplemented from cf::GuiSys::ComponentBaseT.

void ComponentListBoxT::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 cf::TypeSys::MethsDocT ComponentListBoxT::DocCallbacks

staticprotected

Initial value:

=
{
    { "OnSelectionChanged",
      "This method is called when the list box's selection has changed.",
      "", "" },
    { NULL, NULL, NULL, NULL }
}

const char * ComponentListBoxT::DocClass

staticprotected

Initial value:

=
    "This components turns its window into a list-box control.\n"
    "It requires that in the same window a text component is available where the aspects of text rendering are\n"
    "configured (but that has empty text contents itself)."

const cf::TypeSys::MethsDocT ComponentListBoxT::DocMethods

staticprotected

Initial value:

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

const cf::TypeSys::VarsDocT ComponentListBoxT::DocVars

staticprotected

Initial value:

=
{
    { "Items",        "The list of available items." },
    { "Selection",    "The index number of the currently selected item, where 1 corresponds to the first item (as per Lua convention). Use 0 for \"no selection\"." },
    { "BgColorOdd",   "The background color for odd rows." },
    { "BgAlphaOdd",   "The background alpha for odd rows." },
    { "BgColorEven",  "The background color for even rows." },
    { "BgAlphaEven",  "The background alpha for even rows." },
    { "BgColorSel",   "The background color for selected rows." },
    { "BgAlphaSel",   "The background alpha for selected rows." },
    { "TextColorSel", "The foreground color for selected rows." },
    { "TextAlphaSel", "The foreground alpha for selected rows." },
    { NULL, NULL }
}

const luaL_Reg ComponentListBoxT::MethodsList

staticprotected

Initial value:

=
{
    { "GetSelItem", GetSelItem },
    { "__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/CompListBox.hpp
Libs/GuiSys/CompListBox.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation