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

CEGUI::WidgetComponent Class Reference

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

#include <CEGUIFalWidgetComponent.h>

Collaboration diagram for CEGUI::WidgetComponent:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WidgetComponent ()
 WidgetComponent (const String &type, const String &look, const String &suffix)
void create (Window &parent) const
 Create an instance of this widget component adding it as a child to the given Window.
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 StringgetWidgetNameSuffix () const
void setWidgetNameSuffix (const String &suffix)
VerticalAlignment getVerticalWidgetAlignemnt () const
void setVerticalWidgetAlignment (VerticalAlignment alignment)
HorizontalAlignment getHorizontalWidgetAlignemnt () const
void setHorizontalWidgetAlignemnt (HorizontalAlignment alignment)
void addPropertyInitialiser (const PropertyInitialiser &initialiser)
void clearPropertyInitialisers ()
void layout (const Window &owner) const
void writeXMLToStream (OutStream &out_stream) const
 Writes an xml representation of this WidgetComponent to out_stream.

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

Definition at line 46 of file CEGUIFalWidgetComponent.h.


Constructor & Destructor Documentation

CEGUI::WidgetComponent::WidgetComponent  )  [inline]
 

Definition at line 49 of file CEGUIFalWidgetComponent.h.

CEGUI::WidgetComponent::WidgetComponent const String type,
const String look,
const String suffix
 

Definition at line 33 of file CEGUIFalWidgetComponent.cpp.


Member Function Documentation

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

Definition at line 130 of file CEGUIFalWidgetComponent.cpp.

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

void CEGUI::WidgetComponent::clearPropertyInitialisers  ) 
 

Definition at line 135 of file CEGUIFalWidgetComponent.cpp.

void CEGUI::WidgetComponent::create Window parent  )  const
 

Create an instance of this widget component adding it as a child to the given Window.

Definition at line 41 of file CEGUIFalWidgetComponent.cpp.

References CEGUI::Window::addChildWindow(), CEGUI::WindowManager::createWindow(), CEGUI::String::empty(), CEGUI::Window::getName(), CEGUI::WindowManager::getSingleton(), CEGUI::Window::setHorizontalAlignment(), CEGUI::Window::setLookNFeel(), and CEGUI::Window::setVerticalAlignment().

const String & CEGUI::WidgetComponent::getBaseWidgetType  )  const
 

Definition at line 80 of file CEGUIFalWidgetComponent.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementEnd(), and CEGUI::Falagard_xmlHandler::elementStart().

const ComponentArea & CEGUI::WidgetComponent::getComponentArea  )  const
 

Definition at line 70 of file CEGUIFalWidgetComponent.cpp.

HorizontalAlignment CEGUI::WidgetComponent::getHorizontalWidgetAlignemnt  )  const
 

Definition at line 120 of file CEGUIFalWidgetComponent.cpp.

VerticalAlignment CEGUI::WidgetComponent::getVerticalWidgetAlignemnt  )  const
 

Definition at line 110 of file CEGUIFalWidgetComponent.cpp.

const String & CEGUI::WidgetComponent::getWidgetLookName  )  const
 

Definition at line 90 of file CEGUIFalWidgetComponent.cpp.

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

const String & CEGUI::WidgetComponent::getWidgetNameSuffix  )  const
 

Definition at line 100 of file CEGUIFalWidgetComponent.cpp.

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

void CEGUI::WidgetComponent::layout const Window owner  )  const
 

Definition at line 140 of file CEGUIFalWidgetComponent.cpp.

References CEGUI::Absolute, CEGUI::Window::getName(), CEGUI::ComponentArea::getPixelRect(), CEGUI::WindowManager::getSingleton(), CEGUI::WindowManager::getWindow(), and CEGUI::Window::setRect().

void CEGUI::WidgetComponent::setBaseWidgetType const String type  ) 
 

Definition at line 85 of file CEGUIFalWidgetComponent.cpp.

void CEGUI::WidgetComponent::setComponentArea const ComponentArea area  ) 
 

Definition at line 75 of file CEGUIFalWidgetComponent.cpp.

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

void CEGUI::WidgetComponent::setHorizontalWidgetAlignemnt HorizontalAlignment  alignment  ) 
 

Definition at line 125 of file CEGUIFalWidgetComponent.cpp.

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

void CEGUI::WidgetComponent::setVerticalWidgetAlignment VerticalAlignment  alignment  ) 
 

Definition at line 115 of file CEGUIFalWidgetComponent.cpp.

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

void CEGUI::WidgetComponent::setWidgetLookName const String look  ) 
 

Definition at line 95 of file CEGUIFalWidgetComponent.cpp.

void CEGUI::WidgetComponent::setWidgetNameSuffix const String suffix  ) 
 

Definition at line 105 of file CEGUIFalWidgetComponent.cpp.

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

Writes an xml representation of this WidgetComponent to out_stream.

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

Definition at line 150 of file CEGUIFalWidgetComponent.cpp.

References CEGUI::String::empty(), CEGUI::FalagardXMLHelper::horzAlignmentToString(), CEGUI::FalagardXMLHelper::vertAlignmentToString(), and CEGUI::ComponentArea::writeXMLToStream().


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