Blame docs/reference/gio/html/GActionGroup.html

Packit ae235b
Packit ae235b
<html>
Packit ae235b
<head>
Packit ae235b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit ae235b
<title>GActionGroup: GIO Reference Manual</title>
Packit ae235b
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit ae235b
<link rel="home" href="index.html" title="GIO Reference Manual">
Packit ae235b
<link rel="up" href="application.html" title="Application support">
Packit ae235b
<link rel="prev" href="GApplicationCommandLine.html" title="GApplicationCommandLine">
Packit ae235b
<link rel="next" href="GActionMap.html" title="GActionMap">
Packit ae235b
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit ae235b
<link rel="stylesheet" href="style.css" type="text/css">
Packit ae235b
</head>
Packit ae235b
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit ae235b
Packit ae235b
Packit ae235b
Top  | 
Packit ae235b
                  Description  | 
Packit ae235b
                  Object Hierarchy  | 
Packit ae235b
                  Prerequisites  | 
Packit ae235b
                  Known Derived Interfaces  | 
Packit ae235b
                  Known Implementations  | 
Packit ae235b
                  Signals
Packit ae235b
Packit ae235b
Home
Packit ae235b
Up
Packit ae235b
Prev
Packit ae235b
Next
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

GActionGroup

Packit ae235b

GActionGroup — A group of actions

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar **
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_list_actions ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_query_action ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_has_action ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_get_action_enabled ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
const GVariantType *
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_get_action_parameter_type ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
const GVariantType *
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_get_action_state_type ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GVariant *
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_get_action_state_hint ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GVariant *
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_get_action_state ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_change_action_state ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_activate_action ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_action_added ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_action_removed ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_action_enabled_changed ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_action_group_action_state_changed ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Signals

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
action-added
Packit ae235b
Has Details
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
action-enabled-changed
Packit ae235b
Has Details
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
action-removed
Packit ae235b
Has Details
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
action-state-changed
Packit ae235b
Has Details
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
 
Packit ae235b
GActionGroup
Packit ae235b
Packit ae235b
Packit ae235b
struct
Packit ae235b
GActionGroupInterface
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Object Hierarchy

Packit ae235b
    GInterface
Packit ae235b
    ╰── GActionGroup
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Prerequisites

Packit ae235b

Packit ae235b
GActionGroup requires
Packit ae235b
 GObject.

Packit ae235b
Packit ae235b
Packit ae235b

Known Derived Interfaces

Packit ae235b

Packit ae235b
GActionGroup is required by
Packit ae235b
 GRemoteActionGroup.

Packit ae235b
Packit ae235b
Packit ae235b

Known Implementations

Packit ae235b

Packit ae235b
GActionGroup is implemented by
Packit ae235b
 GApplication,  GDBusActionGroup and  GSimpleActionGroup.

Packit ae235b
Packit ae235b
Packit ae235b

Includes

Packit ae235b
#include <gio/gio.h>
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Description

Packit ae235b

GActionGroup represents a group of actions. Actions can be used to

Packit ae235b
expose functionality in a structured way, either from one part of a
Packit ae235b
program to another, or to the outside world. Action groups are often
Packit ae235b
used together with a GMenuModel that provides additional
Packit ae235b
representation data for displaying the actions to the user, e.g. in
Packit ae235b
a menu.

Packit ae235b

The main way to interact with the actions in a GActionGroup is to

Packit ae235b
activate them with g_action_group_activate_action(). Activating an
Packit ae235b
action may require a GVariant parameter. The required type of the
Packit ae235b
parameter can be inquired with g_action_group_get_action_parameter_type().
Packit ae235b
Actions may be disabled, see g_action_group_get_action_enabled().
Packit ae235b
Activating a disabled action has no effect.

Packit ae235b

Actions may optionally have a state in the form of a GVariant. The

Packit ae235b
current state of an action can be inquired with
Packit ae235b
g_action_group_get_action_state(). Activating a stateful action may
Packit ae235b
change its state, but it is also possible to set the state by calling
Packit ae235b
g_action_group_change_action_state().

Packit ae235b

As typical example, consider a text editing application which has an

Packit ae235b
option to change the current font to 'bold'. A good way to represent
Packit ae235b
this would be a stateful action, with a boolean state. Activating the
Packit ae235b
action would toggle the state.

Packit ae235b

Each action in the group has a unique name (which is a string). All

Packit ae235b
method calls, except g_action_group_list_actions() take the name of
Packit ae235b
an action as an argument.

