Commit e71dbb97 authored by Allison Karlitskaya's avatar Allison Karlitskaya

add GActionGroup base class

parent ddad707b
......@@ -162,6 +162,7 @@
</chapter>
<chapter id="application">
<title>Application support</title>
<xi:include href="xml/gactiongroup.xml"/>
<xi:include href="xml/gapplication.xml"/>
</chapter>
<chapter id="extending">
......
......@@ -2662,3 +2662,41 @@ G_APPLICATION_GET_CLASS
GApplicationPrivate
g_application_get_type
</SECTION>
<SECTION>
<FILE>gactiongroup</FILE>
<TITLE>GActionGroup</TITLE>
GActionGroup
GActionGroupClass
<SUBSECTION>
g_action_group_has_action
g_action_group_list_actions
<SUBSECTION>
g_action_group_get_enabled
g_action_group_get_parameter_type
g_action_group_get_state_type
g_action_group_get_state_hint
<SUBSECTION>
g_action_group_get_state
g_action_group_set_state
<SUBSECTION>
g_action_group_activate
<SUBSECTION>
g_action_group_action_added
g_action_group_action_removed
g_action_group_action_enabled_changed
g_action_group_action_state_changed
<SUBSECTION Standard>
g_action_group_get_type
G_TYPE_ACTION_GROUP
G_IS_ACTION_GROUP
G_ACTION_GROUP_CLASS
G_ACTION_GROUP_GET_CLASS
G_ACTION_GROUP
</SECTION>
g_action_group_get_type
g_app_info_create_flags_get_type
g_app_info_get_type
g_app_launch_context_get_type
......
......@@ -128,6 +128,15 @@ settings_sources = \
gsettings-mapping.c \
gsettings.c
application_headers = \
gactiongroup.h \
gapplication.h
application_sources = \
gactiongroup.c \
gapplication.c
local_sources = \
glocaldirectorymonitor.c \
glocaldirectorymonitor.h \
......@@ -256,8 +265,6 @@ SUBDIRS += tests
libgio_2_0_la_SOURCES = \
gappinfo.c \
gapplication.c \
gapplication.h \
gasynchelper.c \
gasynchelper.h \
gasyncinitable.c \
......@@ -356,6 +363,7 @@ libgio_2_0_la_SOURCES = \
$(appinfo_sources) \
$(unix_sources) \
$(win32_sources) \
$(application_sources) \
$(settings_sources) \
$(gdbus_sources) \
$(local_sources) \
......@@ -417,7 +425,6 @@ gio-win32-res.o: gio.rc
gio_headers = \
gappinfo.h \
gapplication.h \
gasyncinitable.h \
gasyncresult.h \
gbufferedinputstream.h \
......@@ -489,6 +496,7 @@ gio_headers = \
gvolumemonitor.h \
gzlibcompressor.h \
gzlibdecompressor.h \
$(application_headers) \
$(settings_headers) \
$(gdbus_headers) \
$(NULL)
......
/*
* 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 "gactiongroup.h"
#include "gio-marshal.h"
/**
* SECTION:gactiongroup
* @title: GActionGroup
* @short_description: a group of actions
*
* #GActionGroup represents a group of actions.
*
* Each action in the group has a unique name (which is a string). All
* method calls, except g_action_group_list_actions() take the name of
* an action as an argument.
*
* The #GActionGroup API is meant to be the 'public' API to the action
* group. The calls here are exactly the interaction that 'external
* forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have
* with actions. 'Internal' APIs (ie: ones meant only to be accessed by
* the action group implementation) are found on subclasses. This is
* why you will find -- for example -- g_action_group_get_enabled() but
* not an equivalent <function>set()</function> call.
*
* Signals are emitted on the action group in response to state changes
* on individual actions.
**/
G_DEFINE_ABSTRACT_TYPE (GActionGroup, g_action_group, G_TYPE_OBJECT)
enum
{
SIGNAL_ACTION_ADDED,
SIGNAL_ACTION_REMOVED,
SIGNAL_ACTION_ENABLED_CHANGED,
SIGNAL_ACTION_STATE_CHANGED,
NR_SIGNALS
};
static guint g_action_group_signals[NR_SIGNALS];
static void
g_action_group_init (GActionGroup *action_group)
{
}
static void
g_action_group_class_init (GActionGroupClass *class)
{
/**
* GActionGroup::action-added:
* @action_group: the #GActionGroup that changed
* @action_name: the name of the action in @action_group
*
* Signals that a new action was just added to the group. This signal
* is emitted after the action has been added and is now visible.
**/
g_action_group_signals[SIGNAL_ACTION_ADDED] =
g_signal_new ("action-added",
G_TYPE_ACTION_GROUP, G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GActionGroupClass, action_added),
NULL, NULL, g_cclosure_marshal_VOID__STRING,
G_TYPE_NONE, 1, G_TYPE_STRING);
/**
* GActionGroup::action-removed:
* @action_group: the #GActionGroup that changed
* @action_name: the name of the action in @action_group
*
* Signals that an action is just about to be removed from the group.
* This signal is emitted before the action is removed, so the action
* is still visible and can be queried from the signal handler.
**/
g_action_group_signals[SIGNAL_ACTION_REMOVED] =
g_signal_new ("action-removed",
G_TYPE_ACTION_GROUP, G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GActionGroupClass, action_removed),
NULL, NULL, g_cclosure_marshal_VOID__STRING,
G_TYPE_NONE, 1, G_TYPE_STRING);
/**
* GActionGroup::action-enabled-changed:
* @action_group: the #GActionGroup that changed
* @action_name: the name of the action in @action_group
* @enabled: whether the action is enabled or not
*
* Signals that the enabled status of the named action has changed.
**/
g_action_group_signals[SIGNAL_ACTION_ENABLED_CHANGED] =
g_signal_new ("action-enabled-changed",
G_TYPE_ACTION_GROUP, G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GActionGroupClass, action_enabled_changed),
NULL, NULL, _gio_marshal_VOID__STRING_BOOLEAN,
G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
/**
* GActionGroup::action-state-changed:
* @action_group: the #GActionGroup that changed
* @action_name: the name of the action in @action_group
* @value: the new value of the state
*
* Signals that the state of the named action has changed.
**/
g_action_group_signals[SIGNAL_ACTION_STATE_CHANGED] =
g_signal_new ("action-state-changed",
G_TYPE_ACTION_GROUP, G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GActionGroupClass, action_state_changed),
NULL, NULL, _gio_marshal_VOID__STRING_VARIANT,
G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_VARIANT);
}
/**
* g_action_group_has_action:
* @action_group: a #GActionGroup
*
* Lists the actions contained within @action_group.
*
* The caller is responsible for freeing the list with g_strfreev() when
* it is no longer required.
*
* Returns: a list of the actions in the group
*
* Since: 2.26
**/
gchar **
g_action_group_list_actions (GActionGroup *action_group)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->list_actions (action_group);
}
/**
* g_action_group_has_action:
* @action_group: a #GActionGroup
* @action_name: the name of the action to check for
*
* Checks if the named action exists within @action_group.
*
* Returns: whether the named action exists
*
* Since: 2.26
**/
gboolean
g_action_group_has_action (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->has_action (action_group, action_name);
}
/**
* g_action_group_get_parameter_type:
* @action_group: a #GActionGroup
* @action_name: the name of the action to query
*
* Queries the type of the parameter that must be given when activating
* the named action within @action_group.
*
* When activating the action using g_action_group_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.
*
* The parameter type of a particular action will never change but it is
* possible for an action to be removed and for a new action to be added
* with the same name but a different parameter type.
*
* Returns: (allow-none): the parameter type
*
* Since: 2.26
**/
const GVariantType *
g_action_group_get_parameter_type (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->get_parameter_type (action_group, action_name);
}
/**
* g_action_group_get_state_type:
* @action_group: a #GActionGroup
* @action_name: the name of the action to query
*
* Queries the type of the state of the named action within
* @action_group.
*
* If the action is stateful then this function returns the
* #GVariantType of the state. All calls to g_action_group_set_state()
* must give a #GVariant of this type and g_action_group_get_state()
* will return a #GVariant of the same type.
*
* If the action is not stateful then this function will return %NULL.
* In that case, g_action_group_get_state() will return %NULL and you
* must not call g_action_group_set_state().
*
* The state type of a particular action will never change but it is
* possible for an action to be removed and for a new action to be added
* with the same name but a different state type.
*
* Returns: (allow-none): the state type, if the action is stateful
*
* Since: 2.26
**/
const GVariantType *
g_action_group_get_state_type (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->get_state_type (action_group, action_name);
}
/**
* g_action_group_get_state_hint:
* @action_group: a #GActionGroup
* @action_name: the name of the action to query
*
* Requests a hint about the valid range of values for the state of the
* named action within @action_group.
*
* 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: (allow-none): the state range hint
*
* Since: 2.26
**/
GVariant *
g_action_group_get_state_hint (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->get_state_hint (action_group, action_name);
}
/**
* g_action_group_get_enabled:
* @action_group: a #GActionGroup
* @action_name: the name of the action to query
*
* Checks if the named action within @action_group 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 or not the action is currently enabled
*
* Since: 2.26
**/
gboolean
g_action_group_get_enabled (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->get_enabled (action_group, action_name);
}
/**
* g_action_group_get_state:
* @action_group: a #GActionGroup
* @action_name: the name of the action to query
*
* Queries the current state of the named action within @action_group.
*
* 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_group_get_state_type().
*
* The return value (if non-%NULL) should be freed with
* g_variant_unref() when it is no longer required.
*
* Returns: (allow-none): the current state of the action
*
* Since: 2.26
**/
GVariant *
g_action_group_get_state (GActionGroup *action_group,
const gchar *action_name)
{
return G_ACTION_GROUP_GET_CLASS (action_group)
->get_state (action_group, action_name);
}
/**
* g_action_group_set_state:
* @action_group: a #GActionGroup
* @action_name: the name of the action to request the change on
* @value: the new state
*
* Request for the state of the named action within @action_group to be
* changed to @value.
*
* The action must be stateful and @value must be of the correct type.
* See g_action_group_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_group_get_state_hint().
*
* Since: 2.26
**/
void
g_action_group_set_state (GActionGroup *action_group,
const gchar *action_name,
GVariant *value)
{
G_ACTION_GROUP_GET_CLASS (action_group)
->set_state (action_group, action_name, value);
}
/**
* g_action_group_activate:
* @action_group: a #GActionGroup
* @action_name: the name of the action to activate
* @parameter: (allow-none): parameters to the activation
*
* Activate the named action within @action_group.
*
* If the action is expecting a parameter, then the correct type of
* parameter must be given as @parameter. If the action is expecting no
* parameters then @parameter must be %NULL. See
* g_action_group_get_parameter_type().
*
* Since: 2.26
**/
void
g_action_group_activate (GActionGroup *action_group,
const gchar *action_name,
GVariant *parameter)
{
G_ACTION_GROUP_GET_CLASS (action_group)
->activate (action_group, action_name, parameter);
}
/**
* g_action_group_action_added:
* @action_group: a #GActionGroup
* @action_name: the name of an action in the group
*
* Emits the "action-added" signal on @action_group.
*
* This function should only be called by #GActionGroup implementations.
*
* Since: 2.26
**/
void
g_action_group_action_added (GActionGroup *action_group,
const gchar *action_name)
{
g_signal_emit (action_group,
g_action_group_signals[SIGNAL_ACTION_ADDED],
g_quark_try_string (action_name), action_name);
}
/**
* g_action_group_action_removed:
* @action_group: a #GActionGroup
* @action_name: the name of an action in the group
*
* Emits the "action-removed" signal on @action_group.
*
* This function should only be called by #GActionGroup implementations.
*
* Since: 2.26
**/
void
g_action_group_action_removed (GActionGroup *action_group,
const gchar *action_name)
{
g_signal_emit (action_group,
g_action_group_signals[SIGNAL_ACTION_REMOVED],
g_quark_try_string (action_name), action_name);
}
/**
* g_action_group_action_enabled_changed:
* @action_group: a #GActionGroup
* @action_name: the name of an action in the group
* @enabled: whether or not the action is now enabled
*
* Emits the "action-enabled-changed" signal on @action_group.
*
* This function should only be called by #GActionGroup implementations.
*
* Since: 2.26
**/
void
g_action_group_action_enabled_changed (GActionGroup *action_group,
const gchar *action_name,
gboolean enabled)
{
g_signal_emit (action_group,
g_action_group_signals[SIGNAL_ACTION_ENABLED_CHANGED],
g_quark_try_string (action_name), action_name);
}
/**
* g_action_group_action_state_changed:
* @action_group: a #GActionGroup
* @action_name: the name of an action in the group
* @state: the new state of the named action
*
* Emits the "action-state-changed" signal on @action_group.
*
* This function should only be called by #GActionGroup implementations.
*
* Since: 2.26
**/
void
g_action_group_action_state_changed (GActionGroup *action_group,
const gchar *action_name,
GVariant *state)
{
g_signal_emit (action_group,
g_action_group_signals[SIGNAL_ACTION_STATE_CHANGED],
g_quark_try_string (action_name), action_name);
}
/*
* 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>
*/
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#ifndef __G_ACTION_GROUP_H__
#define __G_ACTION_GROUP_H__
#include <gio/giotypes.h>
G_BEGIN_DECLS
#define G_TYPE_ACTION_GROUP (g_action_group_get_type ())
#define G_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
G_TYPE_ACTION_GROUP, GActionGroup))
#define G_ACTION_GROUP_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
G_TYPE_ACTION_GROUP, GActionGroupClass))
#define G_IS_ACTION_GROUP(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_ACTION))
#define G_IS_ACTION_GROUP_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_ACTION))
#define G_ACTION_GROUP_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
G_TYPE_ACTION_GROUP, GActionGroupClass))
typedef struct _GActionGroupPrivate GActionGroupPrivate;
typedef struct _GActionGroupClass GActionGroupClass;
/**
* GActionGroup:
*
* The #GActionGroup structure contains private data and should only be accessed using the provided API.
*
* Since: 2.26
*/
struct _GActionGroup
{
/*< private >*/
GObject parent_instance;
GActionGroupPrivate *priv;
};
/**
* GActionGroupClass:
* @has_action: the virtual function pointer for g_action_group_has_action()
* @list_actions: the virtual function pointer for g_action_group_list_actions()
* @get_parameter_type: the virtual function pointer for g_action_group_get_parameter_type()
* @get_state_type: the virtual function pointer for g_action_group_get_state_type()
* @get_state_hint: the virtual function pointer for g_action_group_get_state_hint()
* @get_enabled: the virtual function pointer for g_action_group_get_enabled()
* @get_state: the virtual function pointer for g_action_group_get_state()
* @set_state: the virtual function pointer for g_action_group_set_state()
* @activate: the virtual function pointer for g_action_group_activate()
* @action_added: the class closure for the action-added signal
* @action_removed: the class closure for the action-removed signal
* @action_enabled_changed: the class closure for the action-enabled-changed signal
* @action_state_changed: the class closure for the action-enabled-changed signal
*
* The virtual function table for #GActionGroup.
*
* Since: 2.26
*/
struct _GActionGroupClass
{
/*< private >*/
GObjectClass parent_class;
/*< public >*/
/* virtual functions */
gboolean (* has_action) (GActionGroup *action_group,
const gchar *action_name);
gchar ** (* list_actions) (GActionGroup *action_group);
gboolean (* get_enabled) (GActionGroup *action_group,
const gchar *action_name);
const GVariantType * (* get_parameter_type) (GActionGroup *action_group,
const gchar *action_name);
const GVariantType * (* get_state_type) (GActionGroup *action_group,
const gchar *action_name);
GVariant * (* get_state_hint) (GActionGroup *action_group,
const gchar *action_name);
GVariant * (* get_state) (GActionGroup *action_group,
const gchar *action_name);
void (* set_state) (GActionGroup *action_group,
const gchar *action_name,
GVariant *value);
void (* activate) (GActionGroup *action_group,
const gchar *action_name,
GVariant *parameter);
/* signals */
void (* action_added) (GActionGroup *action_group,
const gchar *action_name);
void (* action_removed) (GActionGroup *action_group,
const gchar *action_name);
void (* action_enabled_changed) (GActionGroup *action_group,
const gchar *action_name,
gboolean enabled);
void (* action_state_changed) (GActionGroup *action_group,
const gchar *action_name,
GVariant *value);
/*< private >*/
gpointer signal_padding[6];
};
GType g_action_group_get_type (void) G_GNUC_CONST;
gboolean g_action_group_has_action (GActionGroup *action_group,
const gchar *action_name);
gchar ** g_action_group_list_actions (GActionGroup *action_group);
const GVariantType * g_action_group_get_parameter_type (GActionGroup *action_group,
const gchar *action_name);
const GVariantType * g_action_group_get_state_type (GActionGroup *action_group,
const gchar *action_name);
GVariant * g_action_group_get_state_hint (GActionGroup *action_group,
const gchar *action_name);
gboolean g_action_group_get_enabled (GActionGroup *action_group,
const gchar *action_name);
GVariant * g_action_group_get_state (GActionGroup *action_group,
const gchar *action_name);
void g_action_group_set_state (GActionGroup *action_group,
const gchar *action_name,
GVariant *value);
void g_action_group_activate (GActionGroup *action_group,
const gchar *action_name,
GVariant *parameter);
/* signals */
void g_action_group_action_added (GActionGroup *action_group,
const gchar *action_name);
void g_action_group_action_removed (GActionGroup *action_group,
const gchar *action_name);
void g_action_group_action_enabled_changed (GActionGroup *action_group,
const gchar *action_name,
gboolean enabled);
void g_action_group_action_state_changed (GActionGroup *action_group,
const gchar *action_name,
GVariant *state);
G_END_DECLS
#endif /* __G_ACTION_GROUP_H__ */
......@@ -20,3 +20,4 @@ VOID:VARIANT,BOXED
VOID:STRING,STRING,VARIANT
VOID:STRING
VOID:STRING,STRING
VOID:STRING,BOOLEAN
......@@ -1822,3 +1822,23 @@ g_simple_permission_get_type
g_simple_permission_new
#endif
#endif
#if IN_HEADER(__G_ACTION_GROUP_H__)
#if IN_FILE(__G_ACTION_GROUP_C__)
g_action_group_action_added
g_action_group_action_enabled_changed
g_action_group_action_removed
g_action_group_action_state_changed
g_action_group_activate
g_action_group_get_enabled
g_action_group_get_parameter_type
g_action_group_get_state
g_action_group_get_state_range
g_action_group_get_state_type
g_action_group_get_type
g_action_group_has_action
g_action_group_list_actions
g_action_group_set_state
#endif
#endif
......@@ -47,6 +47,7 @@ typedef struct _GSimplePermission GSimplePermission;
typedef struct _GZlibCompressor GZlibCompressor;
typedef struct _GZlibDecompressor GZlibDecompressor;
typedef struct _GActionGroup GActionGroup;
typedef struct _GSettingsBackend GSettingsBackend;