#include <imenus.h>

Inheritance diagram for IQuadMenuSettings:

Public Types
enum	{ fnIdResetDefaults , fnIdSetBorderSize , fnIdGetBorderSize , fnIdSetHorizontalMarginInPoints , fnIdGetHorizontalMarginInPoints , fnIdSetVerticalMarginInPoints , fnIdGetVerticalMarginInPoints , fnIdSetItemFontFace , fnIdGetItemFontFace , fnIdSetTitleFontFace , fnIdGetTitleFontFace , fnIdSetItemFontSize , fnIdGetItemFontSize , fnIdSetTitleFontSize , fnIdGetTitleFontSize , fnIdSetUseUniformItemHeight , fnIdGetUseUniformItemHeight , fnIdSetOpacity , fnIdGetOpacity , fnIdSetDisplayMethod , fnIdGetDisplayMethod , fnIdSetAnimatedSteps , fnIdGetAnimatedSteps , fnIdSetAnimatedStepTime , fnIdGetAnimatedStepTime , fnIdSetSubMenuPauseTime , fnIdGetSubMenuPauseTime , fnIdSetUseLastExecutedItem , fnIdGetUseLastExecutedItem , fnIdSetRepositionWhenClipped , fnIdGetRepositionWhenClipped , fnIdSetRemoveRedundantSeparators , fnIdGetRemoveRedundantSeparators , fnIdSetFirstQuadDisplayed , fnIdGetFirstQuadDisplayed , fnIdSetUseUniformQuadWidth , fnIdGetUseUniformQuadWidth , fnIdSetMirrorQuad , fnIdGetMirrorQuad , fnIdSetMoveCursorOnReposition , fnIdGetMoveCursorOnReposition , fnIdSetReturnCursorAfterReposition , fnIdGetReturnCursorAfterReposition , fnIdSetInitialCursorLocInBox_0to1 , fnIdGetInitialCursorLocXInBox_0to1 , fnIdGetInitialCursorLocYInBox_0to1 , fnIdSetTitleBarBackgroundColor , fnIdGetTitleBarBackgroundColor , fnIdSetTitleBarTextColor , fnIdGetTitleBarTextColor , fnIdSetItemBackgroundColor , fnIdGetItemBackgroundColor , fnIdSetItemTextColor , fnIdGetItemTextColor , fnIdSetLastExecutedItemTextColor , fnIdGetLastExecutedItemTextColor , fnIdSetHighlightedItemBackgroundColor , fnIdGetHighlightedItemBackgroundColor , fnIdSetHighlightedItemTextColor , fnIdGetHighlightedItemTextColor , fnIdSetBorderColor , fnIdGetBorderColor , fnIdSetDisabledShadowColor , fnIdGetDisabledShadowColor , fnIdSetDisabledHighlightColor , fnIdGetDisabledHighlightColor }

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual void	SetFirstQuadDisplayed (QuadIndex firstQuadDisplayed)=0

virtual QuadIndex	GetFirstQuadDisplayed () const =0

virtual void	SetUseUniformQuadWidth (bool useUniformQuadWidth)=0

virtual bool	GetUseUniformQuadWidth () const =0

virtual void	SetUseUniformQuadWidthBOOL (BOOL useUniformQuadWidth)=0

virtual BOOL	GetUseUniformQuadWidthBOOL () const =0

virtual void	SetMirrorQuad (bool mirrorQuad)=0

virtual bool	GetMirrorQuad () const =0

virtual void	SetMirrorQuadBOOL (BOOL mirrorQuad)=0

virtual BOOL	GetMirrorQuadBOOL () const =0

virtual void	SetMoveCursorOnReposition (bool moveCursorOnReposition)=0

virtual bool	GetMoveCursorOnReposition () const =0

virtual void	SetMoveCursorOnRepositionBOOL (BOOL moveCursorOnReposition)=0

virtual BOOL	GetMoveCursorOnRepositionBOOL () const =0

virtual void	SetReturnCursorAfterReposition (bool returnCursorAfterReposition)=0

virtual bool	GetReturnCursorAfterReposition () const =0

virtual void	SetReturnCursorAfterRepositionBOOL (BOOL returnCursorAfterReposition)=0

virtual BOOL	GetReturnCursorAfterRepositionBOOL () const =0

virtual void	SetCursorLocInBox_0to1 (float x, float y)=0

