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 gtk.ActionableT;
26 
27 public  import glib.Str;
28 public  import glib.Variant;
29 public  import gtkc.gtk;
30 public  import gtkc.gtktypes;
31 
32 
33 /**
34  * This interface provides a convenient way of associating widgets with
35  * actions on a #GtkApplicationWindow or #GtkApplication.
36  * 
37  * It primarily consists of two properties: #GtkActionable:action-name
38  * and #GtkActionable:action-target. There are also some convenience APIs
39  * for setting these properties.
40  * 
41  * The action will be looked up in action groups that are found among
42  * the widgets ancestors. Most commonly, these will be the actions with
43  * the “win.” or “app.” prefix that are associated with the #GtkApplicationWindow
44  * or #GtkApplication, but other action groups that are added with
45  * gtk_widget_insert_action_group() will be consulted as well.
46  */
47 public template ActionableT(TStruct)
48 {
49 	/** Get the main Gtk struct */
50 	public GtkActionable* getActionableStruct(bool transferOwnership = false)
51 	{
52 		if (transferOwnership)
53 			ownedRef = false;
54 		return cast(GtkActionable*)getStruct();
55 	}
56 
57 
58 	/**
59 	 * Gets the action name for @actionable.
60 	 *
61 	 * See gtk_actionable_set_action_name() for more information.
62 	 *
63 	 * Returns: the action name, or %NULL if none is set
64 	 *
65 	 * Since: 3.4
66 	 */
67 	public string getActionName()
68 	{
69 		return Str.toString(gtk_actionable_get_action_name(getActionableStruct()));
70 	}
71 
72 	/**
73 	 * Gets the current target value of @actionable.
74 	 *
75 	 * See gtk_actionable_set_action_target_value() for more information.
76 	 *
77 	 * Returns: the current target value
78 	 *
79 	 * Since: 3.4
80 	 */
81 	public Variant getActionTargetValue()
82 	{
83 		auto p = gtk_actionable_get_action_target_value(getActionableStruct());
84 		
85 		if(p is null)
86 		{
87 			return null;
88 		}
89 		
90 		return new Variant(cast(GVariant*) p);
91 	}
92 
93 	/**
94 	 * Specifies the name of the action with which this widget should be
95 	 * associated.  If @action_name is %NULL then the widget will be
96 	 * unassociated from any previous action.
97 	 *
98 	 * Usually this function is used when the widget is located (or will be
99 	 * located) within the hierarchy of a #GtkApplicationWindow.
100 	 *
101 	 * Names are of the form “win.save” or “app.quit” for actions on the
102 	 * containing #GtkApplicationWindow or its associated #GtkApplication,
103 	 * respectively.  This is the same form used for actions in the #GMenu
104 	 * associated with the window.
105 	 *
106 	 * Params:
107 	 *     actionName = an action name, or %NULL
108 	 *
109 	 * Since: 3.4
110 	 */
111 	public void setActionName(string actionName)
112 	{
113 		gtk_actionable_set_action_name(getActionableStruct(), Str.toStringz(actionName));
114 	}
115 
116 	/**
117 	 * Sets the target value of an actionable widget.
118 	 *
119 	 * If @target_value is %NULL then the target value is unset.
120 	 *
121 	 * The target value has two purposes.  First, it is used as the
122 	 * parameter to activation of the action associated with the
123 	 * #GtkActionable widget. Second, it is used to determine if the widget
124 	 * should be rendered as “active” — the widget is active if the state
125 	 * is equal to the given target.
126 	 *
127 	 * Consider the example of associating a set of buttons with a #GAction
128 	 * with string state in a typical “radio button” situation.  Each button
129 	 * will be associated with the same action, but with a different target
130 	 * value for that action.  Clicking on a particular button will activate
131 	 * the action with the target of that button, which will typically cause
132 	 * the action’s state to change to that value.  Since the action’s state
133 	 * is now equal to the target value of the button, the button will now
134 	 * be rendered as active (and the other buttons, with different targets,
135 	 * rendered inactive).
136 	 *
137 	 * Params:
138 	 *     targetValue = a #GVariant to set as the target value, or %NULL
139 	 *
140 	 * Since: 3.4
141 	 */
142 	public void setActionTargetValue(Variant targetValue)
143 	{
144 		gtk_actionable_set_action_target_value(getActionableStruct(), (targetValue is null) ? null : targetValue.getVariantStruct());
145 	}
146 
147 	/**
148 	 * Sets the action-name and associated string target value of an
149 	 * actionable widget.
150 	 *
151 	 * This allows for the effect of both gtk_actionable_set_action_name()
152 	 * and gtk_actionable_set_action_target_value() in the common case that
153 	 * the target is string-valued.
154 	 *
155 	 * @detailed_action_name is a string of the form
156 	 * `"action::target"` where `action`
157 	 * is the action name and `target` is the string to use
158 	 * as the target.
159 	 *
160 	 * Params:
161 	 *     detailedActionName = the detailed action name
162 	 *
163 	 * Since: 3.4
164 	 */
165 	public void setDetailedActionName(string detailedActionName)
166 	{
167 		gtk_actionable_set_detailed_action_name(getActionableStruct(), Str.toStringz(detailedActionName));
168 	}
169 }