Packit ae235b

The GActionGroup API is meant to be the 'public' API to the action

Packit ae235b
group.  The calls here are exactly the interaction that 'external
Packit ae235b
forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have
Packit ae235b
with actions.  'Internal' APIs (ie: ones meant only to be accessed by
Packit ae235b
the action group implementation) are found on subclasses.  This is
Packit ae235b
why you will find - for example - g_action_group_get_action_enabled()
Packit ae235b
but not an equivalent set() call.

Packit ae235b

Signals are emitted on the action group in response to state changes

Packit ae235b
on individual actions.

Packit ae235b

Implementations of GActionGroup should provide implementations for

Packit ae235b
the virtual functions g_action_group_list_actions() and
Packit ae235b
g_action_group_query_action().  The other virtual functions should
Packit ae235b
not be implemented - their "wrappers" are actually implemented with
Packit ae235b
calls to g_action_group_query_action().

Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b

g_action_group_list_actions ()

Packit ae235b
gchar **
Packit ae235b
g_action_group_list_actions (GActionGroup *action_group);
Packit ae235b

Lists the actions contained within action_group

Packit ae235b
.

Packit ae235b

The caller is responsible for freeing the list with g_strfreev() when

Packit ae235b
it is no longer required.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a NULL-terminated array of the names of the

Packit ae235b
actions in the group. 

Packit ae235b

[transfer full]

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_query_action ()

Packit ae235b
gboolean
Packit ae235b
g_action_group_query_action (GActionGroup *action_group,
Packit ae235b
                             const gchar *action_name,
Packit ae235b
                             gboolean *enabled,
Packit ae235b
                             const GVariantType **parameter_type,
Packit ae235b
                             const GVariantType **state_type,
Packit ae235b
                             GVariant **state_hint,
Packit ae235b
                             GVariant **state);
Packit ae235b

Queries all aspects of the named action within an action_group

Packit ae235b
.

Packit ae235b

This function acquires the information available from

Packit ae235b
g_action_group_has_action(), g_action_group_get_action_enabled(),
Packit ae235b
g_action_group_get_action_parameter_type(),
Packit ae235b
g_action_group_get_action_state_type(),
Packit ae235b
g_action_group_get_action_state_hint() and
Packit ae235b
g_action_group_get_action_state() with a single function call.

Packit ae235b

This provides two main benefits.

Packit ae235b

The first is the improvement in efficiency that comes with not having

Packit ae235b
to perform repeated lookups of the action in order to discover
Packit ae235b
different things about it.  The second is that implementing
Packit ae235b
GActionGroup can now be done by only overriding this one virtual
Packit ae235b
function.

Packit ae235b

The interface provides a default implementation of this function that

Packit ae235b
calls the individual functions, as required, to fetch the
Packit ae235b
information.  The interface also provides default implementations of
Packit ae235b
those functions that call this function.  All implementations,
Packit ae235b
therefore, must override either this function or all of the others.

Packit ae235b

If the action exists, TRUE is returned and any of the requested

Packit ae235b
fields (as indicated by having a non-NULL reference passed in) are
Packit ae235b
filled.  If the action doesn't exist, FALSE is returned and the
Packit ae235b
fields may or may not have been modified.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of an action in the group

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

enabled

Packit ae235b

if the action is presently enabled.

Packit ae235b
[out]
Packit ae235b
Packit ae235b
Packit ae235b

parameter_type

Packit ae235b

the parameter type, or NULL if none needed.

Packit ae235b
[out][optional]
Packit ae235b
Packit ae235b
Packit ae235b

state_type

Packit ae235b

the state type, or NULL if stateless.

Packit ae235b
[out][optional]
Packit ae235b
Packit ae235b
Packit ae235b

state_hint

Packit ae235b

the state hint, or NULL if none.

Packit ae235b
[out][optional]
Packit ae235b
Packit ae235b
Packit ae235b

state

Packit ae235b

the current state, or NULL if stateless.

Packit ae235b
[out][optional]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the action exists, else FALSE

Packit ae235b
Packit ae235b

Since: 2.32

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_has_action ()

Packit ae235b
gboolean
Packit ae235b
g_action_group_has_action (GActionGroup *action_group,
Packit ae235b
                           const gchar *action_name);
Packit ae235b

Checks if the named action exists within action_group

Packit ae235b
.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to check for

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

whether the named action exists

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_get_action_enabled ()

