Interface: ActionItem

This interface exposes the properties and methods for action items associated with menu items or quad menu items. An ActionItem can be created with the CuiMenu.CreateAction() method (in response to the #cuiRegisterMenus callback notification).

Properties:

    .id : integer : Read

Gets the id of the ActionItem.

    .persistentActionId : string : Read

Gets the persistent ID of the action item.

    .isVisible : boolean : Read

Gets whether the ActionItem is visible.

    .isEnabled : boolean : Read

Gets whether the ActionItem is enabled.

    .isChecked : boolean : Read

Gets whether the ActionItem is checked.

    .description : string : Read

Gets the description for the ActionItem.

    .category : string : Read

Gets the ActionItem's category.

    .buttonText : string : Read

Gets the ActionItem's button text.

    .menuText : string : Read

Gets the ActionItem's menu text.

    .iconFileName : string : Read

Gets the file name for the icon for the ActionItem, if one is assigned.

    .iconIndex : index : Read

Gets the index of the icon in the icon file for the ActionItem, if one is assigned.

    .actionTableID : integer : Read

Gets the ID of the action table that contains the ActionItem.

Methods:

    <void>getDescription <&string>text
       getDescription - no automatic redraw after invoked
       text is Out parameter

Gets the description for the ActionItem.

    <void>getCategory <&string>text
       getCategory - no automatic redraw after invoked
       text is Out parameter

Gets the category for the ActionItem.

    <void>getButtonText <&string>text
       getButtonText - no automatic redraw after invoked
       text is Out parameter

Gets the button text for the ActionItem.

    <void>getMenuText <&string>text
       getMenuText - no automatic redraw after invoked
       text is Out parameter

Gets the menu text for the ActionItem.

    <boolean>hasIcon()
       hasIcon - no automatic redraw after invoked

Returns whether the ActionItem has an icon.

    <boolean>getIconFileName <&string>fileName
       getIconFileName - no automatic redraw after invoked
       fileName is Out parameter

Returns the icon file name for the ActionItem, it it has one.

    <index>getIconIndex()
       getIconIndex - no automatic redraw after invoked

Returns the index of the icon for the ActionItem, if it has one.