xml/org.freedesktop.atspi.DeviceEventListener.xml

   1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   2
   3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
   4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
   5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
   6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
   7   <p>This library is free software; you can redistribute it and/or
   8     modify it under the terms of the GNU Library General Public
   9     License as published by the Free Software Foundation; either
  10     version 2 of the License, or (at your option) any later version.</p>
  11
  12   <p>This library is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15     Library General Public License for more details.</p>
  16
  17   <p>You should have received a copy of the GNU Library General Public
  18     License along with this library; if not, write to the
  19     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20     Boston, MA 02111-1307, USA.</p>
  21 </tp:license>
  22 <interface name="org.freedesktop.atspi.DeviceEventListener">
  23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24     <p>This interface should be implemented by AT-SPI clients who wish to
  25       make use of the DeviceEventController to receive device event notifications.
  26       DeviceEvents include keyboard events and mouse button/motion events.</p>
  27   </tp:docstring>
  28   <method name="notifyEvent">
  29     <tp:docstring>
  30       Notify an interested DeviceEventListener that a DeviceEvent has occurred.
  31     </tp:docstring>
  32     <arg direction="in" name="event" type="(uinnisb)" tp:type="DeviceEvent"/>
  33     <arg direction="out" type="b" tp:type="boolean">
  34     <tp:docstring>
  35       \c True if the recipient/consumer wishes to consume the event, i.e.prevent it from being delivered to the desktop, \c False if the event should continue to be delivered as normal.
  36     </tp:docstring>
  37     </arg>
  38   </method>
  39 </interface>
  40 </node>