/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleValue-Interface.html is in at-spi-doc 1.32.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleValue Interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-component.html" title="Subinterface Methods">
<link rel="prev" href="at-spi-cspi-AccessibleText-Interface.html" title="AccessibleText Interface">
<link rel="next" href="ch05.html" title="Auxiliary Types">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="at-spi-cspi-AccessibleText-Interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-component.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="ch05.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleValue-Interface.synopsis" class="shortcut">Top</a>
|
<a href="#at-spi-cspi-AccessibleValue-Interface.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleValue-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleValue-Interface.top_of_page"></a>AccessibleValue Interface</span></h2>
<p>AccessibleValue Interface — An interface implemented by valuators, sliders, and other onscren components
which allow discrete or continuous values to be manipulated.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleValue-Interface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-ref" title="AccessibleValue_ref ()">AccessibleValue_ref</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-unref" title="AccessibleValue_unref ()">AccessibleValue_unref</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
<span class="returnvalue">double</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-getCurrentValue" title="AccessibleValue_getCurrentValue ()">AccessibleValue_getCurrentValue</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
<span class="returnvalue">double</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-getMaximumValue" title="AccessibleValue_getMaximumValue ()">AccessibleValue_getMaximumValue</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
<span class="returnvalue">double</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-getMinimumValue" title="AccessibleValue_getMinimumValue ()">AccessibleValue_getMinimumValue</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-setCurrentValue" title="AccessibleValue_setCurrentValue ()">AccessibleValue_setCurrentValue</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>,
<em class="parameter"><code><span class="type">double</span> newValue</code></em>);
<span class="returnvalue">double</span> <a class="link" href="at-spi-cspi-AccessibleValue-Interface.html#AccessibleValue-getMinimumIncrement" title="AccessibleValue_getMinimumIncrement ()">AccessibleValue_getMinimumIncrement</a> (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleValue-Interface.description"></a><h2>Description</h2>
<p>
The Value interface is exposed by sliders, scrollbars, dials, and other
components which are used to change scalar values in an application. The
interface may be used to change a value in an "approximately continuous"
fashion, or in integer increments - the interface allows the client to
determine the incremental granularity of the adjustments possible, the
possible range of values, and the current value. It also allows the value to
be programmatically set, if the implementor's state does not include READONLY.
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleValue-Interface.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleValue-ref"></a><h3>AccessibleValue_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleValue_ref (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleValue</span> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-unref"></a><h3>AccessibleValue_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleValue_unref (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleValue</span> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-getCurrentValue"></a><h3>AccessibleValue_getCurrentValue ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> AccessibleValue_getCurrentValue (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Get the current value for an <span class="type">AccessibleValue</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the current value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-getMaximumValue"></a><h3>AccessibleValue_getMaximumValue ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> AccessibleValue_getMaximumValue (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Get the maximum allowed value for an <span class="type">AccessibleValue</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the maximum allowed value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-getMinimumValue"></a><h3>AccessibleValue_getMinimumValue ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> AccessibleValue_getMinimumValue (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Get the minimum allowed value for an <span class="type">AccessibleValue</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the minimum allowed value for this object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-setCurrentValue"></a><h3>AccessibleValue_setCurrentValue ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleValue_setCurrentValue (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>,
<em class="parameter"><code><span class="type">double</span> newValue</code></em>);</pre>
<p>
Set the current value of an <span class="type">AccessibleValue</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>newValue</code></em> :</span></p></td>
<td>a <span class="type">float</span> value which is the desired new value of the object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the value could be assigned the specified value,
<span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleValue-getMinimumIncrement"></a><h3>AccessibleValue_getMinimumIncrement ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> AccessibleValue_getMinimumIncrement (<em class="parameter"><code><span class="type">AccessibleValue</span> *obj</code></em>);</pre>
<p>
Get the minimum increment by which an <span class="type">AccessibleValue</span> can be adjusted.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleValue</span> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the minimum increment by which the value may be changed, or
zero if the minimum increment cannot be determined.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|