Module: Gio::ActionMap

Defined in:
lib/gio2/action-map.rb

Overview

GActionMap is an interface for action containers.

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

Instance Method Summary collapse

Instance Method Details

#add_action(action) ⇒ nil

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:

Returns:

  • (nil) 


20
21
22
23
24
 
# File 'lib/gio2/action-map.rb', line 20

def add_action(action)
  action = convert_to_action(action) unless action.is_a?(Action)
  add_action_raw(action)
  actions[action.name] = action
end

#add_action_entries(entries, n_entries, user_data) ⇒ nil

A convenience function for creating multiple GSimple::Action instances and adding them to a GAction::Map.

Each action is constructed as per one GAction::Entry.

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 (Array<Gio::ActionEntry>) —

    a pointer to the first item in an array of GAction::Entry structs

  • n_entries (Integer) —

    the length of entries, or -1 if entries is nil-terminated

  • user_data (GObject) —

    the user data for signal connections

Returns:

  • (nil)

#add_action_raw ⇒ nil

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:

Returns:

  • (nil) 



# File 'lib/gio2/action-map.rb', line 19

#add_actions(actions) ⇒ Object 



32
33
34
35
36
 
# File 'lib/gio2/action-map.rb', line 32

def add_actions(actions)
  actions.each do |action|
    add_action(action)
  end
end

#lookup_action(action_name) ⇒ Gio::Action

Looks up the action with the name action_name in action_map.

If no such action exists, returns nil.

Parameters:

  • action_name (String) —

    the name of an action

Returns:

#remove_action(name) ⇒ nil

Removes the named action from the action map.

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

Parameters:

  • action_name (String) —

    the name of the action

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/gio2/action-map.rb', line 27

def remove_action(name)
  remove_action_raw(name)
  actions.delete(name)
end

#remove_action_entries(entries, n_entries) ⇒ nil

Remove actions from a GAction::Map. This is meant as the reverse of g_action_map_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 (Array<Gio::ActionEntry>) —

    a pointer to the first item in an array of GAction::Entry structs

  • n_entries (Integer) —

    the length of entries, or -1 if entries is nil-terminated

Returns:

  • (nil)

#remove_action_raw ⇒ nil

Removes the named action from the action map.

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

Parameters:

  • action_name (String) —

    the name of the action

Returns:

  • (nil) 



# File 'lib/gio2/action-map.rb', line 26