#include "atkaction.h"
+/**
+ * SECTION:atkaction
+ * @Short_description: The ATK interface provided by UI components
+ * which the user can activate/interact with.
+ * @Title:AtkAction
+ *
+ * #AtkAction should be implemented by instances of #AtkObject classes
+ * with which the user can interact directly, i.e. buttons,
+ * checkboxes, scrollbars, e.g. components which are not "passive"
+ * providers of UI information.
+ *
+ * Exceptions: when the user interaction is already covered by another
+ * appropriate interface such as #AtkEditableText (insert/delete text,
+ * etc.) or #AtkValue (set value) then these actions should not be
+ * exposed by #AtkAction as well.
+ *
+ * Though most UI interactions on components should be invocable via
+ * keyboard as well as mouse, there will generally be a close mapping
+ * between "mouse actions" that are possible on a component and the
+ * AtkActions. Where mouse and keyboard actions are redundant in
+ * effect, #AtkAction should expose only one action rather than
+ * exposing redundant actions if possible. By convention we have been
+ * using "mouse centric" terminology for #AtkAction names.
+ *
+ */
+
GType
-atk_action_get_type ()
+atk_action_get_type (void)
{
static GType type = 0;
/**
* atk_action_do_action:
* @action: a #GObject instance that implements AtkActionIface
- * @i: the action to be performed
+ * @i: the action index corresponding to the action to be performed
+ *
+ * Perform the specified action on the object.
+ *
+ * Returns: %TRUE if success, %FALSE otherwise
*
- * Perform the specified action on the object
**/
-void
+gboolean
atk_action_do_action (AtkAction *obj,
gint i)
{
AtkActionIface *iface;
- g_return_if_fail (obj != NULL);
- g_return_if_fail (ATK_IS_ACTION (obj));
+ g_return_val_if_fail (ATK_IS_ACTION (obj), FALSE);
iface = ATK_ACTION_GET_IFACE (obj);
if (iface->do_action)
- (iface->do_action) (obj, i);
+ return (iface->do_action) (obj, i);
+ else
+ return FALSE;
}
/**
* If there are more than one, the first one is considered the
* "default" action of the object.
*
- * Returns: a the number of actions , or 0
- * if @action does not implement this interface.
+ * Returns: a the number of actions, or 0 if @action does not
+ * implement this interface.
**/
gint
atk_action_get_n_actions (AtkAction *obj)
{
AtkActionIface *iface;
- g_return_val_if_fail (obj != NULL, 0);
g_return_val_if_fail (ATK_IS_ACTION (obj), 0);
iface = ATK_ACTION_GET_IFACE (obj);
/**
* atk_action_get_description:
* @action: a #GObject instance that implements AtkActionIface
- * @i: a %gint indicating the action
+ * @i: the action index corresponding to the action to be performed
*
- * Returns a description of the specified action of the object
+ * Returns a description of the specified action of the object.
*
- * Returns a description string, or %NULL
- * if @action does not implement this interface.
+ * Returns: a description string, or %NULL if @action does not
+ * implement this interface.
**/
-G_CONST_RETURN gchar*
+const gchar*
atk_action_get_description (AtkAction *obj,
gint i)
{
AtkActionIface *iface;
- g_return_val_if_fail (obj != NULL, NULL);
g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
iface = ATK_ACTION_GET_IFACE (obj);
}
/**
+ * atk_action_get_name:
+ * @action: a #GObject instance that implements AtkActionIface
+ * @i: the action index corresponding to the action to be performed
+ *
+ * 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.
+ *
+ * Returns: a name string, or %NULL if @action does not implement this
+ * interface.
+ **/
+const gchar*
+atk_action_get_name (AtkAction *obj,
+ gint i)
+{
+ AtkActionIface *iface;
+
+ g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
+
+ iface = ATK_ACTION_GET_IFACE (obj);
+
+ if (iface->get_name)
+ return (iface->get_name) (obj, i);
+ else
+ return NULL;
+}
+
+/**
+ * atk_action_get_localized_name:
+ * @action: a #GObject instance that implements AtkActionIface
+ * @i: the action index corresponding to the action to be performed
+ *
+ * Returns the localized name of the specified action of the object.
+ *
+ * Returns: a name string, or %NULL if @action does not implement this
+ * interface.
+ **/
+const gchar*
+atk_action_get_localized_name (AtkAction *obj,
+ gint i)
+{
+ AtkActionIface *iface;
+
+ g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
+
+ iface = ATK_ACTION_GET_IFACE (obj);
+
+ if (iface->get_localized_name)
+ return (iface->get_localized_name) (obj, i);
+ else
+ return NULL;
+}
+
+/**
* atk_action_get_keybinding:
* @action: a #GObject instance that implements AtkActionIface
- * @i: a %gint indicating the action
+ * @i: the action index corresponding to the action to be performed
+ *
+ * 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.
*
- * Returns a keybinding associated with this action, if one exists.
+ * 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.
*
- * Returns a string representing the keybinding, or %NULL
- * if there is no keybinding for this action.
+ * Returns: the keybinding which can be used to activate this action,
+ * or %NULL if there is no keybinding for this action.
*
**/
-G_CONST_RETURN gchar*
+const gchar*
atk_action_get_keybinding (AtkAction *obj,
gint i)
{
AtkActionIface *iface;
- g_return_val_if_fail (obj != NULL, NULL);
g_return_val_if_fail (ATK_IS_ACTION (obj), NULL);
iface = ATK_ACTION_GET_IFACE (obj);
else
return NULL;
}
+
+/**
+ * atk_action_set_description:
+ * @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
+ *
+ * Sets a description of the specified action of the object.
+ *
+ * Returns: a gboolean representing if the description was successfully set;
+ **/
+gboolean
+atk_action_set_description (AtkAction *obj,
+ gint i,
+ const gchar *desc)
+{
+ AtkActionIface *iface;
+
+ g_return_val_if_fail (ATK_IS_ACTION (obj), FALSE);
+
+ iface = ATK_ACTION_GET_IFACE (obj);
+
+ if (iface->set_description)
+ return (iface->set_description) (obj, i, desc);
+ else
+ return FALSE;
+}
projects / platform / upstream / atk.git / blobdiff