virtual float	GetCursorLocXInBox_0to1 () const =0

virtual float	GetCursorLocYInBox_0to1 () const =0

virtual const MenuColors *	GetMenuColors (int quadNum) const =0

virtual void	SetTitleBarBackgroundColor (int quadNum, const Color &color)=0

virtual const Color &	GetTitleBarBackgroundColor (int quadNum) const =0

virtual COLORREF	GetTitleBarBackgroundColorRef (int quadNum) const =0

virtual void	SetTitleBarTextColor (int quadNum, const Color &color)=0

virtual const Color &	GetTitleBarTextColor (int quadNum) const =0

virtual COLORREF	GetTitleBarTextColorRef (int quadNum) const =0

virtual void	SetItemBackgroundColor (int quadNum, const Color &color)=0

virtual const Color &	GetItemBackgroundColor (int quadNum) const =0

virtual COLORREF	GetItemBackgroundColorRef (int quadNum) const =0

virtual void	SetItemTextColor (int quadNum, const Color &color)=0

virtual const Color &	GetItemTextColor (int quadNum) const =0

virtual COLORREF	GetItemTextColorRef (int quadNum) const =0

virtual void	SetLastExecutedItemTextColor (int quadNum, const Color &color)=0

virtual const Color &	GetLastExecutedItemTextColor (int quadNum) const =0

virtual COLORREF	GetLastExecutedItemTextColorRef (int quadNum) const =0

virtual void	SetHighlightedItemBackgroundColor (int quadNum, const Color &color)=0

virtual const Color &	GetHighlightedItemBackgroundColor (int quadNum) const =0

virtual COLORREF	GetHighlightedItemBackgroundColorRef (int quadNum) const =0

virtual void	SetHighlightedItemTextColor (int quadNum, const Color &color)=0

virtual const Color &	GetHighlightedItemTextColor (int quadNum) const =0

virtual COLORREF	GetHighlightedItemTextColorRef (int quadNum) const =0

virtual void	SetBorderColor (int quadNum, const Color &color)=0

virtual const Color &	GetBorderColor (int quadNum) const =0

virtual COLORREF	GetBorderColorRef (int quadNum) const =0

virtual void	SetDisabledShadowColor (int quadNum, const Color &color)=0

virtual const Color &	GetDisabledShadowColor (int quadNum) const =0

virtual COLORREF	GetDisabledShadowColorRef (int quadNum) const =0

virtual void	SetDisabledHighlightColor (int quadNum, const Color &color)=0

virtual const Color &	GetDisabledHighlightColor (int quadNum) const =0

virtual COLORREF	GetDisabledHighlightColorRef (int quadNum) const =0

Public Member Functions inherited from IMenuSettings
virtual	~IMenuSettings ()

virtual bool	IsTokenValid (const ValidityToken &token)=0

virtual void	UpdateValidityToken (ValidityToken &token) const =0

virtual void	ResetDefaults ()=0

virtual void	SetBorderSz (int borderSz)=0

virtual int	GetBorderSz () const =0

virtual void	SetHorizontalMarginInPoints (int horizontalMarginInPoints)=0

virtual int	GetHorizontalMarginInPoints () const =0

virtual void	SetVerticalMarginInPoints (int verticalMarginInPoints)=0

virtual int	GetVerticalMarginInPoints () const =0

virtual int	GetHorizontalMargin (HDC hDC) const =0

virtual int	GetVerticalMargin (HDC hDC) const =0

virtual void	SetItemFontFace (const MCHAR *szItemFontFace)=0

virtual const MCHAR *	GetItemFontFace () const =0

virtual void	SetTitleFontFace (const MCHAR *szTitleFontFace)=0

virtual const MCHAR *	GetTitleFontFace () const =0

virtual void	SetItemFontSize (int itemFontSize)=0

virtual int	GetItemFontSize () const =0

virtual void	SetTitleFontSize (int titleFontSize)=0

virtual int	GetTitleFontSize () const =0

virtual void	SetUseUniformItemHeight (bool useUniformItemHeight)=0

virtual bool	GetUseUniformItemHeight () const =0

virtual void	SetUseUniformItemHeightBOOL (BOOL useUniformItemHeight)=0

virtual BOOL	GetUseUniformItemHeightBOOL () const =0

virtual void	SetOpacity (float opacity)=0

virtual float	GetOpacity () const =0

