ATK Library Reference Manual
<<< Previous PageHomeUpNext Page >>>

AtkAction

Name

AtkAction -- accessibility interface for objects that can perform actions

Synopsis



struct      AtkAction;
struct      AtkActionIface;
void        atk_action_do_action            (AtkAction *action,
                                             gint i);
gint        atk_action_get_n_actions        (AtkAction *action);
G_CONST_RETURN gchar* atk_action_get_description
                                            (AtkAction *action,
                                             gint i);
G_CONST_RETURN gchar* atk_action_get_keybinding
                                            (AtkAction *action,
                                             gint i);

Description

The interface AtkAction should be supported by any object that can perform one or more actions. The interface provides the standard mechanism for an assitive technology to determine what those actions are as well as tell the object to perform them. Any object that can be manipulated should support this interface.

Details

struct AtkAction

struct AtkAction;

struct AtkActionIface

struct AtkActionIface
{
  GTypeInterface parent;

  gboolean (*do_action)         (AtkAction         *action,
                                 gint              i);
  gint     (*get_n_actions)     (AtkAction         *action);
  G_CONST_RETURN gchar*   (*get_description)   (AtkAction         *action,
                                                gint              i);
  G_CONST_RETURN gchar*   (*get_keybinding)    (AtkAction         *action,
                                                gint              i);

};

atk_action_do_action ()

void        atk_action_do_action            (AtkAction *action,
                                             gint i);

Perform the specified action on the object

action : a GObject instance that implements AtkActionIface
i : the action to be performed

atk_action_get_n_actions ()

gint        atk_action_get_n_actions        (AtkAction *action);

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.

action : a GObject instance that implements AtkActionIface
Returns : a the number of actions , or 0 if action does not implement this interface.

atk_action_get_description ()

G_CONST_RETURN gchar* atk_action_get_description
                                            (AtkAction *action,
                                             gint i);

Returns a description of the specified action of the object

action : a GObject instance that implements AtkActionIface
i : a gint indicating the action
Returns :a description string, or NULL if action does not implement this interface.

atk_action_get_keybinding ()

G_CONST_RETURN gchar* atk_action_get_keybinding
                                            (AtkAction *action,
                                             gint i);

Returns a keybinding associated with this action, if one exists.

action : a GObject instance that implements AtkActionIface
i : a gint indicating the action
Returns :a string representing the keybinding, or NULL if there is no keybinding for this action.



<<< Previous PageHomeUpNext Page >>>
ATK LibraryAtkComponent