Kulik: rough initial version

2011-03-27T14:27:09Z

rough initial version

New page

{{VersionBadge|0.8}}

{{Widget
|name=Widget
|cppclass=CEGUI::Widget
}}

CEGUI::Widget is the base class of all CEGUI widgets.

== Properties ==
CEGUI implements a simplistic property introspection via CEGUI::PropertySet. You can set/get properties as strings or even as native types for added speed (added in 0.8). This is used when loading/saving layouts as well.
<source lang="cpp">
// ... wdt is a non-const widget pointer (Widget*)
// using strings
wdt->setProperty("SomeProperty", "True");
// or native types
wdt->setProperty<bool>("SomeProperty", true);
</source>

== Events ==
[[Event]]s are fired by most of the widgets. You can subscribe to them via:
<source lang="cpp">
// ... wdt is a non-const widget pointer (Widget*)
// subscription to a class method
wdt->subscribeEvent("EventName", Event::Subscriber(&ClassType::classMethod, instanceOfTheClass));
// subscription to a free function
wdt->subscribeEvent("EventName", Event::Subscriber(&freeFunction));
</source>
Instead of putting event names as string literals, you might want to use static constants for added safety.
<source lang="cpp">
wdt->subscribeEvent(SomeWidgetSomewhere::EventName, Event::Subscriber(&freeFunction));
</source>

== Positioning ==
All widgets utilise [[Unified_Positions_and_Sizes_System]] so they can be sized in absolute, relative values or combinations of both.

== Enabled/Disabled ==
When a widget is disabled, it usually doesn't allow any interaction with it and may employ a different rendering.
[[File:Enabled_vs_Disabled_FrameWindow.png]]

== Activated/Deactivated ==
When a window is deactivated, no inputs are processed by it until it's activated.

Widget - Revision history

Kulik: rough initial version