doc/libatspi/html/libatspi-atspi-value.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-value</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-editabletext.html" title="atspi-editabletext">
  10 <link rel="next" href="libatspi-atspi-table.html" title="atspi-table">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-editabletext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-table.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-value.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-value.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#libatspi-atspi-value.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#libatspi-atspi-value.implementations" class="shortcut">Known Implementations</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="libatspi-atspi-value"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="libatspi-atspi-value.top_of_page"></a>atspi-value</span></h2>
  38 <p>atspi-value — An interface supporting a one-dimensional scalar
  39 to be modified, or which reflects its value.</p>
  40 </td>
  41 <td valign="top" align="right"></td>
  42 </tr></table></div>
  43 <div class="refsynopsisdiv">
  44 <a name="libatspi-atspi-value.synopsis"></a><h2>Synopsis</h2>
  45 <a name="AtspiValue"></a><pre class="synopsis">                    <a class="link" href="libatspi-atspi-value.html#AtspiValue-struct" title="AtspiValue">AtspiValue</a>;
  46 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-minimum-value" title="atspi_value_get_minimum_value ()">atspi_value_get_minimum_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  47                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  48 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-current-value" title="atspi_value_get_current_value ()">atspi_value_get_current_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  49                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  50 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-maximum-value" title="atspi_value_get_maximum_value ()">atspi_value_get_maximum_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  52 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libatspi-atspi-value.html#atspi-value-set-current-value" title="atspi_value_set_current_value ()">atspi_value_set_current_value</a>       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> new_value</code></em>,
  54                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  55 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="libatspi-atspi-value.html#atspi-value-get-minimum-increment" title="atspi_value_get_minimum_increment ()">atspi_value_get_minimum_increment</a>   (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="libatspi-atspi-value.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   GInterface
  63    +----AtspiValue
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="libatspi-atspi-value.implementations"></a><h2>Known Implementations</h2>
  68 <p>
  69 AtspiValue is implemented by
  70  <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="libatspi-atspi-value.description"></a><h2>Description</h2>
  74 <p>
  75 An interface supporting a one-dimensional scalar
  76 to be modified, or which reflects its value. If
  77 STATE_EDITABLE is not present, the value is
  78 treated as "read only".
  79 </p>
  80 </div>
  81 <div class="refsect1">
  82 <a name="libatspi-atspi-value.details"></a><h2>Details</h2>
  83 <div class="refsect2">
  84 <a name="AtspiValue-struct"></a><h3>AtspiValue</h3>
  85 <pre class="programlisting">typedef struct _AtspiValue AtspiValue;</pre>
  86 <p>
  87 </p>
  88 </div>
  89 <hr>
  90 <div class="refsect2">
  91 <a name="atspi-value-get-minimum-value"></a><h3>atspi_value_get_minimum_value ()</h3>
  92 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             atspi_value_get_minimum_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
  93                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
  94 <p>
  95 Gets the minimum allowed value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
  96 </p>
  97 <div class="variablelist"><table border="0" class="variablelist">
  98 <colgroup>
  99 <col align="left" valign="top">
 100 <col>
 101 </colgroup>
 102 <tbody>
 103 <tr>
 104 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 105 <td>a pointer to the <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 109 <td>the minimum allowed value for this object.</td>
 110 </tr>
 111 </tbody>
 112 </table></div>
 113 </div>
 114 <hr>
 115 <div class="refsect2">
 116 <a name="atspi-value-get-current-value"></a><h3>atspi_value_get_current_value ()</h3>
 117 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             atspi_value_get_current_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
 118                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 119 <p>
 120 Gets the current value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
 121 </p>
 122 <div class="variablelist"><table border="0" class="variablelist">
 123 <colgroup>
 124 <col align="left" valign="top">
 125 <col>
 126 </colgroup>
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 130 <td>a pointer to the <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 134 <td>the current value for this object.</td>
 135 </tr>
 136 </tbody>
 137 </table></div>
 138 </div>
 139 <hr>
 140 <div class="refsect2">
 141 <a name="atspi-value-get-maximum-value"></a><h3>atspi_value_get_maximum_value ()</h3>
 142 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             atspi_value_get_maximum_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
 143                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 144 <p>
 145 Gets the maximum allowed value for an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
 146 </p>
 147 <div class="variablelist"><table border="0" class="variablelist">
 148 <colgroup>
 149 <col align="left" valign="top">
 150 <col>
 151 </colgroup>
 152 <tbody>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 155 <td>a pointer to the <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 159 <td>the maximum allowed value for this object.</td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="atspi-value-set-current-value"></a><h3>atspi_value_set_current_value ()</h3>
 167 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_value_set_current_value       (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
 168                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> new_value</code></em>,
 169                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 170 <p>
 171 Sets the current value of an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>.
 172 </p>
 173 <div class="variablelist"><table border="0" class="variablelist">
 174 <colgroup>
 175 <col align="left" valign="top">
 176 <col>
 177 </colgroup>
 178 <tbody>
 179 <tr>
 180 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 181 <td>a pointer to the <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
 182 </tr>
 183 <tr>
 184 <td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
 185 <td>a <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value which is the desired new value of the object.</td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 189 <td>
 190 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the value could be assigned the specified value,
 191 <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 192 </tr>
 193 </tbody>
 194 </table></div>
 195 </div>
 196 <hr>
 197 <div class="refsect2">
 198 <a name="atspi-value-get-minimum-increment"></a><h3>atspi_value_get_minimum_increment ()</h3>
 199 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             atspi_value_get_minimum_increment   (<em class="parameter"><code><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> *obj</code></em>,
 200                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 201 <p>
 202 Gets the minimum increment by which an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> can be adjusted.
 203 </p>
 204 <div class="variablelist"><table border="0" class="variablelist">
 205 <colgroup>
 206 <col align="left" valign="top">
 207 <col>
 208 </colgroup>
 209 <tbody>
 210 <tr>
 211 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
 212 <td>a pointer to the <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> implementor on which to operate.</td>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 216 <td>the minimum increment by which the value may be changed, or
 217 zero if the minimum increment cannot be determined.</td>
 218 </tr>
 219 </tbody>
 220 </table></div>
 221 </div>
 222 </div>
 223 </div>
 224 <div class="footer">
 225 <hr>
 226           Generated by GTK-Doc V1.18.1</div>
 227 </body>
 228 </html>