1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gtk.TreeSortableT;
public import gobject.Signals;
public import gtk.c.functions;
public import gtk.c.types;
public import gtkc.gtktypes;
public import std.algorithm;
/**
* #GtkTreeSortable is an interface to be implemented by tree models which
* support sorting. The #GtkTreeView uses the methods provided by this interface
* to sort the model.
*/
public template TreeSortableT(TStruct)
{
/** Get the main Gtk struct */
public GtkTreeSortable* getTreeSortableStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return cast(GtkTreeSortable*)getStruct();
}
/**
* Fills in @sort_column_id and @order with the current sort column and the
* order. It returns %TRUE unless the @sort_column_id is
* %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or
* %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
*
* Params:
* sortColumnId = The sort column id to be filled in
* order = The #GtkSortType to be filled in
*
* Returns: %TRUE if the sort column is not one of the special sort
* column ids.
*/
public bool getSortColumnId(out int sortColumnId, out GtkSortType order)
{
return gtk_tree_sortable_get_sort_column_id(getTreeSortableStruct(), &sortColumnId, &order) != 0;
}
/**
* Returns %TRUE if the model has a default sort function. This is used
* primarily by GtkTreeViewColumns in order to determine if a model can
* go back to the default state, or not.
*
* Returns: %TRUE, if the model has a default sort function
*/
public bool hasDefaultSortFunc()
{
return gtk_tree_sortable_has_default_sort_func(getTreeSortableStruct()) != 0;
}
/**
* Sets the default comparison function used when sorting to be @sort_func.
* If the current sort column id of @sortable is
* %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using
* this function.
*
* If @sort_func is %NULL, then there will be no default comparison function.
* This means that once the model has been sorted, it can’t go back to the
* default state. In this case, when the current sort column id of @sortable
* is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
*
* Params:
* sortFunc = The comparison function
* userData = User data to pass to @sort_func, or %NULL
* destroy = Destroy notifier of @user_data, or %NULL
*/
public void setDefaultSortFunc(GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy)
{
gtk_tree_sortable_set_default_sort_func(getTreeSortableStruct(), sortFunc, userData, destroy);
}
/**
* Sets the current sort column to be @sort_column_id. The @sortable will
* resort itself to reflect this change, after emitting a
* #GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be
* a regular column id, or one of the following special values:
*
* - %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function
* will be used, if it is set
*
* - %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur
*
* Params:
* sortColumnId = the sort column id to set
* order = The sort order of the column
*/
public void setSortColumnId(int sortColumnId, GtkSortType order)
{
gtk_tree_sortable_set_sort_column_id(getTreeSortableStruct(), sortColumnId, order);
}
/**
* Sets the comparison function used when sorting to be @sort_func. If the
* current sort column id of @sortable is the same as @sort_column_id, then
* the model will sort using this function.
*
* Params:
* sortColumnId = the sort column id to set the function for
* sortFunc = The comparison function
* userData = User data to pass to @sort_func, or %NULL
* destroy = Destroy notifier of @user_data, or %NULL
*/
public void setSortFunc(int sortColumnId, GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy)
{
gtk_tree_sortable_set_sort_func(getTreeSortableStruct(), sortColumnId, sortFunc, userData, destroy);
}
/**
* Emits a #GtkTreeSortable::sort-column-changed signal on @sortable.
*/
public void sortColumnChanged()
{
gtk_tree_sortable_sort_column_changed(getTreeSortableStruct());
}
/**
* The ::sort-column-changed signal is emitted when the sort column
* or sort order of @sortable is changed. The signal is emitted before
* the contents of @sortable are resorted.
*/
gulong addOnSortColumnChanged(void delegate(TreeSortableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
return Signals.connect(this, "sort-column-changed", dlg, connectFlags ^ ConnectFlags.SWAPPED);
}
}
|
