docs/tmpl/atkaction.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkAction
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface provided by UI components which the user can
   6 activate/interact with,
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 #AtkAction should be implemented by instances of #AtkObject classes with
  11 which the user can interact directly, i.e. buttons, checkboxes,
  12 scrollbars,  e.g. components which are not "passive"
  13 providers of UI information.
  14 </para>
  15 <para>
  16 Exceptions: when the user interaction is already covered by
  17 another appropriate interface such as #AtkEditableText (insert/delete
  18 test, etc.) or #AtkValue (set value) then these actions should not be
  19 exposed by #AtkAction as well.
  20 </para>
  21 <para>
  22 Also note that the #AtkAction API is limited in that parameters may not
  23 be passed to the object being activated; thus the action must be
  24 self-contained and specifiable via only a single "verb".  Concrete
  25 examples include "press", "release", "click" for buttons, "drag"
  26 (meaning initiate drag) and "drop" for drag sources and drop targets,
  27 etc.
  28 </para>
  29 <para>
  30 Though most UI interactions on components should be invocable via
  31 keyboard as well as mouse, there will generally be a close mapping
  32 between "mouse actions" that are possible on a component and the
  33 AtkActions.  Where mouse and keyboard actions are redundant in effect,
  34 #AtkAction should expose only one action rather than exposing redundant
  35 actions if possible.  By convention we have been using "mouse centric"
  36 terminology for #AtkAction names.
  37 </para>
  38
  39 <!-- ##### SECTION See_Also ##### -->
  40 <para>
  41
  42 </para>
  43
  44 <!-- ##### SECTION Stability_Level ##### -->
  45
  46
  47 <!-- ##### SECTION Image ##### -->
  48
  49
  50 <!-- ##### STRUCT AtkAction ##### -->
  51 <para>
  52 The AtkAction structure does not contain any fields.
  53 </para>
  54
  55
  56 <!-- ##### FUNCTION atk_action_do_action ##### -->
  57 <para>
  58
  59 </para>
  60
  61 @action:
  62 @i:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION atk_action_get_n_actions ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @action:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION atk_action_get_description ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @action:
  81 @i:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION atk_action_get_name ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @action:
  91 @i:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION atk_action_get_localized_name ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @action:
 101 @i:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION atk_action_get_keybinding ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @action:
 111 @i:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION atk_action_set_description ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @action:
 121 @i:
 122 @desc:
 123 @Returns:
 124
 125