Cafu Engine
ComponentBasicsT Class Reference

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

Inheritance diagram for ComponentBasicsT:

Public Attributes

string Name
 The name of the window. More...
 
boolean Show
 Is this window currently shown? More...
 

Event Handlers (Callbacks)

See the Event Handlers (Callbacks) overview page for additional information about the methods in this group.

 OnShow ()
 This method is called when the value of the component's Show member has changed. More...
 

Additional Inherited Members

- Public Member Functions inherited from ComponentBaseT
any get (string var_name)
 Returns the value of an attribute (a member variable) of this class. More...
 
 set (string var_name, any new_value)
 Sets an attribute (a member variable) of this class to a new value. More...
 
string GetExtraMessage (string var_name)
 Returns the result of VarBaseT::GetExtraMessage() for the given member variable. More...
 
 interpolate (string var_name, number start_value, number end_value, number time)
 Schedules a value for interpolation between a start and end value over a given period of time. More...
 

Detailed Description

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

Note that the variables of this class (also referred to as "Public Attributes" or "Member Data") must be used with the get() and set() methods at this time – see get() and set() for details.

If you would like to create a new component of this type explicitly (those defined in the CaWE GUI Editor are instantiated automatically), use GuiT::new():

local comp = gui:new("ComponentBasicsT")
Implementing C++ Class:
cf::GuiSys::ComponentBasicsT

Member Function Documentation

OnShow ( )

This method is called when the value of the component's Show member has changed.

The method has no parameters – use self:get("Show") in order to learn whether the window has been shown or hidden.

Member Data Documentation

string Name

The name of the window.

Window names must be valid Lua script identifiers and unique among their siblings.

Related C++ type:
std::string
boolean Show

Is this window currently shown?

Related C++ type:
bool