Merge branch 'mgorse' of git+ssh://git.codethink.co.uk/git/atspi-dbus into rework
[platform/core/uifw/at-spi2-atk.git] / xml / org.freedesktop.atspi.Value.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.Value">
23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
24     <p>An interface supporting controls which allow a
25       one-dimensional, scalar quantity to be modified or which
26       reflect a scalar quantity. (If STATE_EDITABLE is not present, 
27       the valuator is treated as &quot;read only&quot;.  </p>
28
29     <p>@note Events generated by Image instances include:
30       \li \c &quot;object:value-changed&quot;</p>
31   </tp:docstring>
32   <tp:property name="minimumValue" type="d" access="read">
33   <tp:docstring>
34     The minimum value allowed by this valuator.
35   </tp:docstring>
36   </tp:property>
37   <tp:property name="maximumValue" type="d" access="read">
38   <tp:docstring>
39     The maximum value allowed by this valuator.
40   </tp:docstring>
41   </tp:property>
42   <tp:property name="minimumIncrement" type="d" access="read">
43   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
44     <p>The smallest incremental change which this valuator allows.
45       If 0, the incremental changes to the valuator are 
46       limited only by the precision of a double precision value
47       on the platform.</p>
48   </tp:docstring>
49   </tp:property>
50   <tp:property name="currentValue" type="d" access="readwrite">
51   <tp:docstring>
52     The current value of the valuator.
53   </tp:docstring>
54   </tp:property>
55   <method name="unImplemented">
56     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
57       <p>\cond
58         unImplemented:    </p>
59
60       <p>placeholders for future expansion.</p>
61     </tp:docstring>
62   </method>
63   <method name="unImplemented2">
64   </method>
65   <method name="unImplemented3">
66   </method>
67   <method name="unImplemented4">
68   </method>
69 </interface>
70 </node>