Crazy Eddie's GUI System  0.8.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::WidgetComponent Class Reference

Class that encapsulates information regarding a sub-widget required for a widget. More...

+ Inheritance diagram for CEGUI::WidgetComponent:
+ Collaboration diagram for CEGUI::WidgetComponent:

Public Types

typedef ConstVectorIterator
< PropertiesList > 
PropertyIterator
typedef ConstVectorIterator
< EventActionList > 
EventActionIterator

Public Member Functions

 WidgetComponent (const String &type, const String &look, const String &suffix, const String &renderer, bool autoWindow)
void create (Window &parent) const
 Create an instance of this widget component adding it as a child to the given Window.
void cleanup (Window &parent) const
 Cleanup from the given parent widget, the instance of the child created for this WidgetComponent.
const ComponentAreagetComponentArea () const
void setComponentArea (const ComponentArea &area)
const StringgetBaseWidgetType () const
void setBaseWidgetType (const String &type)
const StringgetWidgetLookName () const
void setWidgetLookName (const String &look)
const StringgetWidgetName () const
void setWidgetName (const String &name)
const StringgetWindowRendererType () const
void setWindowRendererType (const String &type)
VerticalAlignment getVerticalWidgetAlignment () const
void setVerticalWidgetAlignment (VerticalAlignment alignment)
HorizontalAlignment getHorizontalWidgetAlignment () const
void setHorizontalWidgetAlignment (HorizontalAlignment alignment)
void addPropertyInitialiser (const PropertyInitialiser &initialiser)
void removePropertyInitialiser (const String &name)
void clearPropertyInitialisers ()
void setAutoWindow (bool is_auto)
bool isAutoWindow () const
void addEventAction (const EventAction &event_action)
void clearEventActions ()
void layout (const Window &owner) const
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this WidgetComponent to out_stream.
const PropertyInitialiserfindPropertyInitialiser (const String &propertyName) const
 Takes the name of a property and returns a pointer to the last PropertyInitialiser for this property or 0 if the is no PropertyInitialiser for this property in the WidgetLookFeel.
bool handleFontRenderSizeChange (Window &window, const Font *font) const
 perform any processing required due to the given font having changed.
PropertyIterator getPropertyIterator () const
EventActionIterator getEventActionIterator () const

Detailed Description

Class that encapsulates information regarding a sub-widget required for a widget.

Todo:
This is not finished in the slightest! There will be many changes here...

Member Function Documentation

const PropertyInitialiser* CEGUI::WidgetComponent::findPropertyInitialiser ( const String propertyName) const

Takes the name of a property and returns a pointer to the last PropertyInitialiser for this property or 0 if the is no PropertyInitialiser for this property in the WidgetLookFeel.

Parameters
propertyNameThe name of the property to look for.
EventActionIterator CEGUI::WidgetComponent::getEventActionIterator ( ) const

Return a WidgetComponent::EventActionIterator that iterates over the EventAction definitions for this WidgetComponent.

PropertyIterator CEGUI::WidgetComponent::getPropertyIterator ( ) const

Return a WidgetComponent::PropertyIterator that iterates over the PropertyInitialiser inside this WidgetComponent.

void CEGUI::WidgetComponent::writeXMLToStream ( XMLSerializer xml_stream) const

Writes an xml representation of this WidgetComponent to out_stream.

Parameters
xml_streamStream where xml data should be output.
Returns
Nothing.