Gio.ActionMap

g GObject.GInterface GObject.GInterface Gio.ActionMap Gio.ActionMap GObject.GInterface->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)

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

The Gio.ActionMap interface is implemented by Gio.ActionGroup implementations that operate by containing a number of named Gio.Action instances, such as 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:

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

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.

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

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.