Revert "Merge remote-tracking branch 'origin/sandbox/mniesluchow/upstream_2_16' into...

[platform/upstream/atk.git] / atk / atkaction.c

diff --git a/atk/atkaction.c b/atk/atkaction.c
index d612758..089a2fd 100755 (executable)
--- a/atk/atkaction.c
+++ b/atk/atkaction.c
@@ -19,6 +19,32 @@
 
 #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 (void)
 {
@@ -98,10 +124,10 @@ atk_action_get_n_actions  (AtkAction *obj)
  *
  * 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)
 {
@@ -122,12 +148,25 @@ atk_action_get_description (AtkAction *obj,
  * @action: a #GObject instance that implements AtkActionIface
  * @i: the action index corresponding to the action to be performed 
  *
- * Returns the name of the specified action of the object.
+ * 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.
+ * Returns: a name string, or %NULL if @action does not implement this
+ * interface.
  **/
-G_CONST_RETURN gchar*
+const gchar*
 atk_action_get_name (AtkAction *obj,
                      gint      i)
 {
@@ -150,10 +189,10 @@ atk_action_get_name (AtkAction *obj,
  *
  * Returns the localized name of the specified action of the object.
  *
- * Returns a name string, or %NULL
- * if @action does not implement this interface.
+ * Returns: a name string, or %NULL if @action does not implement this
+ * interface.
  **/
-G_CONST_RETURN gchar*
+const gchar*
 atk_action_get_localized_name (AtkAction *obj,
                                gint      i)
 {
@@ -172,15 +211,36 @@ atk_action_get_localized_name (AtkAction *obj,
 /**
  * atk_action_get_keybinding:
  * @action: a #GObject instance that implements AtkActionIface
- * @i: the action index corresponding to the action to be performed 
+ * @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)
 {