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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::TreeSortable Class Reference</h1>A GtkTreeSortable C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="treesortable_8hh-source.html">gfc/gtk/treesortable.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::TreeSortable:
<p><center><img src="classGFC_1_1Gtk_1_1TreeSortable.png" usemap="#GFC::Gtk::TreeSortable_map" border="0" alt=""></center>
<map name="GFC::Gtk::TreeSortable_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="162,112,314,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="162,56,314,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="162,0,314,24">
<area href="classGFC_1_1Gtk_1_1ListStore.html" alt="GFC::Gtk::ListStore" shape="rect" coords="0,224,152,248">
<area href="classGFC_1_1Gtk_1_1TreeModelSort.html" alt="GFC::Gtk::TreeModelSort" shape="rect" coords="162,224,314,248">
<area href="classGFC_1_1Gtk_1_1TreeStore.html" alt="GFC::Gtk::TreeStore" shape="rect" coords="324,224,476,248">
</map>
<a href="classGFC_1_1Gtk_1_1TreeSortable-members.html">List of all members.</a><h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">SortColumnChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z996_2">sort_column_changed_signal</a>
<dl class="el"><dd class="mdescRight">Sort column changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z999_0">sig_sort_column_changed()</a>). <a href="#z996_2"></a><br></dl></ul>
<h2>Public Types</h2>
<ul>
<li>typedef sigc::slot< int, const <br>
<a class="el" href="classGFC_1_1Gtk_1_1TreeModel.html">TreeModel</a> &, const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> &,<br>
const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> & > <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">CompareSlot</a>
<dl class="el"><dd class="mdescRight">Signature of the callback slot to be used for comparing two TreeIter's when sorting. <a href="#w0"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z997_0" doxytag="GFC::Gtk::TreeSortable::gtk_tree_sortable" ></a>
GtkTreeSortable * <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z997_0">gtk_tree_sortable</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTreeSortable structure. <br></dl><li><a class="anchor" name="z997_1" doxytag="GFC::Gtk::TreeSortable::operator GtkTreeSortable *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z997_1">operator GtkTreeSortable *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html">TreeSortable</a> to a GtkTreeSortable pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z997_2">get_sort_column_id</a> (int *sort_column_id, <a class="el" href="namespaceGFC_1_1Gtk.html#a339">SortType</a> *order) const
<dl class="el"><dd class="mdescRight">Fills in <em>sort_column_id</em> and <em>order</em> with the current sort column and the order, if applicable. <a href="#z997_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z997_3">has_default_sort_func</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the model has a default sort function. <a href="#z997_3"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li><a class="anchor" name="z998_0" doxytag="GFC::Gtk::TreeSortable::sort_column_changed" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z998_0">sort_column_changed</a> ()
<dl class="el"><dd class="mdescRight">Emits a "sort_column_changed" signal on the sortable. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z998_1">set_sort_column_id</a> (int sort_column_id, <a class="el" href="namespaceGFC_1_1Gtk.html#a339">SortType</a> order)
<dl class="el"><dd class="mdescRight">Sets the current sort column to be <em>sort_column_id</em>. <a href="#z998_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z998_2">set_sort_func</a> (int sort_column_id, const <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">CompareSlot</a> &compare)
<dl class="el"><dd class="mdescRight">Sets the comparison callback slot used when sorting to be <em>compare</em>. <a href="#z998_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z998_3">set_default_sort_func</a> (const <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">CompareSlot</a> &compare)
<dl class="el"><dd class="mdescRight">Sets the default comparison callback slot used when sorting to be <em>compare</em>. <a href="#z998_3"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z999_0" doxytag="GFC::Gtk::TreeSortable::sig_sort_column_changed" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">SortColumnChangedSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z999_0">sig_sort_column_changed</a> ()
<dl class="el"><dd class="mdescRight">Connect to the sort_column_changed_signal; emitted whenever the current sort column is changed. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z995_0" doxytag="GFC::Gtk::TreeSortable::TreeSortable" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z995_0">TreeSortable</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html">TreeSortable</a> object. <br></dl><li><a class="anchor" name="z995_1" doxytag="GFC::Gtk::TreeSortable::~TreeSortable" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z995_1">~TreeSortable</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTreeSortable C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html">TreeSortable</a> interface defines a generic interface for sorting a model. It is an abstract interface, and is designed to be usable with any derived class. The programmer just has to multiplely inherit this interface on their own model for it to be sortable. To make life easier two generic sortable models are already provided, <a class="el" href="classGFC_1_1Gtk_1_1ListStore.html">ListStore</a> and <a class="el" href="classGFC_1_1Gtk_1_1TreeStore.html">TreeStore</a>.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="GFC::Gtk::TreeSortable::CompareSlot" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef sigc::slot<int, const <a class="el" href="classGFC_1_1Gtk_1_1TreeModel.html">TreeModel</a>&, const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a>&, const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a>&> <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">GFC::Gtk::TreeSortable::CompareSlot</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Signature of the callback slot to be used for comparing two TreeIter's when sorting.
<p>
<b>Example:</b> Method signature for CompareSlot. <div class="fragment"><pre> <span class="keywordtype">int</span> method(<span class="keyword">const</span> TreeModel& model, <span class="keyword">const</span> TreeIter& a, <span class="keyword">const</span> TreeIter& b);
<span class="comment">// model: The TreeModel being sorted.</span>
<span class="comment">// a: A TreeIter.</span>
<span class="comment">// b: Another TreeIter.</span>
<span class="comment">// return: -1 if "a" comes before "b" in the tree, 1 if "a" comes after "b" in</span>
<span class="comment">// the tree and 0 if a and b point to the same location in the tree.</span>
</pre></div> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z997_2" doxytag="GFC::Gtk::TreeSortable::get_sort_column_id" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TreeSortable::get_sort_column_id </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>sort_column_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a339">SortType</a> * </td>
<td class="mdname" nowrap> <em>order</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fills in <em>sort_column_id</em> and <em>order</em> with the current sort column and the order, if applicable.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>sort_column_id</em> </td><td>The sort column id to be filled in. </td></tr>
<tr><td></td><td valign=top><em>order</em> </td><td>The SortType to be filled in. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the sort column has been set.</dd></dl>
<br>
If the sort column is not set, then false is returned, and the values in sort_column_id and order are unchanged. </td>
</tr>
</table>
<a class="anchor" name="z997_3" doxytag="GFC::Gtk::TreeSortable::has_default_sort_func" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TreeSortable::has_default_sort_func </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if the model has a default sort function.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the model has a default sort function.</dd></dl>
<br>
This is used primarily by TreeViewColumns in order to determine if a model can go back to its default state, or not. </td>
</tr>
</table>
<a class="anchor" name="z998_3" doxytag="GFC::Gtk::TreeSortable::set_default_sort_func" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::TreeSortable::set_default_sort_func </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">CompareSlot</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>compare</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the default comparison callback slot used when sorting to be <em>compare</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>compare</em> </td><td>The sorting slot.</td></tr>
</table>
</dl>
<br>
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 <em>compare</em> is null, then there will be no default comparison callback slot. This means that once the model has been sorted, it can't go back to its 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. </td>
</tr>
</table>
<a class="anchor" name="z998_1" doxytag="GFC::Gtk::TreeSortable::set_sort_column_id" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::TreeSortable::set_sort_column_id </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>sort_column_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Gtk.html#a339">SortType</a> </td>
<td class="mdname" nowrap> <em>order</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the current sort column to be <em>sort_column_id</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>sort_column_id</em> </td><td>The sort column id to set. </td></tr>
<tr><td></td><td valign=top><em>order</em> </td><td>The sort order of the column.</td></tr>
</table>
</dl>
<br>
The sortable will resort itself to reflect this change, after emitting a <em>sort_column_changed</em> signal. If <em>sort_column_id</em> is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the default sort function will be used, if it is set. </td>
</tr>
</table>
<a class="anchor" name="z998_2" doxytag="GFC::Gtk::TreeSortable::set_sort_func" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::TreeSortable::set_sort_func </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>sort_column_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#w0">CompareSlot</a> & </td>
<td class="mdname" nowrap> <em>compare</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the comparison callback slot used when sorting to be <em>compare</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>sort_column_id</em> </td><td>The sort column id to set the callback slot for. </td></tr>
<tr><td></td><td valign=top><em>compare</em> </td><td>The sorting slot to call.</td></tr>
</table>
</dl>
<br>
If the current sort column id of sortable is the same as <em>sort_column_id</em>, then the model will sort using this function. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z996_2" doxytag="GFC::Gtk::TreeSortable::sort_column_changed_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">SortColumnChangedSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z996_2">GFC::Gtk::TreeSortable::sort_column_changed_signal</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sort column changed signal (see <a class="el" href="classGFC_1_1Gtk_1_1TreeSortable.html#z999_0">sig_sort_column_changed()</a>).
<p>
Calls a slot with the signature: <div class="fragment"><pre> <span class="keywordtype">void</span> function();
</pre></div> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="treesortable_8hh-source.html">treesortable.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:44 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
