Gio.ActionMap

Implementations:

Gio.Application, Gio.SimpleActionGroup

Methods

	add_action (action)
	add_action_entries (entries, user_data)
	lookup_action (action_name)
	remove_action (action_name)
	remove_action_entries (entries)

Virtual Methods

	do_add_action (action)
	do_lookup_action (action_name)
	do_remove_action (action_name)

Properties

None

Signals

None

Fields

None

Class Details

class Gio.ActionMap

Bases:

GObject.GInterface

Structure:

Gio.ActionMapInterface

GActionMap is an interface for action containers.

The GActionMap interface is implemented by [iface`Gio`.ActionGroup] implementations that operate by containing a number of named [iface`Gio`.Action] instances, such as [class`Gio`.SimpleActionGroup].

One useful application of this interface is to map the names of actions from various action groups to unique, prefixed names (e.g. by prepending “app.” or “win.”). This is the motivation for the ‘Map’ part of the interface name.

New in version 2.32.

add_action(action)

Parameters:

action (Gio.Action) – a [iface`Gio`.Action]

Adds an action to the self.

If the action map already contains an action with the same name as action then the old action is dropped from the action map.

The action map takes its own reference on action.

New in version 2.32.

add_action_entries(entries, user_data)

Parameters:

• entries ([Gio.ActionEntry]) – a pointer to the first item in an array of [struct`Gio`.ActionEntry] structs

• user_data (object or None) – the user data for signal connections

A convenience function for creating multiple [class`Gio`.SimpleAction] instances and adding them to a [iface`Gio`.ActionMap].

Each action is constructed as per one [struct`Gio`.ActionEntry].

```c static void activate_quit (Gio.SimpleAction *simple, GLib.Variant *parameter, object user_data) { exit (0); }

static void activate_print_string (Gio.SimpleAction *simple, GLib.Variant *parameter, object user_data) { g_print (“%s\n”, GLib.Variant.get_string (parameter, None)); }

static Gio.ActionGroup * create_action_group (void) { const Gio.ActionEntry entries[] = { { “quit”, activate_quit }, { “print-string”, activate_print_string, “s” } }; Gio.SimpleActionGroup *group;

group = Gio.SimpleActionGroup.new (); Gio.ActionMap.add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), None);

return G_ACTION_GROUP (group); } ```

New in version 2.32.

lookup_action(action_name)

Parameters:

action_name (str) – the name of an action

Returns:

a [iface`Gio`.Action]

Return type:

Gio.Action or None

Looks up the action with the name action_name in self.

If no such action exists, returns NULL.

New in version 2.32.

remove_action(action_name)

Parameters:

action_name (str) – the name of the action

Removes the named action from the action map.

If no action of this name is in the map then nothing happens.

New in version 2.32.

remove_action_entries(entries)

Parameters:

entries ([Gio.ActionEntry]) – a pointer to the first item in an array of [struct`Gio`.ActionEntry] structs

Remove actions from a [iface`Gio`.ActionMap]. This is meant as the reverse of [method`Gio`.ActionMap.add_action_entries].

```c static const Gio.ActionEntry entries[] = { { “quit”, activate_quit }, { “print-string”, activate_print_string, “s” } };

void add_actions (Gio.ActionMap *map) { Gio.ActionMap.add_action_entries (map, entries, G_N_ELEMENTS (entries), None); }

void remove_actions (Gio.ActionMap *map) { Gio.ActionMap.remove_action_entries (map, entries, G_N_ELEMENTS (entries)); } ```

New in version 2.78.

do_add_action(action) virtual

Parameters:

action (Gio.Action) – a [iface`Gio`.Action]

Adds an action to the action_map.

If the action map already contains an action with the same name as action then the old action is dropped from the action map.

The action map takes its own reference on action.

New in version 2.32.

do_lookup_action(action_name) virtual

Parameters:

action_name (str) – the name of an action

Returns:

a [iface`Gio`.Action]

Return type:

Gio.Action or None

Looks up the action with the name action_name in action_map.

If no such action exists, returns NULL.

New in version 2.32.

do_remove_action(action_name) virtual

Parameters:

action_name (str) – the name of the action

Removes the named action from the action map.

If no action of this name is in the map then nothing happens.

New in version 2.32.