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.ReadOnlyListModel;
20 
21 private import dazzle.c.functions;
22 public  import dazzle.c.types;
23 private import gio.ListModelIF;
24 private import gio.ListModelT;
25 private import glib.ConstructionException;
26 private import gobject.ObjectG;
27 
28 
29 /** */
30 public class ReadOnlyListModel : ObjectG, ListModelIF
31 {
32 	/** the main Gtk struct */
33 	protected DzlReadOnlyListModel* dzlReadOnlyListModel;
34 
35 	/** Get the main Gtk struct */
36 	public DzlReadOnlyListModel* getReadOnlyListModelStruct(bool transferOwnership = false)
37 	{
38 		if (transferOwnership)
39 			ownedRef = false;
40 		return dzlReadOnlyListModel;
41 	}
42 
43 	/** the main Gtk struct as a void* */
44 	protected override void* getStruct()
45 	{
46 		return cast(void*)dzlReadOnlyListModel;
47 	}
48 
49 	/**
50 	 * Sets our main struct and passes it to the parent class.
51 	 */
52 	public this (DzlReadOnlyListModel* dzlReadOnlyListModel, bool ownedRef = false)
53 	{
54 		this.dzlReadOnlyListModel = dzlReadOnlyListModel;
55 		super(cast(GObject*)dzlReadOnlyListModel, ownedRef);
56 	}
57 
58 	// add the ListModel capabilities
59 	mixin ListModelT!(DzlReadOnlyListModel);
60 
61 
62 	/** */
63 	public static GType getType()
64 	{
65 		return dzl_read_only_list_model_get_type();
66 	}
67 
68 	/**
69 	 * Creates a new #DzlReadOnlyListModel which is a read-only wrapper around
70 	 * @base_model. This is useful when you want to give API consumers access to
71 	 * a #GListModel but without the ability to mutate the underlying list.
72 	 *
73 	 * Params:
74 	 *     baseModel = a #GListModel
75 	 *
76 	 * Returns: a #DzlReadOnlyListModel
77 	 *
78 	 * Since: 3.30
79 	 *
80 	 * Throws: ConstructionException GTK+ fails to create the object.
81 	 */
82 	public this(ListModelIF baseModel)
83 	{
84 		auto p = dzl_read_only_list_model_new((baseModel is null) ? null : baseModel.getListModelStruct());
85 
86 		if(p is null)
87 		{
88 			throw new ConstructionException("null returned by new");
89 		}
90 
91 		this(cast(DzlReadOnlyListModel*) p, true);
92 	}
93 }