Crazy Eddie's GUI System  0.8.4
CEGUI::LayoutCell Class Reference

Represents a cell in a layout container. More...

+ Inheritance diagram for CEGUI::LayoutCell:
+ Collaboration diagram for CEGUI::LayoutCell:

List of all members.

Public Member Functions

 LayoutCell (const String &type, const String &name)
 Constructor for LayoutCell class.
virtual ~LayoutCell (void)
 Destructor.
virtual const CachedRectfgetClientChildContentArea () const
 Return a Rect that is used by client child elements as content area.
virtual void notifyScreenAreaChanged (bool recursive)
 Inform the window, and optionally all children, that screen area rectangles have changed.

Static Public Attributes

static const String EventNamespace
 Namespace for events.
static const String WidgetTypeName
 Window factory name.

Protected Types

typedef std::multimap< Window
*, Event::Connection
ConnectionTracker

Protected Member Functions

virtual Rectf getUnclippedInnerRect_impl (bool skipAllPixelAlignment) const
Rectf getClientChildContentArea_impl (bool skipAllPixelAlignment) const
virtual void addChild_impl (Element *element)
virtual void removeChild_impl (Element *element)
virtual bool handleChildSized (const EventArgs &e)
 Handler called when child window gets sized.
virtual bool handleChildAdded (const EventArgs &e)
 Handler called when child window gets added.
virtual bool handleChildRemoved (const EventArgs &e)
 Handler called when child window gets removed.

Protected Attributes

ConnectionTracker d_eventConnections
 Tracks event connections we make.
CachedRectf d_clientChildContentArea

Detailed Description

Represents a cell in a layout container.

Layout cell's role is to encapsulate widgets inside a layout container. It also contains a "Margin" property to set contained widget's margin on all 4 edges.

Unless you want to set the margin, you should never encounter this class. Everything is encapsulated automatically when adding widgets into layout containers. You will however see instances of this class inside XML layout files.


Constructor & Destructor Documentation

CEGUI::LayoutCell::LayoutCell ( const String type,
const String name 
)

Constructor for LayoutCell class.

Parameters:
typeString object holding Window type (usually provided by WindowFactory).
nameString object holding unique name for the Window.

Member Function Documentation

virtual void CEGUI::LayoutCell::addChild_impl ( Element element) [protected, virtual]

Add given element to child list at an appropriate position.

Reimplemented from CEGUI::Window.

virtual const CachedRectf& CEGUI::LayoutCell::getClientChildContentArea ( ) const [virtual]

Return a Rect that is used by client child elements as content area.

Client content area is used for relative sizing, positioning and clipping of child elements that are client (their NonClient property is "false").

See also:
Element::getChildContentArea

Reimplemented from CEGUI::Element.

virtual Rectf CEGUI::LayoutCell::getUnclippedInnerRect_impl ( bool  skipAllPixelAlignment) const [protected, virtual]

Default implementation of function to return Element's inner rect area.

Reimplemented from CEGUI::Window.

virtual bool CEGUI::LayoutCell::handleChildAdded ( const EventArgs e) [protected, virtual]

Handler called when child window gets added.

Parameters:
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is the one that was added.
virtual bool CEGUI::LayoutCell::handleChildRemoved ( const EventArgs e) [protected, virtual]

Handler called when child window gets removed.

Parameters:
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is the one that was removed.
virtual bool CEGUI::LayoutCell::handleChildSized ( const EventArgs e) [protected, virtual]

Handler called when child window gets sized.

Parameters:
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is the one that was sized.
virtual void CEGUI::LayoutCell::notifyScreenAreaChanged ( bool  recursive) [virtual]

Inform the window, and optionally all children, that screen area rectangles have changed.

Parameters:
recursive
  • true to recursively call notifyScreenAreaChanged on attached child Window objects.
  • false to just process this Window.

Reimplemented from CEGUI::Window.

virtual void CEGUI::LayoutCell::removeChild_impl ( Element element) [protected, virtual]

Remove given element from child list.

Reimplemented from CEGUI::Window.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends