DigitalSpaces::DICEGUIMenuItem Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
bool	isHovering ()
	return true if user is hovering over this widget (or it's pushed and user is not over it for highlight)
bool	isPushed ()
	Return true if the button widget is in the pushed state.
bool	isOpened ()
	Returns true if the popup menu attached to the menu item is open.
DICEGUIPopupMenu *	getPopupMenu ()
	Get the PopupMenu that is currently attached to this MenuItem.
void	setPopupMenu (DICEGUIPopupMenu *popup)
	Set the popup menu for this item.
void	openPopupMenu ()
	Opens the PopupMenu.
void	openPopupMenu (bool notify)
void	closePopupMenu ()
	Closes the PopupMenu.
void	closePopupMenu (bool notify)
bool	togglePopupMenu ()
	Toggles the PopupMenu.

Member Function Documentation

bool DigitalSpaces::DICEGUIMenuItem::isHovering ( )

return true if user is hovering over this widget (or it's pushed and user is not over it for highlight)

Returns:: true if the user is hovering or if the button is pushed and the mouse is not over the button. Otherwise return false.

bool DigitalSpaces::DICEGUIMenuItem::isPushed ( )

Return true if the button widget is in the pushed state.

Returns:: true if the button-type widget is pushed, false if the widget is not pushed.

bool DigitalSpaces::DICEGUIMenuItem::isOpened ( )

Returns true if the popup menu attached to the menu item is open.

DICEGUIPopupMenu* DigitalSpaces::DICEGUIMenuItem::getPopupMenu ( )

Get the PopupMenu that is currently attached to this MenuItem.

Returns:: A pointer to the currently attached PopupMenu. Null is there is no PopupMenu attached.

void DigitalSpaces::DICEGUIMenuItem::setPopupMenu ( DICEGUIPopupMenu * popup )

Set the popup menu for this item.

Parameters:

popup

popupmenu window to attach to this item

void DigitalSpaces::DICEGUIMenuItem::openPopupMenu ( )

Opens the PopupMenu.

Parameters:

notify

true if the parent menu bar or menu popup (if any) is to handle the open.

void DigitalSpaces::DICEGUIMenuItem::openPopupMenu ( bool notify )

void DigitalSpaces::DICEGUIMenuItem::closePopupMenu ( )

Closes the PopupMenu.

Parameters:

notify

true if the parent menubar (if any) is to handle the close.

void DigitalSpaces::DICEGUIMenuItem::closePopupMenu ( bool notify )

bool DigitalSpaces::DICEGUIMenuItem::togglePopupMenu ( )

Toggles the PopupMenu.

The documentation for this struct was generated from the following file: