/usr/include/CEGUI/elements/CEGUILayoutContainer.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | /***********************************************************************
filename: CEGUILayoutContainer.h
created: 29/7/2010
author: Martin Preisler
purpose: Defines abstract base class for layout containers
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUILayoutContainer_h_
#define _CEGUILayoutContainer_h_
#include "../CEGUIWindow.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
An abstract base class providing common functionality and specifying the
required interface for derived classes.
Layout Container provide means for automatic positioning based on sizes of
it's child Windows. This is usefull for dynamic UIs.
*/
class CEGUIEXPORT LayoutContainer : public Window
{
public:
/*************************************************************************
Event name constants
*************************************************************************/
//! Namespace for global events
static const String EventNamespace;
/*!
\brief
Constructor for Window base class
\param type
String object holding Window type (usually provided by WindowFactory).
\param name
String object holding unique name for the Window.
*/
LayoutContainer(const String& type, const String& name);
/*!
\brief
Destructor for Window base class
*/
virtual ~LayoutContainer(void);
/*!
\brief
marks this layout container for relayouting before drawing
*/
void markNeedsLayouting();
/*!
\brief
returns true if this layout container will be relayouted before drawing
*/
bool needsLayouting() const;
/*!
\brief
(re)layouts all windows inside this layout container immediately
*/
virtual void layout() = 0;
/*!
\brief
(re)layouts all windows inside this layout container if it was marked
necessary
*/
virtual void layoutIfNecessary();
/// @copydoc Window::getUnclippedInnerRect_impl
virtual Rect getUnclippedInnerRect_impl(void) const;
/// @copydoc Window::update
virtual void update(float elapsed);
protected:
/// @copydoc Window::getClientChildWindowContentArea_impl
virtual Rect getClientChildWindowContentArea_impl() const;
//! @copydoc Window::testClassName_impl
virtual bool testClassName_impl(const String& class_name) const
{
if (class_name == "LayoutContainer") return true;
return Window::testClassName_impl(class_name);
}
size_t getIdxOfChildWindow(Window* wnd) const;
/// @copydoc Window::addChild_impl
virtual void addChild_impl(Window* wnd);
/// @copydoc Window::removeChild_impl
virtual void removeChild_impl(Window* wnd);
/*************************************************************************
Event trigger methods
*************************************************************************/
/*!
\brief
Handler called when child window gets sized
\param e
WindowEventArgs 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 bool handleChildSized(const EventArgs& e);
/*!
\brief
Handler called when child window changes margin(s)
\param e
WindowEventArgs object whose 'window' pointer field is set to the
window that triggered the event. For this event the trigger window is
the one that has had it's margin(s) changed.
*/
virtual bool handleChildMarginChanged(const EventArgs& e);
/*!
\brief
Handler called when child window gets added
\param e
WindowEventArgs 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 handleChildAdded(const EventArgs& e);
/*!
\brief
Handler called when child window gets removed
\param e
WindowEventArgs 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 handleChildRemoved(const EventArgs& e);
/*!
\brief
returns margin offset for given window
*/
virtual UVector2 getOffsetForWindow(Window* window) const;
/*!
\brief
returns bounding size for window, including margins
*/
virtual UVector2 getBoundingSizeForWindow(Window* window) const;
/*************************************************************************
Implementation Data
*************************************************************************/
// if true, we will relayout before rendering of this window starts
bool d_needsLayouting;
typedef std::multimap<Window*, Event::Connection> ConnectionTracker;
//! Tracks event connections we make.
ConnectionTracker d_eventConnections;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUILayoutContainer_h_
|