← Back to branch summary

~ubuntu-branches/ubuntu/precise/atkmm1.6/precise

« back to all changes in this revision

Viewing changes to doc/reference/html/classAtk_1_1Value.html

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Klimonda
  • Date: 2010-11-02 20:35:53 UTC
  • Revision ID: james.westby@ubuntu.com-20101102203553-syno2w6yedmcdgk8
Tags: upstream-2.22.1
Import upstream version 2.22.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/classAtk_1_1Value.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>atkmm: Atk::Value Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.2 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul class="tablist">
 
14
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
16
      <li><a href="modules.html"><span>Modules</span></a></li>
 
17
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
18
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
19
    </ul>
 
20
  </div>
 
21
  <div class="tabs2">
 
22
    <ul class="tablist">
 
23
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
24
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
25
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
26
    </ul>
 
27
  </div>
 
28
  <div class="navpath">
 
29
    <ul>
 
30
      <li><a class="el" href="namespaceAtk.html">Atk</a> </li>
 
31
      <li><a class="el" href="classAtk_1_1Value.html">Value</a> </li>
 
32
    </ul>
 
33
  </div>
 
34
</div>
 
35
<div class="header">
 
36
  <div class="summary">
 
37
<a href="#pub-methods">Public Member Functions</a> &#124;
 
38
<a href="#related">Related Functions</a> </div>
 
39
  <div class="headertitle">
 
40
<h1>Atk::Value Class Reference</h1> </div>
 
41
</div>
 
42
<div class="contents">
 
43
<!-- doxytag: class="Atk::Value" --><!-- doxytag: inherits="Glib::Interface" -->
 
44
<p>The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. <a href="#_details">More...</a></p>
 
45
 
 
46
<p><code>#include &lt;atkmm/value.h&gt;</code></p>
 
47
<!-- startSectionHeader --><div class="dynheader">
 
48
Inheritance diagram for Atk::Value:<!-- endSectionHeader --></div>
 
49
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
 
50
<div class="center"><img src="classAtk_1_1Value__inherit__graph.png" border="0" usemap="#Atk_1_1Value_inherit__map" alt="Inheritance graph"/></div>
 
51
<map name="Atk_1_1Value_inherit__map" id="Atk_1_1Value_inherit__map">
 
52
<area shape="rect" id="node9" href="classAtk_1_1NoOpObject.html" title="An Atk::NoOpObject is an Atk::Object which purports to implement all ATK interfaces." alt="" coords="5,315,133,344"/><area shape="rect" id="node2" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="15,160,124,189"/><area shape="rect" id="node4" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="7,83,132,112"/><area shape="rect" id="node6" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,127,35"/></map>
 
53
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
54
 
 
55
<p><a href="classAtk_1_1Value-members.html">List of all members.</a></p>
 
56
<table class="memberdecls">
 
57
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
58
Public Member Functions</h2></td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d492104dfbc24ca3586889e1c9dd122"></a><!-- doxytag: member="Atk::Value::gobj" ref="a1d492104dfbc24ca3586889e1c9dd122" args="()" -->
 
60
AtkValue*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a1d492104dfbc24ca3586889e1c9dd122">gobj</a> ()</td></tr>
 
61
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e9774208afa33f5536d0af2f1542724"></a><!-- doxytag: member="Atk::Value::gobj" ref="a1e9774208afa33f5536d0af2f1542724" args="() const " -->
 
63
const AtkValue*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a1e9774208afa33f5536d0af2f1542724">gobj</a> () const </td></tr>
 
64
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a413b3aa759306e5453c52c3cc633bbdd">get_current_value</a> (<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&amp;<a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01193.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
 
66
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the value of this object. <a href="#a413b3aa759306e5453c52c3cc633bbdd"></a><br/></td></tr>
 
67
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a05900879b78b99af2f608f8aa6225043">get_maximum_value</a> (<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&amp;<a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01193.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
 
68
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the maximum value of this object. <a href="#a05900879b78b99af2f608f8aa6225043"></a><br/></td></tr>
 
69
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#aa846b94c5afd243ad9b6488f3c882b30">get_minimum_value</a> (<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&amp;<a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01193.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
 
