DigitalSpaces::DICEGUIMenuBase Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Public Member Functions

float getItemSpacing ()
 Get the item spacing for this menu.
bool isMultiplePopupsAllowed ()
 Return whether this menu allows multiple popup menus to open at the same time.
DICEGUIMenuItemgetPopupMenuItem ()
 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 (DICEGUIMenuItem *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.

Member Function Documentation

float DigitalSpaces::DICEGUIMenuBase::getItemSpacing (  ) 

Get the item spacing for this menu.

Returns:
A float value with the current item spacing for this menu

bool DigitalSpaces::DICEGUIMenuBase::isMultiplePopupsAllowed (  ) 

Return whether this menu allows multiple popup menus to open at the same time.

Returns:
true if this menu allows multiple popup menus to be opened simultaneously. false if not

DICEGUIMenuItem* DigitalSpaces::DICEGUIMenuBase::getPopupMenuItem (  ) 

Get currently opened MenuItem in this menu. Returns NULL if no menu item is open.

Returns:
Pointer to the MenuItem currently open.

void DigitalSpaces::DICEGUIMenuBase::setItemSpacing ( float  spacing  ) 

Set the item spacing for this menu.

void DigitalSpaces::DICEGUIMenuBase::changePopupMenuItem ( DICEGUIMenuItem item  ) 

Change the currently open MenuItem in this menu.

Parameters:
item Pointer to a MenuItem to open or NULL to close any opened.

void DigitalSpaces::DICEGUIMenuBase::setAllowMultiplePopups ( bool  setting  ) 

Set whether this menu allows multiple popup menus to be opened simultaneously.


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

Generated on Sun Aug 31 17:46:30 2008 for Digital Spaces by  doxygen 1.5.6