Packit ae235b
gboolean
Packit ae235b
g_action_group_get_action_enabled (GActionGroup *action_group,
Packit ae235b
                                   const gchar *action_name);
Packit ae235b

Checks if the named action within action_group

Packit ae235b
 is currently enabled.

Packit ae235b

An action must be enabled in order to be activated or in order to

Packit ae235b
have its state changed from outside callers.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

whether or not the action is currently enabled

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_get_action_parameter_type ()

Packit ae235b
const GVariantType *
Packit ae235b
g_action_group_get_action_parameter_type
Packit ae235b
                               (GActionGroup *action_group,
Packit ae235b
                                const gchar *action_name);
Packit ae235b

Queries the type of the parameter that must be given when activating

Packit ae235b
the named action within action_group
Packit ae235b
.

Packit ae235b

When activating the action using g_action_group_activate_action(),

Packit ae235b
the GVariant given to that function must be of the type returned
Packit ae235b
by this function.

Packit ae235b

In the case that this function returns NULL, you must not give any

Packit ae235b
GVariant, but NULL instead.

Packit ae235b

The parameter type of a particular action will never change but it is

Packit ae235b
possible for an action to be removed and for a new action to be added
Packit ae235b
with the same name but a different parameter type.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the parameter type.

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_get_action_state_type ()

Packit ae235b
const GVariantType *
Packit ae235b
g_action_group_get_action_state_type (GActionGroup *action_group,
Packit ae235b
                                      const gchar *action_name);
Packit ae235b

Queries the type of the state of the named action within

Packit ae235b
action_group
Packit ae235b
.

Packit ae235b

If the action is stateful then this function returns the

Packit ae235b
GVariantType of the state.  All calls to
Packit ae235b
g_action_group_change_action_state() must give a GVariant of this
Packit ae235b
type and g_action_group_get_action_state() will return a GVariant
Packit ae235b
of the same type.

Packit ae235b

If the action is not stateful then this function will return NULL.

Packit ae235b
In that case, g_action_group_get_action_state() will return NULL
Packit ae235b
and you must not call g_action_group_change_action_state().

Packit ae235b

The state type of a particular action will never change but it is

Packit ae235b
possible for an action to be removed and for a new action to be added
Packit ae235b
with the same name but a different state type.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the state type, if the action is stateful.

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_get_action_state_hint ()

Packit ae235b
GVariant *
Packit ae235b
g_action_group_get_action_state_hint (GActionGroup *action_group,
Packit ae235b
                                      const gchar *action_name);
Packit ae235b

Requests a hint about the valid range of values for the state of the

Packit ae235b
named action within action_group
Packit ae235b
.

Packit ae235b

If NULL is returned it either means that the action is not stateful

Packit ae235b
or that there is no hint about the valid range of values for the
Packit ae235b
state of the action.

Packit ae235b

If a GVariant array is returned then each item in the array is a

Packit ae235b
possible value for the state.  If a GVariant pair (ie: two-tuple) is
Packit ae235b
returned then the tuple specifies the inclusive lower and upper bound
Packit ae235b
of valid values for the state.

Packit ae235b

In any case, the information is merely a hint. It may be possible to

Packit ae235b
have a state value outside of the hinted range and setting a value
Packit ae235b
within the range may fail.

Packit ae235b

The return value (if non-NULL) should be freed with

Packit ae235b
g_variant_unref() when it is no longer required.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the state range hint.

Packit ae235b

[nullable][transfer full]

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_get_action_state ()

Packit ae235b
GVariant *
Packit ae235b
g_action_group_get_action_state (GActionGroup *action_group,
Packit ae235b
                                 const gchar *action_name);
Packit ae235b

Queries the current state of the named action within action_group

Packit ae235b
.

Packit ae235b

If the action is not stateful then NULL will be returned. If the

Packit ae235b
action is stateful then the type of the return value is the type
Packit ae235b
given by g_action_group_get_action_state_type().

Packit ae235b

The return value (if non-NULL) should be freed with

Packit ae235b
g_variant_unref() when it is no longer required.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to query

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the current state of the action.

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_change_action_state ()

Packit ae235b
void
Packit ae235b
g_action_group_change_action_state (GActionGroup *action_group,
Packit ae235b
                                    const gchar *action_name,
Packit ae235b
                                    GVariant *value);
Packit ae235b

Request for the state of the named action within action_group

Packit ae235b
 to be
Packit ae235b
changed to value
Packit ae235b
.

Packit ae235b

The action must be stateful and value

