Gio.ActionMap¶

interface

GActionMap is an interface for action containers.

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

Methods¶

add_action¶

def add_action(self, action: Action) -> None

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.

Parameters:

action — a Action

add_action_entries¶

def add_action_entries(self, entries: list[ActionEntry], user_data: int | None = ...) -> None

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

Each action is constructed as per one 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);
}

Parameters:

entries — a pointer to the first item in an array of ActionEntry structs
user_data — the user data for signal connections

lookup_action¶

def lookup_action(self, action_name: str) -> Action | None

Looks up the action with the name action_name in action_map.

If no such action exists, returns NULL.

Parameters:

action_name — the name of an action

remove_action¶

def remove_action(self, action_name: str) -> None

Removes the named action from the action map.

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

Parameters:

action_name — the name of the action

remove_action_entries¶

def remove_action_entries(self, entries: list[ActionEntry]) -> None

Remove actions from a ActionMap. This is meant as the reverse of 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));
}

Parameters:

entries — a pointer to the first item in an array of ActionEntry structs

Virtual methods¶

do_add_action¶

def do_add_action(self, action: Action) -> None

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.

Parameters:

action — a Action

do_lookup_action¶

def do_lookup_action(self, action_name: str) -> Action | None

Looks up the action with the name action_name in action_map.

If no such action exists, returns NULL.

Parameters:

action_name — the name of an action

do_remove_action¶

def do_remove_action(self, action_name: str) -> None

Removes the named action from the action map.

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

Parameters:

action_name — the name of the action