Interface: quadMenuSettings

This represents an interface for quad menu settings.

Note: PickObject() does not pick objects when launched from a Quad Menu. It will hang and refuses to pick any object. Hit 'escape' for emergency exit. PickObject works correctly from a shortcut and toolbar.

<void>ResetDefaults()

This method will reset the menu settings to their defaults.

<void>SetBorderSize <integer>borderSize

This method allows you to set the menu border size.

<integer>borderSize: The border size in pixels.

<integer>GetBorderSize()

This method returns the menu border size.

<void>SetHorizontalMarginInPoints <integer>horizontalMarginInPoints

This method allows you to set the menu's horizontal margin size.

<integer>horizontalMarginInPoints: The horizontal margin size in points.

<integer>GetHorizontalMarginInPoints()

This method returns the menu's horizontal margin size (in points).

<void>SetVerticalMarginInPoints <integer>verticalMarginInPoints

This method allows you to set the menu's vertical margin size.

<integer>verticalMarginInPoints: The vertical margin size in points.

<integer>GetVerticalMarginInPoints()

This method returns the menu's vertical margin size (in points).

<void>SetItemFontFace <string>szItemFontFace

This method allows you to set the menu item's font typeface.

<string>szItemFontFace: A string containing the typeface name.

<string>GetItemFontFace()

This method returns the name of the menu item's font typeface.

<void>SetTitleFontFace <string>szTitleFontFace

This method allows you to set the menu title's font typeface.

<string>szTitleFontFace: A string containing the typeface name.

<string>GetTitleFontFace()

This method returns the name of the menu title's font typeface.

<void>SetItemFontSize <integer>itemFontSize

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

<integer>itemFontSize: The size of the font, in points.

<integer>GetItemFontSize()

This method returns the menu item's font size, in points.

<void>SetTitleFontSize <integer>titleFontSize

This method allows you to set the menu title's font size.

<integer>titleFontSize: The size of the font, in points.

<integer>GetTitleFontSize()

This method returns the menu title's font size, in points.

<void>SetUseUniformItemHeight <boolean>useUniformItemHeight

This method allows you to set the status of a menu item's uniform height flag.

<boolean>useUniformItemHeight: True to set the uniform height flag On, False to set it to Off.

<boolean>GetUseUniformItemHeight()

This method returns true or false if the menu item's uniform height flag is set or not set, respectively.

<void>SetOpacity <float>opacity

This method allows you to set the menu's opacity value.

<float>opacity: The opacity value, ranging from 0.0 û 1.0 where 1 is opaque.

<float>GetOpacity()

This method returns the menu's opacity value.

<void>SetDisplayMethod <integer>displayMethod

This method allows you to set a menu's display method.

<integer>displayMethod: The display method which is one of the following:

0 - displays the menu with transparency, if opacity is < 1.

1 - stretch animate the menu by making it grow in size from its center with transparency, if opacity is < 1.

2 - fade in from invisible to whatever opacity is set to.

<integer>GetDisplayMethod()

This method returns the menu's display method, which is either of the following; DM_NORMAL, DM_STRETCH, DM_FADE, DM_NUM_METHODS

<void>SetAnimatedSteps <integer>animatedSteps

This method allows you to set the menu's number of animated steps for the 'growing' effect.

<integer>animatedSteps: The number of steps.

<integer>GetAnimatedSteps()

This method returns the menu's number of animated steps used for the 'growing' effect.

<void>SetAnimatedStepTime <integer>animatedStepTime

This method allows you to set the menu's animated step time.

<integer>animatedStepTime: The animated step time, in milliseconds.

<integer>GetAnimatedStepTime()

This method returns the menu's animated step time, in milliseconds.

<void>SetSubMenuPauseTime <integer>subMenuPauseTime

This method allows you to set the delay before a submenu is displayed.

<integer>subMenuPauseTime: The delay, in milliseconds.

<integer>GetSubMenuPauseTime()

This method returns the delay before a submenu is displayed, in milliseconds.

<void>SetUseLastExecutedItem <boolean>useLastSelectedItem

This method allows you to set the "last executed item" flag which determines whether to use the menu's last executed item when the user clicks on the menu's titlebar.

<boolean>useLastSelectedItem

<boolean>GetUseLastExecutedItem()

This method returns whether the "last executed item" flag is set (true) or not set (false). The flag determines whether to use the menu's last executed item when the user clicks on the menu's titlebar.

