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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>toolOptions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch01.html" title="Core tools">
<link rel="prev" href="ch01.html" title="Core tools">
<link rel="next" href="v-sim-toolMatrix.html" title="toolMatrix">
<meta name="generator" content="GTK-Doc V1.14 (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="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-toolMatrix.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-toolOptions.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-toolOptions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="toolOptions">
<a name="v-sim-toolOptions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-toolOptions.top_of_page"></a>toolOptions</span></h2>
<p>toolOptions — A convienent wrapper around GHashTable that can support types.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-toolOptions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption">ToolOption</a>;
<a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-new" title="tool_option_new ()">tool_option_new</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> g_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-toolOptions.html#tool-option-free" title="tool_option_free ()">tool_option_free</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-copy" title="tool_option_copy ()">tool_option_copy</a> (<em class="parameter"><code>const <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *from</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-getName" title="tool_option_getName ()">tool_option_getName</a> (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-getLabel" title="tool_option_getLabel ()">tool_option_getLabel</a> (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="v-sim-toolOptions.html#tool-option-getType" title="tool_option_getType ()">tool_option_getType</a> (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-getValue" title="tool_option_getValue ()">tool_option_getValue</a> (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-toolOptions.html#tool-option-getValueAndLabel" title="tool_option_getValueAndLabel ()">tool_option_getValueAndLabel</a> (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-toolOptions.description"></a><h2>Description</h2>
<p>
</p>
<p>This wrapper is a simple way to store integers, floating
point values or booleans in a table, accessing with a string key
and remembering their types.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-toolOptions.details"></a><h2>Details</h2>
<div class="refsect2" title="ToolOption">
<a name="ToolOption"></a><h3>ToolOption</h3>
<pre class="programlisting">typedef struct _ToolOption ToolOption;</pre>
<p>
An opaque structure to store values. It is equivalent to <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
but with a name and a label.
</p>
</div>
<hr>
<div class="refsect2" title="tool_option_new ()">
<a name="tool-option-new"></a><h3>tool_option_new ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* tool_option_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> g_type</code></em>);</pre>
<p>
Create a new <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> using the name as identifier.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a string identifying the option ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a string describing shortly the option (must be in UTF-8).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>g_type</code></em> :</span></p></td>
<td>the type of option to create.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created option, use <a class="link" href="v-sim-toolOptions.html#tool-option-free" title="tool_option_free ()"><code class="function">tool_option_free()</code></a> to free it.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_free ()">
<a name="tool-option-free"></a><h3>tool_option_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tool_option_free (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
Free the memory used by the <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>the <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> to free.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_copy ()">
<a name="tool-option-copy"></a><h3>tool_option_copy ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="returnvalue">ToolOption</span></a>* tool_option_copy (<em class="parameter"><code>const <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *from</code></em>);</pre>
<p>
Create a new <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> using the values from option <em class="parameter"><code>from</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td>
<td>an existing <a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created option, use <a class="link" href="v-sim-toolOptions.html#tool-option-free" title="tool_option_free ()"><code class="function">tool_option_free()</code></a> to free it.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_getName ()">
<a name="tool-option-getName"></a><h3>tool_option_getName ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_option_getName (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);</pre>
<p>
Get the name of the option.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
<td>the <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> to get the name of.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim, should not be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_getLabel ()">
<a name="tool-option-getLabel"></a><h3>tool_option_getLabel ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_option_getLabel (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);</pre>
<p>
Get the label of the option.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
<td>the <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> to get the label of.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a string owned by V_Sim, should not be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_getType ()">
<a name="tool-option-getType"></a><h3>tool_option_getType ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> tool_option_getType (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);</pre>
<p>
Get the type of the option.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
<td>the <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> to get the type of.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="v-sim-toolOptions.html#OptionTypes"><span class="type">OptionTypes</span></a> value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_getValue ()">
<a name="tool-option-getValue"></a><h3>tool_option_getValue ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a>* tool_option_getValue (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);</pre>
<p>
Get the location of the storage for the option.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
<td>a <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> storing the option value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="tool_option_getValueAndLabel ()">
<a name="tool-option-getValueAndLabel"></a><h3>tool_option_getValueAndLabel ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* tool_option_getValueAndLabel (<em class="parameter"><code><a class="link" href="v-sim-toolOptions.html#ToolOption" title="ToolOption"><span class="type">ToolOption</span></a> *option</code></em>);</pre>
<p>
This method returns a string with the value followed by the label in parenthesis
and with Pango markup for smaller font.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>option</code></em> :</span></p></td>
<td>the <a href="v-sim-toolOptions.html#Option"><span class="type">Option</span></a> to get the value from.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created markup string.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
