/usr/include/cegui-0.8.4/CEGUI/widgets/MenuBase.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 | /***********************************************************************
created: 5/4/2005
author: Tomas Lindquist Olsen (based on code by Paul D Turner)
purpose: Interface to base class for MenuBase widget
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 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 _CEGUIMenuBase_h_
#define _CEGUIMenuBase_h_
#include "../Base.h"
#include "../Window.h"
#include "./ItemListBase.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Abstract base class for menus.
*/
class CEGUIEXPORT MenuBase : public ItemListBase
{
public:
static const String EventNamespace; //!< Namespace for global events
/*************************************************************************
Event name constants
*************************************************************************/
// generated internally by Window
/** Event fired when a MenuItem attached to this menu opened a PopupMenu.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the PopupMenu that was opened.
*/
static const String EventPopupOpened;
/** Event fired when a MenuItem attached to this menu closed a PopupMenu.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the PopupMenu that was closed.
*/
static const String EventPopupClosed;
/*************************************************************************
Accessor type functions
*************************************************************************/
/*!
\brief
Get the item spacing for this menu.
\return
A float value with the current item spacing for this menu
*/
float getItemSpacing(void) const
{
return d_itemSpacing;
}
/*!
\brief
Return whether this menu allows multiple popup menus to open at the same time.
\return
true if this menu allows multiple popup menus to be opened simultaneously. false if not
*/
bool isMultiplePopupsAllowed(void) const
{
return d_allowMultiplePopups;
}
/*!
\brief
Return whether this menu should close all its open child popups, when it gets hidden
\return
true if the menu should close all its open child popups, when it gets hidden
*/
bool getAutoCloseNestedPopups(void) const
{
return d_autoCloseNestedPopups;
}
/*!
\brief
Get currently opened MenuItem in this menu. Returns NULL if no menu item is open.
\return
Pointer to the MenuItem currently open.
*/
MenuItem* getPopupMenuItem(void) const
{
return d_popupItem;
}
/*************************************************************************
Manipulators
*************************************************************************/
/*!
\brief
Set the item spacing for this menu.
*/
void setItemSpacing(float spacing)
{
d_itemSpacing = spacing;
handleUpdatedItemData();
}
/*!
\brief
Change the currently open MenuItem in this menu.
\param item
Pointer to a MenuItem to open or NULL to close any opened.
*/
void changePopupMenuItem(MenuItem* item);
/*!
\brief
Set whether this menu allows multiple popup menus to be opened simultaneously.
*/
void setAllowMultiplePopups(bool setting);
/*!
\brief
Set whether the menu should close all its open child popups, when it gets hidden
*/
void setAutoCloseNestedPopups(bool setting)
{
d_autoCloseNestedPopups = setting;
}
/*!
\brief
tells the current popup that it should start its closing timer.
*/
void setPopupMenuItemClosing();
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for MenuBase objects
*/
MenuBase(const String& type, const String& name);
/*!
\brief
Destructor for MenuBase objects
*/
virtual ~MenuBase(void);
protected:
/*************************************************************************
New Event Handlers
*************************************************************************/
/*!
\brief
handler invoked internally when the a MenuItem attached to this menu opens its popup.
*/
virtual void onPopupOpened(WindowEventArgs& e);
/*!
\brief
handler invoked internally when the a MenuItem attached to this menu closes its popup.
*/
virtual void onPopupClosed(WindowEventArgs& e);
// overridden from base
virtual void onChildRemoved(ElementEventArgs& e);
virtual void onHidden(WindowEventArgs& e);
/*************************************************************************
Implementation Data
*************************************************************************/
float d_itemSpacing; //!< The spacing in pixels between items.
MenuItem* d_popupItem; //!< The currently open MenuItem. NULL if no item is open. If multiple popups are allowed, this means nothing.
bool d_allowMultiplePopups; //!< true if multiple popup menus are allowed simultaneously. false if not.
bool d_autoCloseNestedPopups; //!< true if the menu should close all its open child popups, when it gets hidden
private:
/*************************************************************************
Private methods
*************************************************************************/
void addMenuBaseProperties(void);
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIMenuBase_h_
|