gtk.CellRendererCombo source code

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