virtual void	SetDisplayMethod (DisplayMethod displayMethod)=0

virtual DisplayMethod	GetDisplayMethod () const =0

virtual void	SetAnimatedSteps (unsigned int steps)=0

virtual unsigned int	GetAnimatedSteps () const =0

virtual void	SetAnimatedStepTime (unsigned int ms)=0

virtual unsigned int	GetAnimatedStepTime () const =0

virtual void	SetSubMenuPauseTime (unsigned int ms)=0

virtual unsigned int	GetSubMenuPauseTime () const =0

virtual void	SetUseLastExecutedItem (bool useLastExecutedItem)=0

virtual bool	GetUseLastExecutedItem () const =0

virtual void	SetUseLastExecutedItemBOOL (BOOL useLastExecutedItem)=0

virtual BOOL	GetUseLastExecutedItemBOOL () const =0

virtual void	SetRepositionWhenClipped (bool repositionWhenClipped)=0

virtual bool	GetRepositionWhenClipped () const =0

virtual void	SetRepositionWhenClippedBOOL (BOOL repositionWhenClipped)=0

virtual BOOL	GetRepositionWhenClippedBOOL () const =0

virtual void	SetRemoveRedundantSeparators (bool removeRedundantSeparators)=0

virtual bool	GetRemoveRedundantSeparators () const =0

virtual void	SetRemoveRedundantSeparatorsBOOL (BOOL removeRedundantSeparators)=0

virtual BOOL	GetRemoveRedundantSeparatorsBOOL () const =0

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor.

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDesc ()=0

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.

UtilExport BaseInterface *	GetInterface (Interface_ID id) override

virtual UtilExport Interface_ID	GetID ()

virtual LifetimeType	LifetimeControl ()

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)

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.

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

See also: Class IMenuItem, Class ImenuSettings, Class MenuColors

