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  * Conversion parameters:
26  * inFile  = GActionMap.html
27  * outPack = gio
28  * outFile = ActionMapIF
29  * strct   = GActionMap
30  * realStrct=
31  * ctorStrct=
32  * clss    = ActionMapT
33  * interf  = ActionMapIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- g_action_map_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- glib.Str
47  * 	- gio.Action
48  * 	- gio.ActionIF
49  * structWrap:
50  * 	- GAction* -> ActionIF
51  * module aliases:
52  * local aliases:
53  * overrides:
54  */
55 
56 module gio.ActionMapIF;
57 
58 public  import gtkc.giotypes;
59 
60 private import gtkc.gio;
61 private import glib.ConstructionException;
62 private import gobject.ObjectG;
63 
64 
65 private import glib.Str;
66 private import gio.Action;
67 private import gio.ActionIF;
68 
69 
70 
71 
72 /**
73  * The GActionMap interface is implemented by GActionGroup
74  * implementations that operate by containing a number of
75  * named GAction instances, such as GSimpleActionGroup.
76  *
77  * One useful application of this interface is to map the
78  * names of actions from various action groups to unique,
79  * prefixed names (e.g. by prepending "app." or "win.").
80  * This is the motivation for the 'Map' part of the interface
81  * name.
82  */
83 public interface ActionMapIF
84 {
85 	
86 	
87 	public GActionMap* getActionMapTStruct();
88 	
89 	/** the main Gtk struct as a void* */
90 	protected void* getStruct();
91 	
92 	
93 	/**
94 	 */
95 	
96 	/**
97 	 * Looks up the action with the name action_name in action_map.
98 	 * If no such action exists, returns NULL.
99 	 * Since 2.32
100 	 * Params:
101 	 * actionName = the name of an action
102 	 * Returns: a GAction, or NULL. [transfer none]
103 	 */
104 	public ActionIF lookupAction(string actionName);
105 	
106 	/**
107 	 * A convenience function for creating multiple GSimpleAction instances
108 	 * and adding them to a GActionMap.
109 	 * Each action is constructed as per one GActionEntry.
110 	 * $(DDOC_COMMENT example)
111 	 * Since 2.32
112 	 * Params:
113 	 * entries = a pointer to
114 	 * the first item in an array of GActionEntry structs. [array length=n_entries][element-type GActionEntry]
115 	 * nEntries = the length of entries, or -1 if entries is NULL-terminated
116 	 * userData = the user data for signal connections
117 	 */
118 	public void addActionEntries(GActionEntry[] entries, void* userData);
119 	
120 	/**
121 	 * Adds an action to the action_map.
122 	 * If the action map already contains an action with the same name
123 	 * as action then the old action is dropped from the action map.
124 	 * The action map takes its own reference on action.
125 	 * Since 2.32
126 	 * Params:
127 	 * action = a GAction
128 	 */
129 	public void addAction(ActionIF action);
130 	
131 	/**
132 	 * Removes the named action from the action map.
133 	 * If no action of this name is in the map then nothing happens.
134 	 * Since 2.32
135 	 * Params:
136 	 * actionName = the name of the action
137 	 */
138 	public void removeAction(string actionName);
139 }