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.CustomFilter; 26 27 private import glib.ConstructionException; 28 private import gobject.ObjectG; 29 private import gtk.Filter; 30 private import gtk.c.functions; 31 public import gtk.c.types; 32 33 34 /** 35 * `GtkCustomFilter` determines whether to include items with a callback. 36 */ 37 public class CustomFilter : Filter 38 { 39 /** the main Gtk struct */ 40 protected GtkCustomFilter* gtkCustomFilter; 41 42 /** Get the main Gtk struct */ 43 public GtkCustomFilter* getCustomFilterStruct(bool transferOwnership = false) 44 { 45 if (transferOwnership) 46 ownedRef = false; 47 return gtkCustomFilter; 48 } 49 50 /** the main Gtk struct as a void* */ 51 protected override void* getStruct() 52 { 53 return cast(void*)gtkCustomFilter; 54 } 55 56 /** 57 * Sets our main struct and passes it to the parent class. 58 */ 59 public this (GtkCustomFilter* gtkCustomFilter, bool ownedRef = false) 60 { 61 this.gtkCustomFilter = gtkCustomFilter; 62 super(cast(GtkFilter*)gtkCustomFilter, ownedRef); 63 } 64 65 66 /** */ 67 public static GType getType() 68 { 69 return gtk_custom_filter_get_type(); 70 } 71 72 /** 73 * Creates a new filter using the given @match_func to filter 74 * items. 75 * 76 * If @match_func is %NULL, the filter matches all items. 77 * 78 * If the filter func changes its filtering behavior, 79 * gtk_filter_changed() needs to be called. 80 * 81 * Params: 82 * matchFunc = function to filter items 83 * userData = user data to pass to @match_func 84 * userDestroy = destroy notify for @user_data 85 * 86 * Returns: a new `GtkCustomFilter` 87 * 88 * Throws: ConstructionException GTK+ fails to create the object. 89 */ 90 public this(GtkCustomFilterFunc matchFunc, void* userData, GDestroyNotify userDestroy) 91 { 92 auto __p = gtk_custom_filter_new(matchFunc, userData, userDestroy); 93 94 if(__p is null) 95 { 96 throw new ConstructionException("null returned by new"); 97 } 98 99 this(cast(GtkCustomFilter*) __p, true); 100 } 101 102 /** 103 * Sets the function used for filtering items. 104 * 105 * If @match_func is %NULL, the filter matches all items. 106 * 107 * If the filter func changes its filtering behavior, 108 * gtk_filter_changed() needs to be called. 109 * 110 * If a previous function was set, its @user_destroy will be 111 * called now. 112 * 113 * Params: 114 * matchFunc = function to filter items 115 * userData = user data to pass to @match_func 116 * userDestroy = destroy notify for @user_data 117 */ 118 public void setFilterFunc(GtkCustomFilterFunc matchFunc, void* userData, GDestroyNotify userDestroy) 119 { 120 gtk_custom_filter_set_filter_func(gtkCustomFilter, matchFunc, userData, userDestroy); 121 } 122 }