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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gwycheckboxes: Gwyddion Widgets Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Widgets Library Reference Manual">
<link rel="up" href="WidgetUtilities.html" title="Widget Utilities">
<link rel="prev" href="libgwydgets-gwyradiobuttons.html" title="gwyradiobuttons">
<link rel="next" href="GwySensitivityGroup.html" title="GwySensitivityGroup">
<meta name="generator" content="GTK-Doc V1.19 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgwydgets-gwycheckboxes.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="WidgetUtilities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgwydgets-gwyradiobuttons.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwySensitivityGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwydgets-gwycheckboxes"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwydgets-gwycheckboxes.top_of_page"></a>gwycheckboxes</span></h2>
<p>gwycheckboxes — Check box group constructors for flags</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgwydgets-gwycheckboxes.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()">gwy_check_boxes_create</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()">gwy_check_boxes_createl</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-attach-to-table" title="gwy_check_boxes_attach_to_table ()">gwy_check_boxes_attach_to_table</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-set-selected" title="gwy_check_boxes_set_selected ()">gwy_check_boxes_set_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-get-selected" title="gwy_check_boxes_get_selected ()">gwy_check_boxes_get_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-box-get-group" title="gwy_check_box_get_group ()">gwy_check_box_get_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-find" title="gwy_check_boxes_find ()">gwy_check_boxes_find</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-set-sensitive" title="gwy_check_boxes_set_sensitive ()">gwy_check_boxes_set_sensitive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-box-get-value" title="gwy_check_box_get_value ()">gwy_check_box_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwydgets-gwycheckboxes.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libgwydgets/gwydgets.h>
</pre>
</div>
<div class="refsect1">
<a name="libgwydgets-gwycheckboxes.description"></a><h2>Description</h2>
<p>Groups of check boxes associated with integer flags can be easily
constructed from <a href="../GwyEnum.html#GwyEnum-struct"><span class="type">GwyEnum</span></a>'s with <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a>.</p>
</div>
<div class="refsect1">
<a name="libgwydgets-gwycheckboxes.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-check-boxes-create"></a><h3>gwy_check_boxes_create ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gwy_check_boxes_create (<em class="parameter"><code>const <a href="../GwyEnum.html#GwyEnum-struct"><span class="type">GwyEnum</span></a> *entries</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> nentries</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selected</code></em>);</pre>
<p>Creates a check box group from a set of flags.</p>
<p>All the enum values must be distinct flags, i.e. positive integers with
non-overlapping bits (binary AND of any two values must be zero).</p>
<p>The group <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> returned by this function is analogous to <a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a>
groups. However, GTK+ does not know anything about it and it cannot be
used with any functions expecting a <a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> group.</p>
<div class="refsect3">
<a name="gwy-check-boxes-create.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entries</p></td>
<td class="parameter_description"><p>Radio button group items.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nentries</p></td>
<td class="parameter_description"><p>The number of items. Negative value means that <em class="parameter"><code>entries</code></em>
is
terminated with a <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-named item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>A callback called when a button is selected (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for no
callback).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cbdata</p></td>
<td class="parameter_description"><p>User data passed to the callback.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected</p></td>
<td class="parameter_description"><p>Combination of flags corresponding to selected items.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-boxes-create.returns"></a><h4>Returns</h4>
<p> The newly created check box group (a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a>). Iterate over
the list and pack the widgets (the order is the same as in
<em class="parameter"><code>entries</code></em>
). The group is owned by the buttons and must not be
freed.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-createl"></a><h3>gwy_check_boxes_createl ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gwy_check_boxes_createl (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#GCallback"><span class="type">GCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cbdata</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selected</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Creates a check box group from a list of label/value pairs.</p>
<p>All the enum values must be distinct flags, i.e. positive integers with
non-overlapping bits (binary AND of any two values must be zero).</p>
<p>The group <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> returned by this function is analogous to <a href="/usr/share/gtk-doc/html/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a>
groups. However, GTK+ does not know anything about it and it cannot be
used with any functions expecting a <a href="/usr/share/gtk-doc/html/gtk3/GtkRadioButton.html#GtkRadioButton-struct"><span class="type">GtkRadioButton</span></a> group.</p>
<div class="refsect3">
<a name="gwy-check-boxes-createl.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>A callback called when a button is selected (or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for no
callback).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cbdata</p></td>
<td class="parameter_description"><p>User data passed to the callback.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected</p></td>
<td class="parameter_description"><p>Combination of flags corresponding to selected items.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>First item label, first item value, second item label, second item
value, etc. Terminated with <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-boxes-createl.returns"></a><h4>Returns</h4>
<p> The newly created check box group (a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a>). Iterate over
the list and pack the widgets (the order is the same as in
<em class="parameter"><code>entries</code></em>
). The group is owned by the buttons and must not be
freed.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-attach-to-table"></a><h3>gwy_check_boxes_attach_to_table ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gwy_check_boxes_attach_to_table (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTable.html#GtkTable-struct"><span class="type">GtkTable</span></a> *table</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> colspan</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> row</code></em>);</pre>
<p>Attaches a group of check boxes to table rows.</p>
<div class="refsect3">
<a name="gwy-check-boxes-attach-to-table.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A check box group created by <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a> or
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()"><code class="function">gwy_check_boxes_createl()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>table</p></td>
<td class="parameter_description"><p>A table.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>colspan</p></td>
<td class="parameter_description"><p>The number of columns the check boxes should span across.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>row</p></td>
<td class="parameter_description"><p>Table row to start attaching at.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-boxes-attach-to-table.returns"></a><h4>Returns</h4>
<p> The row after the last attached check box.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-set-selected"></a><h3>gwy_check_boxes_set_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_check_boxes_set_selected (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> selected</code></em>);</pre>
<p>Sets the state of all check boxes in <em class="parameter"><code>group</code></em>
to given flag combination.</p>
<p>If <em class="parameter"><code>selected</code></em>
differs significantly from the currently selected flags, lots
of check buttons will change state, resulting in lots of callbacks. You
might want to avoid reacting to each invidivually.</p>
<p>The callback passed upon construction will be called only after all the
state of all check boxes is updated so it will see the check boxes already
correspond to <em class="parameter"><code>selected</code></em>
. However, any additional signal handlers you set up
will be called during the update unless you block them yourself.</p>
<div class="refsect3">
<a name="gwy-check-boxes-set-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A check box group created by <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected</p></td>
<td class="parameter_description"><p>Flags to be shown as currently selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-get-selected"></a><h3>gwy_check_boxes_get_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_check_boxes_get_selected (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>);</pre>
<p>Gets the flag combination corresponding to currently selected items.</p>
<div class="refsect3">
<a name="gwy-check-boxes-get-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A check box group created by <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a> or
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()"><code class="function">gwy_check_boxes_createl()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-boxes-get-selected.returns"></a><h4>Returns</h4>
<p> The combination of flags corresponding to currently selected items.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-box-get-group"></a><h3>gwy_check_box_get_group ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gwy_check_box_get_group (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *checkbox</code></em>);</pre>
<p>Gets the group a check box belongs to.</p>
<div class="refsect3">
<a name="gwy-check-box-get-group.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>checkbox</p></td>
<td class="parameter_description"><p>A check box belonging to a group created by
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a> or <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()"><code class="function">gwy_check_boxes_createl()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-box-get-group.returns"></a><h4>Returns</h4>
<p> The group <em class="parameter"><code>checkbox</code></em>
belongs to.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-find"></a><h3>gwy_check_boxes_find ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gwy_check_boxes_find (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);</pre>
<p>Finds a check box by its associated flag value.</p>
<p>The value must corresponding exactly to the single flag. Otherwise the
check box is not considered a match.</p>
<div class="refsect3">
<a name="gwy-check-boxes-find.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A check box group created by <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a> or
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()"><code class="function">gwy_check_boxes_createl()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The value associated with the check box to find.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-boxes-find.returns"></a><h4>Returns</h4>
<p> The check box corresponding to <em class="parameter"><code>value</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-boxes-set-sensitive"></a><h3>gwy_check_boxes_set_sensitive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_check_boxes_set_sensitive (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *group</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sensitive</code></em>);</pre>
<p>Sets the sensitivity of all check box in a group.</p>
<p>This function is useful to make the choice as a whole available/unavailable.
Use <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-find" title="gwy_check_boxes_find ()"><code class="function">gwy_check_boxes_find()</code></a> combined with <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#gtk-widget-set-sensitive"><code class="function">gtk_widget_set_sensitive()</code></a> to
manage sensitivity of individual options.</p>
<div class="refsect3">
<a name="gwy-check-boxes-set-sensitive.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A check box group created by <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sensitive</p></td>
<td class="parameter_description"><p><a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to make all choices sensitive, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to make all
insensitive.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-check-box-get-value"></a><h3>gwy_check_box_get_value ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gwy_check_box_get_value (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *checkbox</code></em>);</pre>
<p>Gets the flag value associated with a check box.</p>
<div class="refsect3">
<a name="gwy-check-box-get-value.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>checkbox</p></td>
<td class="parameter_description"><p>A check box belonging to a group created by
<a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-create" title="gwy_check_boxes_create ()"><code class="function">gwy_check_boxes_create()</code></a> or <a class="link" href="libgwydgets-gwycheckboxes.html#gwy-check-boxes-createl" title="gwy_check_boxes_createl ()"><code class="function">gwy_check_boxes_createl()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gwy-check-box-get-value.returns"></a><h4>Returns</h4>
<p> The flag value corresponding to <em class="parameter"><code>button</code></em>
.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-51.html#api-index-2.51">2.51</a></p>
</div>
</div>
<div class="refsect1">
<a name="libgwydgets-gwycheckboxes.see-also"></a><h2>See Also</h2>
<a class="link" href="libgwydgets-gwycombobox.html" title="gwycombobox">gwycombobox</a><p>-- combo box constructors;</p>
<a class="link" href="libgwydgets-gwyradiobuttons.html" title="gwyradiobuttons">gwyradiobuttons</a><p>-- radio button constructors</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>
|
