* Boston, MA 02111-1307, USA.
*/
+#include "config.h"
+
#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)
{
*
* Returns a description of the specified action of the object.
*
- * Returns a description string, or %NULL
- * if @action does not implement this interface.
+ * Returns: (nullable): 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)
{
* 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: (nullable): 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)
{
*
* 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: (nullable): 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)
{
/**
* 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.
+ *
+ * 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 keybinding associated with this action, if one exists.
- * The returned string is in the format "<a>;<b>;<c>"
- * (i.e. semicolon-delimited), where <a> is the keybinding which
- * activates the object if it is presently enabled onscreen,
- * <b> corresponds to the keybinding or sequence of keys
- * which invokes the action even if the relevant element is not
- * currently posted on screen (for instance, for a menu item it
- * posts the parent menus before invoking). The last token in the
- * above string, if non-empty, represents a keyboard shortcut which
- * invokes the same action without posting the component or its
- * enclosing menus or dialogs.
- *
- * Returns a string representing the available keybindings, or %NULL
- * if there is no keybinding for this action.
+ * Returns: (nullable): 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)
{
projects / platform / upstream / atk.git / blobdiff