70
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the minimum value of this object. <a href="#aa846b94c5afd243ad9b6488f3c882b30"></a><br/></td></tr>
 
71
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a5f68e4192b070a56f2f5dbdc29d18ef1">set_current_value</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a>&amp;<a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01193.html#ga1c9e781d8d15a3814a601f471797c825">value</a>)</td></tr>
 
72
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the value of this object. <a href="#a5f68e4192b070a56f2f5dbdc29d18ef1"></a><br/></td></tr>
 
73
<tr><td colspan="2"><h2><a name="related"></a>
 
74
Related Functions</h2></td></tr>
 
75
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
 
76
<br/></td></tr>
 
77
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1Value.html">Atk::Value</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Value.html#a68a42fa970f6678863e0d5163fc58439">wrap</a> (AtkValue* object, bool take_copy=false)</td></tr>
 
78
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a68a42fa970f6678863e0d5163fc58439"></a><br/></td></tr>
 
79
</table>
 
80
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
81
<p>The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. </p>
 
82
<p>This should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> representations which implement <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Atk::Value</a> on the component's behalf. Atk::Values may be read-only, in which case attempts to alter the value return false to indicate failure. </p>
 
83
<hr/><h2>Member Function Documentation</h2>
 
84
<a class="anchor" id="a413b3aa759306e5453c52c3cc633bbdd"></a><!-- doxytag: member="Atk::Value::get_current_value" ref="a413b3aa759306e5453c52c3cc633bbdd" args="(Glib::ValueBase &amp;value) const " -->
 
85
<div class="memitem">
 
86
<div class="memproto">
 
87
      <table class="memname">
 
88
        <tr>
 
89
          <td class="memname">void Atk::Value::get_current_value </td>
 
