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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::Value Class Reference</h1>An AtkValue C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <gfc/atk/value.hh></code>
<p>
<p>Inheritance diagram for GFC::Atk::Value:
<p><center><img src="classGFC_1_1Atk_1_1Value.png" usemap="#GFC::Atk::Value_map" border="0" alt=""></center>
<map name="GFC::Atk::Value_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
</map>
<a href="classGFC_1_1Atk_1_1Value-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z97_0" doxytag="GFC::Atk::Value::atk_value" ></a>
AtkValue * <a class="el" href="classGFC_1_1Atk_1_1Value.html#z97_0">atk_value</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkValue structure. <br></dl><li><a class="anchor" name="z97_1" doxytag="GFC::Atk::Value::operator AtkValue *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Value.html#z97_1">operator AtkValue *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Atk_1_1Value.html">Value</a> to an AtkValue pointer. <br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1Value.html#z97_2">get_current_value</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> &value) const
<dl class="el"><dd class="mdescRight">Gets the value of this object. <a href="#z97_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1Value.html#z97_3">get_maximum_value</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> &value) const
<dl class="el"><dd class="mdescRight">Gets the maximum value for this object. <a href="#z97_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Atk_1_1Value.html#z97_4">get_minimum_value</a> (<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> &value) const
<dl class="el"><dd class="mdescRight">Gets the minimum value for this object. <a href="#z97_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Atk_1_1Value.html#z98_0">set_current_value</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> &value)
<dl class="el"><dd class="mdescRight">Sets the value of this object. <a href="#z98_0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z96_0" doxytag="GFC::Atk::Value::Value" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Value.html#z96_0">Value</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Atk_1_1Value.html">Value</a> object. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkValue C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Atk_1_1Value.html">Value</a> 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="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> representations which implement <a class="el" href="classGFC_1_1Atk_1_1Value.html">Value</a> on the component's behalf. Values may be read-only, in which case attempts to alter the value return false to indicate failure.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z97_2" doxytag="GFC::Atk::Value::get_current_value" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::Value::get_current_value </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the value of this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>value</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> representing the current accessible value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z97_3" doxytag="GFC::Atk::Value::get_maximum_value" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::Value::get_maximum_value </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the maximum value for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>value</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> representing the maximum accessible value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z97_4" doxytag="GFC::Atk::Value::get_minimum_value" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Atk::Value::get_minimum_value </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the minimum value for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>value</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> representing the minimum accessible value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z98_0" doxytag="GFC::Atk::Value::set_current_value" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Value::set_current_value </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the value of this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>value</em> </td><td>A <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Value.html">G::Value</a> which is the desired new accessible value. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the new value is successfully set, <em>false</em> otherwise. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="value_8hh-source.html">value.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:35 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
