IMenuGlobalContext Class Reference

#include <imenus.h>

Inheritance diagram for IMenuGlobalContext:

Public Member Functions
virtual	~IMenuGlobalContext ()
virtual void	SetIMenuSettings (IMenuSettings *pIMenuSettings)=0
virtual IMenuSettings *	GetIMenuSettings () const =0
virtual void	UpdateCursorPosition ()=0
virtual const IPoint2 &	GetCursorPosition () const =0
virtual const IPoint2 &	GetInitialCursorPosition () const =0
virtual void	SetInitialCursorPosition (IPoint2 &initPos)=0
virtual void	SetIMenuTimer (IMenuTimer *pIMenuTimer)=0
virtual IMenuTimer *	GetIMenuTimer () const =0
virtual void	SetHDisplayWnd (HWND hDisplayWnd)=0
virtual HWND	GetHDisplayWnd () const =0
virtual void	SetHMessageWnd (HWND hDisplayWnd)=0
virtual HWND	GetHMessageWnd () const =0
virtual void	SetHDisplayDC (HDC hDisplayDC)=0
virtual HDC	GetHDisplayDC () const =0
virtual void	SetTitleHFont (HFONT hTitleFont)=0
virtual HFONT	GetTitleHFont () const =0
virtual void	SetItemHFont (HFONT hItemFont)=0
virtual HFONT	GetItemHFont () const =0
virtual void	SetAcceleratorHFont (HFONT hItemFont)=0
virtual HFONT	GetAcceleratorHFont () const =0
virtual void	SetUniformItemSize (const IPoint2 &itemSize)=0
virtual const IPoint2 &	GetUniformItemSize () const =0
virtual int	GetTitleBarHeight ()=0
virtual ItemID &	GetCurrentItemID ()=0
virtual ItemID &	GetSelectionItemID ()=0
virtual bool	HasSelection ()=0
virtual bool	IsCurrentMenuSelected ()=0
virtual bool	IsCurrentItemSelected ()=0
virtual void	SelectCurrentItem ()=0

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 ImenuItem, Class IMenuSettings, Class IMenuTimer, Class ItemID, Class IPoint2

Description:

This abstract class represents an global context interface for all menus that might be displayed during a user's menuing action and is used internally. Methods that are marked as internal should not be used.

Constructor & Destructor Documentation

~IMenuGlobalContext()

virtual ~IMenuGlobalContext ( )

inlinevirtual

Remarks

Destructor.

{}

Member Function Documentation

SetIMenuSettings()

virtual void SetIMenuSettings ( IMenuSettings *  pIMenuSettings )

pure virtual

Remarks

This method is used internally.

This method allows you to set the menu settings associated with this global context.

Parameters:

IMenuSettings* pIMenuSettings

A pointer to a menu settings object.

GetIMenuSettings()

virtual IMenuSettings * GetIMenuSettings ( ) const

pure virtual

Remarks

This method is used internally.

This method returns a pointer to the menu settings associated with this global context.

UpdateCursorPosition()

virtual void UpdateCursorPosition ( )

pure virtual

Remarks

This method is used internally.

This method updates the cursor position from Win32.

GetCursorPosition()

virtual const IPoint2 & GetCursorPosition ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the cached cursor position.

Returns

The x and y coordinates of the cursor.

GetInitialCursorPosition()

virtual const IPoint2 & GetInitialCursorPosition ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the cached initial cursor position (i.e. the coordinate where the user clicked).

Returns

The x and y coordinates of the cached initial cursor position.

SetInitialCursorPosition()

virtual void SetInitialCursorPosition ( IPoint2 &  initPos )

pure virtual

Remarks

This method is used internally.

This method allows you to set the cached initial cursor position (i.e. the coordinate where the user clicked).

Parameters:

IPoint2& initPos

The x and y coordinate of the cursor position.

SetIMenuTimer()

virtual void SetIMenuTimer ( IMenuTimer *  pIMenuTimer )

pure virtual

Remarks

This method is used internally.

This method allows you to set a global timer for the menu's global context.

Parameters:

IMenuTimer* pIMenuTimer

