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. | |
colour | getHoverColour (void) const |
return text label colour used for hover / highlight rendering | |
colour | getPushedColour (void) const |
return text label colour used for pushed rendering | |
colour | getOpenedColour (void) const |
return text label colour used for opened rendering | |
colour | getNormalTextColour (void) const |
return text label colour used for normal rendering | |
colour | getDisabledTextColour (void) const |
return text label colour used for disabled rendering | |
PopupMenu * | getPopupMenu (void) const |
Get the PopupMenu that is currently attached to this MenuItem. | |
void | setHoverColour (const colour &colour) |
Set the colour to use when rendering in the hover / highlighted states. | |
void | setPushedColour (const colour &colour) |
Set the colour to use when rendering in the pushed state. | |
void | setOpenedColour (const colour &colour) |
Set the colour to use when rendering in the opened state. | |
void | setNormalTextColour (const colour &colour) |
Set the colour to use for the label text when rendering in the normal state. | |
void | setDisabledTextColour (const colour &colour) |
Set the colour to use for the label text when rendering in the disabled state. | |
void | setPopupMenu (PopupMenu *popup) |
Set the popup menu for this item. | |
void | openPopupMenu (void) |
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 colour | DefaultHoverColour = 0xFFFFFFFF |
Default colour used when rendering in hover / highlight state. | |
static const colour | DefaultPushedColour = 0xFFFFFFFF |
Default colour used when rendering in pushed state. | |
static const colour | DefaultOpenedColour = 0xFFEFEFEF |
Default colour used when rendering in opended state. | |
static const colour | DefaultNormalTextColour = 0xFFFFFFFF |
Default colour used when rendering the text in normal state. | |
static const colour | DefaultDisabledTextColour = 0xFF7F7F7F |
Default colour used when rendering the text in disabled state. | |
static const String | EventClicked |
The menuitem 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. | |
void | updateInternalState (const Point &mouse_pos) |
Update the internal state of the widget with the mouse at the given position. | |
void | addMenuItemEvents (void) |
Add menuitem specific events. | |
void | closeAllMenuItemPopups () |
Recursive function that closes all popups down the hierarcy starting with this one. | |
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 heirarchy. | |
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 opened. | |
colour | d_hoverColour |
Colour used when rendering in highlighted state. | |
colour | d_pushedColour |
Colour used when rendering in pushed state. | |
colour | d_openedColour |
Colour used when rendering in opened state. | |
colour | d_normalTextColour |
Colour used for the text when rendering in normal state. | |
colour | d_disabledTextColour |
Colour used for the text when rendering in disabled 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. |
|
Recursive function that closes all popups down the hierarcy starting with this one.
|
|
Closes the PopupMenu.
|
|
return text label colour used for disabled rendering
|
|
return text label colour used for hover / highlight rendering
|
|
return text label colour used for normal rendering
|
|
return text label colour used for opened rendering
|
|
Get the PopupMenu that is currently attached to this MenuItem.
|
|
return text label colour used for pushed rendering
|
|
return true if user is hovering over this widget (or it's pushed and user is not over it for highlight)
|
|
Return true if the button widget is in the pushed state.
|
|
Handler called when this window loses capture of mouse inputs.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been depressed within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been released within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse cursor has left this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse cursor has been moved within this window's area.
Reimplemented from CEGUI::Window. |
|
Set the colour to use for the label text when rendering in the disabled state.
|
|
Set the colour to use when rendering in the hover / highlighted states.
|
|
Set the colour to use for the label text when rendering in the normal state.
|
|
Set the colour to use when rendering in the opened state.
|
|
Set the popup menu for this item.
|
|
Set the colour to use when rendering in the pushed state.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::TextItem. |
|
Toggles the PopupMenu.
|
|
Update the internal state of the widget with the mouse at the given position.
|