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

An abstract base class providing common functionality and specifying the required interface for derived classes. More...

+ Inheritance diagram for CEGUI::SequentialLayoutContainer:
+ Collaboration diagram for CEGUI::SequentialLayoutContainer:

List of all members.

Public Member Functions

 SequentialLayoutContainer (const String &type, const String &name)
 Constructor for Window base class.
virtual ~SequentialLayoutContainer (void)
 Destructor for Window base class.
size_t getPositionOfChild (Window *wnd) const
 Gets the position of given child window.
size_t getPositionOfChild (const String &wnd) const
 Gets the position of given child window.
WindowgetChildAtPosition (size_t position) const
 Gets the child window that currently is at given position.
virtual void swapChildPositions (size_t wnd1, size_t wnd2)
 Swaps windows at given positions.
void swapChildren (Window *wnd1, Window *wnd2)
 Swaps positions of given windows.
void swapChildren (const String &wnd1, Window *wnd2)
 Swaps positions of given windows.
void swapChildren (Window *wnd1, const String &wnd2)
 Swaps positions of given windows.
void swapChildren (const String &wnd1, const String &wnd2)
 Swaps positions of given windows.
virtual void moveChildToPosition (Window *wnd, size_t position)
 Moves a window that is alrady child of thi layout container to given position (if the window is currently in a position that is smaller than given position, given position is automatically decremented.
void moveChildToPosition (const String &wnd, size_t position)
 Moves a window that is alrady child of thi layout container to given position (if the window is currently in a position that is smaller than given position, given position is automatically decremented.
void moveChild (Window *window, int delta=1)
 Moves a window forward or backward, depending on delta (-1 moves it backward one step, 1 moves it forward one step)
void addChildToPosition (Window *window, size_t position)
 Adds a window to given position.
void removeChildFromPosition (size_t position)
 Removes a window from given position.

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
static const String EventChildOrderChanged
 fired when child windows get rearranged

Protected Member Functions

virtual void onChildOrderChanged (WindowEventArgs &e)
 Handler called when children of this window gets rearranged in any way.

Detailed Description

An abstract base class providing common functionality and specifying the required interface for derived classes.

Sequential Layout Container provide means for automatic positioning of windows in sequence


Constructor & Destructor Documentation

Constructor for Window base class.

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

Member Function Documentation

void CEGUI::SequentialLayoutContainer::moveChild ( Window window,
int  delta = 1 
)

Moves a window forward or backward, depending on delta (-1 moves it backward one step, 1 moves it forward one step)

Parameters:
deltaThe amount of steps the window will be moved (old position + delta = new position)
virtual void CEGUI::SequentialLayoutContainer::onChildOrderChanged ( WindowEventArgs e) [protected, virtual]

Handler called when children of this window gets rearranged in any way.

Parameters:
eWindowEventArgs object whose 'window' field is set this layout container.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends