xml/org.freedesktop.atspi.Action.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3
   4 <interface name="org.freedesktop.atspi/Action">
   5   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   6     <p>An interface through which a user-actionable user interface
   7       component can be manipulated.  Components which react to mouse or
   8       keyboard input from the user, (with the exception of pure text entry
   9       fields with no other function), should implement this interface.
  10       Typical actions include "click", "press", "release" (for instance for
  11       buttons), "menu" (for objects which have context menus invokable from
  12       mouse or keyboard), "open" for icons representing files folders, and others.</p>
  13   </tp:docstring>
  14   <tp:struct name="Action">
  15     <tp:member type="s" tp:name="name">
  16       <tp:docstring>
  17       A string containing the description of the specified action.
  18       </tp:docstring>
  19     </tp:member>
  20     <tp:member type="s" tp:name="description">
  21       <tp:docstring>
  22         The description of the specified action. The description of an actionmay provide information about the result of action invocation, unlike the action name.
  23     </tp:docstring>
  24   </tp:member>
  25     <tp:member type="s" tp:name="keyBinding">
  26       <tp:docstring>
  27         A string containing the key binding for the specified action,or an empty string ("") if none exists.
  28       </tp:docstring>
  29     </tp:member>
  30   </tp:struct>
  31
  32   <tp:property name="nActions" type="i" access="read">
  33     <tp:docstring>The number of actions this object supports</tp:docstring>
  34   </tp:property>
  35
  36   <method name="getDescription">
  37     <tp:docstring>
  38       <p>Get the description for the specified action. The description of an action may provide information about the result of action invocation, unlike the action name.</p>
  39     </tp:docstring>
  40     <arg type="i" name="index" direction="in">
  41       <tp:docstring>The index of the action</tp:docstring>
  42     </arg>
  43     <arg type="s" direction="out">
  44       <tp:docstring>A string containing the description of the specified action</tp:docstring>
  45     </arg>
  46   </method>
  47
  48   <method name="getName">
  49     <tp:docstring>
  50       <p>Get the name of the specified action.  Action names generally describe the user action, i.e. "click" or "press", rather than the result of invoking the action.</p>
  51     </tp:docstring>
  52     <arg type="i" name="index" direction="in">
  53       <tp:docstring>The index of the action</tp:docstring>
  54     </arg>
  55     <arg type="s" direction="out">
  56       <tp:docstring>A string containing the name of the specified action</tp:docstring>
  57     </arg>
  58   </method>
  59
  60   <method name="getKeyBinding">
  61     <tp:docstring>
  62       <p>Get the key binding associated with a specific action.</p>
  63     </tp:docstring>
  64     <arg type="i" name="index" direction="in">
  65       <tp:docstring>The index of the action</tp:docstring>
  66     </arg>
  67     <arg type="s" direction="out">
  68       <tp:docstring>A string containing the key binding for the specified action, or an empty string ("") if none exists.</tp:docstring>
  69     </arg>
  70   </method>
  71
  72   <method name="getActions">
  73     <tp:docstring>
  74       Retrieves the actions associated with the object.
  75     </tp:docstring>
  76     <arg direction="out" name="index" type="a(sss)" tp:type="Action"/>
  77   </method>
  78   <method name="doAction">
  79     <tp:docstring>
  80       Causes the object to perform the specified action.
  81     </tp:docstring>
  82     <arg direction="in" name="index" type="i">
  83     <tp:docstring>
  84       The 0-based index of the action to perform.
  85     </tp:docstring>
  86     </arg>
  87     <arg direction="out" type="b" tp:type="boolean">
  88     <tp:docstring>
  89       A boolean indicating success or failure.
  90     </tp:docstring>
  91     </arg>
  92   </method>
  93 </interface>
  94 </node>