Packit ae235b
 must be of the correct type.
Packit ae235b
See g_action_group_get_action_state_type().

Packit ae235b

This call merely requests a change. The action may refuse to change

Packit ae235b
its state or may change its state to something other than value
Packit ae235b
.
Packit ae235b
See g_action_group_get_action_state_hint().

Packit ae235b

If the value

Packit ae235b
 GVariant is floating, it is consumed.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to request the change on

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

value

Packit ae235b

the new state

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_activate_action ()

Packit ae235b
void
Packit ae235b
g_action_group_activate_action (GActionGroup *action_group,
Packit ae235b
                                const gchar *action_name,
Packit ae235b
                                GVariant *parameter);
Packit ae235b

Activate the named action within action_group

Packit ae235b
.

Packit ae235b

If the action is expecting a parameter, then the correct type of

Packit ae235b
parameter must be given as parameter
Packit ae235b
.  If the action is expecting no
Packit ae235b
parameters then parameter
Packit ae235b
 must be NULL.  See
Packit ae235b
g_action_group_get_action_parameter_type().

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action to activate

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

parameter

Packit ae235b

parameters to the activation.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_action_added ()

Packit ae235b
void
Packit ae235b
g_action_group_action_added (GActionGroup *action_group,
Packit ae235b
                             const gchar *action_name);
Packit ae235b

Emits the “action-added” signal on action_group

Packit ae235b
.

Packit ae235b

This function should only be called by GActionGroup implementations.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of an action in the group

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_action_removed ()

Packit ae235b
void
Packit ae235b
g_action_group_action_removed (GActionGroup *action_group,
Packit ae235b
                               const gchar *action_name);
Packit ae235b

Emits the “action-removed” signal on action_group

Packit ae235b
.

Packit ae235b

This function should only be called by GActionGroup implementations.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of an action in the group

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_action_enabled_changed ()

Packit ae235b
void
Packit ae235b
g_action_group_action_enabled_changed (GActionGroup *action_group,
Packit ae235b
                                       const gchar *action_name,
Packit ae235b
                                       gboolean enabled);
Packit ae235b

Emits the “action-enabled-changed” signal on action_group

Packit ae235b
.

Packit ae235b

This function should only be called by GActionGroup implementations.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of an action in the group

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

enabled

Packit ae235b

whether or not the action is now enabled

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_action_group_action_state_changed ()

Packit ae235b
void
Packit ae235b
g_action_group_action_state_changed (GActionGroup *action_group,
Packit ae235b
                                     const gchar *action_name,
Packit ae235b
                                     GVariant *state);
Packit ae235b

Emits the “action-state-changed” signal on action_group

Packit ae235b
.

Packit ae235b

This function should only be called by GActionGroup implementations.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

a GActionGroup

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of an action in the group

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

state

Packit ae235b

the new state of the named action

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b

GActionGroup

Packit ae235b
typedef struct _GActionGroup GActionGroup;
Packit ae235b

GActionGroup is an opaque data structure and can only be accessed

Packit ae235b
using the following functions.

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

struct GActionGroupInterface