Description:: This abstract class represents an interface for quad menu settings. The methods contained in this class allow you to access and control all quad menu related settings and configuration parameters.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
fnIdResetDefaults
fnIdSetBorderSize
fnIdGetBorderSize
fnIdSetHorizontalMarginInPoints
fnIdGetHorizontalMarginInPoints
fnIdSetVerticalMarginInPoints
fnIdGetVerticalMarginInPoints
fnIdSetItemFontFace
fnIdGetItemFontFace
fnIdSetTitleFontFace
fnIdGetTitleFontFace
fnIdSetItemFontSize
fnIdGetItemFontSize
fnIdSetTitleFontSize
fnIdGetTitleFontSize
fnIdSetUseUniformItemHeight
fnIdGetUseUniformItemHeight
fnIdSetOpacity
fnIdGetOpacity
fnIdSetDisplayMethod
fnIdGetDisplayMethod
fnIdSetAnimatedSteps
fnIdGetAnimatedSteps
fnIdSetAnimatedStepTime
fnIdGetAnimatedStepTime
fnIdSetSubMenuPauseTime
fnIdGetSubMenuPauseTime
fnIdSetUseLastExecutedItem
fnIdGetUseLastExecutedItem
fnIdSetRepositionWhenClipped
fnIdGetRepositionWhenClipped
fnIdSetRemoveRedundantSeparators
fnIdGetRemoveRedundantSeparators
fnIdSetFirstQuadDisplayed
fnIdGetFirstQuadDisplayed
fnIdSetUseUniformQuadWidth
fnIdGetUseUniformQuadWidth
fnIdSetMirrorQuad
fnIdGetMirrorQuad
fnIdSetMoveCursorOnReposition
fnIdGetMoveCursorOnReposition
fnIdSetReturnCursorAfterReposition
fnIdGetReturnCursorAfterReposition
fnIdSetInitialCursorLocInBox_0to1
fnIdGetInitialCursorLocXInBox_0to1
fnIdGetInitialCursorLocYInBox_0to1
fnIdSetTitleBarBackgroundColor
fnIdGetTitleBarBackgroundColor
fnIdSetTitleBarTextColor
fnIdGetTitleBarTextColor
fnIdSetItemBackgroundColor
fnIdGetItemBackgroundColor
fnIdSetItemTextColor
fnIdGetItemTextColor
fnIdSetLastExecutedItemTextColor
fnIdGetLastExecutedItemTextColor
fnIdSetHighlightedItemBackgroundColor
fnIdGetHighlightedItemBackgroundColor
fnIdSetHighlightedItemTextColor
fnIdGetHighlightedItemTextColor
fnIdSetBorderColor
fnIdGetBorderColor
fnIdSetDisabledShadowColor
fnIdGetDisabledShadowColor
fnIdSetDisabledHighlightColor
fnIdGetDisabledHighlightColor

    {
        // from IMenuSettings
        fnIdResetDefaults,
        fnIdSetBorderSize,
        fnIdGetBorderSize,
        fnIdSetHorizontalMarginInPoints,
        fnIdGetHorizontalMarginInPoints,
        fnIdSetVerticalMarginInPoints,
        fnIdGetVerticalMarginInPoints,
        fnIdSetItemFontFace,
        fnIdGetItemFontFace,
        fnIdSetTitleFontFace,
        fnIdGetTitleFontFace,
        fnIdSetItemFontSize,
        fnIdGetItemFontSize,
        fnIdSetTitleFontSize,
        fnIdGetTitleFontSize,
        fnIdSetUseUniformItemHeight,
        fnIdGetUseUniformItemHeight,
        fnIdSetOpacity,
        fnIdGetOpacity,
        fnIdSetDisplayMethod,
        fnIdGetDisplayMethod,
        fnIdSetAnimatedSteps,
        fnIdGetAnimatedSteps,
        fnIdSetAnimatedStepTime,
        fnIdGetAnimatedStepTime,
        fnIdSetSubMenuPauseTime,
        fnIdGetSubMenuPauseTime,
        fnIdSetUseLastExecutedItem,
        fnIdGetUseLastExecutedItem,
        fnIdSetRepositionWhenClipped,
        fnIdGetRepositionWhenClipped,
        fnIdSetRemoveRedundantSeparators,
        fnIdGetRemoveRedundantSeparators,
 
        // from IQuadMenuSettings
        fnIdSetFirstQuadDisplayed,
        fnIdGetFirstQuadDisplayed,
        fnIdSetUseUniformQuadWidth,
        fnIdGetUseUniformQuadWidth,
        fnIdSetMirrorQuad,
        fnIdGetMirrorQuad,
        fnIdSetMoveCursorOnReposition,
        fnIdGetMoveCursorOnReposition,
        fnIdSetReturnCursorAfterReposition,
        fnIdGetReturnCursorAfterReposition,
        fnIdSetInitialCursorLocInBox_0to1,
        fnIdGetInitialCursorLocXInBox_0to1,
        fnIdGetInitialCursorLocYInBox_0to1,
 
        fnIdSetTitleBarBackgroundColor,
        fnIdGetTitleBarBackgroundColor,
        fnIdSetTitleBarTextColor,
        fnIdGetTitleBarTextColor,
        fnIdSetItemBackgroundColor,
        fnIdGetItemBackgroundColor,
        fnIdSetItemTextColor,
        fnIdGetItemTextColor,
        fnIdSetLastExecutedItemTextColor,
        fnIdGetLastExecutedItemTextColor,
        fnIdSetHighlightedItemBackgroundColor,
        fnIdGetHighlightedItemBackgroundColor,
        fnIdSetHighlightedItemTextColor,
        fnIdGetHighlightedItemTextColor,
        fnIdSetBorderColor,
        fnIdGetBorderColor,
        fnIdSetDisabledShadowColor,
        fnIdGetDisabledShadowColor,
        fnIdSetDisabledHighlightColor,
        fnIdGetDisabledHighlightColor,
};

Member Function Documentation

◆ SetFirstQuadDisplayed()

virtual void SetFirstQuadDisplayed ( QuadIndex firstQuadDisplayed )

pure virtual

Remarks: This method allows you to set the first quad which will be displayed when a quad menu pops up.

Parameters:: QuadIndex firstQuadDisplayed

The quad index, one of the following; QUAD_ONE, QUAD_TWO, QUAD_THREE, or QUAD_FOUR.

◆ GetFirstQuadDisplayed()

virtual QuadIndex GetFirstQuadDisplayed ( ) const

pure virtual

Remarks: This method returns the index of the first quad which will be displayed.

Returns: The quad index, one of the following; QUAD_ONE, QUAD_TWO, QUAD_THREE, or QUAD_FOUR.

◆ SetUseUniformQuadWidth()

virtual void SetUseUniformQuadWidth ( bool useUniformQuadWidth )

