1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.ActionMapIF;
26 
27 private import gio.Action;
28 private import gio.ActionIF;
29 private import glib.Str;
30 private import gobject.ObjectG;
31 private import gtkc.gio;
32 public  import gtkc.giotypes;
33 
34 
35 /**
36  * The GActionMap interface is implemented by #GActionGroup
37  * implementations that operate by containing a number of
38  * named #GAction instances, such as #GSimpleActionGroup.
39  * 
40  * One useful application of this interface is to map the
41  * names of actions from various action groups to unique,
42  * prefixed names (e.g. by prepending "app." or "win.").
43  * This is the motivation for the 'Map' part of the interface
44  * name.
45  */
46 public interface ActionMapIF{
47 	/** Get the main Gtk struct */
48 	public GActionMap* getActionMapStruct(bool transferOwnership = false);
49 
50 	/** the main Gtk struct as a void* */
51 	protected void* getStruct();
52 
53 
54 	/**
55 	 * Adds an action to the @action_map.
56 	 *
57 	 * If the action map already contains an action with the same name
58 	 * as @action then the old action is dropped from the action map.
59 	 *
60 	 * The action map takes its own reference on @action.
61 	 *
62 	 * Params:
63 	 *     action = a #GAction
64 	 *
65 	 * Since: 2.32
66 	 */
67 	public void addAction(ActionIF action);
68 
69 	/**
70 	 * A convenience function for creating multiple #GSimpleAction instances
71 	 * and adding them to a #GActionMap.
72 	 *
73 	 * Each action is constructed as per one #GActionEntry.
74 	 *
75 	 * |[<!-- language="C" -->
76 	 * static void
77 	 * activate_quit (GSimpleAction *simple,
78 	 * GVariant      *parameter,
79 	 * gpointer       user_data)
80 	 * {
81 	 * exit (0);
82 	 * }
83 	 *
84 	 * static void
85 	 * activate_print_string (GSimpleAction *simple,
86 	 * GVariant      *parameter,
87 	 * gpointer       user_data)
88 	 * {
89 	 * g_print ("%s\n", g_variant_get_string (parameter, NULL));
90 	 * }
91 	 *
92 	 * static GActionGroup *
93 	 * create_action_group (void)
94 	 * {
95 	 * const GActionEntry entries[] = {
96 	 * { "quit",         activate_quit              },
97 	 * { "print-string", activate_print_string, "s" }
98 	 * };
99 	 * GSimpleActionGroup *group;
100 	 *
101 	 * group = g_simple_action_group_new ();
102 	 * g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL);
103 	 *
104 	 * return G_ACTION_GROUP (group);
105 	 * }
106 	 * ]|
107 	 *
108 	 * Params:
109 	 *     entries = a pointer to
110 	 *         the first item in an array of #GActionEntry structs
111 	 *     nEntries = the length of @entries, or -1 if @entries is %NULL-terminated
112 	 *     userData = the user data for signal connections
113 	 *
114 	 * Since: 2.32
115 	 */
116 	public void addActionEntries(GActionEntry[] entries, void* userData);
117 
118 	/**
119 	 * Looks up the action with the name @action_name in @action_map.
120 	 *
121 	 * If no such action exists, returns %NULL.
122 	 *
123 	 * Params:
124 	 *     actionName = the name of an action
125 	 *
126 	 * Returns: a #GAction, or %NULL
127 	 *
128 	 * Since: 2.32
129 	 */
130 	public ActionIF lookupAction(string actionName);
131 
132 	/**
133 	 * Removes the named action from the action map.
134 	 *
135 	 * If no action of this name is in the map then nothing happens.
136 	 *
137 	 * Params:
138 	 *     actionName = the name of the action
139 	 *
140 	 * Since: 2.32
141 	 */
142 	public void removeAction(string actionName);
143 }