IQuadMenuContext Class Reference

This abstract class represents the interface for a quad menu bar context. More...

#include <imenuman.h>

Inheritance diagram for IQuadMenuContext:

Public Types
enum	RightClickContext {   kNonePressed , kShiftPressed , kAltPressed , kControlPressed ,   kShiftAndAltPressed , kShiftAndControlPressed , kControlAndAltPressed , kShiftAndAltAndControlPressed }

Public Member Functions
virtual bool	AddQuadMenu (IQuadMenu *pMenu, const MCHAR *pName)=0
virtual void	SetMenu (int index, IQuadMenu *pMenu, const MCHAR *pName)=0
virtual void	RemoveMenu (int index)=0
virtual int	MenuCount ()=0
virtual IQuadMenu *	GetMenu (int index)=0
virtual int	GetCurrentMenuIndex ()=0
virtual void	SetCurrentMenuIndex (int index)=0
virtual bool	GetShowAllQuads (int index)=0
virtual void	SetShowAllQuads (int index, bool showAll)=0
virtual RightClickContext	GetRightClickContext ()=0
virtual IQuadMenu *	GetRightClickMenu (RightClickContext context)=0
virtual void	SetRightClickMenu (RightClickContext context, IQuadMenu *pMenu)=0
virtual int	FindMenu (IQuadMenu *pMenu)=0
virtual IQuadMenu *	FindMenuByTitle (const MCHAR *pTitle)=0
Public Member Functions inherited from IMenuContext
virtual MenuContextId	GetId ()=0
	This method returns the Menu Context ID.
virtual MenuContextType	GetType ()=0
	This method returns the enum MenuContextType.
virtual MSTR &	GetName ()=0
	This method returns the name of the Menu Context.
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

This abstract class represents the interface for a quad menu bar context.

This abstract class represents the interface for a quad menu bar context and provides the functionality to manage the quad menu context by adding and removing menu sections.

Note

Methods marked for internal use only should not be used.

See also

Class IMenuContext, Class Interface, Right-Click Contexts.

Member Function Documentation

AddQuadMenu()

virtual bool AddQuadMenu ( IQuadMenu *  pMenu, const MCHAR *  pName  )

pure virtual

Remarks

This method allows you to add a new quad menu to the context.

Parameters:

IQuadMenu* pMenu

A pointer to the quad menu you wish to add.

MCHAR* pName

The name of the quad menu.

Returns

TRUE if the quad menu is successfully added, otherwise FALSE.

SetMenu()

virtual void SetMenu ( int  index, IQuadMenu *  pMenu, const MCHAR *  pName  )

pure virtual

Remarks

This method allows you to set a quad menu for a slot in the context.

Parameters:

int index

The index of the slot in the context.

IQuadMenu* pMenu

A pointer to the quad menu you wish to set.

MCHAR* pName

The name of the quad menu.

RemoveMenu()

virtual void RemoveMenu ( int  index )

pure virtual

Remarks

This method allows you to remove a quad menu from the context.

Parameters:

int index

The index of the quad menu to remove.

MenuCount()

virtual int MenuCount ( )

pure virtual

Remarks

This method returns the number of quad menu's in this context.

GetMenu()

virtual IQuadMenu * GetMenu ( int  index )

pure virtual

Remarks

This method returns a pointer to a quad menu based on its index in the context.

Parameters:

int index

The index of the quad menu you wish to retrieve.

GetCurrentMenuIndex()

virtual int GetCurrentMenuIndex ( )

pure virtual

Remarks

This method returns the index of the currently set default right-click menu.

SetCurrentMenuIndex()

virtual void SetCurrentMenuIndex ( int  index )

pure virtual

Remarks

This method allows you to set the current default right-click menu.

Parameters:

int index

The index of the menu you wish to set as the default menu.

GetShowAllQuads()

virtual bool GetShowAllQuads ( int  index )

pure virtual

Remarks

This method returns the state of the "Show All Menus" flag in each quad registered in the menu manager. TRUE if the flag is set or FALSE if the flag is not set.

Parameters:

int index

The index of the quad menu.

SetShowAllQuads()

virtual void SetShowAllQuads ( int  index, bool  showAll  )

pure virtual

Remarks

This method allows you to set the "Show All Menus" flag in each quad registered in the menu manager.

Parameters:

int index

The index of the quad menu.

bool showAll

Set this parameter to TRUE if you wish to enable the "Show All Menus" flag. Otherwise FALSE.

GetRightClickContext()

virtual RightClickContext GetRightClickContext ( )

pure virtual

Remarks

This method queries the state of the modifier keys and returns the appropriate context.

Returns

See Right-Click Contexts.

GetRightClickMenu()

virtual IQuadMenu * GetRightClickMenu ( RightClickContext  context )

pure virtual

Remarks

This method returns a pointer to the quad menu which has been assigned to the specified right-click context, or NULL if no menu is assigned.

Parameters:

RightClickContext context

See Right-Click Contexts.

SetRightClickMenu()

virtual void SetRightClickMenu ( RightClickContext  context, IQuadMenu *  pMenu  )

pure virtual

Remarks

This method allows you to set the quad menu associated with a specific right-click context.

Parameters:

RightClickContext context

See Right-Click Contexts IQuadMenu *pMenu

A pointer to the quad menu you wish to set.

FindMenu()

virtual int FindMenu ( IQuadMenu *  pMenu )

pure virtual

Remarks

This method returns the index for a specified quad menu, or -1 if the menu is not in the context.

Parameters:

IQuadMenu* pMenu

A pointer to the quad menu you wish to obtain the index of.

FindMenuByTitle()

virtual IQuadMenu * FindMenuByTitle ( const MCHAR *  pTitle )

pure virtual

Remarks

This method returns a pointer to a quad menu by specifying the title of the menu you wish to find. NULL will be returned if the menu was not found.

Parameters:

MCHAR* pTitle

The title string of the menu.