Detailed Description
- See also:
- Class IMenuItem, Class ImenuSettings, Class
MenuColors
- 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.
#include <imenus.h>
Inheritance diagram for
IQuadMenuSettings:
Member Enumeration Documentation
| anonymous enum |
- Enumerator:
{
// 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,
#if defined(USE_NEW_CUI_IO_METHODS) && !defined(NO_CUI) // russom - 02/15/02
fnIdSaveSettingsFile,
fnIdLoadSettingsFile,
#endif
};
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).
