~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html>
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
5
<title>GIO Reference Manual: GActionGroup</title>
1.65.1 by Iain Lane
Import upstream version 2.37.0
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
7
<link rel="home" href="index.html" title="GIO Reference Manual">
8
<link rel="up" href="application.html" title="Application support">
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
9
<link rel="prev" href="GApplicationCommandLine.html" title="GApplicationCommandLine">
10
<link rel="next" href="GActionMap.html" title="GActionMap">
1.67.3 by Iain Lane
Import upstream version 2.43.3
11
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
12
<link rel="stylesheet" href="style.css" type="text/css">
13
</head>
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
1.66.16 by Iain Lane
Import upstream version 2.41.2
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
16
<td width="100%" align="left" class="shortcuts">
1.66.16 by Iain Lane
Import upstream version 2.41.2
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18
                  <a href="#GActionGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19
                  <a href="#GActionGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
20
                  <a href="#GActionGroup.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_derived_interfaces">  <span class="dim">|</span> 
21
                  <a href="#GActionGroup.derived-interfaces" class="shortcut">Known Derived Interfaces</a></span><span id="nav_implementations">  <span class="dim">|</span> 
22
                  <a href="#GActionGroup.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
23
                  <a href="#GActionGroup.signals" class="shortcut">Signals</a></span>
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
24
</td>
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
26
<td><a accesskey="u" href="application.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
27
<td><a accesskey="p" href="GApplicationCommandLine.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
28
<td><a accesskey="n" href="GActionMap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
29
</tr></table>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
30
<div class="refentry">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
31
<a name="GActionGroup"></a><div class="titlepage"></div>
32
<div class="refnamediv"><table width="100%"><tr>
33
<td valign="top">
34
<h2><span class="refentrytitle"><a name="GActionGroup.top_of_page"></a>GActionGroup</span></h2>
1.59.5 by Emilio Pozuelo Monfort
Import upstream version 2.27.4
35
<p>GActionGroup — A group of actions</p>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
36
</td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
37
<td class="gallery_image" valign="top" align="right"></td>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
38
</tr></table></div>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
39
<div class="refsect1">
40
<a name="GActionGroup.functions"></a><h2>Functions</h2>
41
<div class="informaltable"><table width="100%" border="0">
42
<colgroup>
43
<col width="150px" class="functions_return">
44
<col class="functions_name">
45
</colgroup>
46
<tbody>
47
<tr>
48
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
49
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
50
</td>
51
<td class="function_name">
52
<a class="link" href="GActionGroup.html#g-action-group-list-actions" title="g_action_group_list_actions ()">g_action_group_list_actions</a> <span class="c_punctuation">()</span>
53
</td>
54
</tr>
55
<tr>
56
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
57
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
58
</td>
59
<td class="function_name">
60
<a class="link" href="GActionGroup.html#g-action-group-query-action" title="g_action_group_query_action ()">g_action_group_query_action</a> <span class="c_punctuation">()</span>
61
</td>
62
</tr>
63
<tr>
64
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
65
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
66
</td>
67
<td class="function_name">
68
<a class="link" href="GActionGroup.html#g-action-group-has-action" title="g_action_group_has_action ()">g_action_group_has_action</a> <span class="c_punctuation">()</span>
69
</td>
70
</tr>
71
<tr>
72
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
73
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
74
</td>
75
<td class="function_name">
76
<a class="link" href="GActionGroup.html#g-action-group-get-action-enabled" title="g_action_group_get_action_enabled ()">g_action_group_get_action_enabled</a> <span class="c_punctuation">()</span>
77
</td>
78
</tr>
79
<tr>
1.66.21 by Iain Lane
Import upstream version 2.42.1
80
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
81
</td>
82
<td class="function_name">
83
<a class="link" href="GActionGroup.html#g-action-group-get-action-parameter-type" title="g_action_group_get_action_parameter_type ()">g_action_group_get_action_parameter_type</a> <span class="c_punctuation">()</span>
84
</td>
85
</tr>
86
<tr>
1.66.21 by Iain Lane
Import upstream version 2.42.1
87
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
88
</td>
89
<td class="function_name">
90
<a class="link" href="GActionGroup.html#g-action-group-get-action-state-type" title="g_action_group_get_action_state_type ()">g_action_group_get_action_state_type</a> <span class="c_punctuation">()</span>
91
</td>
92
</tr>
93
<tr>
94
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
95
<a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
96
</td>
97
<td class="function_name">
98
<a class="link" href="GActionGroup.html#g-action-group-get-action-state-hint" title="g_action_group_get_action_state_hint ()">g_action_group_get_action_state_hint</a> <span class="c_punctuation">()</span>
99
</td>
100
</tr>
101
<tr>
102
<td class="function_type">
1.66.21 by Iain Lane
Import upstream version 2.42.1
103
<a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
104
</td>
105
<td class="function_name">
106
<a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()">g_action_group_get_action_state</a> <span class="c_punctuation">()</span>
107
</td>
108
</tr>
109
<tr>
110
<td class="function_type">
111
<span class="returnvalue">void</span>
112
</td>
113
<td class="function_name">
114
<a class="link" href="GActionGroup.html#g-action-group-change-action-state" title="g_action_group_change_action_state ()">g_action_group_change_action_state</a> <span class="c_punctuation">()</span>
115
</td>
116
</tr>
117
<tr>
118
<td class="function_type">
119
<span class="returnvalue">void</span>
120
</td>
121
<td class="function_name">
122
<a class="link" href="GActionGroup.html#g-action-group-activate-action" title="g_action_group_activate_action ()">g_action_group_activate_action</a> <span class="c_punctuation">()</span>
123
</td>
124
</tr>
125
<tr>
126
<td class="function_type">
127
<span class="returnvalue">void</span>
128
</td>
129
<td class="function_name">
130
<a class="link" href="GActionGroup.html#g-action-group-action-added" title="g_action_group_action_added ()">g_action_group_action_added</a> <span class="c_punctuation">()</span>
131
</td>
132
</tr>
133
<tr>
134
<td class="function_type">
135
<span class="returnvalue">void</span>
136
</td>
137
<td class="function_name">
138
<a class="link" href="GActionGroup.html#g-action-group-action-removed" title="g_action_group_action_removed ()">g_action_group_action_removed</a> <span class="c_punctuation">()</span>
139
</td>
140
</tr>
141
<tr>
142
<td class="function_type">
143
<span class="returnvalue">void</span>
144
</td>
145
<td class="function_name">
146
<a class="link" href="GActionGroup.html#g-action-group-action-enabled-changed" title="g_action_group_action_enabled_changed ()">g_action_group_action_enabled_changed</a> <span class="c_punctuation">()</span>
147
</td>
148
</tr>
149
<tr>
150
<td class="function_type">
151
<span class="returnvalue">void</span>
152
</td>
153
<td class="function_name">
154
<a class="link" href="GActionGroup.html#g-action-group-action-state-changed" title="g_action_group_action_state_changed ()">g_action_group_action_state_changed</a> <span class="c_punctuation">()</span>
155
</td>
156
</tr>
157
</tbody>
158
</table></div>
159
</div>
160
<div class="refsect1">
161
<a name="GActionGroup.signals"></a><h2>Signals</h2>
162
<div class="informaltable"><table border="0">
163
<colgroup>
164
<col width="150px" class="signals_return">
165
<col width="300px" class="signals_name">
166
<col width="200px" class="signals_flags">
167
</colgroup>
168
<tbody>
169
<tr>
170
<td class="signal_type"><span class="returnvalue">void</span></td>
171
<td class="signal_name"><a class="link" href="GActionGroup.html#GActionGroup-action-added" title="The “action-added” signal">action-added</a></td>
1.66.14 by Iain Lane
Import upstream version 2.41.0
172
<td class="signal_flags">Has Details</td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
173
</tr>
174
<tr>
175
<td class="signal_type"><span class="returnvalue">void</span></td>
176
<td class="signal_name"><a class="link" href="GActionGroup.html#GActionGroup-action-enabled-changed" title="The “action-enabled-changed” signal">action-enabled-changed</a></td>
1.66.14 by Iain Lane
Import upstream version 2.41.0
177
<td class="signal_flags">Has Details</td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
178
</tr>
179
<tr>
180
<td class="signal_type"><span class="returnvalue">void</span></td>
181
<td class="signal_name"><a class="link" href="GActionGroup.html#GActionGroup-action-removed" title="The “action-removed” signal">action-removed</a></td>
1.66.14 by Iain Lane
Import upstream version 2.41.0
182
<td class="signal_flags">Has Details</td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
183
</tr>
184
<tr>
185
<td class="signal_type"><span class="returnvalue">void</span></td>
186
<td class="signal_name"><a class="link" href="GActionGroup.html#GActionGroup-action-state-changed" title="The “action-state-changed” signal">action-state-changed</a></td>
1.66.14 by Iain Lane
Import upstream version 2.41.0
187
<td class="signal_flags">Has Details</td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
188
</tr>
189
</tbody>
190
</table></div>
191
</div>
192
<div class="refsect1">
193
<a name="GActionGroup.other"></a><h2>Types and Values</h2>
194
<div class="informaltable"><table width="100%" border="0">
195
<colgroup>
196
<col width="150px" class="name">
197
<col class="description">
198
</colgroup>
199
<tbody>
200
<tr>
201
<td class="datatype_keyword"> </td>
202
<td class="function_name"><a class="link" href="GActionGroup.html#GActionGroup-struct" title="GActionGroup">GActionGroup</a></td>
203
</tr>
204
<tr>
205
<td class="datatype_keyword">struct</td>
206
<td class="function_name"><a class="link" href="GActionGroup.html#GActionGroupInterface" title="struct GActionGroupInterface">GActionGroupInterface</a></td>
207
</tr>
208
</tbody>
209
</table></div>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
210
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
211
<div class="refsect1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
212
<a name="GActionGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
1.67.3 by Iain Lane
Import upstream version 2.43.3
213
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
214
    <span class="lineart">╰──</span> GActionGroup
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
215
</pre>
216
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
217
<div class="refsect1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
218
<a name="GActionGroup.prerequisites"></a><h2>Prerequisites</h2>
219
<p>
220
GActionGroup requires
1.66.21 by Iain Lane
Import upstream version 2.42.1
221
 <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
