gio/gaction.c - third_party/glib - Git at Google

 /*
  * Copyright © 2010 Codethink Limited
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published
  * by the Free Software Foundation; either version 2 of the licence or (at
  * your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General
  * Public License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  *
  * Authors: Ryan Lortie <desrt@desrt.ca>
  */

 #include "config.h"
 #include "gaction.h"
 #include "glibintl.h"

 G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)

 /**
  * SECTION:gaction
  * @title: GAction
  * @short_description: An action
  *
  * #GAction represents a single named action.
  *
  * The main interface to an action is that it can be activated with
  * g_action_activate().  This results in the 'activate' signal being
  * emitted.  An activation has a #GVariant parameter (which may be
  * %NULL).  The correct type for the parameter is determined by a static
  * parameter type (which is given at construction time).
  *
  * An action may optionally have a state, in which case the state may be
  * set with g_action_set_state().  This call takes a #GVariant.  The
  * correct type for the state is determined by a static state type
  * (which is given at construction time).
  *
  * The state may have a hint associated with it, specifying its valid
  * range.
  *
  * #GAction is merely the interface to the concept of an action, as
  * described above.  Various implementations of actions exist, including
  * #GSimpleAction and #GtkAction.
  *
  * In all cases, the implementing class is responsible for storing the
  * name of the action, the parameter type, the enabled state, the
  * optional state type and the state and emitting the appropriate
  * signals when these change.  The implementor responsible for filtering
  * calls to g_action_activate() and g_action_set_state() for type safety
  * and for the state being enabled.
  *
  * Probably the only useful thing to do with a #GAction is to put it
  * inside of a #GSimpleActionGroup.
  **/

 void
 g_action_default_init (GActionInterface *iface)
 {
   /**
    * GAction:name:
    *
    * The name of the action.  This is mostly meaningful for identifying
    * the action once it has been added to a #GActionGroup.
    *
    * Since: 2.28
    **/
   g_object_interface_install_property (iface,
                                        g_param_spec_string ("name",
                                                             P_("Action Name"),
                                                             P_("The name used to invoke the action"),
                                                             NULL,
                                                             G_PARAM_READWRITE |
                                                             G_PARAM_CONSTRUCT_ONLY |
                                                             G_PARAM_STATIC_STRINGS));

   /**
    * GAction:parameter-type:
    *
    * The type of the parameter that must be given when activating the
    * action.
    *
    * Since: 2.28
    **/
   g_object_interface_install_property (iface,
                                        g_param_spec_boxed ("parameter-type",
                                                            P_("Parameter Type"),
                                                            P_("The type of GVariant passed to activate()"),
                                                            G_TYPE_VARIANT_TYPE,
                                                            G_PARAM_READWRITE |
                                                            G_PARAM_CONSTRUCT_ONLY |
                                                            G_PARAM_STATIC_STRINGS));

   /**
    * GAction:enabled:
    *
    * If @action is currently enabled.
    *
    * If the action is disabled then calls to g_action_activate() and
    * g_action_set_state() have no effect.
    *
    * Since: 2.28
    **/
   g_object_interface_install_property (iface,
                                        g_param_spec_boolean ("enabled",
                                                              P_("Enabled"),
                                                              P_("If the action can be activated"),
                                                              TRUE,
                                                              G_PARAM_CONSTRUCT |
                                                              G_PARAM_READWRITE |
                                                              G_PARAM_STATIC_STRINGS));

   /**
    * GAction:state-type:
    *
    * The #GVariantType of the state that the action has, or %NULL if the
    * action is stateless.
    *
    * Since: 2.28
    **/
   g_object_interface_install_property (iface,
                                        g_param_spec_boxed ("state-type",
                                                            P_("State Type"),
                                                            P_("The type of the state kept by the action"),
                                                            G_TYPE_VARIANT_TYPE,
                                                            G_PARAM_READABLE |
                                                            G_PARAM_STATIC_STRINGS));

   /**
    * GAction:state:
    *
    * The state of the action, or %NULL if the action is stateless.
    *
    * Since: 2.28
    **/
   g_object_interface_install_property (iface,
                                        g_param_spec_variant ("state",
                                                              P_("State"),
                                                              P_("The state the action is in"),
                                                              G_VARIANT_TYPE_ANY,
                                                              NULL,
                                                              G_PARAM_CONSTRUCT |
                                                              G_PARAM_READWRITE |
                                                              G_PARAM_STATIC_STRINGS));
 }

 /**
  * g_action_set_state:
  * @action: a #GAction
  * @value: the new state
  *
  * Request for the state of @action to be changed to @value.
  *
  * The action must be stateful and @value must be of the correct type.
  * See g_action_get_state_type().
  *
  * This call merely requests a change.  The action may refuse to change
  * its state or may change its state to something other than @value.
  * See g_action_get_state_hint().
  *
  * If the @value GVariant is floating, it is consumed.
  *
  * Since: 2.28
  **/
 void
 g_action_set_state (GAction  *action,
                     GVariant *value)
 {
   const GVariantType *state_type;

   g_return_if_fail (G_IS_ACTION (action));
   g_return_if_fail (value != NULL);
   state_type = g_action_get_state_type (action);
   g_return_if_fail (state_type != NULL);
   g_return_if_fail (g_variant_is_of_type (value, state_type));

   g_variant_ref_sink (value);

   G_ACTION_GET_IFACE (action)
     ->set_state (action, value);

   g_variant_unref (value);
 }

 /**
  * g_action_get_state:
  * @action: a #GAction
  *
  * Queries the current state of @action.
  *
  * If the action is not stateful then %NULL will be returned.  If the
  * action is stateful then the type of the return value is the type
  * given by g_action_get_state_type().
  *
  * The return value (if non-%NULL) should be freed with
  * g_variant_unref() when it is no longer required.
  *
  * Returns: (transfer full): the current state of the action
  *
  * Since: 2.28
  **/
 GVariant *
 g_action_get_state (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), NULL);

   return G_ACTION_GET_IFACE (action)
     ->get_state (action);
 }

 /**
  * g_action_get_name:
  * @action: a #GAction
  *
  * Queries the name of @action.
  *
  * Returns: the name of the action
  *
  * Since: 2.28
  **/
 const gchar *
 g_action_get_name (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), NULL);

   return G_ACTION_GET_IFACE (action)
     ->get_name (action);
 }

 /**
  * g_action_get_parameter_type:
  * @action: a #GAction
  *
  * Queries the type of the parameter that must be given when activating
  * @action.
  *
  * When activating the action using g_action_activate(), the #GVariant
  * given to that function must be of the type returned by this function.
  *
  * In the case that this function returns %NULL, you must not give any
  * #GVariant, but %NULL instead.
  *
  * Returns: (allow-none): the parameter type
  *
  * Since: 2.28
  **/
 const GVariantType *
 g_action_get_parameter_type (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), NULL);

   return G_ACTION_GET_IFACE (action)
     ->get_parameter_type (action);
 }

 /**
  * g_action_get_state_type:
  * @action: a #GAction
  *
  * Queries the type of the state of @action.
  *
  * If the action is stateful (ie: was created with
  * g_action_new_stateful()) then this function returns the #GVariantType
  * of the state.  This is the type of the initial value given as the
  * state.  All calls to g_action_set_state() must give a #GVariant of
  * this type and g_action_get_state() will return a #GVariant of the
  * same type.
  *
  * If the action is not stateful (ie: created with g_action_new()) then
  * this function will return %NULL.  In that case, g_action_get_state()
  * will return %NULL and you must not call g_action_set_state().
  *
  * Returns: (allow-none): the state type, if the action is stateful
  *
  * Since: 2.28
  **/
 const GVariantType *
 g_action_get_state_type (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), NULL);

   return G_ACTION_GET_IFACE (action)
     ->get_state_type (action);
 }

 /**
  * g_action_get_state_hint:
  * @action: a #GAction
  *
  * Requests a hint about the valid range of values for the state of
  * @action.
  *
  * If %NULL is returned it either means that the action is not stateful
  * or that there is no hint about the valid range of values for the
  * state of the action.
  *
  * If a #GVariant array is returned then each item in the array is a
  * possible value for the state.  If a #GVariant pair (ie: two-tuple) is
  * returned then the tuple specifies the inclusive lower and upper bound
  * of valid values for the state.
  *
  * In any case, the information is merely a hint.  It may be possible to
  * have a state value outside of the hinted range and setting a value
  * within the range may fail.
  *
  * The return value (if non-%NULL) should be freed with
  * g_variant_unref() when it is no longer required.
  *
  * Returns: (transfer full): the state range hint
  *
  * Since: 2.28
  **/
 GVariant *
 g_action_get_state_hint (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), NULL);

   return G_ACTION_GET_IFACE (action)
     ->get_state_hint (action);
 }

 /**
  * g_action_get_enabled:
  * @action: a #GAction
  *
  * Checks if @action is currently enabled.
  *
  * An action must be enabled in order to be activated or in order to
  * have its state changed from outside callers.
  *
  * Returns: whether the action is enabled
  *
  * Since: 2.28
  **/
 gboolean
 g_action_get_enabled (GAction *action)
 {
   g_return_val_if_fail (G_IS_ACTION (action), FALSE);

   return G_ACTION_GET_IFACE (action)
     ->get_enabled (action);
 }

 /**
  * g_action_activate:
  * @action: a #GAction
  * @parameter: (allow-none): the parameter to the activation
  *
  * Activates the action.
  *
  * @parameter must be the correct type of parameter for the action (ie:
  * the parameter type given at construction time).  If the parameter
  * type was %NULL then @parameter must also be %NULL.
  *
  * Since: 2.28
  **/
 void
 g_action_activate (GAction  *action,
                    GVariant *parameter)
 {
   g_return_if_fail (G_IS_ACTION (action));

   if (parameter != NULL)
     g_variant_ref_sink (parameter);

   G_ACTION_GET_IFACE (action)
     ->activate (action, parameter);

   if (parameter != NULL)
     g_variant_unref (parameter);
 }
	/*
	* Copyright © 2010 Codethink Limited
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU Lesser General Public License as published
	* by the Free Software Foundation; either version 2 of the licence or (at
	* your option) any later version.
	*
	* This library is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* Lesser General Public License for more details.
	*
	* You should have received a copy of the GNU Lesser General
	* Public License along with this library; if not, write to the
	* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
	* Boston, MA 02111-1307, USA.
	*
	* Authors: Ryan Lortie <desrt@desrt.ca>
	*/

	#include "config.h"
	#include "gaction.h"
	#include "glibintl.h"

	G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)

	/**
	* SECTION:gaction
	* @title: GAction
	* @short_description: An action
	*
	* #GAction represents a single named action.
	*
	* The main interface to an action is that it can be activated with
	* g_action_activate(). This results in the 'activate' signal being
	* emitted. An activation has a #GVariant parameter (which may be
	* %NULL). The correct type for the parameter is determined by a static
	* parameter type (which is given at construction time).
	*
	* An action may optionally have a state, in which case the state may be
	* set with g_action_set_state(). This call takes a #GVariant. The
	* correct type for the state is determined by a static state type
	* (which is given at construction time).
	*
	* The state may have a hint associated with it, specifying its valid
	* range.
	*
	* #GAction is merely the interface to the concept of an action, as
	* described above. Various implementations of actions exist, including
	* #GSimpleAction and #GtkAction.
	*
	* In all cases, the implementing class is responsible for storing the
	* name of the action, the parameter type, the enabled state, the
	* optional state type and the state and emitting the appropriate
	* signals when these change. The implementor responsible for filtering
	* calls to g_action_activate() and g_action_set_state() for type safety
	* and for the state being enabled.
	*
	* Probably the only useful thing to do with a #GAction is to put it
	* inside of a #GSimpleActionGroup.
	**/

	void
	g_action_default_init (GActionInterface *iface)
	{
	/**
	* GAction:name:
	*
	* The name of the action. This is mostly meaningful for identifying
	* the action once it has been added to a #GActionGroup.
	*
	* Since: 2.28
	**/
	g_object_interface_install_property (iface,
	g_param_spec_string ("name",
	P_("Action Name"),
	P_("The name used to invoke the action"),
	NULL,
	G_PARAM_READWRITE \|
	G_PARAM_CONSTRUCT_ONLY \|
	G_PARAM_STATIC_STRINGS));

	/**
	* GAction:parameter-type:
	*
	* The type of the parameter that must be given when activating the
	* action.
	*
	* Since: 2.28
	**/
	g_object_interface_install_property (iface,
	g_param_spec_boxed ("parameter-type",
	P_("Parameter Type"),
	P_("The type of GVariant passed to activate()"),
	G_TYPE_VARIANT_TYPE,
	G_PARAM_READWRITE \|
	G_PARAM_CONSTRUCT_ONLY \|
	G_PARAM_STATIC_STRINGS));

	/**
	* GAction:enabled:
	*
	* If @action is currently enabled.
	*
	* If the action is disabled then calls to g_action_activate() and
	* g_action_set_state() have no effect.
	*
	* Since: 2.28
	**/
	g_object_interface_install_property (iface,
	g_param_spec_boolean ("enabled",
	P_("Enabled"),
	P_("If the action can be activated"),
	TRUE,
	G_PARAM_CONSTRUCT \|
	G_PARAM_READWRITE \|
	G_PARAM_STATIC_STRINGS));

	/**
	* GAction:state-type:
	*
	* The #GVariantType of the state that the action has, or %NULL if the
	* action is stateless.
	*
	* Since: 2.28
	**/
	g_object_interface_install_property (iface,
	g_param_spec_boxed ("state-type",
	P_("State Type"),
	P_("The type of the state kept by the action"),
	G_TYPE_VARIANT_TYPE,
	G_PARAM_READABLE \|
	G_PARAM_STATIC_STRINGS));

	/**
	* GAction:state:
	*
	* The state of the action, or %NULL if the action is stateless.
	*
	* Since: 2.28
	**/
	g_object_interface_install_property (iface,
	g_param_spec_variant ("state",
	P_("State"),
	P_("The state the action is in"),
	G_VARIANT_TYPE_ANY,
	NULL,
	G_PARAM_CONSTRUCT \|
	G_PARAM_READWRITE \|
	G_PARAM_STATIC_STRINGS));
	}

	/**
	* g_action_set_state:
	* @action: a #GAction
	* @value: the new state
	*
	* Request for the state of @action to be changed to @value.
	*
	* The action must be stateful and @value must be of the correct type.
	* See g_action_get_state_type().
	*
	* This call merely requests a change. The action may refuse to change
	* its state or may change its state to something other than @value.
	* See g_action_get_state_hint().
	*
	* If the @value GVariant is floating, it is consumed.
	*
	* Since: 2.28
	**/
	void
	g_action_set_state (GAction *action,
	GVariant *value)
	{
	const GVariantType *state_type;

	g_return_if_fail (G_IS_ACTION (action));
	g_return_if_fail (value != NULL);
	state_type = g_action_get_state_type (action);
	g_return_if_fail (state_type != NULL);
	g_return_if_fail (g_variant_is_of_type (value, state_type));

	g_variant_ref_sink (value);

	G_ACTION_GET_IFACE (action)
	->set_state (action, value);

	g_variant_unref (value);
	}

	/**
	* g_action_get_state:
	* @action: a #GAction
	*
	* Queries the current state of @action.
	*
	* If the action is not stateful then %NULL will be returned. If the
	* action is stateful then the type of the return value is the type
	* given by g_action_get_state_type().
	*
	* The return value (if non-%NULL) should be freed with
	* g_variant_unref() when it is no longer required.
	*
	* Returns: (transfer full): the current state of the action
	*
	* Since: 2.28
	**/
	GVariant *
	g_action_get_state (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), NULL);

	return G_ACTION_GET_IFACE (action)
	->get_state (action);
	}

	/**
	* g_action_get_name:
	* @action: a #GAction
	*
	* Queries the name of @action.
	*
	* Returns: the name of the action
	*
	* Since: 2.28
	**/
	const gchar *
	g_action_get_name (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), NULL);

	return G_ACTION_GET_IFACE (action)
	->get_name (action);
	}

	/**
	* g_action_get_parameter_type:
	* @action: a #GAction
	*
	* Queries the type of the parameter that must be given when activating
	* @action.
	*
	* When activating the action using g_action_activate(), the #GVariant
	* given to that function must be of the type returned by this function.
	*
	* In the case that this function returns %NULL, you must not give any
	* #GVariant, but %NULL instead.
	*
	* Returns: (allow-none): the parameter type
	*
	* Since: 2.28
	**/
	const GVariantType *
	g_action_get_parameter_type (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), NULL);

	return G_ACTION_GET_IFACE (action)
	->get_parameter_type (action);
	}

	/**
	* g_action_get_state_type:
	* @action: a #GAction
	*
	* Queries the type of the state of @action.
	*
	* If the action is stateful (ie: was created with
	* g_action_new_stateful()) then this function returns the #GVariantType
	* of the state. This is the type of the initial value given as the
	* state. All calls to g_action_set_state() must give a #GVariant of
	* this type and g_action_get_state() will return a #GVariant of the
	* same type.
	*
	* If the action is not stateful (ie: created with g_action_new()) then
	* this function will return %NULL. In that case, g_action_get_state()
	* will return %NULL and you must not call g_action_set_state().
	*
	* Returns: (allow-none): the state type, if the action is stateful
	*
	* Since: 2.28
	**/
	const GVariantType *
	g_action_get_state_type (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), NULL);

	return G_ACTION_GET_IFACE (action)
	->get_state_type (action);
	}

	/**
	* g_action_get_state_hint:
	* @action: a #GAction
	*
	* Requests a hint about the valid range of values for the state of
	* @action.
	*
	* If %NULL is returned it either means that the action is not stateful
	* or that there is no hint about the valid range of values for the
	* state of the action.
	*
	* If a #GVariant array is returned then each item in the array is a
	* possible value for the state. If a #GVariant pair (ie: two-tuple) is
	* returned then the tuple specifies the inclusive lower and upper bound
	* of valid values for the state.
	*
	* In any case, the information is merely a hint. It may be possible to
	* have a state value outside of the hinted range and setting a value
	* within the range may fail.
	*
	* The return value (if non-%NULL) should be freed with
	* g_variant_unref() when it is no longer required.
	*
	* Returns: (transfer full): the state range hint
	*
	* Since: 2.28
	**/
	GVariant *
	g_action_get_state_hint (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), NULL);

	return G_ACTION_GET_IFACE (action)
	->get_state_hint (action);
	}

	/**
	* g_action_get_enabled:
	* @action: a #GAction
	*
	* Checks if @action is currently enabled.
	*
	* An action must be enabled in order to be activated or in order to
	* have its state changed from outside callers.
	*
	* Returns: whether the action is enabled
	*
	* Since: 2.28
	**/
	gboolean
	g_action_get_enabled (GAction *action)
	{
	g_return_val_if_fail (G_IS_ACTION (action), FALSE);

	return G_ACTION_GET_IFACE (action)
	->get_enabled (action);
	}

	/**
	* g_action_activate:
	* @action: a #GAction
	* @parameter: (allow-none): the parameter to the activation
	*
	* Activates the action.
	*
	* @parameter must be the correct type of parameter for the action (ie:
	* the parameter type given at construction time). If the parameter
	* type was %NULL then @parameter must also be %NULL.
	*
	* Since: 2.28
	**/
	void
	g_action_activate (GAction *action,
	GVariant *parameter)
	{
	g_return_if_fail (G_IS_ACTION (action));

	if (parameter != NULL)
	g_variant_ref_sink (parameter);

	G_ACTION_GET_IFACE (action)
	->activate (action, parameter);

	if (parameter != NULL)
	g_variant_unref (parameter);
	}