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(); 49 50 /** the main Gtk struct as a void* */ 51 protected void* getStruct(); 52 53 /** 54 */ 55 56 /** 57 * Adds an action to the @action_map. 58 * 59 * If the action map already contains an action with the same name 60 * as @action then the old action is dropped from the action map. 61 * 62 * The action map takes its own reference on @action. 63 * 64 * Params: 65 * action = a #GAction 66 * 67 * Since: 2.32 68 */ 69 public void addAction(ActionIF action); 70 71 /** 72 * A convenience function for creating multiple #GSimpleAction instances 73 * and adding them to a #GActionMap. 74 * 75 * Each action is constructed as per one #GActionEntry. 76 * 77 * |[<!-- language="C" --> 78 * static void 79 * activate_quit (GSimpleAction *simple, 80 * GVariant *parameter, 81 * gpointer user_data) 82 * { 83 * exit (0); 84 * } 85 * 86 * static void 87 * activate_print_string (GSimpleAction *simple, 88 * GVariant *parameter, 89 * gpointer user_data) 90 * { 91 * g_print ("%s\n", g_variant_get_string (parameter, NULL)); 92 * } 93 * 94 * static GActionGroup * 95 * create_action_group (void) 96 * { 97 * const GActionEntry entries[] = { 98 * { "quit", activate_quit }, 99 * { "print-string", activate_print_string, "s" } 100 * }; 101 * GSimpleActionGroup *group; 102 * 103 * group = g_simple_action_group_new (); 104 * g_action_map_add_action_entries (G_ACTION_MAP (group), entries, G_N_ELEMENTS (entries), NULL); 105 * 106 * return G_ACTION_GROUP (group); 107 * } 108 * ]| 109 * 110 * Params: 111 * entries = a pointer to 112 * the first item in an array of #GActionEntry structs 113 * nEntries = the length of @entries, or -1 if @entries is %NULL-terminated 114 * userData = the user data for signal connections 115 * 116 * Since: 2.32 117 */ 118 public void addActionEntries(GActionEntry[] entries, void* userData); 119 120 /** 121 * Looks up the action with the name @action_name in @action_map. 122 * 123 * If no such action exists, returns %NULL. 124 * 125 * Params: 126 * actionName = the name of an action 127 * 128 * Return: a #GAction, or %NULL 129 * 130 * Since: 2.32 131 */ 132 public ActionIF lookupAction(string actionName); 133 134 /** 135 * Removes the named action from the action map. 136 * 137 * If no action of this name is in the map then nothing happens. 138 * 139 * Params: 140 * actionName = the name of the action 141 * 142 * Since: 2.32 143 */ 144 public void removeAction(string actionName); 145 }