summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkaction.sgml
blob: fb425ead82d35ec62f7a788a7e05c6ead3548a8c (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
<!-- ##### SECTION Title ##### -->
GtkAction

<!-- ##### SECTION Short_Description ##### -->
an action which can be triggered by a menu or toolbar item

<!-- ##### SECTION Long_Description ##### -->
<para>
Actions represent operations that the user can be perform, along with
some information how it should be presented in the interface. Each action 
provides methods to create icons, menu items and toolbar items representing 
itself.
</para>
<para>
As well as the callback that is called when the action gets activated, the 
following also gets associated with the action:
<itemizedlist>
  <listitem><para>a name (not translated, for path lookup)</para></listitem>
  <listitem><para>a label (translated, for display)</para></listitem>
  <listitem><para>an accelerator</para></listitem>
  <listitem><para>whether label indicates a stock id</para></listitem>
  <listitem><para>a tooltip (optional, translated)</para></listitem>
  <listitem><para>a toolbar label (optional, shorter than label)</para></listitem>
</itemizedlist>
The action will also have some state information:
<itemizedlist>
  <listitem><para>visible (shown/hidden)</para></listitem>
  <listitem><para>sensitive (enabled/disabled)</para></listitem>
</itemizedlist>
</para>
<para>
Apart from regular actions, there are <link linkend="GtkToggleAction">toggle 
actions</link>, which can be toggled between two states and <link 
linkend="GtkRadioAction">radio actions</link>, of which only one in a group 
can be in the "active" state. Other actions can be implemented as #GtkAction 
subclasses.
</para>
<para>
Each action can have one or more proxy menu item, toolbar button or
other proxy widgets.  Proxies mirror the state of the action (text
label, tooltip, icon, visible, sensitive, etc), and should change when
the action's state changes. When the proxy is activated, it should
activate its action.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GtkActionGroup, #GtkUIManager
</para>

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


<!-- ##### SIGNAL GtkAction::activate ##### -->
<para>

</para>

@action: the object which received the signal.

<!-- ##### ARG GtkAction:action-group ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:hide-if-empty ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:is-important ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:label ##### -->
<para>

</para>

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

</para>

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

</para>

<!-- ##### ARG GtkAction:short-label ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:stock-id ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:tooltip ##### -->
<para>

</para>

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

</para>

<!-- ##### ARG GtkAction:visible-horizontal ##### -->
<para>

</para>

<!-- ##### ARG GtkAction:visible-vertical ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_action_new ##### -->
<para>

</para>

@name: 
@label: 
@tooltip: 
@stock_id: 
@Returns: 


<!-- ##### FUNCTION gtk_action_get_name ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_is_sensitive ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_get_sensitive ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_is_visible ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_get_visible ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_activate ##### -->
<para>

</para>

@action: 


<!-- ##### FUNCTION gtk_action_create_icon ##### -->
<para>

</para>

@action: 
@icon_size: 
@Returns: 


<!-- ##### FUNCTION gtk_action_create_menu_item ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_create_tool_item ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_connect_proxy ##### -->
<para>

</para>

@action: 
@proxy: 


<!-- ##### FUNCTION gtk_action_disconnect_proxy ##### -->
<para>

</para>

@action: 
@proxy: 


<!-- ##### FUNCTION gtk_action_get_proxies ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION gtk_action_connect_accelerator ##### -->
<para>

</para>

@action: 


<!-- ##### FUNCTION gtk_action_disconnect_accelerator ##### -->
<para>

</para>

@action: 


<!-- ##### FUNCTION gtk_action_block_activate_from ##### -->
<para>

</para>

@action: 
@proxy: 


<!-- ##### FUNCTION gtk_action_unblock_activate_from ##### -->
<para>

</para>

@action: 
@proxy: 


<!-- ##### FUNCTION gtk_action_set_accel_path ##### -->
<para>

</para>

@action: 
@accel_path: 


<!-- ##### FUNCTION gtk_action_set_accel_group ##### -->
<para>

</para>

@action: 
@accel_group: