summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkactiongroup.sgml
blob: 6ec1b5fea0cc078fbece2ffa0dc1cc3eabba3460 (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
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
<!-- ##### SECTION Title ##### -->
GtkActionGroup

<!-- ##### SECTION Short_Description ##### -->
a group of actions

<!-- ##### SECTION Long_Description ##### -->
<para>
Actions are organised into groups.  An action group is essentially a
map from names to #GtkAction objects.
</para>
<para>
All actions that would make sense to use in a particular context
should be in a single group.  Multiple action groups may be used for a
particular user interface.  In fact, it is expected that most nontrivial 
applications will make use of multiple groups.  For example, in an application
that can edit multiple documents, one group holding global actions 
(e.g. quit, about, new), and one group per document holding actions that 
act on that document (eg. save, cut/copy/paste, etc).  Each window's menus 
would be constructed from a combination of two action groups.
</para>
<para id="Action-Accel">
Accelerators are handled by the GTK+ accelerator map. All actions are assigned an 
accelerator path (which normally has the form 
<literal>&lt;Actions&gt;/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>) 
and a shortcut is associated with this accelerator path. All menuitems and 
toolitems take on this accelerator path. The GTK+ accelerator map code makes 
sure that the correct shortcut is displayed next to the menu item.
</para>

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

</para>

<!-- ##### STRUCT GtkActionGroup ##### -->
<para>
The <structname>GtkActionGroup</structname> struct contains only private 
members and should not be accessed directly.
</para>


<!-- ##### SIGNAL GtkActionGroup::connect-proxy ##### -->
<para>

</para>

@actiongroup: the object which received the signal.
@arg1: 
@widget: 

<!-- ##### SIGNAL GtkActionGroup::disconnect-proxy ##### -->
<para>

</para>

@actiongroup: the object which received the signal.
@arg1: 
@widget: 

<!-- ##### SIGNAL GtkActionGroup::post-activate ##### -->
<para>

</para>

@actiongroup: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL GtkActionGroup::pre-activate ##### -->
<para>

</para>

@actiongroup: the object which received the signal.
@arg1: 

<!-- ##### ARG GtkActionGroup:name ##### -->
<para>

</para>

<!-- ##### ARG GtkActionGroup:sensitive ##### -->
<para>

</para>

<!-- ##### ARG GtkActionGroup:visible ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_action_group_new ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_get_name ##### -->
<para>

</para>

@action_group: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_get_sensitive ##### -->
<para>

</para>

@action_group: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_set_sensitive ##### -->
<para>

</para>

@action_group: 
@sensitive: 


<!-- ##### FUNCTION gtk_action_group_get_visible ##### -->
<para>

</para>

@action_group: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_set_visible ##### -->
<para>

</para>

@action_group: 
@visible: 


<!-- ##### FUNCTION gtk_action_group_get_action ##### -->
<para>

</para>

@action_group: 
@action_name: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_list_actions ##### -->
<para>

</para>

@action_group: 
@Returns: 


<!-- ##### FUNCTION gtk_action_group_add_action ##### -->
<para>

</para>

@action_group: 
@action: 


<!-- ##### FUNCTION gtk_action_group_add_action_with_accel ##### -->
<para>

</para>

@action_group: 
@action: 
@accelerator: 


<!-- ##### FUNCTION gtk_action_group_remove_action ##### -->
<para>

</para>

@action_group: 
@action: 


<!-- ##### STRUCT GtkActionEntry ##### -->
<para>
<structname>GtkActionEntry</structname> structs are used with 
gtk_action_group_add_actions() to construct actions.
</para>

@name: The name of the action.
@stock_id: The stock id for the action.
@label: The label for the action. This field should typically be marked for 
    translation, see gtk_action_group_set_translation_domain().
@accelerator: The accelerator for the action, in the format understood by 
    gtk_accelerator_parse().
@tooltip: The tooltip for the action. This field should typically be marked 
    for translation, see gtk_action_group_set_translation_domain().
@callback: The function to call when the action is activated.

<!-- ##### FUNCTION gtk_action_group_add_actions ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@user_data: 


<!-- ##### FUNCTION gtk_action_group_add_actions_full ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@user_data: 
@destroy: 


<!-- ##### STRUCT GtkToggleActionEntry ##### -->
<para>
<structname>GtkToggleActionEntry</structname> structs are used with 
gtk_action_group_add_toggle_actions() to construct toggle actions.
</para>

@name: The name of the action.
@stock_id: The stock id for the action.
@label: The label for the action. This field should typically be marked for 
    translation, see gtk_action_group_set_translation_domain().
@accelerator: The accelerator for the action, in the format understood by 
    gtk_accelerator_parse().
@tooltip: The tooltip for the action. This field should typically be marked 
    for translation, see gtk_action_group_set_translation_domain().
@callback: The function to call when the action is activated.
@is_active: The initial state of the toggle action.

<!-- ##### FUNCTION gtk_action_group_add_toggle_actions ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@user_data: 


<!-- ##### FUNCTION gtk_action_group_add_toggle_actions_full ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@user_data: 
@destroy: 


<!-- ##### STRUCT GtkRadioActionEntry ##### -->
<para>
<structname>GtkRadioActionEntry</structname> structs are used with 
gtk_action_group_add_radio_actions() to construct groups of radio actions.
</para>

@name: The name of the action.
@stock_id: The stock id for the action.
@label: The label for the action. This field should typically be marked for 
    translation, see gtk_action_group_set_translation_domain().
@accelerator: The accelerator for the action, in the format understood by 
    gtk_accelerator_parse().
@tooltip: The tooltip for the action. This field should typically be marked for 
    translation, see gtk_action_group_set_translation_domain().
@value: The value to set on the radio action. See gtk_radio_action_get_current_value().

<!-- ##### FUNCTION gtk_action_group_add_radio_actions ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@value: 
@on_change: 
@user_data: 


<!-- ##### FUNCTION gtk_action_group_add_radio_actions_full ##### -->
<para>

</para>

@action_group: 
@entries: 
@n_entries: 
@value: 
@on_change: 
@user_data: 
@destroy: 


<!-- ##### FUNCTION gtk_action_group_set_translate_func ##### -->
<para>

</para>

@action_group: 
@func: 
@data: 
@notify: 


<!-- ##### FUNCTION gtk_action_group_set_translation_domain ##### -->
<para>

</para>

@action_group: 
@domain: