Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::WidgetLookFeel Class Reference

Class that encapsulates look & feel information for a particular widget type. More...

#include <CEGUIFalWidgetLookFeel.h>

Collaboration diagram for CEGUI::WidgetLookFeel:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WidgetLookFeel (const String &name)
 WidgetLookFeel ()
const StateImagerygetStateImagery (const CEGUI::String &state) const
 Return a const reference to the StateImagery object for the specified state.
const ImagerySectiongetImagerySection (const CEGUI::String &section) const
 Return a const reference to the ImagerySection object with the specified name.
const StringgetName () const
 Return the name of the widget look.
void addImagerySection (const ImagerySection &section)
 Add an ImagerySection to the WidgetLookFeel.
void addWidgetComponent (const WidgetComponent &widget)
 Add a WidgetComponent to the WidgetLookFeel.
void addStateSpecification (const StateImagery &state)
 Add a state specification (StateImagery object) to the WidgetLookFeel.
void addPropertyInitialiser (const PropertyInitialiser &initialiser)
 Add a property initialiser to the WidgetLookFeel.
void clearImagerySections ()
 Clear all ImagerySections from the WidgetLookFeel.
void clearWidgetComponents ()
 Clear all WidgetComponents from the WidgetLookFeel.
void clearStateSpecifications ()
 Clear all StateImagery objects from the WidgetLookFeel.
void clearPropertyInitialisers ()
 Clear all PropertyInitialiser objects from the WidgetLookFeel.
void initialiseWidget (Window &widget) const
 Initialise the given window using PropertyInitialsers and component widgets specified for this WidgetLookFeel.
bool isStateImageryPresent (const String &state) const
 Return whether imagery is defined for the given state.
void addNamedArea (const NamedArea &area)
 Adds a named area to the WidgetLookFeel.
void clearNamedAreas ()
 Clear all defined named areas from the WidgetLookFeel.
const NamedAreagetNamedArea (const String &name) const
 Return the NamedArea with the specified name.
bool isNamedAreaDefined (const String &name) const
 return whether a NamedArea object with the specified name exists for this WidgetLookFeel.
void layoutChildWidgets (const Window &owner) const
 Layout the child widgets defined for this WidgetLookFeel which are attached to the given window.
void addPropertyDefinition (const PropertyDefinition &propdef)
 Adds a property definition to the WidgetLookFeel.
void clearPropertyDefinitions ()
 Clear all defined property definitions from the WidgetLookFeel.
void writeXMLToStream (OutStream &out_stream) const
 Writes an xml representation of this WidgetLookFeel to out_stream.

Detailed Description

Class that encapsulates look & feel information for a particular widget type.

Definition at line 48 of file CEGUIFalWidgetLookFeel.h.


Constructor & Destructor Documentation

CEGUI::WidgetLookFeel::WidgetLookFeel const String name  ) 
 

Definition at line 32 of file CEGUIFalWidgetLookFeel.cpp.

CEGUI::WidgetLookFeel::WidgetLookFeel  )  [inline]
 

Definition at line 52 of file CEGUIFalWidgetLookFeel.h.


Member Function Documentation

void CEGUI::WidgetLookFeel::addImagerySection const ImagerySection section  ) 
 

Add an ImagerySection to the WidgetLookFeel.

Parameters:
section ImagerySection object to be added.
Returns:
Nothing.

Definition at line 67 of file CEGUIFalWidgetLookFeel.cpp.

References CEGUI::ImagerySection::getName(), CEGUI::Logger::getSingleton(), and CEGUI::Logger::logEvent().

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

void CEGUI::WidgetLookFeel::addNamedArea const NamedArea area  ) 
 

Adds a named area to the WidgetLookFeel.

Parameters:
area NamedArea to be added.
Returns:
Nothing.

Definition at line 148 of file CEGUIFalWidgetLookFeel.cpp.

References CEGUI::NamedArea::getName(), CEGUI::Logger::getSingleton(), and CEGUI::Logger::logEvent().

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

void CEGUI::WidgetLookFeel::addPropertyDefinition const PropertyDefinition propdef  ) 
 

Adds a property definition to the WidgetLookFeel.

Parameters:
propdef PropertyDefinition to be added.
Returns:
Nothing.

Definition at line 190 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::addPropertyInitialiser const PropertyInitialiser initialiser  ) 
 

Add a property initialiser to the WidgetLookFeel.

Parameters:
initialiser PropertyInitialiser object to be added.
Returns:
Nothing.

Definition at line 94 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::WidgetLookFeel::addStateSpecification const StateImagery state  ) 
 

