2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
26 G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
31 * @short_description: An action
33 * #GAction represents a single named action.
35 * The main interface to an action is that it can be activated with
36 * g_action_activate(). This results in the 'activate' signal being
37 * emitted. An activation has a #GVariant parameter (which may be
38 * %NULL). The correct type for the parameter is determined by a static
39 * parameter type (which is given at construction time).
41 * An action may optionally have a state, in which case the state may be
42 * set with g_action_change_state(). This call takes a #GVariant. The
43 * correct type for the state is determined by a static state type
44 * (which is given at construction time).
46 * The state may have a hint associated with it, specifying its valid
49 * #GAction is merely the interface to the concept of an action, as
50 * described above. Various implementations of actions exist, including
51 * #GSimpleAction and #GtkAction.
53 * In all cases, the implementing class is responsible for storing the
54 * name of the action, the parameter type, the enabled state, the
55 * optional state type and the state and emitting the appropriate
56 * signals when these change. The implementor responsible for filtering
57 * calls to g_action_activate() and g_action_change_state() for type
58 * safety and for the state being enabled.
60 * Probably the only useful thing to do with a #GAction is to put it
61 * inside of a #GSimpleActionGroup.
65 g_action_default_init (GActionInterface *iface)
70 * The name of the action. This is mostly meaningful for identifying
71 * the action once it has been added to a #GActionGroup.
75 g_object_interface_install_property (iface,
76 g_param_spec_string ("name",
78 P_("The name used to invoke the action"),
81 G_PARAM_STATIC_STRINGS));
84 * GAction:parameter-type:
86 * The type of the parameter that must be given when activating the
91 g_object_interface_install_property (iface,
92 g_param_spec_boxed ("parameter-type",
94 P_("The type of GVariant passed to activate()"),
97 G_PARAM_STATIC_STRINGS));
102 * If @action is currently enabled.
104 * If the action is disabled then calls to g_action_activate() and
105 * g_action_change_state() have no effect.
109 g_object_interface_install_property (iface,
110 g_param_spec_boolean ("enabled",
112 P_("If the action can be activated"),
115 G_PARAM_STATIC_STRINGS));
118 * GAction:state-type:
120 * The #GVariantType of the state that the action has, or %NULL if the
121 * action is stateless.
125 g_object_interface_install_property (iface,
126 g_param_spec_boxed ("state-type",
128 P_("The type of the state kept by the action"),
131 G_PARAM_STATIC_STRINGS));
136 * The state of the action, or %NULL if the action is stateless.
140 g_object_interface_install_property (iface,
141 g_param_spec_variant ("state",
143 P_("The state the action is in"),
147 G_PARAM_STATIC_STRINGS));
151 * g_action_change_state:
152 * @action: a #GAction
153 * @value: the new state
155 * Request for the state of @action to be changed to @value.
157 * The action must be stateful and @value must be of the correct type.
158 * See g_action_get_state_type().
160 * This call merely requests a change. The action may refuse to change
161 * its state or may change its state to something other than @value.
162 * See g_action_get_state_hint().
164 * If the @value GVariant is floating, it is consumed.
169 g_action_change_state (GAction *action,
172 const GVariantType *state_type;
174 g_return_if_fail (G_IS_ACTION (action));
175 g_return_if_fail (value != NULL);
176 state_type = g_action_get_state_type (action);
177 g_return_if_fail (state_type != NULL);
178 g_return_if_fail (g_variant_is_of_type (value, state_type));
180 g_variant_ref_sink (value);
182 G_ACTION_GET_IFACE (action)
183 ->change_state (action, value);
185 g_variant_unref (value);
189 * g_action_get_state:
190 * @action: a #GAction
192 * Queries the current state of @action.
194 * If the action is not stateful then %NULL will be returned. If the
195 * action is stateful then the type of the return value is the type
196 * given by g_action_get_state_type().
198 * The return value (if non-%NULL) should be freed with
199 * g_variant_unref() when it is no longer required.
201 * Returns: (transfer full): the current state of the action
206 g_action_get_state (GAction *action)
208 g_return_val_if_fail (G_IS_ACTION (action), NULL);
210 return G_ACTION_GET_IFACE (action)
211 ->get_state (action);
216 * @action: a #GAction
218 * Queries the name of @action.
220 * Returns: the name of the action
225 g_action_get_name (GAction *action)
227 g_return_val_if_fail (G_IS_ACTION (action), NULL);
229 return G_ACTION_GET_IFACE (action)
234 * g_action_get_parameter_type:
235 * @action: a #GAction
237 * Queries the type of the parameter that must be given when activating
240 * When activating the action using g_action_activate(), the #GVariant
241 * given to that function must be of the type returned by this function.
243 * In the case that this function returns %NULL, you must not give any
244 * #GVariant, but %NULL instead.
246 * Returns: (allow-none): the parameter type
251 g_action_get_parameter_type (GAction *action)
253 g_return_val_if_fail (G_IS_ACTION (action), NULL);
255 return G_ACTION_GET_IFACE (action)
256 ->get_parameter_type (action);
260 * g_action_get_state_type:
261 * @action: a #GAction
263 * Queries the type of the state of @action.
265 * If the action is stateful (e.g. created with
266 * g_simple_action_new_stateful()) then this function returns the
267 * #GVariantType of the state. This is the type of the initial value
268 * given as the state. All calls to g_action_change_state() must give a
269 * #GVariant of this type and g_action_get_state() will return a
270 * #GVariant of the same type.
272 * If the action is not stateful (e.g. created with g_simple_action_new())
273 * then this function will return %NULL. In that case, g_action_get_state()
274 * will return %NULL and you must not call g_action_change_state().
276 * Returns: (allow-none): the state type, if the action is stateful
281 g_action_get_state_type (GAction *action)
283 g_return_val_if_fail (G_IS_ACTION (action), NULL);
285 return G_ACTION_GET_IFACE (action)
286 ->get_state_type (action);
290 * g_action_get_state_hint:
291 * @action: a #GAction
293 * Requests a hint about the valid range of values for the state of
296 * If %NULL is returned it either means that the action is not stateful
297 * or that there is no hint about the valid range of values for the
298 * state of the action.
300 * If a #GVariant array is returned then each item in the array is a
301 * possible value for the state. If a #GVariant pair (ie: two-tuple) is
302 * returned then the tuple specifies the inclusive lower and upper bound
303 * of valid values for the state.
305 * In any case, the information is merely a hint. It may be possible to
306 * have a state value outside of the hinted range and setting a value
307 * within the range may fail.
309 * The return value (if non-%NULL) should be freed with
310 * g_variant_unref() when it is no longer required.
312 * Returns: (transfer full): the state range hint
317 g_action_get_state_hint (GAction *action)
319 g_return_val_if_fail (G_IS_ACTION (action), NULL);
321 return G_ACTION_GET_IFACE (action)
322 ->get_state_hint (action);
326 * g_action_get_enabled:
327 * @action: a #GAction
329 * Checks if @action is currently enabled.
331 * An action must be enabled in order to be activated or in order to
332 * have its state changed from outside callers.
334 * Returns: whether the action is enabled
339 g_action_get_enabled (GAction *action)
341 g_return_val_if_fail (G_IS_ACTION (action), FALSE);
343 return G_ACTION_GET_IFACE (action)
344 ->get_enabled (action);
349 * @action: a #GAction
350 * @parameter: (allow-none): the parameter to the activation
352 * Activates the action.
354 * @parameter must be the correct type of parameter for the action (ie:
355 * the parameter type given at construction time). If the parameter
356 * type was %NULL then @parameter must also be %NULL.
361 g_action_activate (GAction *action,
364 g_return_if_fail (G_IS_ACTION (action));
366 if (parameter != NULL)
367 g_variant_ref_sink (parameter);
369 G_ACTION_GET_IFACE (action)
370 ->activate (action, parameter);
372 if (parameter != NULL)
373 g_variant_unref (parameter);