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.ActionableIF;
26 
27 private import glib.Str;
28 private import glib.Variant;
29 private 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 interface ActionableIF{
48 	/** Get the main Gtk struct */
49 	public GtkActionable* getActionableStruct(bool transferOwnership = false);
50 
51 	/** the main Gtk struct as a void* */
52 	protected void* getStruct();
53 
54 
55 	/**
56 	 * Gets the action name for @actionable.
57 	 *
58 	 * See gtk_actionable_set_action_name() for more information.
59 	 *
60 	 * Returns: the action name, or %NULL if none is set
61 	 *
62 	 * Since: 3.4
63 	 */
64 	public string getActionName();
65 
66 	/**
67 	 * Gets the current target value of @actionable.
68 	 *
69 	 * See gtk_actionable_set_action_target_value() for more information.
70 	 *
71 	 * Returns: the current target value
72 	 *
73 	 * Since: 3.4
74 	 */
75 	public Variant getActionTargetValue();
76 
77 	/**
78 	 * Specifies the name of the action with which this widget should be
79 	 * associated.  If @action_name is %NULL then the widget will be
80 	 * unassociated from any previous action.
81 	 *
82 	 * Usually this function is used when the widget is located (or will be
83 	 * located) within the hierarchy of a #GtkApplicationWindow.
84 	 *
85 	 * Names are of the form “win.save” or “app.quit” for actions on the
86 	 * containing #GtkApplicationWindow or its associated #GtkApplication,
87 	 * respectively.  This is the same form used for actions in the #GMenu
88 	 * associated with the window.
89 	 *
90 	 * Params:
91 	 *     actionName = an action name, or %NULL
92 	 *
93 	 * Since: 3.4
94 	 */
95 	public void setActionName(string actionName);
96 
97 	/**
98 	 * Sets the target value of an actionable widget.
99 	 *
100 	 * If @target_value is %NULL then the target value is unset.
101 	 *
102 	 * The target value has two purposes.  First, it is used as the
103 	 * parameter to activation of the action associated with the
104 	 * #GtkActionable widget. Second, it is used to determine if the widget
105 	 * should be rendered as “active” — the widget is active if the state
106 	 * is equal to the given target.
107 	 *
108 	 * Consider the example of associating a set of buttons with a #GAction
109 	 * with string state in a typical “radio button” situation.  Each button
110 	 * will be associated with the same action, but with a different target
111 	 * value for that action.  Clicking on a particular button will activate
112 	 * the action with the target of that button, which will typically cause
113 	 * the action’s state to change to that value.  Since the action’s state
114 	 * is now equal to the target value of the button, the button will now
115 	 * be rendered as active (and the other buttons, with different targets,
116 	 * rendered inactive).
117 	 *
118 	 * Params:
119 	 *     targetValue = a #GVariant to set as the target value, or %NULL
120 	 *
121 	 * Since: 3.4
122 	 */
123 	public void setActionTargetValue(Variant targetValue);
124 
125 	/**
126 	 * Sets the action-name and associated string target value of an
127 	 * actionable widget.
128 	 *
129 	 * This allows for the effect of both gtk_actionable_set_action_name()
130 	 * and gtk_actionable_set_action_target_value() in the common case that
131 	 * the target is string-valued.
132 	 *
133 	 * @detailed_action_name is a string of the form
134 	 * `"action::target"` where `action`
135 	 * is the action name and `target` is the string to use
136 	 * as the target.
137 	 *
138 	 * Params:
139 	 *     detailedActionName = the detailed action name
140 	 *
141 	 * Since: 3.4
142 	 */
143 	public void setDetailedActionName(string detailedActionName);
144 }