RightClickMenuManager Class Reference

#include <rtclick.h>

Inheritance diagram for RightClickMenuManager:

Public Member Functions
CoreExport void	Register (RightClickMenu *menu)
CoreExport void	Unregister (RightClickMenu *menu)
CoreExport void	Init (HMENU menu, int iStartId, int iLimit, HWND hWnd, IPoint2 m)
CoreExport void	CleanUp ()
CoreExport int	AddMenu (RightClickMenu *menu, UINT flags, UINT id, const MCHAR *data)
CoreExport int	BeginSubMenu (const MCHAR *name)
CoreExport int	EndSubMenu ()
CoreExport void	Process (UINT id)

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

See also

Class RightClickMenu, Class Interface.

Description:

Methods of this class allow a developer to extend the menu presented when a user right clicks on an item in the viewports. All methods of this class are implemented by the system.

Member Function Documentation

Register()

CoreExport void Register

(

RightClickMenu *

menu

)

Remarks

This method is used to register an instance of a class derived from RightClickMenu. This allows its methods to be called when the user right clicks on an object in a viewport.

Parameters:

RightClickMenu *menu

The menu to set as register.

Unregister()

CoreExport void Unregister

(

RightClickMenu *

menu

)

Remarks

This method is used to un-register a registered right click menu.

Parameters:

RightClickMenu *menu

The menu to set as un-register.

Init()

CoreExport void Init	(	HMENU	menu,
		int	iStartId,
		int	iLimit,
		HWND	hWnd,
		IPoint2	m
	)

Remarks

This method is used internally.

CleanUp()

CoreExport void CleanUp

(

)

Remarks

This method is available in release 3.0 and later only.

This removes all sub menus from the right click menu.

AddMenu()

CoreExport int AddMenu	(	RightClickMenu *	menu,
		UINT	flags,
		UINT	id,
		const MCHAR *	data
	)

Remarks

This method is called to add items to the right click menu passed. A string or separator may be added. Strings may be checked or unchecked. They may also be disabled and grayed.

Parameters:

RightClickMenu *menu

The menu to add the item to.

UINT flags

Describes the item being added. One or more of the following values:

MF_CHECKED

MF_UNCHECKED

MF_STRING

MF_DISABLED

MF_GRAYED

MF_SEPARATOR

UINT id

The id of the selection. This is the id passed to the RightClickMenu::Selected() method when the user makes a selection from the menu.

MCHAR* data

The string to display in the menu (or NULL if adding a separator).

Returns

Nonzero if the item was added; otherwise 0.

BeginSubMenu()

CoreExport int BeginSubMenu

(

const MCHAR *

name

)

Remarks

This method is available in release 3.0 and later only.

This begins a new sub menu. Items added after this call will appear as sub choices of this one until EndSubMenu() is called.

Parameters:

MCHAR* name

The name to appear for the sub menu item.

Returns

Always returns TRUE.

EndSubMenu()

CoreExport int EndSubMenu

(

)

Remarks

This method is available in release 3.0 and later only.

This ends a sub menu. Items added after this call will appear as they did prior to calling BeginSubMenu().

Returns

Always returns TRUE.

Process()

CoreExport void Process

(

UINT

id

)

Remarks

This method is used internally.