Crazy Eddie's GUI System
0.8.4
|
Abstract base class for menus. More...
Public Member Functions | |
float | getItemSpacing (void) const |
Get the item spacing for this menu. | |
bool | isMultiplePopupsAllowed (void) const |
Return whether this menu allows multiple popup menus to open at the same time. | |
bool | getAutoCloseNestedPopups (void) const |
Return whether this menu should close all its open child popups, when it gets hidden. | |
MenuItem * | getPopupMenuItem (void) const |
Get currently opened MenuItem in this menu. Returns NULL if no menu item is open. | |
void | setItemSpacing (float spacing) |
Set the item spacing for this menu. | |
void | changePopupMenuItem (MenuItem *item) |
Change the currently open MenuItem in this menu. | |
void | setAllowMultiplePopups (bool setting) |
Set whether this menu allows multiple popup menus to be opened simultaneously. | |
void | setAutoCloseNestedPopups (bool setting) |
Set whether the menu should close all its open child popups, when it gets hidden. | |
void | setPopupMenuItemClosing () |
tells the current popup that it should start its closing timer. | |
MenuBase (const String &type, const String &name) | |
Constructor for MenuBase objects. | |
virtual | ~MenuBase (void) |
Destructor for MenuBase objects. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventPopupOpened |
static const String | EventPopupClosed |
Protected Member Functions | |
virtual void | onPopupOpened (WindowEventArgs &e) |
handler invoked internally when the a MenuItem attached to this menu opens its popup. | |
virtual void | onPopupClosed (WindowEventArgs &e) |
handler invoked internally when the a MenuItem attached to this menu closes its popup. | |
virtual void | onChildRemoved (ElementEventArgs &e) |
Handler called when a child window is removed from this window. | |
virtual void | onHidden (WindowEventArgs &e) |
Handler called when the window is hidden. | |
Protected Attributes | |
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 |
Abstract base class for menus.
void CEGUI::MenuBase::changePopupMenuItem | ( | MenuItem * | item | ) |
bool CEGUI::MenuBase::getAutoCloseNestedPopups | ( | void | ) | const [inline] |
Return whether this menu should close all its open child popups, when it gets hidden.
float CEGUI::MenuBase::getItemSpacing | ( | void | ) | const [inline] |
Get the item spacing for this menu.
MenuItem* CEGUI::MenuBase::getPopupMenuItem | ( | void | ) | const [inline] |
bool CEGUI::MenuBase::isMultiplePopupsAllowed | ( | void | ) | const [inline] |
Return whether this menu allows multiple popup menus to open at the same time.
virtual void CEGUI::MenuBase::onChildRemoved | ( | ElementEventArgs & | e | ) | [protected, virtual] |
Handler called when a child window is removed from this window.
e | WindowEventArgs object whose 'window' pointer field is set the window that has been removed. |
Reimplemented from CEGUI::Window.
virtual void CEGUI::MenuBase::onHidden | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when the window is hidden.
e | WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. |
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::PopupMenu.
const String CEGUI::MenuBase::EventPopupClosed [static] |
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.
const String CEGUI::MenuBase::EventPopupOpened [static] |
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.