Add a state specification (StateImagery object) to the WidgetLookFeel.

Parameters:
section StateImagery object to be added.
Returns:
Nothing.

Definition at line 83 of file CEGUIFalWidgetLookFeel.cpp.

References CEGUI::StateImagery::getName(), CEGUI::Logger::getSingleton(), and CEGUI::Logger::logEvent().

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

void CEGUI::WidgetLookFeel::addWidgetComponent const WidgetComponent widget  ) 
 

Add a WidgetComponent to the WidgetLookFeel.

Parameters:
widget WidgetComponent object to be added.
Returns:
Nothing.

Definition at line 78 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementEnd().

void CEGUI::WidgetLookFeel::clearImagerySections  ) 
 

Clear all ImagerySections from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 99 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::clearNamedAreas  ) 
 

Clear all defined named areas from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 159 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::clearPropertyDefinitions  ) 
 

Clear all defined property definitions from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 195 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::clearPropertyInitialisers  ) 
 

Clear all PropertyInitialiser objects from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 114 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::clearStateSpecifications  ) 
 

Clear all StateImagery objects from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 109 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::clearWidgetComponents  ) 
 

Clear all WidgetComponents from the WidgetLookFeel.

Returns:
Nothing.

Definition at line 104 of file CEGUIFalWidgetLookFeel.cpp.

const ImagerySection & CEGUI::WidgetLookFeel::getImagerySection const CEGUI::String section  )  const
 

Return a const reference to the ImagerySection object with the specified name.

Returns:
ImagerySection object with the specified name.

Definition at line 49 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::SectionSpecification::render().

const String & CEGUI::WidgetLookFeel::getName  )  const
 

Return the name of the widget look.

Returns:
String object holding the name of the WidgetLookFeel.

Definition at line 62 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::WidgetLookManager::addWidgetLook(), and CEGUI::Falagard_xmlHandler::elementStart().

const NamedArea & CEGUI::WidgetLookFeel::getNamedArea const String name  )  const
 

Return the NamedArea with the specified name.

Parameters:
name String object holding the name of the NamedArea to be returned.
Returns:
The requested NamedArea object.

Definition at line 164 of file CEGUIFalWidgetLookFeel.cpp.

const StateImagery & CEGUI::WidgetLookFeel::getStateImagery const CEGUI::String state  )  const
 

Return a const reference to the StateImagery object for the specified state.

Returns:
StateImagery object for the requested state.

Definition at line 36 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::initialiseWidget Window widget  )  const
 

Initialise the given window using PropertyInitialsers and component widgets specified for this WidgetLookFeel.

Parameters:
widget Window based object to be initialised.
Returns:
Nothing.

Definition at line 119 of file CEGUIFalWidgetLookFeel.cpp.

References CEGUI::PropertySet::addProperty(), and CEGUI::PropertySet::setProperty().

Referenced by CEGUI::Window::setLookNFeel().

bool CEGUI::WidgetLookFeel::isNamedAreaDefined const String name  )  const
 

return whether a NamedArea object with the specified name exists for this WidgetLookFeel.

Parameters:
name String holding the name of the NamedArea to check for.
Returns:
  • true if a named area with the requested name is defined for this WidgetLookFeel.
  • false if no such named area is defined for this WidgetLookFeel.

Definition at line 176 of file CEGUIFalWidgetLookFeel.cpp.

bool CEGUI::WidgetLookFeel::isStateImageryPresent const String state  )  const
 

Return whether imagery is defined for the given state.

Parameters:
state String object containing name of state to look for.
Returns:
  • true if imagery exists for the specified state,
  • false if no imagery exists for the specified state.

Definition at line 143 of file CEGUIFalWidgetLookFeel.cpp.

void CEGUI::WidgetLookFeel::layoutChildWidgets const Window owner  )  const
 

Layout the child widgets defined for this WidgetLookFeel which are attached to the given window.

Parameters:
owner Window object that has the child widgets that require laying out.
Returns:
Nothing.

Definition at line 181 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::Window::performChildWindowLayout().

void CEGUI::WidgetLookFeel::writeXMLToStream OutStream out_stream  )  const
 

Writes an xml representation of this WidgetLookFeel to out_stream.

Parameters:
out_stream Stream where xml data should be output.
Returns:
Nothing.

Definition at line 200 of file CEGUIFalWidgetLookFeel.cpp.

Referenced by CEGUI::WidgetLookManager::writeWidgetLookToStream().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:10:14 2005 for Crazy Eddies GUI System by  doxygen 1.4.3