Crazy Eddie's GUI System  0.8.7
SequentialLayoutContainer.h
1 /***********************************************************************
2  created: 02/8/2010
3  author: Martin Preisler
4 
5  purpose: Defines abstract base class for layout containers
6 *************************************************************************/
7 /***************************************************************************
8  * Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining
11  * a copy of this software and associated documentation files (the
12  * "Software"), to deal in the Software without restriction, including
13  * without limitation the rights to use, copy, modify, merge, publish,
14  * distribute, sublicense, and/or sell copies of the Software, and to
15  * permit persons to whom the Software is furnished to do so, subject to
16  * the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27  * OTHER DEALINGS IN THE SOFTWARE.
28  ***************************************************************************/
29 #ifndef _CEGUISequentialLayoutContainer_h_
30 #define _CEGUISequentialLayoutContainer_h_
31 
32 #include "./LayoutContainer.h"
33 
34 #if defined(_MSC_VER)
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
37 #endif
38 
39 // Start of CEGUI namespace section
40 namespace CEGUI
41 {
42 
51 class CEGUIEXPORT SequentialLayoutContainer : public LayoutContainer
52 {
53 public:
54  /*************************************************************************
55  Event name constants
56  *************************************************************************/
58  static const String EventNamespace;
59 
62 
73  SequentialLayoutContainer(const String& type, const String& name);
74 
80 
85  size_t getPositionOfChild(Window* wnd) const;
86 
91  size_t getPositionOfChild(const String& wnd) const;
92 
97  Window* getChildAtPosition(size_t position) const;
98 
103  virtual void swapChildPositions(size_t wnd1, size_t wnd2);
104 
109  void swapChildren(Window* wnd1, Window* wnd2);
110 
115  void swapChildren(const String& wnd1, Window* wnd2);
116 
121  void swapChildren(Window* wnd1, const String& wnd2);
122 
127  void swapChildren(const String& wnd1, const String& wnd2);
128 
136  virtual void moveChildToPosition(Window* wnd, size_t position);
137 
145  void moveChildToPosition(const String& wnd, size_t position);
146 
156  void moveChild(Window* window, int delta = 1);
157 
162  void addChildToPosition(Window* window, size_t position);
163 
168  void removeChildFromPosition(size_t position);
169 
170 protected:
180 };
181 
182 } // End of CEGUI namespace section
183 
184 #if defined(_MSC_VER)
185 # pragma warning(pop)
186 #endif
187 
188 #endif // end of guard _CEGUISequentialLayoutContainer_h_
189 
CEGUI::SequentialLayoutContainer::moveChildToPosition
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 curre...
CEGUI::SequentialLayoutContainer::addChildToPosition
void addChildToPosition(Window *window, size_t position)
Adds a window to given position.
CEGUI::SequentialLayoutContainer::swapChildren
void swapChildren(Window *wnd1, const String &wnd2)
Swaps positions of given windows.
CEGUI::SequentialLayoutContainer::getPositionOfChild
size_t getPositionOfChild(const String &wnd) const
Gets the position of given child window.
CEGUI::SequentialLayoutContainer::~SequentialLayoutContainer
virtual ~SequentialLayoutContainer(void)
Destructor for Window base class.
CEGUI::LayoutContainer
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: LayoutContainer.h:54
CEGUI::SequentialLayoutContainer::removeChildFromPosition
void removeChildFromPosition(size_t position)
Removes a window from given position.
CEGUI::SequentialLayoutContainer::EventNamespace
static const String EventNamespace
Namespace for global events.
Definition: SequentialLayoutContainer.h:58
CEGUI::SequentialLayoutContainer
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: SequentialLayoutContainer.h:52
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::SequentialLayoutContainer::onChildOrderChanged
virtual void onChildOrderChanged(WindowEventArgs &e)
Handler called when children of this window gets rearranged in any way.
CEGUI::SequentialLayoutContainer::swapChildPositions
virtual void swapChildPositions(size_t wnd1, size_t wnd2)
Swaps windows at given positions.
CEGUI::SequentialLayoutContainer::moveChildToPosition
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 curre...
CEGUI::WindowEventArgs
EventArgs based class that is used for objects passed to handlers triggered for events concerning som...
Definition: InputEvent.h:252
CEGUI::SequentialLayoutContainer::swapChildren
void swapChildren(Window *wnd1, Window *wnd2)
Swaps positions of given windows.
CEGUI::SequentialLayoutContainer::swapChildren
void swapChildren(const String &wnd1, const String &wnd2)
Swaps positions of given windows.
CEGUI::SequentialLayoutContainer::swapChildren
void swapChildren(const String &wnd1, Window *wnd2)
Swaps positions of given windows.
CEGUI::SequentialLayoutContainer::EventChildOrderChanged
static const String EventChildOrderChanged
fired when child windows get rearranged
Definition: SequentialLayoutContainer.h:61
CEGUI::SequentialLayoutContainer::getChildAtPosition
Window * getChildAtPosition(size_t position) const
Gets the child window that currently is at given position.
CEGUI::SequentialLayoutContainer::SequentialLayoutContainer
SequentialLayoutContainer(const String &type, const String &name)
Constructor for Window base class.
CEGUI::Window
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
CEGUI::SequentialLayoutContainer::moveChild
void moveChild(Window *window, int delta=1)
Moves a window forward or backward, depending on delta (-1 moves it backward one step,...
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::SequentialLayoutContainer::getPositionOfChild
size_t getPositionOfChild(Window *wnd) const
Gets the position of given child window.