Packit ae235b
struct GActionGroupInterface {
Packit ae235b
  GTypeInterface g_iface;
Packit ae235b
Packit ae235b
  /* virtual functions */
Packit ae235b
  gboolean              (* has_action)                 (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  gchar **              (* list_actions)               (GActionGroup  *action_group);
Packit ae235b
Packit ae235b
  gboolean              (* get_action_enabled)         (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  const GVariantType *  (* get_action_parameter_type)  (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  const GVariantType *  (* get_action_state_type)      (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  GVariant *            (* get_action_state_hint)      (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  GVariant *            (* get_action_state)           (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
Packit ae235b
  void                  (* change_action_state)        (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name,
Packit ae235b
                                                        GVariant      *value);
Packit ae235b
Packit ae235b
  void                  (* activate_action)            (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name,
Packit ae235b
                                                        GVariant      *parameter);
Packit ae235b
Packit ae235b
  /* signals */
Packit ae235b
  void                  (* action_added)               (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
  void                  (* action_removed)             (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name);
Packit ae235b
  void                  (* action_enabled_changed)     (GActionGroup  *action_group,
Packit ae235b
                                                        const gchar   *action_name,
Packit ae235b
                                                        gboolean       enabled);
Packit ae235b
  void                  (* action_state_changed)       (GActionGroup   *action_group,
Packit ae235b
                                                        const gchar    *action_name,
Packit ae235b
                                                        GVariant       *state);
Packit ae235b
Packit ae235b
  /* more virtual functions */
Packit ae235b
  gboolean              (* query_action)               (GActionGroup        *action_group,
Packit ae235b
                                                        const gchar         *action_name,
Packit ae235b
                                                        gboolean            *enabled,
Packit ae235b
                                                        const GVariantType **parameter_type,
Packit ae235b
                                                        const GVariantType **state_type,
Packit ae235b
                                                        GVariant           **state_hint,
Packit ae235b
                                                        GVariant           **state);
Packit ae235b
};
Packit ae235b
Packit ae235b

The virtual function table for GActionGroup.

Packit ae235b
Packit ae235b

Members

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

has_action ()

Packit ae235b

the virtual function pointer for g_action_group_has_action()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

list_actions ()

Packit ae235b

the virtual function pointer for g_action_group_list_actions()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

get_action_enabled ()

Packit ae235b

the virtual function pointer for g_action_group_get_action_enabled()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

get_action_parameter_type ()

Packit ae235b

the virtual function pointer for g_action_group_get_action_parameter_type()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

get_action_state_type ()

Packit ae235b

the virtual function pointer for g_action_group_get_action_state_type()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

get_action_state_hint ()

Packit ae235b

the virtual function pointer for g_action_group_get_action_state_hint()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

get_action_state ()

Packit ae235b

the virtual function pointer for g_action_group_get_action_state()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

change_action_state ()

Packit ae235b

the virtual function pointer for g_action_group_change_action_state()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

activate_action ()

Packit ae235b

the virtual function pointer for g_action_group_activate_action()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_added ()

Packit ae235b

the class closure for the “action-added” signal

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_removed ()

Packit ae235b

the class closure for the “action-removed” signal

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_enabled_changed ()

Packit ae235b

the class closure for the “action-enabled-changed” signal

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_state_changed ()

Packit ae235b

the class closure for the “action-enabled-changed” signal

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

query_action ()

Packit ae235b

the virtual function pointer for g_action_group_query_action()

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Signal Details

Packit ae235b
Packit ae235b

The “action-added” signal

Packit ae235b
void
Packit ae235b
user_function (GActionGroup *action_group,
Packit ae235b
               gchar        *action_name,
Packit ae235b
               gpointer      user_data)
Packit ae235b

Signals that a new action was just added to the group.

Packit ae235b
This signal is emitted after the action has been added
Packit ae235b
and is now visible.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

the GActionGroup that changed

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action in action_group

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

user_data

Packit ae235b

user data set when the signal handler was connected.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Flags: Has Details

Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

The “action-enabled-changed” signal

Packit ae235b
void
Packit ae235b
user_function (GActionGroup *action_group,
Packit ae235b
               gchar        *action_name,
Packit ae235b
               gboolean      enabled,
Packit ae235b
               gpointer      user_data)
Packit ae235b

Signals that the enabled status of the named action has changed.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

the GActionGroup that changed

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action in action_group

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

enabled

Packit ae235b

whether the action is enabled or not

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

user_data

Packit ae235b

user data set when the signal handler was connected.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Flags: Has Details

Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

The “action-removed” signal

Packit ae235b
void
Packit ae235b
user_function (GActionGroup *action_group,
Packit ae235b
               gchar        *action_name,
Packit ae235b
               gpointer      user_data)
Packit ae235b

Signals that an action is just about to be removed from the group.

Packit ae235b
This signal is emitted before the action is removed, so the action
Packit ae235b
is still visible and can be queried from the signal handler.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

the GActionGroup that changed

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action in action_group

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

user_data

Packit ae235b

user data set when the signal handler was connected.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Flags: Has Details

Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

The “action-state-changed” signal

Packit ae235b
void
Packit ae235b
user_function (GActionGroup *action_group,
Packit ae235b
               gchar        *action_name,
Packit ae235b
               GVariant     *value,
Packit ae235b
               gpointer      user_data)
Packit ae235b

Signals that the state of the named action has changed.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

action_group

Packit ae235b

the GActionGroup that changed

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

action_name

Packit ae235b

the name of the action in action_group

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

value

Packit ae235b

the new value of the state

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

user_data

Packit ae235b

user data set when the signal handler was connected.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Flags: Has Details

Packit ae235b

Since: 2.28

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

See Also

Packit ae235b

GAction

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Generated by GTK-Doc V1.27
Packit ae235b
</body>
Packit ae235b
</html>