Inheritance diagram for CEGUI::MenuItem:
Public Member Functions | |
bool | isHovering (void) const |
return true if user is hovering over this widget (or it's pushed and user is not over it for highlight) | |
bool | isPushed (void) const |
Return true if the button widget is in the pushed state. | |
bool | isOpened (void) const |
Returns true if the popup menu attached to the menu item is open. | |
PopupMenu * | getPopupMenu (void) const |
Get the PopupMenu that is currently attached to this MenuItem. | |
void | setPopupMenu (PopupMenu *popup) |
Set the popup menu for this item. | |
void | openPopupMenu (bool notify=true) |
Opens the PopupMenu. | |
void | closePopupMenu (bool notify=true) |
Closes the PopupMenu. | |
bool | togglePopupMenu (void) |
Toggles the PopupMenu. | |
MenuItem (const String &type, const String &name) | |
Constructor for MenuItem objects. | |
virtual | ~MenuItem (void) |
Destructor for MenuItem objects. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | WidgetTypeName |
Window factory name. | |
static const String | EventClicked |
The menu item was clicked. | |
Protected Member Functions | |
virtual void | onClicked (WindowEventArgs &e) |
handler invoked internally when the MenuItem is clicked. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseButtonUp (MouseEventArgs &e) |
Handler called when a mouse button has been released within this window's area. | |
virtual void | onCaptureLost (WindowEventArgs &e) |
Handler called when this window loses capture of mouse inputs. | |
virtual void | onMouseLeaves (MouseEventArgs &e) |
Handler called when the mouse cursor has left this window's area. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
void | updateInternalState (const Point &mouse_pos) |
Update the internal state of the widget with the mouse at the given position. | |
void | closeAllMenuItemPopups () |
Recursive function that closes all popups down the hierarcy starting with this one. | |
void | setPopupMenu_impl (PopupMenu *popup, bool add_as_child=true) |
Set the popup menu for this item. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. | |
Protected Attributes | |
bool | d_pushed |
true when widget is pushed | |
bool | d_hovering |
true when the button is in 'hover' state and requires the hover rendering. | |
bool | d_opened |
true when the menu item's popup menu is in its opened state. | |
PopupMenu * | d_popup |
PopupMenu that this item displays when activated. | |
bool | d_popupWasClosed |
Used internally to determine if a popup was just closed on a Clicked event. |
void CEGUI::MenuItem::closeAllMenuItemPopups | ( | ) | [protected] |
Recursive function that closes all popups down the hierarcy starting with this one.
void CEGUI::MenuItem::closePopupMenu | ( | bool | notify = true |
) |
Closes the PopupMenu.
notify | true if the parent menubar (if any) is to handle the close. |
PopupMenu* CEGUI::MenuItem::getPopupMenu | ( | void | ) | const [inline] |
bool CEGUI::MenuItem::isHovering | ( | void | ) | const [inline] |
return true if user is hovering over this widget (or it's pushed and user is not over it for highlight)
bool CEGUI::MenuItem::isPushed | ( | void | ) | const [inline] |
Return true if the button widget is in the pushed state.
void CEGUI::MenuItem::onCaptureLost | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when this window loses capture of mouse inputs.
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.
void CEGUI::MenuItem::onMouseButtonDown | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been depressed within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::MenuItem::onMouseButtonUp | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been released within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::MenuItem::onMouseLeaves | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse cursor has left this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::MenuItem::onMouseMove | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse cursor has been moved within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
void CEGUI::MenuItem::onTextChanged | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when the window's text is changed.
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.
void CEGUI::MenuItem::openPopupMenu | ( | bool | notify = true |
) |
Opens the PopupMenu.
notify | true if the parent menu bar or menu popup (if any) is to handle the open. |
void CEGUI::MenuItem::setPopupMenu | ( | PopupMenu * | popup | ) |
Set the popup menu for this item.
popup | popupmenu window to attach to this item |
void CEGUI::MenuItem::setPopupMenu_impl | ( | PopupMenu * | popup, | |
bool | add_as_child = true | |||
) | [protected] |
Set the popup menu for this item.
popup | popupmenu window to attach to this item |
virtual bool CEGUI::MenuItem::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::ItemEntry.
bool CEGUI::MenuItem::togglePopupMenu | ( | void | ) |
void CEGUI::MenuItem::updateInternalState | ( | const Point & | mouse_pos | ) | [protected] |
Update the internal state of the widget with the mouse at the given position.
mouse_pos | Point object describing, in screen pixel co-ordinates, the location of the mouse cursor. |