dazzle.ListBox source code

1 /*
2  * This file is part of d-dazzle.
3  *
4  * d-dazzle 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  * d-dazzle 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 d-dazzle; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 module dazzle.ListBox;
20 
21 private import dazzle.c.functions;
22 public  import dazzle.c.types;
23 private import gio.ListModelIF;
24 private import glib.ConstructionException;
25 private import glib.Str;
26 private import gobject.ObjectG;
27 private import gtk.BuildableIF;
28 private import gtk.BuildableT;
29 private import gtk.ListBox : GtkListBoxEx = ListBox;
30 private import gtk.Widget;
31 
32 
33 /** */
34 public class ListBox : GtkListBoxEx
35 {
36 	/** the main Gtk struct */
37 	protected DzlListBox* dzlListBox;
38 
39 	/** Get the main Gtk struct */
40 	public DzlListBox* getDazzleListBoxStruct(bool transferOwnership = false)
41 	{
42 		if (transferOwnership)
43 			ownedRef = false;
44 		return dzlListBox;
45 	}
46 
47 	/** the main Gtk struct as a void* */
48 	protected override void* getStruct()
49 	{
50 		return cast(void*)dzlListBox;
51 	}
52 
53 	/**
54 	 * Sets our main struct and passes it to the parent class.
55 	 */
56 	public this (DzlListBox* dzlListBox, bool ownedRef = false)
57 	{
58 		this.dzlListBox = dzlListBox;
59 		super(cast(GtkListBox*)dzlListBox, ownedRef);
60 	}
61 
62 
63 	/** */
64 	public static GType getType()
65 	{
66 		return dzl_list_box_get_type();
67 	}
68 
69 	/** */
70 	public this(GType rowType, string propertyName)
71 	{
72 		auto p = dzl_list_box_new(rowType, Str.toStringz(propertyName));
73 
74 		if(p is null)
75 		{
76 			throw new ConstructionException("null returned by new");
77 		}
78 
79 		this(cast(DzlListBox*) p);
80 	}
81 
82 	/**
83 	 * Returns: A #GListModel or %NULL.
84 	 */
85 	public ListModelIF getModel()
86 	{
87 		auto p = dzl_list_box_get_model(dzlListBox);
88 
89 		if(p is null)
90 		{
91 			return null;
92 		}
93 
94 		return ObjectG.getDObject!(ListModelIF)(cast(GListModel*) p);
95 	}
96 
97 	/** */
98 	public string getPropertyName()
99 	{
100 		return Str.toString(dzl_list_box_get_property_name(dzlListBox));
101 	}
102 
103 	/** */
104 	public GType getRowType()
105 	{
106 		return dzl_list_box_get_row_type(dzlListBox);
107 	}
108 
109 	/** */
110 	public void setModel(ListModelIF model)
111 	{
112 		dzl_list_box_set_model(dzlListBox, (model is null) ? null : model.getListModelStruct());
113 	}
114 
115 	/**
116 	 * Sets the max number of rows to cache for reuse.  Set to 0 to return
117 	 * to the default.
118 	 *
119 	 * Params:
120 	 *     recycleMax = max number of rows to cache
121 	 *
122 	 * Since: 3.28
123 	 */
124 	public void setRecycleMax(uint recycleMax)
125 	{
126 		dzl_list_box_set_recycle_max(dzlListBox, recycleMax);
127 	}
128 }