90
          <td>(</td>
 
91
          <td class="paramtype"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a> &amp;&#160;</td>
 
92
          <td class="paramname"> <em>value</em>&#160;)</td>
 
93
          <td> const</td>
 
94
        </tr>
 
95
      </table>
 
96
</div>
 
97
<div class="memdoc">
 
98
 
 
99
<p>Gets the value of this object. </p>
 
100
<dl><dt><b>Parameters:</b></dt><dd>
 
101
  <table class="params">
 
102
    <tr><td class="paramname">value</td><td>A <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Value</a> representing the current accessible value. </td></tr>
 
103
  </table>
 
104
  </dd>
 
105
</dl>
 
106
 
 
107
</div>
 
108
</div>
 
109
<a class="anchor" id="a05900879b78b99af2f608f8aa6225043"></a><!-- doxytag: member="Atk::Value::get_maximum_value" ref="a05900879b78b99af2f608f8aa6225043" args="(Glib::ValueBase &amp;value) const " -->
 
110
<div class="memitem">
 
111
<div class="memproto">
 
112
      <table class="memname">
 
113
        <tr>
 
114
          <td class="memname">void Atk::Value::get_maximum_value </td>
 
115
          <td>(</td>
 
116
          <td class="paramtype"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a> &amp;&#160;</td>
 
117
          <td class="paramname"> <em>value</em>&#160;)</td>
 
118
          <td> const</td>
 
119
        </tr>
 
120
      </table>
 
121
</div>
 
122
<div class="memdoc">
 
123
 
 
124
<p>Gets the maximum value of this object. </p>
 
125
<dl><dt><b>Parameters:</b></dt><dd>
 
126
  <table class="params">
 
127
    <tr><td class="paramname">value</td><td>A <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Value</a> representing the maximum accessible value. </td></tr>
 
128
  </table>
 
129
  </dd>
 
130
</dl>
 
131
 
 
132
</div>
 
133
</div>
 
134
<a class="anchor" id="aa846b94c5afd243ad9b6488f3c882b30"></a><!-- doxytag: member="Atk::Value::get_minimum_value" ref="aa846b94c5afd243ad9b6488f3c882b30" args="(Glib::ValueBase &amp;value) const " -->
 
135
<div class="memitem">
 
136
<div class="memproto">
 
137
      <table class="memname">
 
138
        <tr>
 
139
          <td class="memname">void Atk::Value::get_minimum_value </td>
 
140
          <td>(</td>
 
141
          <td class="paramtype"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a> &amp;&#160;</td>
 
142
          <td class="paramname"> <em>value</em>&#160;)</td>
 
143
          <td> const</td>
 
144
        </tr>
 
145
      </table>
 
146
</div>
 
147
<div class="memdoc">
 
148
 
 
149
<p>Gets the minimum value of this object. </p>
 
150
<dl><dt><b>Parameters:</b></dt><dd>
 
151
  <table class="params">
 
152
    <tr><td class="paramname">value</td><td>A <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Value</a> representing the minimum accessible value. </td></tr>
 
153
  </table>
 
154
  </dd>
 
155
</dl>
 
156
 
 
157
</div>
 
158
</div>
 
159
<a class="anchor" id="a5f68e4192b070a56f2f5dbdc29d18ef1"></a><!-- doxytag: member="Atk::Value::set_current_value" ref="a5f68e4192b070a56f2f5dbdc29d18ef1" args="(const Glib::ValueBase &amp;value)" -->
 
160
<div class="memitem">
 
161
<div class="memproto">
 
162
      <table class="memname">
 
163
        <tr>
 
164
          <td class="memname">bool Atk::Value::set_current_value </td>
 
165
          <td>(</td>
 
166
          <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ValueBase.html">Glib::ValueBase</a> &amp;&#160;</td>
 
167
          <td class="paramname"> <em>value</em>&#160;)</td>
 
168
          <td></td>
 
169
        </tr>
 
170
      </table>
 
171
</div>
 
172
<div class="memdoc">
 
173
 
 
174
<p>Sets the value of this object. </p>
 
175
<dl><dt><b>Parameters:</b></dt><dd>
 
176
  <table class="params">
 
177
    <tr><td class="paramname">value</td><td>A <a class="el" href="classAtk_1_1Value.html" title="The ATK interface implemented by valuators and components which display or select a value from a boun...">Value</a> which is the desired new accessible value. </td></tr>
 
178
  </table>
 
179
  </dd>
 
180
</dl>
 
181
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if new value is successfully set, <code>false</code> otherwise. </dd></dl>
 
182
 
 
183
</div>
 
184
</div>
 
185
<hr/><h2>Friends And Related Function Documentation</h2>
 
186
<a class="anchor" id="a68a42fa970f6678863e0d5163fc58439"></a><!-- doxytag: member="Atk::Value::wrap" ref="a68a42fa970f6678863e0d5163fc58439" args="(AtkValue *object, bool take_copy=false)" -->
 
187
<div class="memitem">
 
188
<div class="memproto">
 
189
      <table class="memname">
 
190
        <tr>
 
191
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1Value.html">Atk::Value</a> &gt; wrap </td>
 
192
          <td>(</td>
 
193
          <td class="paramtype">AtkValue *&#160;</td>
 
194
          <td class="paramname"> <em>object</em>, </td>
 
195
        </tr>
 
196
        <tr>
 
197
          <td class="paramkey"></td>
 
198
          <td></td>
 
199
          <td class="paramtype">bool&#160;</td>
 
200
          <td class="paramname"> <em>take_copy</em> = <code>false</code>&#160;</td>
 
201
        </tr>
 
202
        <tr>
 
203
          <td></td>
 
204
          <td>)</td>
 
205
          <td></td><td><code> [related]</code></td>
 
206
        </tr>
 
207
      </table>
 
208
</div>
 
209
<div class="memdoc">
 
210
 
 
211
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
 
212
<dl><dt><b>Parameters:</b></dt><dd>
 
213
  <table class="params">
 
214
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
215
    <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
 
216
  </table>
 
217
  </dd>
 
218
</dl>
 
219
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
220
 
 
221
</div>
 
222
</div>
 
223
</div>
 
224
<hr class="footer"/><address class="footer"><small>Generated on Sat Nov 20 2010 13:35:45 for atkmm by&#160;
 
225
<a href="http://www.doxygen.org/index.html">
 
226
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
227
</body>
 
228
</html>