| ATK Library Reference Manual | |||
|---|---|---|---|
| <<< Previous Page | Home | Up | Next Page >>> |
struct AtkAction; struct AtkActionIface; gboolean 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_name (AtkAction *action, gint i); G_CONST_RETURN gchar* atk_action_get_keybinding (AtkAction *action, gint i); gboolean atk_action_set_description (AtkAction *action, gint i, const gchar *desc); |
The interface AtkAction should be supported by any object that can perform one or more actions. The interface provides the standard mechanism for an assistive 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.
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_name) (AtkAction *action,
gint i);
G_CONST_RETURN gchar* (*get_keybinding) (AtkAction *action,
gint i);
gboolean (*set_description) (AtkAction *action,
gint i,
const gchar *desc);
}; |
gboolean 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 index corresponding to the action to be performed |
| Returns : | TRUE if success, FALSE otherwise |
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. |
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 : | the action index corresponding to the action to be performed |
| Returns : | a description string, or NULL if action does not implement this interface. |
G_CONST_RETURN gchar* atk_action_get_name (AtkAction *action, gint i); |
Returns the name of the specified action of the object.
| action : | a GObject instance that implements AtkActionIface |
| i : | the action index corresponding to the action to be performed |
| Returns : | a name string, or NULL if action does not implement this interface. |
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 : | the action index corresponding to the action to be performed |
| Returns : | a string representing the keybinding, or NULL if there is no keybinding for this action. |
gboolean atk_action_set_description (AtkAction *action, gint i, const gchar *desc); |
Sets a description of the specified action of the object.
| action : | a GObject instance that implements AtkActionIface |
| i : | the action index corresponding to the action to be performed |
| desc : | the description to be assigned to this action |
| Returns : | a gboolean representing if the description was successfully set; |