DigitalSpaces::DICEGUIPopupMenu Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
float	getFadeInTime ()
	Get the fade in time for this popup menu.
float	getFadeOutTime ()
	Get the fade out time for this popup menu.
bool	isPopupMenuOpen ()
	Find out if this popup menu is open or closed;.
void	setFadeInTime (float fadetime)
	Set the fade in time for this popup menu.
void	setFadeOutTime (float fadetime)
	Set the fade out time for this popup menu.
void	openPopupMenu ()
	Tells the popup menu to open.
void	openPopupMenu (bool notify)
void	closePopupMenu ()
	Tells the popup menu to close.
void	closePopupMenu (bool notify)

Member Function Documentation

float DigitalSpaces::DICEGUIPopupMenu::getFadeInTime ( )

Get the fade in time for this popup menu.

Returns:: The time in seconds that it takes for the popup to fade in. 0 if fading is disabled.

float DigitalSpaces::DICEGUIPopupMenu::getFadeOutTime ( )

Get the fade out time for this popup menu.

Returns:: The time in seconds that it takes for the popup to fade out. 0 if fading is disabled.

bool DigitalSpaces::DICEGUIPopupMenu::isPopupMenuOpen ( )

Find out if this popup menu is open or closed;.

void DigitalSpaces::DICEGUIPopupMenu::setFadeInTime ( float fadetime )

Set the fade in time for this popup menu.

Parameters:

fadetime

The time in seconds that it takes for the popup to fade in. If this parameter is zero, fading is disabled.

void DigitalSpaces::DICEGUIPopupMenu::setFadeOutTime ( float fadetime )

Set the fade out time for this popup menu.

Parameters:

fadetime

The time in seconds that it takes for the popup to fade out. If this parameter is zero, fading is disabled.

void DigitalSpaces::DICEGUIPopupMenu::openPopupMenu ( )

Tells the popup menu to open.

Parameters:

notify

true if the parent menu item (if any) is to handle the opening. false if not.

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

void DigitalSpaces::DICEGUIPopupMenu::closePopupMenu ( )

Tells the popup menu to close.

Parameters:

notify

true if the parent menu item (if any) is to handle the closing. false if not.

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

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