IQuadMenuSettings Class Reference

IQuadMenuSettings Class Referenceabstract
Public Types | Public Member Functions

#include <imenus.h>

Class 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.
+ 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. More...
 
CoreExport void AppendProperty (int id,...)
 Add a new property to this interface descriptor. More...
 
CoreExport void AppendEnum (int id,...)
 Add a new enum to this interface descriptor. More...
 
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 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)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterface * AcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterface * CloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport void * operator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport void * operator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
- 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)
 

Member Enumeration Documentation

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 
821  {
822  // from IMenuSettings
823  fnIdResetDefaults,
824  fnIdSetBorderSize,
825  fnIdGetBorderSize,
826  fnIdSetHorizontalMarginInPoints,
827  fnIdGetHorizontalMarginInPoints,
828  fnIdSetVerticalMarginInPoints,
829  fnIdGetVerticalMarginInPoints,
830  fnIdSetItemFontFace,
831  fnIdGetItemFontFace,
832  fnIdSetTitleFontFace,
833  fnIdGetTitleFontFace,
834  fnIdSetItemFontSize,
835  fnIdGetItemFontSize,
836  fnIdSetTitleFontSize,
837  fnIdGetTitleFontSize,
838  fnIdSetUseUniformItemHeight,
839  fnIdGetUseUniformItemHeight,
840  fnIdSetOpacity,
841  fnIdGetOpacity,
842  fnIdSetDisplayMethod,
843  fnIdGetDisplayMethod,
844  fnIdSetAnimatedSteps,
845  fnIdGetAnimatedSteps,
846  fnIdSetAnimatedStepTime,
847  fnIdGetAnimatedStepTime,
848  fnIdSetSubMenuPauseTime,
849  fnIdGetSubMenuPauseTime,
850  fnIdSetUseLastExecutedItem,
851  fnIdGetUseLastExecutedItem,
852  fnIdSetRepositionWhenClipped,
853  fnIdGetRepositionWhenClipped,
854  fnIdSetRemoveRedundantSeparators,
855  fnIdGetRemoveRedundantSeparators,
856 
857  // from IQuadMenuSettings
858  fnIdSetFirstQuadDisplayed,
859  fnIdGetFirstQuadDisplayed,
860  fnIdSetUseUniformQuadWidth,
861  fnIdGetUseUniformQuadWidth,
862  fnIdSetMirrorQuad,
863  fnIdGetMirrorQuad,
864  fnIdSetMoveCursorOnReposition,
865  fnIdGetMoveCursorOnReposition,
866  fnIdSetReturnCursorAfterReposition,
867  fnIdGetReturnCursorAfterReposition,
868  fnIdSetInitialCursorLocInBox_0to1,
869  fnIdGetInitialCursorLocXInBox_0to1,
870  fnIdGetInitialCursorLocYInBox_0to1,
871 
872  fnIdSetTitleBarBackgroundColor,
873  fnIdGetTitleBarBackgroundColor,
874  fnIdSetTitleBarTextColor,
875  fnIdGetTitleBarTextColor,
876  fnIdSetItemBackgroundColor,
877  fnIdGetItemBackgroundColor,
878  fnIdSetItemTextColor,
879  fnIdGetItemTextColor,
880  fnIdSetLastExecutedItemTextColor,
881  fnIdGetLastExecutedItemTextColor,
882  fnIdSetHighlightedItemBackgroundColor,
883  fnIdGetHighlightedItemBackgroundColor,
884  fnIdSetHighlightedItemTextColor,
885  fnIdGetHighlightedItemTextColor,
886  fnIdSetBorderColor,
887  fnIdGetBorderColor,
888  fnIdSetDisabledShadowColor,
889  fnIdGetDisabledShadowColor,
890  fnIdSetDisabledHighlightColor,
891  fnIdGetDisabledHighlightColor,
892 };
IQuadMenuSettings::fnIdResetDefaults
Definition: imenus.h:823
IQuadMenuSettings::fnIdSetBorderSize
Definition: imenus.h:824
IQuadMenuSettings::fnIdSetMirrorQuad
Definition: imenus.h:862
IQuadMenuSettings::fnIdSetOpacity
Definition: imenus.h:840
IQuadMenuSettings::fnIdGetOpacity
Definition: imenus.h:841
IQuadMenuSettings::fnIdGetMirrorQuad
Definition: imenus.h:863
IQuadMenuSettings::fnIdGetBorderSize
Definition: imenus.h:825

Member Function Documentation

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.
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.
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.
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.
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.
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.
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.
virtual bool GetMirrorQuad ( ) const
pure virtual
Remarks
This method returns TRUE if the quad menu is mirrored left to right, otherwise FALSE.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
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.
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).
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).
Please send us your comment about this page