<void>SetRepositionWhenClipped <boolean>repositionWhenClipped

This method allows you to set the flag which controls and determines whether the menu is repositioned when near the edge of the screen.

<boolean>repositionWhenClipped: True to turn repositioning On, false to turn it Off.

<integer>GetRepositionWhenClipped()

This method returns the status of the flag which controls and determines whether the menu is repositioned when near the edge of the screen. Returns true if the flag is on, otherwise false.

<void>SetRemoveRedundantSeparators <boolean>removeRedundantSeparators

This method allows you to set the flag which controls and determines whether the menu should remove redundant separators.

<boolean>removeRedundantSeparators: True to turn the flag On, false to turn it Off.

<integer>GetRemoveRedundantSeparators()

This method returns the status of the flag which controls and determines whether the menu should remove redundant separators. Returns true if the flag is on, otherwise false.

<void>SetFirstQuadDisplayed <integer>firstQuadDisplayed

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

<integer>firstQuadDisplayed: The quad index, one of the following; QUAD_ONE, QUAD_TWO, QUAD_THREE, or QUAD_FOUR.

<integer>GetFirstQuadDisplayed()

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.

<void>SetUseUniformQuadWidth <boolean>useUniformQuadWidth

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

<boolean>useUniformQuadWidth: True to set the uniform width, false to set it to non-uniform.

<boolean>GetUseUniformQuadWidth()

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.

<void>SetMirrorQuad <boolean>mirrorQuad

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

<boolean>mirrorQuad: True to mirror the menus, otherwise false.

<integer>GetMirrorQuad()

This method returns true if the quad menu is mirrored left to right, otherwise false.

<void>SetMoveCursorOnReposition <boolean>moveCursorOnReposition

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

<boolean>moveCursorOnReposition: True to move the cursor, otherwise false.

<boolean>GetMoveCursorOnReposition()

This method returns true if the cursor moves when the quad menu is repositioned because of clipping the edge of the screen, otherwise false.

<void>SetReturnCursorAfterReposition <boolean>returnCursorAfterReposition

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.

<boolean>returnCursorAfterReposition: True to set the flag, otherwise False.

<boolean>GetReturnCursorAfterReposition()

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.

<void>SetInitialCursorLocInBox_0to1 <float>initialCursorLocX <float>initialCursorLocY

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

<float>initialCursorLocX:

<float>initialCursorLocY: The location of the cursor, as a ratio of the box size, between 0.0 and 1.0.

<float>GetInitialCursorLocXInBox_0to1()

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.

<float>GetInitialCursorLocYInBox_0to1()

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.

<void>SetTitleBarBackgroundColor <integer>quad <&RGBA color>color

This method allows you to set the title bar background color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetTitleBarBackgroundColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetTitleBarTextColor <integer>quad <&RGBA color>color

This method allows you to set the title bar text color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetTitleBarTextColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetItemBackgroundColor <integer>quad <&RGBA color>color

This method allows you to set the item background color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetItemBackgroundColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetItemTextColor <integer>quad <&RGBA color>color

This method allows you to set the item text color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetItemTextColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetLastExecutedItemTextColor <integer>quad <&RGBA color>color

This method allows you to set the last executed item text color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetLastExecutedItemTextColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetHighlightedItemBackgroundColor <integer>quad <&RGBA color>color

This method allows you to set the highlighted item background color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetHighlightedItemBackgroundColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetHighlightedItemTextColor <integer>quad <&RGBA color>color

This method allows you to set the highlighted item text color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetHighlightedItemTextColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetBorderColor <integer>quad <&RGBA color>color

This method allows you to set the border color for a specific quad. Note: color is In parameter

<integer>quad: The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetBorderColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetDisabledShadowColor <integer>quad <&RGBA color>color

This method allows you to set the disabled shadow color for a specific quad. Note: color is In parameter

<integer>quad : The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetDisabledShadowColor <integer>quad

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

<integer>quad: The quad (numbered 1 through 4).

<void>SetDisabledHighlightColor <integer>quad <&RGBA color>color

This method allows you to set the disabled highlight color for a specific quad. Note: color is In parameter

<integer>quad : The quad (numbered 1 through 4).

<&RGBA color>color: The color to set.

<&RGBA color>GetDisabledHighlightColor <integer>quad

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

<integer>quad : The quad (numbered 1 through 4).