A pointer to the menu timer object,

GetIMenuTimer()

virtual IMenuTimer * GetIMenuTimer ( ) const

pure virtual

Remarks

This method is used internally.

This method returns a pointer to the global timer for the menu's global context.

SetHDisplayWnd()

virtual void SetHDisplayWnd ( HWND  hDisplayWnd )

pure virtual

Remarks

This method is used internally.

This method allows you to set the handle to the display window.

Parameters:

HWND hDisplayWnd

The handle to the display window.

GetHDisplayWnd()

virtual HWND GetHDisplayWnd ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the display window.

SetHMessageWnd()

virtual void SetHMessageWnd ( HWND  hDisplayWnd )

pure virtual

Remarks

This method is used internally.

This method allows you to set the handle to the message window

Parameters:

HWND hDisplayWnd

The handle to the message window.

GetHMessageWnd()

virtual HWND GetHMessageWnd ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the message window.

SetHDisplayDC()

virtual void SetHDisplayDC ( HDC  hDisplayDC )

pure virtual

Remarks

This method is used internally.

This method allows you to set a handle to the display device context.

Parameters:

HDC hDisplayDC

The handle to the display device context.

GetHDisplayDC()

virtual HDC GetHDisplayDC ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the display device context.

SetTitleHFont()

virtual void SetTitleHFont ( HFONT  hTitleFont )

pure virtual

Remarks

This method is used internally.

This method allows you to set the handle to the title font.

Parameters:

HFONT hTitleFont

The handle to the title font.

GetTitleHFont()

virtual HFONT GetTitleHFont ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the title font.

SetItemHFont()

virtual void SetItemHFont ( HFONT  hItemFont )

pure virtual

Remarks

This method is used internally.

This method allows you to set the handle to the item font.

Parameters:

HFONT hItemFont

The handle to the item font.

GetItemHFont()

virtual HFONT GetItemHFont ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the item font.

SetAcceleratorHFont()

virtual void SetAcceleratorHFont ( HFONT  hItemFont )

pure virtual

Remarks

This method is used internally.

This method allows you to set the handle to the accelerator font.

Parameters:

HFONT hItemFont

The handle to the accelerator font.

GetAcceleratorHFont()

virtual HFONT GetAcceleratorHFont ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the handle to the accelerator font.

SetUniformItemSize()

virtual void SetUniformItemSize ( const IPoint2 &  itemSize )

pure virtual

Remarks

This method is used internally.

This method allows you to set the menu's maximum uniform item size.

Parameters:

IPoint2& itemSize

The size rectangle.

GetUniformItemSize()

virtual const IPoint2 & GetUniformItemSize ( ) const

pure virtual

Remarks

This method is used internally.

This method returns the menu's maximum uniform item size as a rectangle.

GetTitleBarHeight()

virtual int GetTitleBarHeight ( )

pure virtual

Remarks

This method is used internally.

This method returns the height of the title bar, not counting the border.

GetCurrentItemID()

virtual ItemID & GetCurrentItemID ( )

pure virtual

Remarks

This method is used internally.

This method returns the ItemID of the menu/item triplet that's currently being traversed.

GetSelectionItemID()

virtual ItemID & GetSelectionItemID ( )

pure virtual

Remarks

This method is used internally.

This method returns the ItemID of the menu/item triplet that's currently selected.

HasSelection()

virtual bool HasSelection ( )

pure virtual

Remarks

This method is used internally.

This method will determine selection is available and will return TRUE if selection is available or FALSE if it is not.

IsCurrentMenuSelected()

virtual bool IsCurrentMenuSelected ( )

pure virtual

Remarks

This method is used internally.

This method will determine the selection status of the current menu and will return TRUE if the current menu is selected or FALSE if it is not.

IsCurrentItemSelected()

virtual bool IsCurrentItemSelected ( )

pure virtual

Remarks

This method is used internally.

This method will determine the selection status of the current menu and item and will return TRUE if the current menu and item are selected or FALSE if they are not.

SelectCurrentItem()

virtual void SelectCurrentItem ( )

pure virtual

Remarks

This method is used internally.

This method selects the current item.