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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkCheckMenuItem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem">
<link rel="next" href="GtkSeparatorMenuItem.html" title="GtkSeparatorMenuItem">
<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="GtkRadioMenuItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MenusAndCombos.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">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkSeparatorMenuItem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtk-gtkcheckmenuitem.synopsis" class="shortcut">Top</a>
|
<a href="#gtk-gtkcheckmenuitem.description" class="shortcut">Description</a>
|
<a href="#gtk-gtkcheckmenuitem.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#gtk-gtkcheckmenuitem.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#gtk-gtkcheckmenuitem.properties" class="shortcut">Properties</a>
|
<a href="#gtk-gtkcheckmenuitem.style-properties" class="shortcut">Style Properties</a>
|
<a href="#gtk-gtkcheckmenuitem.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GtkCheckMenuItem">
<a name="gtk-gtkcheckmenuitem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtk-gtkcheckmenuitem.top_of_page"></a>GtkCheckMenuItem</span></h2>
<p>GtkCheckMenuItem — A menu item with a check box</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gtk-gtkcheckmenuitem.synopsis"></a><h2>Synopsis</h2>
<a name="GtkCheckMenuItem"></a><pre class="synopsis">
#include <gtk/gtk.h>
<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem-struct" title="GtkCheckMenuItem">GtkCheckMenuItem</a>;
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-new" title="gtk_check_menu_item_new ()">gtk_check_menu_item_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-new-with-label" title="gtk_check_menu_item_new_with_label ()">gtk_check_menu_item_new_with_label</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> *label</code></em>);
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-new-with-mnemonic" title="gtk_check_menu_item_new_with_mnemonic ()">gtk_check_menu_item_new_with_mnemonic</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> *label</code></em>);
#define <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-state" title="gtk_check_menu_item_set_state">gtk_check_menu_item_set_state</a>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-get-active" title="gtk_check_menu_item_get_active ()">gtk_check_menu_item_get_active</a> (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-active" title="gtk_check_menu_item_set_active ()">gtk_check_menu_item_set_active</a> (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> is_active</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-show-toggle" title="gtk_check_menu_item_set_show_toggle ()">gtk_check_menu_item_set_show_toggle</a> (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *menu_item</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> always</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-toggled" title="gtk_check_menu_item_toggled ()">gtk_check_menu_item_toggled</a> (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-get-inconsistent" title="gtk_check_menu_item_get_inconsistent ()">gtk_check_menu_item_get_inconsistent</a>
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-inconsistent" title="gtk_check_menu_item_set_inconsistent ()">gtk_check_menu_item_set_inconsistent</a>
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> setting</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-draw-as-radio" title="gtk_check_menu_item_set_draw_as_radio ()">gtk_check_menu_item_set_draw_as_radio</a>
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> draw_as_radio</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-get-draw-as-radio" title="gtk_check_menu_item_get_draw_as_radio ()">gtk_check_menu_item_get_draw_as_radio</a>
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="gtk-gtkcheckmenuitem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
+----<a class="link" href="GtkItem.html" title="GtkItem">GtkItem</a>
+----<a class="link" href="GtkMenuItem.html" title="GtkMenuItem">GtkMenuItem</a>
+----GtkCheckMenuItem
+----<a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem">GtkRadioMenuItem</a>
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="gtk-gtkcheckmenuitem.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkCheckMenuItem implements
AtkImplementorIface, <a class="link" href="gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="gtk-gtkcheckmenuitem.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem--active" title='The "active" property'>active</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem--draw-as-radio" title='The "draw-as-radio" property'>draw-as-radio</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem--inconsistent" title='The "inconsistent" property'>inconsistent</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Style Properties">
<a name="gtk-gtkcheckmenuitem.style-properties"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem--s-indicator-size" title='The "indicator-size" style property'>indicator-size</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="gtk-gtkcheckmenuitem.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem-toggled" title='The "toggled" signal'>toggled</a>" : Run First
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gtk-gtkcheckmenuitem.description"></a><h2>Description</h2>
<p>
A <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> is a menu item that maintains the state of a boolean
value in addition to a <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a>'s usual role in activating application
code.
</p>
<p>
A check box indicating the state of the boolean value is displayed
at the left side of the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a>. Activating the <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a>
toggles the value.
</p>
</div>
<div class="refsect1" title="Details">
<a name="gtk-gtkcheckmenuitem.details"></a><h2>Details</h2>
<div class="refsect2" title="GtkCheckMenuItem">
<a name="GtkCheckMenuItem-struct"></a><h3>GtkCheckMenuItem</h3>
<pre class="programlisting">typedef struct _GtkCheckMenuItem GtkCheckMenuItem;</pre>
<p>
The <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem-struct" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)
</p>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody><tr>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> active;</td>
<td>TRUE if the check box is active.</td>
</tr></tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_new ()">
<a name="gtk-check-menu-item-new"></a><h3>gtk_check_menu_item_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* gtk_check_menu_item_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_new_with_label ()">
<a name="gtk-check-menu-item-new-with-label"></a><h3>gtk_check_menu_item_new_with_label ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* gtk_check_menu_item_new_with_label (<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>);</pre>
<p>
Creates a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> with a label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>the string to use for the label.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_new_with_mnemonic ()">
<a name="gtk-check-menu-item-new-with-mnemonic"></a><h3>gtk_check_menu_item_new_with_mnemonic ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a>* gtk_check_menu_item_new_with_mnemonic
(<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>);</pre>
<p>
Creates a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> containing a label. The label
will be created using <a class="link" href="GtkLabel.html#gtk-label-new-with-mnemonic" title="gtk_label_new_with_mnemonic ()"><code class="function">gtk_label_new_with_mnemonic()</code></a>, so underscores
in <em class="parameter"><code>label</code></em> indicate the mnemonic for the menu item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>The text of the button, with an underscore in front of the
mnemonic character
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_set_state">
<a name="gtk-check-menu-item-set-state"></a><h3>gtk_check_menu_item_set_state</h3>
<pre class="programlisting">#define gtk_check_menu_item_set_state gtk_check_menu_item_set_active
</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_check_menu_item_set_state</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-active" title="gtk_check_menu_item_set_active ()"><code class="function">gtk_check_menu_item_set_active()</code></a> instead.</p>
</div>
<p>
Sets the active state of the menu item's check box.
</p>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_get_active ()">
<a name="gtk-check-menu-item-get-active"></a><h3>gtk_check_menu_item_get_active ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_check_menu_item_get_active (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);</pre>
<p>
Returns whether the check menu item is active. See
<a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-active" title="gtk_check_menu_item_set_active ()"><code class="function">gtk_check_menu_item_set_active()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the menu item is checked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_set_active ()">
<a name="gtk-check-menu-item-set-active"></a><h3>gtk_check_menu_item_set_active ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_check_menu_item_set_active (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> is_active</code></em>);</pre>
<p>
Sets the active state of the menu item's check box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
<td>boolean value indicating whether the check box is active.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_set_show_toggle ()">
<a name="gtk-check-menu-item-set-show-toggle"></a><h3>gtk_check_menu_item_set_show_toggle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_check_menu_item_set_show_toggle (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *menu_item</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> always</code></em>);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_check_menu_item_set_show_toggle</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Controls whether the check box is shown at all times.
Normally the check box is shown only when it is active or while the
menu item is selected.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>always</code></em> :</span></p></td>
<td>boolean value indicating whether to always show the check box.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_toggled ()">
<a name="gtk-check-menu-item-toggled"></a><h3>gtk_check_menu_item_toggled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_check_menu_item_toggled (<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);</pre>
<p>
Emits the GtkCheckMenuItem::toggled signal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_get_inconsistent ()">
<a name="gtk-check-menu-item-get-inconsistent"></a><h3>gtk_check_menu_item_get_inconsistent ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_check_menu_item_get_inconsistent
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);</pre>
<p>
Retrieves the value set by <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-inconsistent" title="gtk_check_menu_item_set_inconsistent ()"><code class="function">gtk_check_menu_item_set_inconsistent()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if inconsistent
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_set_inconsistent ()">
<a name="gtk-check-menu-item-set-inconsistent"></a><h3>gtk_check_menu_item_set_inconsistent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_check_menu_item_set_inconsistent
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> setting</code></em>);</pre>
<p>
If the user has selected a range of elements (such as some text or
spreadsheet cells) that are affected by a boolean setting, and the
current values in that range are inconsistent, you may want to
display the check in an "in between" state. This function turns on
"in between" display. Normally you would turn off the inconsistent
state again if the user explicitly selects a setting. This has to be
done manually, <a class="link" href="gtk-gtkcheckmenuitem.html#gtk-check-menu-item-set-inconsistent" title="gtk_check_menu_item_set_inconsistent ()"><code class="function">gtk_check_menu_item_set_inconsistent()</code></a> only affects
visual appearance, it doesn't affect the semantics of the widget.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to display an "inconsistent" third state check
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_set_draw_as_radio ()">
<a name="gtk-check-menu-item-set-draw-as-radio"></a><h3>gtk_check_menu_item_set_draw_as_radio ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_check_menu_item_set_draw_as_radio
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</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> draw_as_radio</code></em>);</pre>
<p>
Sets whether <em class="parameter"><code>check_menu_item</code></em> is drawn like a <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>draw_as_radio</code></em> :</span></p></td>
<td>whether <em class="parameter"><code>check_menu_item</code></em> is drawn like a <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" title="gtk_check_menu_item_get_draw_as_radio ()">
<a name="gtk-check-menu-item-get-draw-as-radio"></a><h3>gtk_check_menu_item_get_draw_as_radio ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_check_menu_item_get_draw_as_radio
(<em class="parameter"><code><a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *check_menu_item</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>check_menu_item</code></em> looks like a <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_menu_item</code></em> :</span></p></td>
<td>a <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether <em class="parameter"><code>check_menu_item</code></em> looks like a <a class="link" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="gtk-gtkcheckmenuitem.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "active" property'>
<a name="GtkCheckMenuItem--active"></a><h3>The <code class="literal">"active"</code> property</h3>
<pre class="programlisting"> "active" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Whether the menu item is checked.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "draw-as-radio" property'>
<a name="GtkCheckMenuItem--draw-as-radio"></a><h3>The <code class="literal">"draw-as-radio"</code> property</h3>
<pre class="programlisting"> "draw-as-radio" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Whether the menu item looks like a radio menu item.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" title='The "inconsistent" property'>
<a name="GtkCheckMenuItem--inconsistent"></a><h3>The <code class="literal">"inconsistent"</code> property</h3>
<pre class="programlisting"> "inconsistent" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>Whether to display an "inconsistent" state.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" title="Style Property Details">
<a name="gtk-gtkcheckmenuitem.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2" title='The "indicator-size" style property'>
<a name="GtkCheckMenuItem--s-indicator-size"></a><h3>The <code class="literal">"indicator-size"</code> style property</h3>
<pre class="programlisting"> "indicator-size" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre>
<p>Size of check or radio indicator.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 13</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="gtk-gtkcheckmenuitem.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "toggled" signal'>
<a name="GtkCheckMenuItem-toggled"></a><h3>The <code class="literal">"toggled"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> *checkmenuitem,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre>
<p>
This signal is emitted when the state of the check box is changed.
</p>
<p>
A signal handler can examine the <em class="structfield"><code>active</code></em>
field of the <a class="link" href="gtk-gtkcheckmenuitem.html#GtkCheckMenuItem-struct" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a> struct to discover the new state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>checkmenuitem</code></em> :</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