pure virtual

Remarks: This method allows you to set whether the quad menu has a uniform width.

Parameters:: bool useUniformQuadWidth

TRUE to set the uniform width, FALSE to set it to non-uniform.

◆ GetUseUniformQuadWidth()

virtual bool GetUseUniformQuadWidth ( ) const

pure virtual

Remarks: This method returns the status of the uniform width flag for the quad menu. TRUE if the quad menu has been set to use uniform width, otherwise FALSE.

◆ SetUseUniformQuadWidthBOOL()

virtual void SetUseUniformQuadWidthBOOL ( BOOL useUniformQuadWidth )

pure virtual

Remarks: This method allows you to set whether the quad menu has a uniform width. This version of SetUseUniformQuadWidth() is provided for the function publishing system.

Parameters:: BOOL useUniformQuadWidth

TRUE to set the uniform width, FALSE to set it to non-uniform.

◆ GetUseUniformQuadWidthBOOL()

virtual BOOL GetUseUniformQuadWidthBOOL ( ) const

pure virtual

Remarks: This method returns the status of the uniform width flag for the quad menu. TRUE if the quad menu has been set to use uniform width, otherwise FALSE. This version of GetUseUniformQuadWidth() is provided for the function publishing system.

◆ SetMirrorQuad()

virtual void SetMirrorQuad ( bool mirrorQuad )

pure virtual

Remarks: This method allows you to set whether the quad menus are mirrored left to right.

Parameters:: bool mirrorQuad

TRUE to mirror the menus, otherwise FALSE.

◆ GetMirrorQuad()

virtual bool GetMirrorQuad ( ) const

pure virtual

Remarks: This method returns TRUE if the quad menu is mirrored left to right, otherwise FALSE.

◆ SetMirrorQuadBOOL()

virtual void SetMirrorQuadBOOL ( BOOL mirrorQuad )

pure virtual

Remarks: This method allows you to set whether the quad menus are mirrored left to right. This version of SetMirrorQuad() is provided for the function publishing system.

Parameters:: BOOL mirrorQuad

TRUE to mirror the menus, otherwise FALSE.

◆ GetMirrorQuadBOOL()

virtual BOOL GetMirrorQuadBOOL ( ) const

pure virtual

Remarks: This method returns TRUE if the quad menu is mirrored left to right, otherwise FALSE. This version of GetMirrorQuad() is provided for the function publishing system.

◆ SetMoveCursorOnReposition()

virtual void SetMoveCursorOnReposition ( bool moveCursorOnReposition )

pure virtual

Remarks: This method allows you to set whether the cursor moves when the quad menu is repositioned because of clipping the edge of the screen.

Parameters:: bool moveCursorOnReposition

TRUE to move the cursor, otherwise FALSE.

◆ GetMoveCursorOnReposition()

virtual bool GetMoveCursorOnReposition ( ) const

pure virtual

Remarks: This method returns TRUE if the cursor moves when the quad menu is repositioned because of clipping the edge of the screen, otherwise FALSE.

◆ SetMoveCursorOnRepositionBOOL()

virtual void SetMoveCursorOnRepositionBOOL ( BOOL moveCursorOnReposition )

pure virtual

Remarks: This method allows you to set whether the cursor moves when the quad menu is repositioned because of clipping the edge of the screen. This version of SetMoveCursorOnReposition() is provided for the function publishing system.

Parameters:: BOOL moveCursorOnReposition

TRUE to move the cursor, otherwise FALSE.

◆ GetMoveCursorOnRepositionBOOL()

virtual BOOL GetMoveCursorOnRepositionBOOL ( ) const

pure virtual

Remarks: This method returns TRUE if the cursor moves when the quad menu is repositioned because of clipping the edge of the screen, otherwise FALSE. This version of GetMoveCursorOnReposition() is provided for the function publishing system.

◆ SetReturnCursorAfterReposition()

virtual void SetReturnCursorAfterReposition ( bool returnCursorAfterReposition )

pure virtual

Remarks: This method allows you to set whether the cursor is moved the opposite distance that it was automatically moved when the quad menu is repositioned because of clipping the edge of the screen.

Parameters:: bool returnCursorAfterReposition

TRUE to set the flag, otherwise FALSE.

◆ GetReturnCursorAfterReposition()

virtual bool GetReturnCursorAfterReposition ( ) const