222
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
223
<div class="refsect1">
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
224
<a name="GActionGroup.derived-interfaces"></a><h2>Known Derived Interfaces</h2>
225
<p>
226
GActionGroup is required by
1.65.1 by Iain Lane
Import upstream version 2.37.0
227
 <a class="link" href="GRemoteActionGroup.html" title="GRemoteActionGroup">GRemoteActionGroup</a>.</p>
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
228
</div>
229
<div class="refsect1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
230
<a name="GActionGroup.implementations"></a><h2>Known Implementations</h2>
231
<p>
232
GActionGroup is implemented by
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
233
 <a class="link" href="GApplication.html" title="GApplication">GApplication</a>,  <a class="link" href="GDBusActionGroup.html" title="GDBusActionGroup">GDBusActionGroup</a> and  <a class="link" href="GSimpleActionGroup.html" title="GSimpleActionGroup">GSimpleActionGroup</a>.</p>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
234
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
235
<div class="refsect1">
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
236
<a name="GActionGroup.includes"></a><h2>Includes</h2>
237
<pre class="synopsis">#include &lt;gio/gio.h&gt;
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
238
</pre>
239
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
240
<div class="refsect1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
241
<a name="GActionGroup.description"></a><h2>Description</h2>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
242
<p><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> represents a group of actions. Actions can be used to
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
243
expose functionality in a structured way, either from one part of a
244
program to another, or to the outside world. Action groups are often
245
used together with a <a class="link" href="GMenuModel.html" title="GMenuModel"><span class="type">GMenuModel</span></a> that provides additional
246
representation data for displaying the actions to the user, e.g. in
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
247
a menu.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
248
<p>The main way to interact with the actions in a GActionGroup is to
249
activate them with <a class="link" href="GActionGroup.html#g-action-group-activate-action" title="g_action_group_activate_action ()"><code class="function">g_action_group_activate_action()</code></a>. Activating an
1.66.21 by Iain Lane
Import upstream version 2.42.1
250
action may require a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> parameter. The required type of the
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
251
parameter can be inquired with <a class="link" href="GActionGroup.html#g-action-group-get-action-parameter-type" title="g_action_group_get_action_parameter_type ()"><code class="function">g_action_group_get_action_parameter_type()</code></a>.
252
Actions may be disabled, see <a class="link" href="GActionGroup.html#g-action-group-get-action-enabled" title="g_action_group_get_action_enabled ()"><code class="function">g_action_group_get_action_enabled()</code></a>.
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
253
Activating a disabled action has no effect.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
254
<p>Actions may optionally have a state in the form of a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. The
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
255
current state of an action can be inquired with
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
256
<a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()"><code class="function">g_action_group_get_action_state()</code></a>. Activating a stateful action may
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
257
change its state, but it is also possible to set the state by calling
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
258
<a class="link" href="GActionGroup.html#g-action-group-change-action-state" title="g_action_group_change_action_state ()"><code class="function">g_action_group_change_action_state()</code></a>.</p>
259
<p>As typical example, consider a text editing application which has an
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
260
option to change the current font to 'bold'. A good way to represent
261
this would be a stateful action, with a boolean state. Activating the
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
262
action would toggle the state.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
263
<p>Each action in the group has a unique name (which is a string).  All
264
method calls, except <a class="link" href="GActionGroup.html#g-action-group-list-actions" title="g_action_group_list_actions ()"><code class="function">g_action_group_list_actions()</code></a> take the name of
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
265
an action as an argument.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
266
<p>The <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> API is meant to be the 'public' API to the action
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
267
group.  The calls here are exactly the interaction that 'external
268
forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have
269
with actions.  'Internal' APIs (ie: ones meant only to be accessed by
270
the action group implementation) are found on subclasses.  This is
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
271
why you will find - for example - <a class="link" href="GActionGroup.html#g-action-group-get-action-enabled" title="g_action_group_get_action_enabled ()"><code class="function">g_action_group_get_action_enabled()</code></a>
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
272
but not an equivalent <code class="function">set()</code> call.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
273
<p>Signals are emitted on the action group in response to state changes
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
274
on individual actions.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
275
<p>Implementations of <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> should provide implementations for
276
the virtual functions <a class="link" href="GActionGroup.html#g-action-group-list-actions" title="g_action_group_list_actions ()"><code class="function">g_action_group_list_actions()</code></a> and
277
<a class="link" href="GActionGroup.html#g-action-group-query-action" title="g_action_group_query_action ()"><code class="function">g_action_group_query_action()</code></a>.  The other virtual functions should
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
278
not be implemented - their "wrappers" are actually implemented with
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
279
calls to <a class="link" href="GActionGroup.html#g-action-group-query-action" title="g_action_group_query_action ()"><code class="function">g_action_group_query_action()</code></a>.</p>
280
</div>
281
<div class="refsect1">
282
<a name="GActionGroup.functions_details"></a><h2>Functions</h2>
283
<div class="refsect2">
284
<a name="g-action-group-list-actions"></a><h3>g_action_group_list_actions ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
285
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
286
g_action_group_list_actions (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>);</pre>
287
<p>Lists the actions contained within <em class="parameter"><code>action_group</code></em>
288
.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
289
<p>The caller is responsible for freeing the list with <a href="https://developer.gnome.org/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
290
it is no longer required.</p>
291
<div class="refsect3">
292
<a name="id-1.4.22.4.12.2.6"></a><h4>Parameters</h4>
293
<div class="informaltable"><table width="100%" border="0">
294
<colgroup>
295
<col width="150px" class="parameters_name">
296
<col class="parameters_description">
297
<col width="200px" class="parameters_annotations">
298
</colgroup>
299
<tbody><tr>
300
<td class="parameter_name"><p>action_group</p></td>
301
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
302
<td class="parameter_annotations"> </td>
303
</tr></tbody>
304
</table></div>
305
</div>
306
<div class="refsect3">
307
<a name="id-1.4.22.4.12.2.7"></a><h4>Returns</h4>
1.66.21 by Iain Lane
Import upstream version 2.42.1
308
<p> a <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of the names of the
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
309
actions in the groupb. </p>
310
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
311
</div>
312
<p class="since">Since 2.28</p>
313
</div>
314
<hr>
315
<div class="refsect2">
316
<a name="g-action-group-query-action"></a><h3>g_action_group_query_action ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
317
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
318
g_action_group_query_action (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
319
                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>,
320
                             <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *enabled</code></em>,
321
                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> **parameter_type</code></em>,
322
                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> **state_type</code></em>,
323
                             <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> **state_hint</code></em>,
324
                             <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> **state</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
325
<p>Queries all aspects of the named action within an <em class="parameter"><code>action_group</code></em>
326
.</p>
327
<p>This function acquires the information available from
328
<a class="link" href="GActionGroup.html#g-action-group-has-action" title="g_action_group_has_action ()"><code class="function">g_action_group_has_action()</code></a>, <a class="link" href="GActionGroup.html#g-action-group-get-action-enabled" title="g_action_group_get_action_enabled ()"><code class="function">g_action_group_get_action_enabled()</code></a>,
329
<a class="link" href="GActionGroup.html#g-action-group-get-action-parameter-type" title="g_action_group_get_action_parameter_type ()"><code class="function">g_action_group_get_action_parameter_type()</code></a>,
330
<a class="link" href="GActionGroup.html#g-action-group-get-action-state-type" title="g_action_group_get_action_state_type ()"><code class="function">g_action_group_get_action_state_type()</code></a>,
331
<a class="link" href="GActionGroup.html#g-action-group-get-action-state-hint" title="g_action_group_get_action_state_hint ()"><code class="function">g_action_group_get_action_state_hint()</code></a> and
332
<a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()"><code class="function">g_action_group_get_action_state()</code></a> with a single function call.</p>
333
<p>This provides two main benefits.</p>
334
<p>The first is the improvement in efficiency that comes with not having
335
to perform repeated lookups of the action in order to discover
336
different things about it.  The second is that implementing
337
<a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> can now be done by only overriding this one virtual
338
function.</p>
339
<p>The interface provides a default implementation of this function that
340
calls the individual functions, as required, to fetch the
341
information.  The interface also provides default implementations of
342
those functions that call this function.  All implementations,
343
therefore, must override either this function or all of the others.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
344
<p>If the action exists, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned and any of the requested
345
fields (as indicated by having a non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> reference passed in) are
346
filled.  If the action doesn't exist, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and the
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
347
fields may or may not have been modified.</p>
348
<div class="refsect3">
349
<a name="id-1.4.22.4.12.3.10"></a><h4>Parameters</h4>
350
<div class="informaltable"><table width="100%" border="0">
351
<colgroup>
352
<col width="150px" class="parameters_name">
353
<col class="parameters_description">
354
<col width="200px" class="parameters_annotations">
355
</colgroup>
356
<tbody>
357
<tr>
358
<td class="parameter_name"><p>action_group</p></td>
359
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
360
<td class="parameter_annotations"> </td>
361
</tr>
362
<tr>
363
<td class="parameter_name"><p>action_name</p></td>
364
<td class="parameter_description"><p>the name of an action in the group</p></td>
365
<td class="parameter_annotations"> </td>
366
</tr>
367
<tr>
368
<td class="parameter_name"><p>enabled</p></td>
369
<td class="parameter_description"><p> if the action is presently enabled. </p></td>
370
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
371
</tr>
372
<tr>
373
<td class="parameter_name"><p>parameter_type</p></td>
1.66.21 by Iain Lane
Import upstream version 2.42.1
374
<td class="parameter_description"><p> the parameter type, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none needed. </p></td>
1.66.17 by Iain Lane
Import upstream version 2.41.3
375
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
376
</tr>
377
<tr>
378
<td class="parameter_name"><p>state_type</p></td>
1.66.21 by Iain Lane
Import upstream version 2.42.1
379
<td class="parameter_description"><p> the state type, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if stateless. </p></td>
1.66.17 by Iain Lane
Import upstream version 2.41.3
380
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
381
</tr>
382
<tr>
383
<td class="parameter_name"><p>state_hint</p></td>
1.66.21 by Iain Lane
Import upstream version 2.42.1
384
<td class="parameter_description"><p> the state hint, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none. </p></td>
1.66.17 by Iain Lane
Import upstream version 2.41.3
385
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
386
</tr>
387
<tr>
388
<td class="parameter_name"><p>state</p></td>
1.66.21 by Iain Lane
Import upstream version 2.42.1
389
<td class="parameter_description"><p> the current state, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if stateless. </p></td>
1.66.17 by Iain Lane
Import upstream version 2.41.3
390
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
391
</tr>
392
</tbody>
393
</table></div>
394
</div>
395
<div class="refsect3">
396
<a name="id-1.4.22.4.12.3.11"></a><h4>Returns</h4>
1.66.21 by Iain Lane
Import upstream version 2.42.1
397
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the action exists, else <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a></p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
398
<p></p>
399
</div>
400
<p class="since">Since 2.32</p>
401
</div>
402
<hr>
403
<div class="refsect2">
404
<a name="g-action-group-has-action"></a><h3>g_action_group_has_action ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
405
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
406
g_action_group_has_action (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
407
                           <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
408
<p>Checks if the named action exists within <em class="parameter"><code>action_group</code></em>
409
.</p>
410
<div class="refsect3">
411
<a name="id-1.4.22.4.12.4.5"></a><h4>Parameters</h4>
412
<div class="informaltable"><table width="100%" border="0">
413
<colgroup>
414
<col width="150px" class="parameters_name">
415
<col class="parameters_description">
416
<col width="200px" class="parameters_annotations">
417
</colgroup>
418
<tbody>
419
<tr>
420
<td class="parameter_name"><p>action_group</p></td>
421
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
422
<td class="parameter_annotations"> </td>
423
</tr>
424
<tr>
425
<td class="parameter_name"><p>action_name</p></td>
426
<td class="parameter_description"><p>the name of the action to check for</p></td>
427
<td class="parameter_annotations"> </td>
428
</tr>
429
</tbody>
430
</table></div>
431
</div>
432
<div class="refsect3">
433
<a name="id-1.4.22.4.12.4.6"></a><h4>Returns</h4>
434
<p> whether the named action exists</p>
435
<p></p>
436
</div>
437
<p class="since">Since 2.28</p>
438
</div>
439
<hr>
440
<div class="refsect2">
441
<a name="g-action-group-get-action-enabled"></a><h3>g_action_group_get_action_enabled ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
442
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
443
g_action_group_get_action_enabled (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
444
                                   <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
445
<p>Checks if the named action within <em class="parameter"><code>action_group</code></em>
446
 is currently enabled.</p>
447
<p>An action must be enabled in order to be activated or in order to
448
have its state changed from outside callers.</p>
449
<div class="refsect3">
450
<a name="id-1.4.22.4.12.5.6"></a><h4>Parameters</h4>
451
<div class="informaltable"><table width="100%" border="0">
452
<colgroup>
453
<col width="150px" class="parameters_name">
454
<col class="parameters_description">
455
<col width="200px" class="parameters_annotations">
456
</colgroup>
457
<tbody>
458
<tr>
459
<td class="parameter_name"><p>action_group</p></td>
460
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
461
<td class="parameter_annotations"> </td>
462
</tr>
463
<tr>
464
<td class="parameter_name"><p>action_name</p></td>
465
<td class="parameter_description"><p>the name of the action to query</p></td>
466
<td class="parameter_annotations"> </td>
467
</tr>
468
</tbody>
469
</table></div>
470
</div>
471
<div class="refsect3">
472
<a name="id-1.4.22.4.12.5.7"></a><h4>Returns</h4>
473
<p> whether or not the action is currently enabled</p>
474
<p></p>
475
</div>
476
<p class="since">Since 2.28</p>
477
</div>
478
<hr>
479
<div class="refsect2">
480
<a name="g-action-group-get-action-parameter-type"></a><h3>g_action_group_get_action_parameter_type ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
481
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
482
g_action_group_get_action_parameter_type
483
                               (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
484
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
485
<p>Queries the type of the parameter that must be given when activating
486
the named action within <em class="parameter"><code>action_group</code></em>
487
.</p>
488
<p>When activating the action using <a class="link" href="GActionGroup.html#g-action-group-activate-action" title="g_action_group_activate_action ()"><code class="function">g_action_group_activate_action()</code></a>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
489
the <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> given to that function must be of the type returned
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
490
by this function.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
491
<p>In the case that this function returns <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, you must not give any
492
<a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>, but <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> instead.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
493
<p>The parameter type of a particular action will never change but it is
494
possible for an action to be removed and for a new action to be added
495
with the same name but a different parameter type.</p>
496
<div class="refsect3">
497
<a name="id-1.4.22.4.12.6.8"></a><h4>Parameters</h4>
498
<div class="informaltable"><table width="100%" border="0">
499
<colgroup>
500
<col width="150px" class="parameters_name">
501
<col class="parameters_description">
502
<col width="200px" class="parameters_annotations">
503
</colgroup>
504
<tbody>
505
<tr>
506
<td class="parameter_name"><p>action_group</p></td>
507
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
508
<td class="parameter_annotations"> </td>
509
</tr>
510
<tr>
511
<td class="parameter_name"><p>action_name</p></td>
512
<td class="parameter_description"><p>the name of the action to query</p></td>
513
<td class="parameter_annotations"> </td>
514
</tr>
515
</tbody>
516
</table></div>
517
</div>
518
<div class="refsect3">
519
<a name="id-1.4.22.4.12.6.9"></a><h4>Returns</h4>
1.66.14 by Iain Lane
Import upstream version 2.41.0
520
<p> the parameter type. </p>
1.66.17 by Iain Lane
Import upstream version 2.41.3
521
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
522
</div>
523
<p class="since">Since 2.28</p>
524
</div>
525
<hr>
526
<div class="refsect2">
527
<a name="g-action-group-get-action-state-type"></a><h3>g_action_group_get_action_state_type ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
528
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="returnvalue">GVariantType</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
529
g_action_group_get_action_state_type (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
530
                                      <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
531
<p>Queries the type of the state of the named action within
532
<em class="parameter"><code>action_group</code></em>
533
.</p>
534
<p>If the action is stateful then this function returns the
1.66.21 by Iain Lane
Import upstream version 2.42.1
535
<a href="https://developer.gnome.org/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> of the state.  All calls to
536
<a class="link" href="GActionGroup.html#g-action-group-change-action-state" title="g_action_group_change_action_state ()"><code class="function">g_action_group_change_action_state()</code></a> must give a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of this
537
type and <a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()"><code class="function">g_action_group_get_action_state()</code></a> will return a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
538
of the same type.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
539
<p>If the action is not stateful then this function will return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
540
In that case, <a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()"><code class="function">g_action_group_get_action_state()</code></a> will return <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
541
and you must not call <a class="link" href="GActionGroup.html#g-action-group-change-action-state" title="g_action_group_change_action_state ()"><code class="function">g_action_group_change_action_state()</code></a>.</p>
542
<p>The state type of a particular action will never change but it is
543
possible for an action to be removed and for a new action to be added
544
with the same name but a different state type.</p>
545
<div class="refsect3">
546
<a name="id-1.4.22.4.12.7.8"></a><h4>Parameters</h4>
547
<div class="informaltable"><table width="100%" border="0">
548
<colgroup>
549
<col width="150px" class="parameters_name">
550
<col class="parameters_description">
551
<col width="200px" class="parameters_annotations">
552
</colgroup>
553
<tbody>
554
<tr>
555
<td class="parameter_name"><p>action_group</p></td>
556
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
557
<td class="parameter_annotations"> </td>
558
</tr>
559
<tr>
560
<td class="parameter_name"><p>action_name</p></td>
561
<td class="parameter_description"><p>the name of the action to query</p></td>
562
<td class="parameter_annotations"> </td>
563
</tr>
564
</tbody>
565
</table></div>
566
</div>
567
<div class="refsect3">
568
<a name="id-1.4.22.4.12.7.9"></a><h4>Returns</h4>
1.66.14 by Iain Lane
Import upstream version 2.41.0
569
<p> the state type, if the action
570
is stateful. </p>
1.66.17 by Iain Lane
Import upstream version 2.41.3
571
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
572
</div>
573
<p class="since">Since 2.28</p>
574
</div>
575
<hr>
576
<div class="refsect2">
577
<a name="g-action-group-get-action-state-hint"></a><h3>g_action_group_get_action_state_hint ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
578
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
579
g_action_group_get_action_state_hint (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
580
                                      <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
581
<p>Requests a hint about the valid range of values for the state of the
582
named action within <em class="parameter"><code>action_group</code></em>
583
.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
584
<p>If <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned it either means that the action is not stateful
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
585
or that there is no hint about the valid range of values for the
586
state of the action.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
587
<p>If a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> array is returned then each item in the array is a
588
possible value for the state.  If a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> pair (ie: two-tuple) is
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
589
returned then the tuple specifies the inclusive lower and upper bound
590
of valid values for the state.</p>
591
<p>In any case, the information is merely a hint.  It may be possible to
592
have a state value outside of the hinted range and setting a value
593
within the range may fail.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
594
<p>The return value (if non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) should be freed with
595
<a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> when it is no longer required.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
596
<div class="refsect3">
597
<a name="id-1.4.22.4.12.8.9"></a><h4>Parameters</h4>
598
<div class="informaltable"><table width="100%" border="0">
599
<colgroup>
600
<col width="150px" class="parameters_name">
601
<col class="parameters_description">
602
<col width="200px" class="parameters_annotations">
603
</colgroup>
604
<tbody>
605
<tr>
606
<td class="parameter_name"><p>action_group</p></td>
607
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
608
<td class="parameter_annotations"> </td>
609
</tr>
610
<tr>
611
<td class="parameter_name"><p>action_name</p></td>
612
<td class="parameter_description"><p>the name of the action to query</p></td>
613
<td class="parameter_annotations"> </td>
614
</tr>
615
</tbody>
616
</table></div>
617
</div>
618
<div class="refsect3">
619
<a name="id-1.4.22.4.12.8.10"></a><h4>Returns</h4>
620
<p> the state range hint. </p>
1.66.17 by Iain Lane
Import upstream version 2.41.3
621
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
622
</div>
623
<p class="since">Since 2.28</p>
624
</div>
625
<hr>
626
<div class="refsect2">
627
<a name="g-action-group-get-action-state"></a><h3>g_action_group_get_action_state ()</h3>
1.66.21 by Iain Lane
Import upstream version 2.42.1
628
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
629
g_action_group_get_action_state (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
630
                                 <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
631
<p>Queries the current state of the named action within <em class="parameter"><code>action_group</code></em>
632
.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
633
<p>If the action is not stateful then <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.  If the
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
634
action is stateful then the type of the return value is the type
635
given by <a class="link" href="GActionGroup.html#g-action-group-get-action-state-type" title="g_action_group_get_action_state_type ()"><code class="function">g_action_group_get_action_state_type()</code></a>.</p>
1.66.21 by Iain Lane
Import upstream version 2.42.1
636
<p>The return value (if non-<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) should be freed with
637
<a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> when it is no longer required.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
638
<div class="refsect3">
639
<a name="id-1.4.22.4.12.9.7"></a><h4>Parameters</h4>
640
<div class="informaltable"><table width="100%" border="0">
641
<colgroup>
642
<col width="150px" class="parameters_name">
643
<col class="parameters_description">
644
<col width="200px" class="parameters_annotations">
645
</colgroup>
646
<tbody>
647
<tr>
648
<td class="parameter_name"><p>action_group</p></td>
649
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
650
<td class="parameter_annotations"> </td>
651
</tr>
652
<tr>
653
<td class="parameter_name"><p>action_name</p></td>
654
<td class="parameter_description"><p>the name of the action to query</p></td>
655
<td class="parameter_annotations"> </td>
656
</tr>
657
</tbody>
658
</table></div>
659
</div>
660
<div class="refsect3">
661
<a name="id-1.4.22.4.12.9.8"></a><h4>Returns</h4>
662
<p> the current state of the action. </p>
1.66.17 by Iain Lane
Import upstream version 2.41.3
663
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
664
</div>
665
<p class="since">Since 2.28</p>
666
</div>
667
<hr>
668
<div class="refsect2">
669
<a name="g-action-group-change-action-state"></a><h3>g_action_group_change_action_state ()</h3>
670
<pre class="programlisting"><span class="returnvalue">void</span>
671
g_action_group_change_action_state (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
672
                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>,
673
                                    <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
674
<p>Request for the state of the named action within <em class="parameter"><code>action_group</code></em>
675
 to be
676
changed to <em class="parameter"><code>value</code></em>
677
.</p>
678
<p>The action must be stateful and <em class="parameter"><code>value</code></em>
679
 must be of the correct type.
680
See <a class="link" href="GActionGroup.html#g-action-group-get-action-state-type" title="g_action_group_get_action_state_type ()"><code class="function">g_action_group_get_action_state_type()</code></a>.</p>
681
<p>This call merely requests a change.  The action may refuse to change
682
its state or may change its state to something other than <em class="parameter"><code>value</code></em>
683
.
684
See <a class="link" href="GActionGroup.html#g-action-group-get-action-state-hint" title="g_action_group_get_action_state_hint ()"><code class="function">g_action_group_get_action_state_hint()</code></a>.</p>
685
<p>If the <em class="parameter"><code>value</code></em>
686
 GVariant is floating, it is consumed.</p>
687
<div class="refsect3">
688
<a name="id-1.4.22.4.12.10.8"></a><h4>Parameters</h4>
689
<div class="informaltable"><table width="100%" border="0">
690
<colgroup>
691
<col width="150px" class="parameters_name">
692
<col class="parameters_description">
693
<col width="200px" class="parameters_annotations">
694
</colgroup>
695
<tbody>
696
<tr>
697
<td class="parameter_name"><p>action_group</p></td>
698
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
699
<td class="parameter_annotations"> </td>
700
</tr>
701
<tr>
702
<td class="parameter_name"><p>action_name</p></td>
703
<td class="parameter_description"><p>the name of the action to request the change on</p></td>
704
<td class="parameter_annotations"> </td>
705
</tr>
706
<tr>
707
<td class="parameter_name"><p>value</p></td>
708
<td class="parameter_description"><p>the new state</p></td>
709
<td class="parameter_annotations"> </td>
710
</tr>
711
</tbody>
712
</table></div>
713
</div>
714
<p class="since">Since 2.28</p>
715
</div>
716
<hr>
717
<div class="refsect2">
718
<a name="g-action-group-activate-action"></a><h3>g_action_group_activate_action ()</h3>
719
<pre class="programlisting"><span class="returnvalue">void</span>
720
g_action_group_activate_action (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
721
                                <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>,
722
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *parameter</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
723
<p>Activate the named action within <em class="parameter"><code>action_group</code></em>
724
.</p>
725
<p>If the action is expecting a parameter, then the correct type of
726
parameter must be given as <em class="parameter"><code>parameter</code></em>
727
.  If the action is expecting no
728
parameters then <em class="parameter"><code>parameter</code></em>
1.66.21 by Iain Lane
Import upstream version 2.42.1
729
 must be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  See
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
730
<a class="link" href="GActionGroup.html#g-action-group-get-action-parameter-type" title="g_action_group_get_action_parameter_type ()"><code class="function">g_action_group_get_action_parameter_type()</code></a>.</p>
731
<div class="refsect3">
732
<a name="id-1.4.22.4.12.11.6"></a><h4>Parameters</h4>
733
<div class="informaltable"><table width="100%" border="0">
734
<colgroup>
735
<col width="150px" class="parameters_name">
736
<col class="parameters_description">
737
<col width="200px" class="parameters_annotations">
738
</colgroup>
739
<tbody>
740
<tr>
741
<td class="parameter_name"><p>action_group</p></td>
742
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
743
<td class="parameter_annotations"> </td>
744
</tr>
745
<tr>
746
<td class="parameter_name"><p>action_name</p></td>
747
<td class="parameter_description"><p>the name of the action to activate</p></td>
748
<td class="parameter_annotations"> </td>
749
</tr>
750
<tr>
751
<td class="parameter_name"><p>parameter</p></td>
752
<td class="parameter_description"><p> parameters to the activation. </p></td>
1.66.17 by Iain Lane
Import upstream version 2.41.3
753
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
754
</tr>
755
</tbody>
756
</table></div>
757
</div>
758
<p class="since">Since 2.28</p>
759
</div>
760
<hr>
761
<div class="refsect2">
762
<a name="g-action-group-action-added"></a><h3>g_action_group_action_added ()</h3>
763
<pre class="programlisting"><span class="returnvalue">void</span>
764
g_action_group_action_added (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
765
                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
766
<p>Emits the <a class="link" href="GActionGroup.html#GActionGroup-action-added" title="The “action-added” signal"><span class="type">“action-added”</span></a> signal on <em class="parameter"><code>action_group</code></em>
767
.</p>
768
<p>This function should only be called by <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> implementations.</p>
769
<div class="refsect3">
770
<a name="id-1.4.22.4.12.12.6"></a><h4>Parameters</h4>
771
<div class="informaltable"><table width="100%" border="0">
772
<colgroup>
773
<col width="150px" class="parameters_name">
774
<col class="parameters_description">
775
<col width="200px" class="parameters_annotations">
776
</colgroup>
777
<tbody>
778
<tr>
779
<td class="parameter_name"><p>action_group</p></td>
780
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
781
<td class="parameter_annotations"> </td>
782
</tr>
783
<tr>
784
<td class="parameter_name"><p>action_name</p></td>
785
<td class="parameter_description"><p>the name of an action in the group</p></td>
786
<td class="parameter_annotations"> </td>
787
</tr>
788
</tbody>
789
</table></div>
790
</div>
791
<p class="since">Since 2.28</p>
792
</div>
793
<hr>
794
<div class="refsect2">
795
<a name="g-action-group-action-removed"></a><h3>g_action_group_action_removed ()</h3>
796
<pre class="programlisting"><span class="returnvalue">void</span>
797
g_action_group_action_removed (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
798
                               <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
799
<p>Emits the <a class="link" href="GActionGroup.html#GActionGroup-action-removed" title="The “action-removed” signal"><span class="type">“action-removed”</span></a> signal on <em class="parameter"><code>action_group</code></em>
800
.</p>
801
<p>This function should only be called by <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> implementations.</p>
802
<div class="refsect3">
803
<a name="id-1.4.22.4.12.13.6"></a><h4>Parameters</h4>
804
<div class="informaltable"><table width="100%" border="0">
805
<colgroup>
806
<col width="150px" class="parameters_name">
807
<col class="parameters_description">
808
<col width="200px" class="parameters_annotations">
809
</colgroup>
810
<tbody>
811
<tr>
812
<td class="parameter_name"><p>action_group</p></td>
813
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
814
<td class="parameter_annotations"> </td>
815
</tr>
816
<tr>
817
<td class="parameter_name"><p>action_name</p></td>
818
<td class="parameter_description"><p>the name of an action in the group</p></td>
819
<td class="parameter_annotations"> </td>
820
</tr>
821
</tbody>
822
</table></div>
823
</div>
824
<p class="since">Since 2.28</p>
825
</div>
826
<hr>
827
<div class="refsect2">
828
<a name="g-action-group-action-enabled-changed"></a><h3>g_action_group_action_enabled_changed ()</h3>
829
<pre class="programlisting"><span class="returnvalue">void</span>
830
g_action_group_action_enabled_changed (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
831
                                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>,
832
                                       <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
833
<p>Emits the <a class="link" href="GActionGroup.html#GActionGroup-action-enabled-changed" title="The “action-enabled-changed” signal"><span class="type">“action-enabled-changed”</span></a> signal on <em class="parameter"><code>action_group</code></em>
834
.</p>
835
<p>This function should only be called by <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> implementations.</p>
836
<div class="refsect3">
837
<a name="id-1.4.22.4.12.14.6"></a><h4>Parameters</h4>
838
<div class="informaltable"><table width="100%" border="0">
839
<colgroup>
840
<col width="150px" class="parameters_name">
841
<col class="parameters_description">
842
<col width="200px" class="parameters_annotations">
843
</colgroup>
844
<tbody>
845
<tr>
846
<td class="parameter_name"><p>action_group</p></td>
847
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
848
<td class="parameter_annotations"> </td>
849
</tr>
850
<tr>
851
<td class="parameter_name"><p>action_name</p></td>
852
<td class="parameter_description"><p>the name of an action in the group</p></td>
853
<td class="parameter_annotations"> </td>
854
</tr>
855
<tr>
856
<td class="parameter_name"><p>enabled</p></td>
857
<td class="parameter_description"><p>whether or not the action is now enabled</p></td>
858
<td class="parameter_annotations"> </td>
859
</tr>
860
</tbody>
861
</table></div>
862
</div>
863
<p class="since">Since 2.28</p>
864
</div>
865
<hr>
866
<div class="refsect2">
867
<a name="g-action-group-action-state-changed"></a><h3>g_action_group_action_state_changed ()</h3>
868
<pre class="programlisting"><span class="returnvalue">void</span>
869
g_action_group_action_state_changed (<em class="parameter"><code><a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group</code></em>,
1.66.21 by Iain Lane
Import upstream version 2.42.1
870
                                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action_name</code></em>,
871
                                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *state</code></em>);</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
872
<p>Emits the <a class="link" href="GActionGroup.html#GActionGroup-action-state-changed" title="The “action-state-changed” signal"><span class="type">“action-state-changed”</span></a> signal on <em class="parameter"><code>action_group</code></em>
873
.</p>
874
<p>This function should only be called by <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> implementations.</p>
875
<div class="refsect3">
876
<a name="id-1.4.22.4.12.15.6"></a><h4>Parameters</h4>
877
<div class="informaltable"><table width="100%" border="0">
878
<colgroup>
879
<col width="150px" class="parameters_name">
880
<col class="parameters_description">
881
<col width="200px" class="parameters_annotations">
882
</colgroup>
883
<tbody>
884
<tr>
885
<td class="parameter_name"><p>action_group</p></td>
886
<td class="parameter_description"><p>a <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a></p></td>
887
<td class="parameter_annotations"> </td>
888
</tr>
889
<tr>
890
<td class="parameter_name"><p>action_name</p></td>
891
<td class="parameter_description"><p>the name of an action in the group</p></td>
892
<td class="parameter_annotations"> </td>
893
</tr>
894
<tr>
895
<td class="parameter_name"><p>state</p></td>
896
<td class="parameter_description"><p>the new state of the named action</p></td>
897
<td class="parameter_annotations"> </td>
898
</tr>
899
</tbody>
900
</table></div>
901
</div>
902
<p class="since">Since 2.28</p>
903
</div>
904
</div>
905
<div class="refsect1">
906
<a name="GActionGroup.other_details"></a><h2>Types and Values</h2>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
907
<div class="refsect2">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
908
<a name="GActionGroup-struct"></a><h3>GActionGroup</h3>
909
<pre class="programlisting">typedef struct _GActionGroup GActionGroup;</pre>
910
</div>
911
<hr>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
912
<div class="refsect2">
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
913
<a name="GActionGroupInterface"></a><h3>struct GActionGroupInterface</h3>
914
<pre class="programlisting">struct GActionGroupInterface {
915
  GTypeInterface g_iface;
916
917
  /* virtual functions */
918
  gboolean              (* has_action)                 (GActionGroup  *action_group,
919
                                                        const gchar   *action_name);
920
921
  gchar **              (* list_actions)               (GActionGroup  *action_group);
922
923
  gboolean              (* get_action_enabled)         (GActionGroup  *action_group,
924
                                                        const gchar   *action_name);
925
926
  const GVariantType *  (* get_action_parameter_type)  (GActionGroup  *action_group,
927
                                                        const gchar   *action_name);
928
929
  const GVariantType *  (* get_action_state_type)      (GActionGroup  *action_group,
930
                                                        const gchar   *action_name);
931
932
  GVariant *            (* get_action_state_hint)      (GActionGroup  *action_group,
933
                                                        const gchar   *action_name);
934
935
  GVariant *            (* get_action_state)           (GActionGroup  *action_group,
936
                                                        const gchar   *action_name);
937
938
  void                  (* change_action_state)        (GActionGroup  *action_group,
939
                                                        const gchar   *action_name,
940
                                                        GVariant      *value);
941
942
  void                  (* activate_action)            (GActionGroup  *action_group,
943
                                                        const gchar   *action_name,
944
                                                        GVariant      *parameter);
945
946
  /* signals */
947
  void                  (* action_added)               (GActionGroup  *action_group,
948
                                                        const gchar   *action_name);
949
  void                  (* action_removed)             (GActionGroup  *action_group,
950
                                                        const gchar   *action_name);
951
  void                  (* action_enabled_changed)     (GActionGroup  *action_group,
952
                                                        const gchar   *action_name,
953
                                                        gboolean       enabled);
954
  void                  (* action_state_changed)       (GActionGroup   *action_group,
955
                                                        const gchar    *action_name,
956
                                                        GVariant       *state);
957
958
  /* more virtual functions */
959
  gboolean              (* query_action)               (GActionGroup        *action_group,
960
                                                        const gchar         *action_name,
961
                                                        gboolean            *enabled,
962
                                                        const GVariantType **parameter_type,
963
                                                        const GVariantType **state_type,
964
                                                        GVariant           **state_hint,
965
                                                        GVariant           **state);
966
};
967
</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
968
<p>The virtual function table for <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a>.</p>
969
<div class="refsect3">
970
<a name="id-1.4.22.4.13.3.5"></a><h4>Members</h4>
971
<div class="informaltable"><table width="100%" border="0">
972
<colgroup>
973
<col width="300px" class="struct_members_name">
974
<col class="struct_members_description">
975
<col width="200px" class="struct_members_annotations">
976
</colgroup>
977
<tbody>
978
<tr>
1.66.21 by Iain Lane
Import upstream version 2.42.1
979
<td class="struct_member_name"><p><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GActionGroupInterface.g-iface"></a>g_iface</code></em>;</p></td>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
980
<td> </td>
981
<td> </td>
982
</tr>
983
<tr>
984
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.has-action"></a>has_action</code></em> ()</p></td>
985
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-has-action" title="g_action_group_has_action ()"><code class="function">g_action_group_has_action()</code></a></p></td>
986
<td class="struct_member_annotations"> </td>
987
</tr>
988
<tr>
989
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.list-actions"></a>list_actions</code></em> ()</p></td>
990
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-list-actions" title="g_action_group_list_actions ()"><code class="function">g_action_group_list_actions()</code></a></p></td>
991
<td class="struct_member_annotations"> </td>
992
</tr>
993
<tr>
994
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.get-action-enabled"></a>get_action_enabled</code></em> ()</p></td>
995
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-get-action-enabled" title="g_action_group_get_action_enabled ()"><code class="function">g_action_group_get_action_enabled()</code></a></p></td>
996
<td class="struct_member_annotations"> </td>
997
</tr>
998
<tr>
999
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.get-action-parameter-type"></a>get_action_parameter_type</code></em> ()</p></td>
1000
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-get-action-parameter-type" title="g_action_group_get_action_parameter_type ()"><code class="function">g_action_group_get_action_parameter_type()</code></a></p></td>
1001
<td class="struct_member_annotations"> </td>
1002
</tr>
1003
<tr>
1004
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.get-action-state-type"></a>get_action_state_type</code></em> ()</p></td>
1005
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-get-action-state-type" title="g_action_group_get_action_state_type ()"><code class="function">g_action_group_get_action_state_type()</code></a></p></td>
1006
<td class="struct_member_annotations"> </td>
1007
</tr>
1008
<tr>
1009
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.get-action-state-hint"></a>get_action_state_hint</code></em> ()</p></td>
1010
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-get-action-state-hint" title="g_action_group_get_action_state_hint ()"><code class="function">g_action_group_get_action_state_hint()</code></a></p></td>
1011
<td class="struct_member_annotations"> </td>
1012
</tr>
1013
<tr>
1014
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.get-action-state"></a>get_action_state</code></em> ()</p></td>
1015
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-get-action-state" title="g_action_group_get_action_state ()"><code class="function">g_action_group_get_action_state()</code></a></p></td>
1016
<td class="struct_member_annotations"> </td>
1017
</tr>
1018
<tr>
1019
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.change-action-state"></a>change_action_state</code></em> ()</p></td>
1020
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-change-action-state" title="g_action_group_change_action_state ()"><code class="function">g_action_group_change_action_state()</code></a></p></td>
1021
<td class="struct_member_annotations"> </td>
1022
</tr>
1023
<tr>
1024
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.activate-action"></a>activate_action</code></em> ()</p></td>
1025
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-activate-action" title="g_action_group_activate_action ()"><code class="function">g_action_group_activate_action()</code></a></p></td>
1026
<td class="struct_member_annotations"> </td>
1027
</tr>
1028
<tr>
1029
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.action-added"></a>action_added</code></em> ()</p></td>
1030
<td class="struct_member_description"><p>the class closure for the <a class="link" href="GActionGroup.html#GActionGroup-action-added" title="The “action-added” signal"><span class="type">“action-added”</span></a> signal</p></td>
1031
<td class="struct_member_annotations"> </td>
1032
</tr>
1033
<tr>
1034
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.action-removed"></a>action_removed</code></em> ()</p></td>
1035
<td class="struct_member_description"><p>the class closure for the <a class="link" href="GActionGroup.html#GActionGroup-action-removed" title="The “action-removed” signal"><span class="type">“action-removed”</span></a> signal</p></td>
1036
<td class="struct_member_annotations"> </td>
1037
</tr>
1038
<tr>
1039
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.action-enabled-changed"></a>action_enabled_changed</code></em> ()</p></td>
1040
<td class="struct_member_description"><p>the class closure for the <a class="link" href="GActionGroup.html#GActionGroup-action-enabled-changed" title="The “action-enabled-changed” signal"><span class="type">“action-enabled-changed”</span></a> signal</p></td>
1041
<td class="struct_member_annotations"> </td>
1042
</tr>
1043
<tr>
1044
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.action-state-changed"></a>action_state_changed</code></em> ()</p></td>
1045
<td class="struct_member_description"><p>the class closure for the <a class="link" href="GActionGroup.html#GActionGroup-action-enabled-changed" title="The “action-enabled-changed” signal"><span class="type">“action-enabled-changed”</span></a> signal</p></td>
1046
<td class="struct_member_annotations"> </td>
1047
</tr>
1048
<tr>
1049
<td class="struct_member_name"><p><em class="structfield"><code><a name="GActionGroupInterface.query-action"></a>query_action</code></em> ()</p></td>
1050
<td class="struct_member_description"><p>the virtual function pointer for <a class="link" href="GActionGroup.html#g-action-group-query-action" title="g_action_group_query_action ()"><code class="function">g_action_group_query_action()</code></a></p></td>
1051
<td class="struct_member_annotations"> </td>
1052
</tr>
1053
</tbody>
1054
</table></div>
1055
</div>
1.59.2 by Sebastian Dröge
Import upstream version 2.27.1
1056
<p class="since">Since 2.28</p>
1057
</div>
1058
</div>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
1059
<div class="refsect1">
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1060
<a name="GActionGroup.signal-details"></a><h2>Signal Details</h2>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
1061
<div class="refsect2">
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1062
<a name="GActionGroup-action-added"></a><h3>The <code class="literal">“action-added”</code> signal</h3>
1063
<pre class="programlisting"><span class="returnvalue">void</span>
1064
user_function (<a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group,
1.66.21 by Iain Lane
Import upstream version 2.42.1
1065
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *action_name,
1066
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1067
<p>Signals that a new action was just added to the group.
1.59.20 by Sebastien Bacher
Import upstream version 2.29.6
1068
This signal is emitted after the action has been added
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
1069
and is now visible.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1070
<div class="refsect3">
1071
<a name="id-1.4.22.4.14.2.5"></a><h4>Parameters</h4>
1072
<div class="informaltable"><table width="100%" border="0">
1073
<colgroup>
1074
<col width="150px" class="parameters_name">
1075
<col class="parameters_description">
1076
<col width="200px" class="parameters_annotations">
1077
</colgroup>
1078
<tbody>
1079
<tr>
1080
<td class="parameter_name"><p>action_group</p></td>
1081
<td class="parameter_description"><p>the <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> that changed</p></td>
1082
<td class="parameter_annotations"> </td>
1083
</tr>
1084
<tr>
1085
<td class="parameter_name"><p>action_name</p></td>
1086
<td class="parameter_description"><p>the name of the action in <em class="parameter"><code>action_group</code></em>
1087
</p></td>
1088
<td class="parameter_annotations"> </td>
1089
</tr>
1090
<tr>
1091
<td class="parameter_name"><p>user_data</p></td>
1092
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1093
<td class="parameter_annotations"> </td>
1094
</tr>
1095
</tbody>
1096
</table></div>
1097
</div>
1.66.14 by Iain Lane
Import upstream version 2.41.0
1098
<p>Flags: Has Details</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1099
<p class="since">Since 2.28</p>
1100
</div>
1101
<hr>
1102
<div class="refsect2">
1103
<a name="GActionGroup-action-enabled-changed"></a><h3>The <code class="literal">“action-enabled-changed”</code> signal</h3>
1104
<pre class="programlisting"><span class="returnvalue">void</span>
1105
user_function (<a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group,
1.66.21 by Iain Lane
Import upstream version 2.42.1
1106
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *action_name,
1107
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>      enabled,
1108
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1109
<p>Signals that the enabled status of the named action has changed.</p>
1110
<div class="refsect3">
1111
<a name="id-1.4.22.4.14.3.5"></a><h4>Parameters</h4>
1112
<div class="informaltable"><table width="100%" border="0">
1113
<colgroup>
1114
<col width="150px" class="parameters_name">
1115
<col class="parameters_description">
1116
<col width="200px" class="parameters_annotations">
1117
</colgroup>
1118
<tbody>
1119
<tr>
1120
<td class="parameter_name"><p>action_group</p></td>
1121
<td class="parameter_description"><p>the <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> that changed</p></td>
1122
<td class="parameter_annotations"> </td>
1123
</tr>
1124
<tr>
1125
<td class="parameter_name"><p>action_name</p></td>
1126
<td class="parameter_description"><p>the name of the action in <em class="parameter"><code>action_group</code></em>
1127
</p></td>
1128
<td class="parameter_annotations"> </td>
1129
</tr>
1130
<tr>
1131
<td class="parameter_name"><p>enabled</p></td>
1132
<td class="parameter_description"><p>whether the action is enabled or not</p></td>
1133
<td class="parameter_annotations"> </td>
1134
</tr>
1135
<tr>
1136
<td class="parameter_name"><p>user_data</p></td>
1137
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1138
<td class="parameter_annotations"> </td>
1139
</tr>
1140
</tbody>
1141
</table></div>
1142
</div>
1.66.14 by Iain Lane
Import upstream version 2.41.0
1143
<p>Flags: Has Details</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1144
<p class="since">Since 2.28</p>
1145
</div>
1146
<hr>
1147
<div class="refsect2">
1148
<a name="GActionGroup-action-removed"></a><h3>The <code class="literal">“action-removed”</code> signal</h3>
1149
<pre class="programlisting"><span class="returnvalue">void</span>
1150
user_function (<a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group,
1.66.21 by Iain Lane
Import upstream version 2.42.1
1151
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *action_name,
1152
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1153
<p>Signals that an action is just about to be removed from the group.
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1154
This signal is emitted before the action is removed, so the action
1.66.9 by Emilio Pozuelo Monfort
Import upstream version 2.39.4
1155
is still visible and can be queried from the signal handler.</p>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1156
<div class="refsect3">
1157
<a name="id-1.4.22.4.14.4.5"></a><h4>Parameters</h4>
1158
<div class="informaltable"><table width="100%" border="0">
1.62.13 by Josselin Mouette
Import upstream version 2.33.12+really2.32.4
1159
<colgroup>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1160
<col width="150px" class="parameters_name">
1161
<col class="parameters_description">
1162
<col width="200px" class="parameters_annotations">
1.62.13 by Josselin Mouette
Import upstream version 2.33.12+really2.32.4
1163
</colgroup>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1164
<tbody>
1165
<tr>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1166
<td class="parameter_name"><p>action_group</p></td>
1167
<td class="parameter_description"><p>the <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> that changed</p></td>
1168
<td class="parameter_annotations"> </td>
1169
</tr>
1170
<tr>
1171
<td class="parameter_name"><p>action_name</p></td>
1172
<td class="parameter_description"><p>the name of the action in <em class="parameter"><code>action_group</code></em>
1173
</p></td>
1174
<td class="parameter_annotations"> </td>
1175
</tr>
1176
<tr>
1177
<td class="parameter_name"><p>user_data</p></td>
1178
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1179
<td class="parameter_annotations"> </td>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1180
</tr>
1181
</tbody>
1182
</table></div>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1183
</div>
1.66.14 by Iain Lane
Import upstream version 2.41.0
1184
<p>Flags: Has Details</p>
1.59.2 by Sebastian Dröge
Import upstream version 2.27.1
1185
<p class="since">Since 2.28</p>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1186
</div>
1187
<hr>
1.59.10 by Sebastien Bacher
Import upstream version 2.27.93
1188
<div class="refsect2">
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1189
<a name="GActionGroup-action-state-changed"></a><h3>The <code class="literal">“action-state-changed”</code> signal</h3>
1190
<pre class="programlisting"><span class="returnvalue">void</span>
1191
user_function (<a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> *action_group,
1.66.21 by Iain Lane
Import upstream version 2.42.1
1192
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>        *action_name,
1193
               <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>     *value,
1194
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>      user_data)</pre>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1195
<p>Signals that the state of the named action has changed.</p>
1196
<div class="refsect3">
1197
<a name="id-1.4.22.4.14.5.5"></a><h4>Parameters</h4>
1198
<div class="informaltable"><table width="100%" border="0">
1.62.13 by Josselin Mouette
Import upstream version 2.33.12+really2.32.4
1199
<colgroup>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1200
<col width="150px" class="parameters_name">
1201
<col class="parameters_description">
1202
<col width="200px" class="parameters_annotations">
1.62.13 by Josselin Mouette
Import upstream version 2.33.12+really2.32.4
1203
</colgroup>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1204
<tbody>
1205
<tr>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1206
<td class="parameter_name"><p>action_group</p></td>
1207
<td class="parameter_description"><p>the <a class="link" href="GActionGroup.html" title="GActionGroup"><span class="type">GActionGroup</span></a> that changed</p></td>
1208
<td class="parameter_annotations"> </td>
1209
</tr>
1210
<tr>
1211
<td class="parameter_name"><p>action_name</p></td>
1212
<td class="parameter_description"><p>the name of the action in <em class="parameter"><code>action_group</code></em>
1213
</p></td>
1214
<td class="parameter_annotations"> </td>
1215
</tr>
1216
<tr>
1217
<td class="parameter_name"><p>value</p></td>
1218
<td class="parameter_description"><p>the new value of the state</p></td>
1219
<td class="parameter_annotations"> </td>
1220
</tr>
1221
<tr>
1222
<td class="parameter_name"><p>user_data</p></td>
1223
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
1224
<td class="parameter_annotations"> </td>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1225
</tr>
1226
</tbody>
1227
</table></div>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1228
</div>
1.66.14 by Iain Lane
Import upstream version 2.41.0
1229
<p>Flags: Has Details</p>
1.59.2 by Sebastian Dröge
Import upstream version 2.27.1
1230
<p class="since">Since 2.28</p>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1231
</div>
1232
</div>
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
1233
<div class="refsect1">
1234
<a name="GActionGroup.see-also"></a><h2>See Also</h2>
1.66.10 by Andreas Henriksson
Import upstream version 2.39.90
1235
<p><a class="link" href="GAction.html" title="GAction"><span class="type">GAction</span></a></p>
1.59.33 by Sebastien Bacher
Import upstream version 2.31.4.tested
1236
</div>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1237
</div>
1238
<div class="footer">
1239
<hr>
1.67.3 by Iain Lane
Import upstream version 2.43.3
1240
          Generated by GTK-Doc V1.21</div>
1.59.1 by Sebastian Dröge
Import upstream version 2.27.0
1241
</body>
1242
</html>