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)[source]¶

Parameters:: action (Gio.Action) – a 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)[source]¶

Parameters:

entries ([Gio.ActionEntry]) – a pointer to the first item in an array of Gio.ActionEntry structs
user_data (object or None) – the user data for signal connections

A convenience function for creating multiple Gio.SimpleAction instances and adding them to a Gio.ActionMap.

Each action is constructed as per one Gio.ActionEntry.

static void
activate_quit (GSimpleAction *simple,
               GVariant      *parameter,
               gpointer       user_data)
{
  exit (0);
}

static void
activate_print_string (GSimpleAction *simple,
                       GVariant      *parameter,
                       gpointer       user_data)
{
  g_print ("%s\n", g_variant_get_string (parameter, NULL));
}

static GActionGroup *
create_action_group (void)
{
  const GActionEntry entries[] = {
    { "quit",         activate_quit              },
    { "print-string", activate_print_string, "s" }
  };
  GSimpleActionGroup *group;

  group = g_simple_action_group_new ();
  g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL);

  return G_ACTION_GROUP (group);
}

New in version 2.32.

lookup_action(action_name)[source]¶

Parameters:: action_name (str) – the name of an action
Returns:: a Gio.Action, or None
Return type:: Gio.Action or None

Looks up the action with the name action_name in self.

If no such action exists, returns None.

New in version 2.32.

remove_action(action_name)[source]¶

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)[source]¶

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

Remove actions from a Gio.ActionMap. This is meant as the reverse of Gio.ActionMap.add_action_entries().

static const GActionEntry entries[] = {
    { "quit",         activate_quit              },
    { "print-string", activate_print_string, "s" }
};

void
add_actions (GActionMap *map)
{
  g_action_map_add_action_entries (map, entries, G_N_ELEMENTS (entries), NULL);
}

void
remove_actions (GActionMap *map)
{
  g_action_map_remove_action_entries (map, entries, G_N_ELEMENTS (entries));
}

New in version 2.78.

do_add_action(action) virtual¶

Parameters:: action (Gio.Action) – a 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 Gio.Action, or None
Return type:: Gio.Action or None

Looks up the action with the name action_name in action_map.

If no such action exists, returns None.

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.