pure virtual

Remarks: This method returns TRUE if the cursor is moved the opposite distance that it was automatically moved when the quad menu is repositioned because of clipping the edge of the screen, otherwise FALSE.

◆ SetReturnCursorAfterRepositionBOOL()

virtual void SetReturnCursorAfterRepositionBOOL ( BOOL returnCursorAfterReposition )

pure virtual

Remarks: This method allows you to set whether the cursor is moved the opposite distance that it was automatically moved when the quad menu is repositioned because of clipping the edge of the screen. This version of GetReturnCursorAfterReposition() is provided for the function publishing system.

Parameters:: BOOL returnCursorAfterReposition

TRUE to set the flag, otherwise FALSE.

◆ GetReturnCursorAfterRepositionBOOL()

virtual BOOL GetReturnCursorAfterRepositionBOOL ( ) const

pure virtual

Remarks: This method returns TRUE if the cursor is moved the opposite distance that it was automatically moved when the quad menu is repositioned because of clipping the edge of the screen, otherwise FALSE. This version of GetReturnCursorAfterReposition() is provided for the function publishing system.

◆ SetCursorLocInBox_0to1()

virtual void SetCursorLocInBox_0to1	(	float	x,
		float	y
	)

pure virtual

Remarks: This method allows you to set the initial location of the cursor in the center quad box.

Parameters:: float x, float y

The location of the cursor, as a ratio of the box size, between 0.0 and 1.0.

◆ GetCursorLocXInBox_0to1()

virtual float GetCursorLocXInBox_0to1 ( ) const

pure virtual

Remarks: This method returns the initial x location of the cursor in the center quad box, as a ratio of the box size, between 0.0 and 1.0.

◆ GetCursorLocYInBox_0to1()

virtual float GetCursorLocYInBox_0to1 ( ) const

pure virtual

Remarks: This method returns the initial y location of the cursor in the center quad box, as a ratio of the box size, between 0.0 and 1.0.

◆ GetMenuColors()

virtual const MenuColors * GetMenuColors ( int quadNum ) const

pure virtual

Remarks: This method returns the color array for a specific quad.

Parameters:: int quadNum

The quad to obtain the color array for, (numbered 1 through 4).

◆ SetTitleBarBackgroundColor()

virtual void SetTitleBarBackgroundColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the title bar background color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetTitleBarBackgroundColor()

virtual const Color & GetTitleBarBackgroundColor ( int quadNum ) const

pure virtual

Remarks: This method returns the title bar background color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetTitleBarBackgroundColorRef()

virtual COLORREF GetTitleBarBackgroundColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the title bar background color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetTitleBarTextColor()

virtual void SetTitleBarTextColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the title bar text color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetTitleBarTextColor()

virtual const Color & GetTitleBarTextColor ( int quadNum ) const

pure virtual

Remarks: This method returns the title bar text color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetTitleBarTextColorRef()

virtual COLORREF GetTitleBarTextColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the title bar text color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetItemBackgroundColor()

virtual void SetItemBackgroundColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the item background color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetItemBackgroundColor()

virtual const Color & GetItemBackgroundColor ( int quadNum ) const

pure virtual

Remarks: This method returns the item background color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetItemBackgroundColorRef()

virtual COLORREF GetItemBackgroundColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the item background color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetItemTextColor()

virtual void SetItemTextColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the item text color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetItemTextColor()

virtual const Color & GetItemTextColor ( int quadNum ) const

pure virtual

Remarks: This method returns the item text color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetItemTextColorRef()

virtual COLORREF GetItemTextColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the item text color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetLastExecutedItemTextColor()

virtual void SetLastExecutedItemTextColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the last executed item text color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetLastExecutedItemTextColor()

virtual const Color & GetLastExecutedItemTextColor ( int quadNum ) const

pure virtual

Remarks: This method returns the last executed item text color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetLastExecutedItemTextColorRef()

virtual COLORREF GetLastExecutedItemTextColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the last executed item text color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetHighlightedItemBackgroundColor()

virtual void SetHighlightedItemBackgroundColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the highlighted item background color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetHighlightedItemBackgroundColor()

virtual const Color & GetHighlightedItemBackgroundColor ( int quadNum ) const

pure virtual

Remarks: This method returns the highlighted item background color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetHighlightedItemBackgroundColorRef()

