Interface

Atk-1.0 ▶ Atk ▶ Action ▶ Interface

Interface for implementing Action. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_do_action(i: number): boolean;
    vfunc_get_description(i: number): string;
    vfunc_get_keybinding(i: number): string;
    vfunc_get_localized_name(i: number): string;
    vfunc_get_n_actions(): number;
    vfunc_get_name(i: number): string;
    vfunc_set_description(i: number, desc: string): boolean;
}

Hierarchy (View Summary)

Index

Methods

vfunc_do_action vfunc_get_description vfunc_get_keybinding vfunc_get_localized_name vfunc_get_n_actions vfunc_get_name vfunc_set_description

Methods

  • Perform the specified action on the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns boolean

  • Returns a description of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format "mnemonic;sequence;shortcut".

    • The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for a button.
    • The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a traditional "New..." menu item.
    • The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a traditional "New..." menu item.

    Example: For a traditional "New..." menu item, the expected return value would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N" for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Returns the localized name of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the "default" action of the object.

    Returns number

  • Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the 'interaction type' which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. "click", "press", "release", "drag", "drop", "popup", etc. The "popup" action should be used to pop up a context menu for the object, if one exists.

    For technical reasons, some toolkits cannot guarantee that the reported action is actually 'bound' to a nontrivial user event; i.e. the result of some actions via atk_action_do_action() may be NIL.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    Returns string

  • Sets a description of the specified action of the object.

    Parameters

    • i: number

      the action index corresponding to the action to be performed

    • desc: string

      the description to be assigned to this action

    Returns boolean