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.CellRendererCombo;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gobject.Signals;
31 private import gtk.CellRenderer;
32 private import gtk.CellRendererText;
33 private import gtk.TreeIter;
34 public  import gtkc.gdktypes;
35 private import gtkc.gtk;
36 public  import gtkc.gtktypes;
37 
38 
39 /**
40  * #GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from
41  * which it is derived. But while #GtkCellRendererText offers a simple entry to
42  * edit the text, #GtkCellRendererCombo offers a #GtkComboBox
43  * widget to edit the text. The values to display in the combo box are taken from
44  * the tree model specified in the #GtkCellRendererCombo:model property.
45  * 
46  * The combo cell renderer takes care of adding a text cell renderer to the combo
47  * box and sets it to display the column specified by its
48  * #GtkCellRendererCombo:text-column property. Further properties of the combo box
49  * can be set in a handler for the #GtkCellRenderer::editing-started signal.
50  * 
51  * The #GtkCellRendererCombo cell renderer was added in GTK+ 2.6.
52  */
53 public class CellRendererCombo : CellRendererText
54 {
55 	/** the main Gtk struct */
56 	protected GtkCellRendererCombo* gtkCellRendererCombo;
57 
58 	/** Get the main Gtk struct */
59 	public GtkCellRendererCombo* getCellRendererComboStruct()
60 	{
61 		return gtkCellRendererCombo;
62 	}
63 
64 	/** the main Gtk struct as a void* */
65 	protected override void* getStruct()
66 	{
67 		return cast(void*)gtkCellRendererCombo;
68 	}
69 
70 	protected override void setStruct(GObject* obj)
71 	{
72 		gtkCellRendererCombo = cast(GtkCellRendererCombo*)obj;
73 		super.setStruct(obj);
74 	}
75 
76 	/**
77 	 * Sets our main struct and passes it to the parent class.
78 	 */
79 	public this (GtkCellRendererCombo* gtkCellRendererCombo, bool ownedRef = false)
80 	{
81 		this.gtkCellRendererCombo = gtkCellRendererCombo;
82 		super(cast(GtkCellRendererText*)gtkCellRendererCombo, ownedRef);
83 	}
84 
85 	/**
86 	 */
87 
88 	public static GType getType()
89 	{
90 		return gtk_cell_renderer_combo_get_type();
91 	}
92 
93 	/**
94 	 * Creates a new #GtkCellRendererCombo.
95 	 * Adjust how text is drawn using object properties.
96 	 * Object properties can be set globally (with g_object_set()).
97 	 * Also, with #GtkTreeViewColumn, you can bind a property to a value
98 	 * in a #GtkTreeModel. For example, you can bind the “text” property
99 	 * on the cell renderer to a string value in the model, thus rendering
100 	 * a different string in each row of the #GtkTreeView.
101 	 *
102 	 * Return: the new cell renderer
103 	 *
104 	 * Since: 2.6
105 	 *
106 	 * Throws: ConstructionException GTK+ fails to create the object.
107 	 */
108 	public this()
109 	{
110 		auto p = gtk_cell_renderer_combo_new();
111 		
112 		if(p is null)
113 		{
114 			throw new ConstructionException("null returned by new");
115 		}
116 		
117 		this(cast(GtkCellRendererCombo*) p);
118 	}
119 
120 	int[string] connectedSignals;
121 
122 	void delegate(string, TreeIter, CellRendererCombo)[] onChangedListeners;
123 	/**
124 	 * This signal is emitted each time after the user selected an item in
125 	 * the combo box, either by using the mouse or the arrow keys.  Contrary
126 	 * to GtkComboBox, GtkCellRendererCombo::changed is not emitted for
127 	 * changes made to a selected item in the entry.  The argument @new_iter
128 	 * corresponds to the newly selected item in the combo box and it is relative
129 	 * to the GtkTreeModel set via the model property on GtkCellRendererCombo.
130 	 *
131 	 * Note that as soon as you change the model displayed in the tree view,
132 	 * the tree view will immediately cease the editing operating.  This
133 	 * means that you most probably want to refrain from changing the model
134 	 * until the combo cell renderer emits the edited or editing_canceled signal.
135 	 *
136 	 * Params:
137 	 *     pathString = a string of the path identifying the edited cell
138 	 *         (relative to the tree view model)
139 	 *     newIter = the new iter selected in the combo box
140 	 *         (relative to the combo box model)
141 	 *
142 	 * Since: 2.14
143 	 */
144 	void addOnChanged(void delegate(string, TreeIter, CellRendererCombo) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
145 	{
146 		if ( "changed" !in connectedSignals )
147 		{
148 			Signals.connectData(
149 				this,
150 				"changed",
151 				cast(GCallback)&callBackChanged,
152 				cast(void*)this,
153 				null,
154 				connectFlags);
155 			connectedSignals["changed"] = 1;
156 		}
157 		onChangedListeners ~= dlg;
158 	}
159 	extern(C) static void callBackChanged(GtkCellRendererCombo* cellrenderercomboStruct, char* pathString, GtkTreeIter* newIter, CellRendererCombo _cellrenderercombo)
160 	{
161 		foreach ( void delegate(string, TreeIter, CellRendererCombo) dlg; _cellrenderercombo.onChangedListeners )
162 		{
163 			dlg(Str.toString(pathString), ObjectG.getDObject!(TreeIter)(newIter), _cellrenderercombo);
164 		}
165 	}
166 }