virtual COLORREF GetHighlightedItemBackgroundColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the highlighted item background color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetHighlightedItemTextColor()

virtual void SetHighlightedItemTextColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the highlighted item text color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetHighlightedItemTextColor()

virtual const Color & GetHighlightedItemTextColor ( int quadNum ) const

pure virtual

Remarks: This method returns the highlighted item text color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetHighlightedItemTextColorRef()

virtual COLORREF GetHighlightedItemTextColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the highlighted item text color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetBorderColor()

virtual void SetBorderColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the border color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetBorderColor()

virtual const Color & GetBorderColor ( int quadNum ) const

pure virtual

Remarks: This method returns the border color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetBorderColorRef()

virtual COLORREF GetBorderColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the border color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetDisabledShadowColor()

virtual void SetDisabledShadowColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the disabled shadow color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetDisabledShadowColor()

virtual const Color & GetDisabledShadowColor ( int quadNum ) const

pure virtual

Remarks: This method returns the disabled shadow color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetDisabledShadowColorRef()

virtual COLORREF GetDisabledShadowColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the disabled shadow color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ SetDisabledHighlightColor()

virtual void SetDisabledHighlightColor	(	int	quadNum,
		const Color &	color
	)

pure virtual

Remarks: This method allows you to set the disabled highlight color for a specific quad.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Color& color

The color to set.

◆ GetDisabledHighlightColor()

virtual const Color & GetDisabledHighlightColor ( int quadNum ) const

pure virtual

Remarks: This method returns the disabled highlight color of a specific quad. This method returns the color as a Color.

Parameters:: int quadNum

The quad (numbered 1 through 4).

◆ GetDisabledHighlightColorRef()

virtual COLORREF GetDisabledHighlightColorRef ( int quadNum ) const

pure virtual

Remarks: This method returns the disabled highlight color of a specific quad. This method returns the color as a COLORREF.

Parameters:: int quadNum

The quad (numbered 1 through 4).

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ SetFirstQuadDisplayed()

◆ GetFirstQuadDisplayed()

◆ SetUseUniformQuadWidth()

◆ GetUseUniformQuadWidth()

◆ SetUseUniformQuadWidthBOOL()

◆ GetUseUniformQuadWidthBOOL()

◆ SetMirrorQuad()

◆ GetMirrorQuad()

◆ SetMirrorQuadBOOL()

◆ GetMirrorQuadBOOL()

◆ SetMoveCursorOnReposition()

◆ GetMoveCursorOnReposition()

◆ SetMoveCursorOnRepositionBOOL()

◆ GetMoveCursorOnRepositionBOOL()

◆ SetReturnCursorAfterReposition()

◆ GetReturnCursorAfterReposition()

◆ SetReturnCursorAfterRepositionBOOL()

◆ GetReturnCursorAfterRepositionBOOL()

◆ SetCursorLocInBox_0to1()

◆ GetCursorLocXInBox_0to1()

◆ GetCursorLocYInBox_0to1()

◆ GetMenuColors()

◆ SetTitleBarBackgroundColor()

◆ GetTitleBarBackgroundColor()

◆ GetTitleBarBackgroundColorRef()

◆ SetTitleBarTextColor()

◆ GetTitleBarTextColor()

◆ GetTitleBarTextColorRef()

◆ SetItemBackgroundColor()

◆ GetItemBackgroundColor()

◆ GetItemBackgroundColorRef()

◆ SetItemTextColor()

◆ GetItemTextColor()

◆ GetItemTextColorRef()

◆ SetLastExecutedItemTextColor()

◆ GetLastExecutedItemTextColor()

◆ GetLastExecutedItemTextColorRef()

◆ SetHighlightedItemBackgroundColor()

◆ GetHighlightedItemBackgroundColor()

◆ GetHighlightedItemBackgroundColorRef()

◆ SetHighlightedItemTextColor()

◆ GetHighlightedItemTextColor()

◆ GetHighlightedItemTextColorRef()

◆ SetBorderColor()

◆ GetBorderColor()

◆ GetBorderColorRef()

◆ SetDisabledShadowColor()

◆ GetDisabledShadowColor()

◆ GetDisabledShadowColorRef()

◆ SetDisabledHighlightColor()

◆ GetDisabledHighlightColor()

◆ GetDisabledHighlightColorRef()