A class that manages a hierarchical menu organized by resource categories, types, and subtypes. More...

#include <omEditorTypeMenu.h>

Classes
class	Delegate
	A class that contains callback functions that respond to type menu events. More...

Public Types
enum	Flag { TYPE_MENUS = (1 << 0), SUB_TYPE_MENUS = (1 << 1), CATEGORIES = (1 << 2), TYPES = (1 << 3), SUB_TYPES = (1 << 4) }
	A class that specifies boolean configuration flags for a type menu. More...

Public Member Functions
	TypeMenu ()
	Create a new empty type menu. More...

	~TypeMenu ()
	Destroy a type menu and release internal resources. More...

OM_INLINE Menu &	getMenu ()
	Return a reference to the GUI menu for this type menu. More...

OM_INLINE const Menu &	getMenu () const
	Return a reference to the GUI menu for this type menu. More...

void	addType (const ResourceTypeEditorFactory &newType)
	Add the specified resource type to this type menu and update the menu. More...

void	addTypes (const ResourceEditorManager &newTypes)
	Add the resource types from a resource manager to this type menu and update the menu. More...

void	clearTypes ()
	Remove all types from this menu and return it to its initial state. More...

OM_INLINE Delegate &	getDelegate ()
	Return a reference to the delegate for this type menu. More...

OM_INLINE const Delegate &	getDelegate () const
	Return a reference to the delegate for this type menu. More...

OM_INLINE void	setDelegate (const Delegate &newDelegate)
	Set a reference to the delegate for this type menu. More...

Detailed Description

A class that manages a hierarchical menu organized by resource categories, types, and subtypes.

Member Enumeration Documentation

A class that specifies boolean configuration flags for a type menu.

Enumerator
TYPE_MENUS	A flag indicating whether or not resource types should be in child menus of categories or part of the parent menu.
SUB_TYPE_MENUS	A flag indicating whether or not resource sub-types should be in child menus or part of the parent menu.
CATEGORIES	A flag indicating whether or not resource categories should be visible in the type menu.
TYPES	A flag indicating whether or not resource types should be visible in the type menu.
SUB_TYPES	A flag indicating whether or not resource sub-types should be visible in the type menu. If this flag is set and not the TYPES flag, all types with no subtypes are promoted to subtypes.

om::editors::base::TypeMenu::TypeMenu ( )

Create a new empty type menu.

om::editors::base::TypeMenu::~TypeMenu ( )

Destroy a type menu and release internal resources.

OM_INLINE Menu& om::editors::base::TypeMenu::getMenu ( )

inline

Return a reference to the GUI menu for this type menu.

OM_INLINE const Menu& om::editors::base::TypeMenu::getMenu ( ) const

inline

Return a reference to the GUI menu for this type menu.

void om::editors::base::TypeMenu::addType ( const ResourceTypeEditorFactory & newType )

Add the specified resource type to this type menu and update the menu.

void om::editors::base::TypeMenu::addTypes ( const ResourceEditorManager & newTypes )

Add the resource types from a resource manager to this type menu and update the menu.

void om::editors::base::TypeMenu::clearTypes ( )

Remove all types from this menu and return it to its initial state.

OM_INLINE Delegate& om::editors::base::TypeMenu::getDelegate ( )

inline

Return a reference to the delegate for this type menu.

OM_INLINE const Delegate& om::editors::base::TypeMenu::getDelegate ( ) const

inline

Return a reference to the delegate for this type menu.

OM_INLINE void om::editors::base::TypeMenu::setDelegate ( const Delegate & newDelegate )

inline

Set a reference to the delegate for this type menu.

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