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.TreeSortableIF; 26 27 private import gobject.Signals; 28 public import gtkc.gdktypes; 29 private import gtkc.gtk; 30 public import gtkc.gtktypes; 31 private import std.algorithm; 32 33 34 /** 35 * #GtkTreeSortable is an interface to be implemented by tree models which 36 * support sorting. The #GtkTreeView uses the methods provided by this interface 37 * to sort the model. 38 */ 39 public interface TreeSortableIF{ 40 /** Get the main Gtk struct */ 41 public GtkTreeSortable* getTreeSortableStruct(); 42 43 /** the main Gtk struct as a void* */ 44 protected void* getStruct(); 45 46 47 /** 48 * Fills in @sort_column_id and @order with the current sort column and the 49 * order. It returns %TRUE unless the @sort_column_id is 50 * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or 51 * %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. 52 * 53 * Params: 54 * sortColumnId = The sort column id to be filled in 55 * order = The #GtkSortType to be filled in 56 * 57 * Return: %TRUE if the sort column is not one of the special sort 58 * column ids. 59 */ 60 public bool getSortColumnId(out int sortColumnId, out GtkSortType order); 61 62 /** 63 * Returns %TRUE if the model has a default sort function. This is used 64 * primarily by GtkTreeViewColumns in order to determine if a model can 65 * go back to the default state, or not. 66 * 67 * Return: %TRUE, if the model has a default sort function 68 */ 69 public bool hasDefaultSortFunc(); 70 71 /** 72 * Sets the default comparison function used when sorting to be @sort_func. 73 * If the current sort column id of @sortable is 74 * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using 75 * this function. 76 * 77 * If @sort_func is %NULL, then there will be no default comparison function. 78 * This means that once the model has been sorted, it can’t go back to the 79 * default state. In this case, when the current sort column id of @sortable 80 * is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. 81 * 82 * Params: 83 * sortFunc = The comparison function 84 * userData = User data to pass to @sort_func, or %NULL 85 * destroy = Destroy notifier of @user_data, or %NULL 86 */ 87 public void setDefaultSortFunc(GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy); 88 89 /** 90 * Sets the current sort column to be @sort_column_id. The @sortable will 91 * resort itself to reflect this change, after emitting a 92 * #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be 93 * a regular column id, or one of the following special values: 94 * 95 * - %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function 96 * will be used, if it is set 97 * 98 * - %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur 99 * 100 * Params: 101 * sortColumnId = the sort column id to set 102 * order = The sort order of the column 103 */ 104 public void setSortColumnId(int sortColumnId, GtkSortType order); 105 106 /** 107 * Sets the comparison function used when sorting to be @sort_func. If the 108 * current sort column id of @sortable is the same as @sort_column_id, then 109 * the model will sort using this function. 110 * 111 * Params: 112 * sortColumnId = the sort column id to set the function for 113 * sortFunc = The comparison function 114 * userData = User data to pass to @sort_func, or %NULL 115 * destroy = Destroy notifier of @user_data, or %NULL 116 */ 117 public void setSortFunc(int sortColumnId, GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy); 118 119 /** 120 * Emits a #GtkTreeSortable::sort-column-changed signal on @sortable. 121 */ 122 public void sortColumnChanged(); 123 /** 124 * The ::sort-column-changed signal is emitted when the sort column 125 * or sort order of @sortable is changed. The signal is emitted before 126 * the contents of @sortable are resorted. 127 */ 128 gulong addOnSortColumnChanged(void delegate(TreeSortableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 129 ; 130 131 }