Class IQuadMenuSettings
See Also: Class IMenuItem , Class ImenuSettings, Class IMenuColors
class IQuadMenuSettings : public IMenuSettings, public FPStaticInterface
Description:
This class is available in release 4.0 and later only.
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.
Methods:
public:
Prototype:
virtual void SetFirstQuadDisplayed(QuadIndex firstQuadDisplayed) = 0;
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.
Prototype:
virtual QuadIndex GetFirstQuadDisplayed() const = 0;
Remarks:
This method returns the index of the first quad which will be displayed.
Return Value:
The quad index, one of the following; QUAD_ONE, QUAD_TWO, QUAD_THREE, or QUAD_FOUR.
Prototype:
virtual void SetUseUniformQuadWidth(bool useUniformQuadWidth) = 0;
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.
Prototype:
virtual bool GetUseUniformQuadWidth() const = 0;
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.
Prototype:
virtual void SetUseUniformQuadWidthBOOL(BOOL useUniformQuadWidth) = 0;
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.
Prototype:
virtual BOOL GetUseUniformQuadWidthBOOL() const = 0;
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.
Prototype:
virtual void SetMirrorQuad(bool mirrorQuad) = 0;
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.
Prototype:
virtual bool GetMirrorQuad() const = 0;
Remarks:
This method returns TRUE if the quad menu is mirrored left to right, otherwise FALSE.
Prototype:
virtual void SetMirrorQuadBOOL(BOOL mirrorQuad) = 0;
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.
Prototype:
virtual BOOL GetMirrorQuadBOOL() const = 0;
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.
Prototype:
virtual void SetMoveCursorOnReposition(bool moveCursorOnReposition) = 0;
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.
Prototype:
virtual bool GetMoveCursorOnReposition() const = 0;
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.
Prototype:
virtual void SetMoveCursorOnRepositionBOOL(BOOL moveCursorOnReposition) = 0;
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.
Prototype:
virtual BOOL GetMoveCursorOnRepositionBOOL() const = 0;
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.
Prototype:
virtual void SetReturnCursorAfterReposition(bool returnCursorAfterReposition) = 0;
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.
Prototype:
virtual bool GetReturnCursorAfterReposition() const = 0;
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.
Prototype:
virtual void SetReturnCursorAfterRepositionBOOL(BOOL returnCursorAfterReposition) = 0;
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.
Prototype:
virtual BOOL GetReturnCursorAfterRepositionBOOL() const = 0;
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.
Prototype:
virtual void SetCursorLocInBox_0to1(float x, float y) = 0;
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.
Prototype:
virtual float GetCursorLocXInBox_0to1() const = 0;
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.
Prototype:
virtual float GetCursorLocYInBox_0to1() const = 0;
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.
Prototype:
virtual const MenuColors *GetMenuColors(int quadNum) const = 0;
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).
Prototype:
virtual void SetTitleBarBackgroundColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetTitleBarBackgroundColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetTitleBarBackgroundColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetTitleBarTextColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetTitleBarTextColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetTitleBarTextColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetItemBackgroundColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetItemBackgroundColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetItemBackgroundColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetItemTextColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetItemTextColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetItemTextColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetLastExecutedItemTextColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetLastExecutedItemTextColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetLastExecutedItemTextColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetHighlightedItemBackgroundColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetHighlightedItemBackgroundColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetHighlightedItemBackgroundColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetHighlightedItemTextColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetHighlightedItemTextColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetHighlightedItemTextColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetBorderColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetBorderColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetBorderColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetDisabledShadowColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetDisabledShadowColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetDisabledShadowColorRef(int quadNum) const = 0;
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).
Prototype:
virtual void SetDisabledHighlightColor(int quadNum, const Color& color) = 0;
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.
Prototype:
virtual const Color& GetDisabledHighlightColor(int quadNum) const = 0;
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).
Prototype:
virtual COLORREF GetDisabledHighlightColorRef(int quadNum) const = 0;
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).