xml/org.freedesktop.atspi.Selector.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
   5
   6
   7
   8 <tp:struct name="Command">
   9   <tp:docstring>
  10     A structure which encapsulates both a string representation of a command and a unique command ID
  11   </tp:docstring>
  12   <tp:member type="s" tp:name="name"/>
  13   <tp:member type="i" tp:name="id"/>
  14 </tp:struct>
  15 <method name="notifyCommands">
  16   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  17     <p>Notify the CommandListener instance of changes to the currently
  18       available commands, by sending the current ::CommandList.  </p>
  19
  20     <p>@param commands The newly-available list of ::Command objects which
  21       may be invoked by the listener.</p>
  22   </tp:docstring>
  23   <arg direction="in" name="commands" type="a(si)" tp:type="CommandList"/>
  24 </method>
  25 <interface name="org.freedesktop.atspi.Selector">
  26   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  27     <p>This interface is intended for use by assistive technologies
  28       and related user-agents.  Via this interface, an assistive technology or
  29       user agent may expose a series of choices or selections in textual form,
  30       which can be activated on demand by a client of the Selector interface.  </p>
  31
  32     <p>Examples of the use of this interface include voice-command and remote-control
  33       applications, in which the user interaction is wholly or partly delegated by the
  34       implementor to an external agent.
  35       @since AT-SPI 1.7.0</p>
  36   </tp:docstring>
  37   <tp:enum name="CommandResult" type="u">
  38     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  39       <p>A code returned by a call to ::activateCommand, indicating
  40         the result of the activation request.</p>
  41     </tp:docstring>
  42     <tp:enumvalue suffix="COMMAND_RESULT_INVALID">
  43     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  44       <p>&lt; The command was invalid or ill-formed; usually indicates
  45         an error condition. </p>
  46     </tp:docstring>
  47     </tp:enumvalue>
  48     <tp:enumvalue suffix="COMMAND_RESULT_SUCCESS" value="1">
  49     <tp:docstring>
  50       &lt; The command was successfully activated.
  51     </tp:docstring>
  52     </tp:enumvalue>
  53     <tp:enumvalue suffix="COMMAND_RESULT_FAILED" value="2">
  54     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  55       <p>&lt; The command was valid, but could not be activated.
  56         This may be due to problems with permissions or error conditions.</p>
  57     </tp:docstring>
  58     </tp:enumvalue>
  59     <tp:enumvalue suffix="COMMAND_RESULT_OBSOLETE" value="3">
  60     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  61       <p>&lt; The command is no longer valid in the current program context.
  62         This may mean that the application has changed state in such a
  63         way that the specified command it no longer applicable, or
  64         because changes to the application state have rendered it
  65         ambiguous.  Commands should be re-fetched and a new selection
  66         made.</p>
  67     </tp:docstring>
  68     </tp:enumvalue>
  69     <tp:enumvalue suffix="COMMAND_RESULT_LAST_DEFINED" value="4">
  70     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  71       <p>&lt; Defines size of enumeration;
  72         do not use this value as a parameter.</p>
  73     </tp:docstring>
  74     </tp:enumvalue>
  75   </tp:enum>
  76   <tp:property name="supportsReplace" type="b" access="read">
  77   <tp:docstring>
  78     This attribute is TRUE if this Selector allows its ::CommandList to be specified by the client
  79   </tp:docstring>
  80   </tp:property>
  81   <method name="getCommands">
  82     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  83       <p>Query the ::Selector for the current ::CommandList.    </p>
  84     </tp:docstring>
  85     <arg direction="out" type="a(si)" tp:type="CommandList">
  86     <tp:docstring>
  87       the currently available ::CommandList
  88     </tp:docstring>
  89     </arg>
  90   </method>
  91   <method name="replaceCommands">
  92     <arg direction="in" name="commands" type="a(si)" tp:type="CommandList"/>
  93     <arg direction="out" type="b" tp:type="boolean">
  94     <tp:docstring>
  95       TRUE if the replacement request was successful, FALSE if the request could not be honored.
  96     </tp:docstring>
  97     </arg>
  98   </method>
  99   <method name="refreshCommands">
 100     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 101       <p>Ask the ::Selector to re-calculate its ::CommandList.
 102         @note in most cases the ::Selector will continuously
 103         update its ::CommandList without recourse to this call.
 104         This call is equivalent to ::getCommands, except that
 105         after ::refreshCommands the new ::CommandList will be returned
 106         via any registered ::CommandListener instances rather than
 107         synchronously via this call.    </p>
 108     </tp:docstring>
 109     <arg direction="out" type="b" tp:type="boolean">
 110     <tp:docstring>
 111       TRUE if the ::CommandList changed.
 112     </tp:docstring>
 113     </arg>
 114   </method>
 115   <method name="activateCommand">
 116     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 117       <p>Request that the ::Selector invoke the specified ::Command.
 118         @param cmd the ::Command to activate/invoke.</p>
 119     </tp:docstring>
 120     <arg direction="in" name="cmd" type="(si)" tp:type="Command"/>
 121     <arg direction="out" type="u" tp:type="CommandResult">
 122     <tp:docstring>
 123       a ::CommandResult indicating whether the request was honored, and the reason for failure if the::Command could not be activated or invoked.
 124     </tp:docstring>
 125     </arg>
 126   </method>
 127   <method name="registerChangeListener">
 128     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 129       <p>Register a :CommandListener instance for notification of
 130         changes to the command set.
 131         @param listener the ::CommandListener to be notified of changes.</p>
 132     </tp:docstring>
 133     <arg direction="in" name="listener" type="o" tp:type="CommandListener"/>
 134   </method>
 135   <method name="deregisterChangeListener">
 136     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 137       <p>Tell the ::Selector instance to cease notifying the
 138         specified ::CommandListener of changes to the command list.
 139         @param listener the ::CommandListener to remove from the
 140         notification list.</p>
 141     </tp:docstring>
 142     <arg direction="in" name="listener" type="o" tp:type="CommandListener"/>
 143   </method>
 144   <method name="unImplemented">
 145     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 146       <p>\cond
 147         unImplemented:    </p>
 148
 149       <p>placeholders for future expansion.</p>
 150     </tp:docstring>
 151   </method>
 152   <method name="unImplemented2">
 153   </method>
 154   <method name="unImplemented3">
 155   </method>
 156   <method name="unImplemented4">
 157   </method>
 158 </interface>
 159 </node>