summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkcheckmenuitem.sgml
blob: 4ad0ce4ca4fb3c6189ca6b4e81c340c0c8a59a38 (plain)
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
<!-- ##### SECTION Title ##### -->
GtkCheckMenuItem

<!-- ##### SECTION Short_Description ##### -->
A menu item with a check box

<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkCheckMenuItem is a menu item that maintains the state of a boolean 
value in addition to a #GtkMenuItem's usual role in activating application
code.
</para>

<para>
A check box indicating the state of the boolean value is displayed
at the left side of the #GtkMenuItem.  Activating the #GtkMenuItem 
toggles the value.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT GtkCheckMenuItem ##### -->
<para>
The #GtkCheckMenuItem-struct struct contains the following fields.
(These fields should be considered read-only. They should never be set by
an application.)

<informaltable pgwide="1" frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
<tbody>

<row>
<entry>#guint active;</entry>
<entry>TRUE if the check box is active.</entry>
</row>

</tbody></tgroup></informaltable>
</para>


<!-- ##### SIGNAL GtkCheckMenuItem::toggled ##### -->
<para>
This signal is emitted when the state of the check box is changed.
</para>

<para>
A signal handler can examine the <structfield>active</structfield> 
field of the #GtkCheckMenuItem-struct struct to discover the new state.
</para>

@checkmenuitem: the object which received the signal.

<!-- ##### ARG GtkCheckMenuItem:active ##### -->
<para>

</para>

<!-- ##### ARG GtkCheckMenuItem:draw-as-radio ##### -->
<para>

</para>

<!-- ##### ARG GtkCheckMenuItem:inconsistent ##### -->
<para>

</para>

<!-- ##### ARG GtkCheckMenuItem:indicator-size ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_check_menu_item_new ##### -->
<para>
Creates a new #GtkCheckMenuItem.
</para>

@void: 
@Returns: a new #GtkCheckMenuItem.


<!-- ##### FUNCTION gtk_check_menu_item_new_with_label ##### -->
<para>
Creates a new #GtkCheckMenuItem with a label.
</para>

@label: the string to use for the label.
@Returns: a new #GtkCheckMenuItem.


<!-- ##### FUNCTION gtk_check_menu_item_new_with_mnemonic ##### -->
<para>

</para>

@label: 
@Returns: 


<!-- ##### MACRO gtk_check_menu_item_set_state ##### -->
<para>
Sets the active state of the menu item's check box.
</para>

@Deprecated: Use gtk_check_menu_item_set_active() instead.


<!-- ##### FUNCTION gtk_check_menu_item_get_active ##### -->
<para>

</para>

@check_menu_item: 
@Returns: 


<!-- ##### FUNCTION gtk_check_menu_item_set_active ##### -->
<para>
Sets the active state of the menu item's check box.
</para>

@check_menu_item: a #GtkCheckMenuItem.
@is_active: boolean value indicating whether the check box is active.


<!-- ##### FUNCTION gtk_check_menu_item_set_show_toggle ##### -->
<para>
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.
</para>

@menu_item: a #GtkCheckMenuItem.
@always: boolean value indicating whether to always show the check box.


<!-- ##### FUNCTION gtk_check_menu_item_toggled ##### -->
<para>
Emits the GtkCheckMenuItem::toggled signal.
</para>

@check_menu_item: a #GtkCheckMenuItem.


<!-- ##### FUNCTION gtk_check_menu_item_get_inconsistent ##### -->
<para>

</para>

@check_menu_item: 
@Returns: 


<!-- ##### FUNCTION gtk_check_menu_item_set_inconsistent ##### -->
<para>

</para>

@check_menu_item: 
@setting: 


<!-- ##### FUNCTION gtk_check_menu_item_set_draw_as_radio ##### -->
<para>

</para>

@check_menu_item: 
@draw_as_radio: 


<!-- ##### FUNCTION gtk_check_menu_item_get_draw_as_radio ##### -->
<para>

</para>

@check_menu_item: 
@Returns: