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.SelectionFilterModel; 26 27 private import gio.ListModelIF; 28 private import gio.ListModelT; 29 private import glib.ConstructionException; 30 private import gobject.ObjectG; 31 private import gtk.SelectionModelIF; 32 private import gtk.c.functions; 33 public import gtk.c.types; 34 35 36 /** 37 * `GtkSelectionFilterModel` is a list model that presents the selection from 38 * a `GtkSelectionModel`. 39 */ 40 public class SelectionFilterModel : ObjectG, ListModelIF 41 { 42 /** the main Gtk struct */ 43 protected GtkSelectionFilterModel* gtkSelectionFilterModel; 44 45 /** Get the main Gtk struct */ 46 public GtkSelectionFilterModel* getSelectionFilterModelStruct(bool transferOwnership = false) 47 { 48 if (transferOwnership) 49 ownedRef = false; 50 return gtkSelectionFilterModel; 51 } 52 53 /** the main Gtk struct as a void* */ 54 protected override void* getStruct() 55 { 56 return cast(void*)gtkSelectionFilterModel; 57 } 58 59 /** 60 * Sets our main struct and passes it to the parent class. 61 */ 62 public this (GtkSelectionFilterModel* gtkSelectionFilterModel, bool ownedRef = false) 63 { 64 this.gtkSelectionFilterModel = gtkSelectionFilterModel; 65 super(cast(GObject*)gtkSelectionFilterModel, ownedRef); 66 } 67 68 // add the ListModel capabilities 69 mixin ListModelT!(GtkSelectionFilterModel); 70 71 72 /** */ 73 public static GType getType() 74 { 75 return gtk_selection_filter_model_get_type(); 76 } 77 78 /** 79 * Creates a new `GtkSelectionFilterModel` that will include the 80 * selected items from the underlying selection model. 81 * 82 * Params: 83 * model = the selection model to filter, or %NULL 84 * 85 * Returns: a new `GtkSelectionFilterModel` 86 * 87 * Throws: ConstructionException GTK+ fails to create the object. 88 */ 89 public this(SelectionModelIF model) 90 { 91 auto __p = gtk_selection_filter_model_new((model is null) ? null : model.getSelectionModelStruct()); 92 93 if(__p is null) 94 { 95 throw new ConstructionException("null returned by new"); 96 } 97 98 this(cast(GtkSelectionFilterModel*) __p, true); 99 } 100 101 /** 102 * Gets the model currently filtered or %NULL if none. 103 * 104 * Returns: The model that gets filtered 105 */ 106 public SelectionModelIF getModel() 107 { 108 auto __p = gtk_selection_filter_model_get_model(gtkSelectionFilterModel); 109 110 if(__p is null) 111 { 112 return null; 113 } 114 115 return ObjectG.getDObject!(SelectionModelIF)(cast(GtkSelectionModel*) __p); 116 } 117 118 /** 119 * Sets the model to be filtered. 120 * 121 * Note that GTK makes no effort to ensure that @model conforms to 122 * the item type of @self. It assumes that the caller knows what they 123 * are doing and have set up an appropriate filter to ensure that item 124 * types match. 125 * 126 * Params: 127 * model = The model to be filtered 128 */ 129 public void setModel(SelectionModelIF model) 130 { 131 gtk_selection_filter_model_set_model(gtkSelectionFilterModel, (model is null) ? null : model.getSelectionModelStruct()); 132 } 133 }