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>
24 #include "gsimpleaction.h"
30 * SECTION:gsimpleaction
31 * @title: GSimpleAction
32 * @short_description: A simple GSimpleAction
34 * A #GSimpleAction is the obvious simple implementation of the #GAction
35 * interface. This is the easiest way to create an action for purposes of
36 * adding it to a #GSimpleActionGroup.
38 * See also #GtkAction.
42 GObject parent_instance;
45 GVariantType *parameter_type;
50 typedef GObjectClass GSimpleActionClass;
52 static void g_simple_action_iface_init (GActionInterface *iface);
53 G_DEFINE_TYPE_WITH_CODE (GSimpleAction, g_simple_action, G_TYPE_OBJECT,
54 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION, g_simple_action_iface_init))
73 static guint g_simple_action_signals[NR_SIGNALS];
76 g_simple_action_get_name (GAction *action)
78 GSimpleAction *simple = G_SIMPLE_ACTION (action);
84 g_simple_action_get_parameter_type (GAction *action)
86 GSimpleAction *simple = G_SIMPLE_ACTION (action);
88 return simple->parameter_type;
91 static const GVariantType *
92 g_simple_action_get_state_type (GAction *action)
94 GSimpleAction *simple = G_SIMPLE_ACTION (action);
96 if (simple->state != NULL)
97 return g_variant_get_type (simple->state);
103 g_simple_action_get_state_hint (GAction *action)
109 g_simple_action_get_enabled (GAction *action)
111 GSimpleAction *simple = G_SIMPLE_ACTION (action);
113 return simple->enabled;
117 g_simple_action_change_state (GAction *action,
120 GSimpleAction *simple = G_SIMPLE_ACTION (action);
122 /* If the user connected a signal handler then they are responsible
123 * for handling state changes.
125 if (g_signal_has_handler_pending (action, g_simple_action_signals[SIGNAL_CHANGE_STATE], 0, TRUE))
126 g_signal_emit (action, g_simple_action_signals[SIGNAL_CHANGE_STATE], 0, value);
128 /* If not, then the default behaviour is to just set the state. */
130 g_simple_action_set_state (simple, value);
134 * g_simple_action_set_state:
135 * @simple: a #GSimpleAction
136 * @value: the new #GVariant for the state
138 * Sets the state of the action.
140 * This directly updates the 'state' property to the given value.
142 * This should only be called by the implementor of the action. Users
143 * of the action should not attempt to directly modify the 'state'
144 * property. Instead, they should call g_action_change_state() to
145 * request the change.
150 g_simple_action_set_state (GSimpleAction *simple,
153 g_return_if_fail (G_IS_SIMPLE_ACTION (simple));
154 g_return_if_fail (value != NULL);
157 const GVariantType *state_type;
159 state_type = simple->state ?
160 g_variant_get_type (simple->state) : NULL;
161 g_return_if_fail (state_type != NULL);
162 g_return_if_fail (g_variant_is_of_type (value, state_type));
165 g_variant_ref_sink (value);
167 if (!simple->state || !g_variant_equal (simple->state, value))
170 g_variant_unref (simple->state);
172 simple->state = g_variant_ref (value);
174 g_object_notify (G_OBJECT (simple), "state");
177 g_variant_unref (value);
181 g_simple_action_get_state (GAction *action)
183 GSimpleAction *simple = G_SIMPLE_ACTION (action);
185 return simple->state ? g_variant_ref (simple->state) : NULL;
189 g_simple_action_activate (GAction *action,
192 GSimpleAction *simple = G_SIMPLE_ACTION (action);
194 g_return_if_fail (simple->parameter_type == NULL ?
196 (parameter != NULL &&
197 g_variant_is_of_type (parameter,
198 simple->parameter_type)));
200 if (parameter != NULL)
201 g_variant_ref_sink (parameter);
204 g_signal_emit (simple, g_simple_action_signals[SIGNAL_ACTIVATE], 0, parameter);
206 if (parameter != NULL)
207 g_variant_unref (parameter);
211 g_simple_action_get_property (GObject *object,
216 GAction *action = G_ACTION (object);
221 g_value_set_string (value, g_simple_action_get_name (action));
224 case PROP_PARAMETER_TYPE:
225 g_value_set_boxed (value, g_simple_action_get_parameter_type (action));
229 g_value_set_boolean (value, g_simple_action_get_enabled (action));
232 case PROP_STATE_TYPE:
233 g_value_set_boxed (value, g_simple_action_get_state_type (action));
237 g_value_take_variant (value, g_simple_action_get_state (action));
241 g_assert_not_reached ();
246 g_simple_action_finalize (GObject *object)
248 GSimpleAction *simple = G_SIMPLE_ACTION (object);
250 g_free (simple->name);
251 if (simple->parameter_type)
252 g_variant_type_free (simple->parameter_type);
254 g_variant_unref (simple->state);
256 G_OBJECT_CLASS (g_simple_action_parent_class)
261 g_simple_action_init (GSimpleAction *simple)
266 g_simple_action_iface_init (GActionInterface *iface)
268 iface->get_name = g_simple_action_get_name;
269 iface->get_parameter_type = g_simple_action_get_parameter_type;
270 iface->get_state_type = g_simple_action_get_state_type;
271 iface->get_state_hint = g_simple_action_get_state_hint;
272 iface->get_enabled = g_simple_action_get_enabled;
273 iface->get_state = g_simple_action_get_state;
274 iface->change_state = g_simple_action_change_state;
275 iface->activate = g_simple_action_activate;
279 g_simple_action_class_init (GSimpleActionClass *class)
281 GObjectClass *object_class = G_OBJECT_CLASS (class);
283 object_class->get_property = g_simple_action_get_property;
284 object_class->finalize = g_simple_action_finalize;
287 * GSimpleAction::activate:
288 * @simple: the #GSimpleAction
289 * @parameter: (allow-none): the parameter to the activation
291 * Indicates that the action was just activated.
293 * @parameter will always be of the expected type. In the event that
294 * an incorrect type was given, no signal will be emitted.
298 g_simple_action_signals[SIGNAL_ACTIVATE] =
299 g_signal_new (I_("activate"),
300 G_TYPE_SIMPLE_ACTION,
301 G_SIGNAL_RUN_LAST | G_SIGNAL_MUST_COLLECT,
303 g_cclosure_marshal_VOID__VARIANT,
308 * GSimpleAction::change-state:
309 * @simple: the #GSimpleAction
310 * @value: (allow-none): the requested value for the state
312 * Indicates that the action just received a request to change its
315 * @value will always be of the correct state type. In the event that
316 * an incorrect type was given, no signal will be emitted.
318 * If no handler is connected to this signal then the default
319 * behaviour is to call g_simple_action_set_state() to set the state
320 * to the requested value. If you connect a signal handler then no
321 * default action is taken. If the state should change then you must
322 * call g_simple_action_set_state() from the handler.
325 * <title>Example 'change-state' handler</title>
328 * change_volume_state (GSimpleAction *action,
330 * gpointer user_data)
334 * requested = g_variant_get_int32 (value);
336 * // Volume only goes from 0 to 10
337 * if (0 <= requested && requested <= 10)
338 * g_simple_action_set_state (action, value);
343 * The handler need not set the state to the requested value. It
344 * could set it to any value at all, or take some other action.
348 g_simple_action_signals[SIGNAL_CHANGE_STATE] =
349 g_signal_new (I_("change-state"),
350 G_TYPE_SIMPLE_ACTION,
351 G_SIGNAL_RUN_LAST | G_SIGNAL_MUST_COLLECT,
353 g_cclosure_marshal_VOID__VARIANT,
358 * GSimpleAction:name:
360 * The name of the action. This is mostly meaningful for identifying
361 * the action once it has been added to a #GSimpleActionGroup.
365 g_object_class_install_property (object_class, PROP_NAME,
366 g_param_spec_string ("name",
368 P_("The name used to invoke the action"),
371 G_PARAM_STATIC_STRINGS));
374 * GSimpleAction:parameter-type:
376 * The type of the parameter that must be given when activating the
381 g_object_class_install_property (object_class, PROP_PARAMETER_TYPE,
382 g_param_spec_boxed ("parameter-type",
383 P_("Parameter Type"),
384 P_("The type of GVariant passed to activate()"),
387 G_PARAM_STATIC_STRINGS));
390 * GSimpleAction:enabled:
392 * If @action is currently enabled.
394 * If the action is disabled then calls to g_action_activate() and
395 * g_action_change_state() have no effect.
399 g_object_class_install_property (object_class, PROP_ENABLED,
400 g_param_spec_boolean ("enabled",
402 P_("If the action can be activated"),
405 G_PARAM_STATIC_STRINGS));
408 * GSimpleAction:state-type:
410 * The #GVariantType of the state that the action has, or %NULL if the
411 * action is stateless.
415 g_object_class_install_property (object_class, PROP_STATE_TYPE,
416 g_param_spec_boxed ("state-type",
418 P_("The type of the state kept by the action"),
421 G_PARAM_STATIC_STRINGS));
424 * GSimpleAction:state:
426 * The state of the action, or %NULL if the action is stateless.
430 g_object_class_install_property (object_class, PROP_STATE,
431 g_param_spec_variant ("state",
433 P_("The state the action is in"),
437 G_PARAM_STATIC_STRINGS));
441 * g_simple_action_set_enabled:
442 * @simple: a #GSimpleAction
443 * @enabled: whether the action is enabled
445 * Sets the action as enabled or not.
447 * An action must be enabled in order to be activated or in order to
448 * have its state changed from outside callers.
450 * This should only be called by the implementor of the action. Users
451 * of the action should not attempt to modify its enabled flag.
456 g_simple_action_set_enabled (GSimpleAction *simple,
459 g_return_if_fail (G_IS_SIMPLE_ACTION (simple));
463 if (simple->enabled != enabled)
465 simple->enabled = enabled;
466 g_object_notify (G_OBJECT (simple), "enabled");
470 * g_simple_action_new:
471 * @name: the name of the action
472 * @parameter_type: (allow-none): the type of parameter to the activate function
474 * Creates a new action.
476 * The created action is stateless. See g_simple_action_new_stateful().
478 * Returns: a new #GSimpleAction
483 g_simple_action_new (const gchar *name,
484 const GVariantType *parameter_type)
486 GSimpleAction *simple;
488 g_return_val_if_fail (name != NULL, NULL);
490 simple = g_object_new (G_TYPE_SIMPLE_ACTION, NULL);
491 simple->name = g_strdup (name);
494 simple->parameter_type = g_variant_type_copy (parameter_type);
496 simple->enabled = TRUE;
502 * g_simple_action_new_stateful:
503 * @name: the name of the action
504 * @parameter_type: (allow-none): the type of the parameter to the activate function
505 * @state: the initial state of the action
507 * Creates a new stateful action.
509 * @state is the initial state of the action. All future state values
510 * must have the same #GVariantType as the initial state.
512 * If the @state GVariant is floating, it is consumed.
514 * Returns: a new #GSimpleAction
519 g_simple_action_new_stateful (const gchar *name,
520 const GVariantType *parameter_type,
523 GSimpleAction *simple;
525 g_return_val_if_fail (name != NULL, NULL);
526 g_return_val_if_fail (state != NULL, NULL);
528 simple = g_object_new (G_TYPE_SIMPLE_ACTION, NULL);
529 simple->name = g_strdup (name);
532 simple->parameter_type = g_variant_type_copy (parameter_type);
534 simple->state = g_variant_ref_sink (state);
536 simple->enabled = TRUE;