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
|
<!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::TreeIter Class Reference</h1>A GtkTreeIter C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="treemodel_8hh-source.html">gfc/gtk/treemodel.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::TreeIter:
<p><center><img src="classGFC_1_1Gtk_1_1TreeIter.png" usemap="#GFC::Gtk::TreeIter_map" border="0" alt=""></center>
<map name="GFC::Gtk::TreeIter_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html" alt="GFC::G::Boxed" shape="rect" coords="0,112,112,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,112,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,112,24">
</map>
<a href="classGFC_1_1Gtk_1_1TreeIter-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z969_0" doxytag="GFC::Gtk::TreeIter::TreeIter" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_0">TreeIter</a> ()
<dl class="el"><dd class="mdescRight">Construct an properly initialized tree iterator. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_1">TreeIter</a> (GtkTreeIter *iter)
<dl class="el"><dd class="mdescRight">Construct a new tree iterator from an existing GtkTreeIter. <a href="#z969_1"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_2">TreeIter</a> (GtkTreeIter *iter, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z5_0">copy</a>)
<dl class="el"><dd class="mdescRight">Construct a new text iterator from an existing GtkTreeIter. <a href="#z969_2"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_3">TreeIter</a> (const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#z969_3"></a><br></dl><li><a class="anchor" name="z969_4" doxytag="GFC::Gtk::TreeIter::~TreeIter" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_4">~TreeIter</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> & <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z969_5">operator=</a> (const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#z969_5"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z970_0" doxytag="GFC::Gtk::TreeIter::gtk_tree_iter" ></a>
GtkTreeIter * <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z970_0">gtk_tree_iter</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTreeIter structure. <br></dl><li><a class="anchor" name="z970_1" doxytag="GFC::Gtk::TreeIter::operator GtkTreeIter *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html#z970_1">operator GtkTreeIter *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> to a GtkTreeIter pointer. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTreeIter C++ wrapper class.
<p>
A <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> is a reference to a specific node on a specific model. It is a generic class with an integer and three generic pointers. These are filled in by the model in a model-specific way. One can convert a path to an iterator by calling <a class="el" href="classGFC_1_1Gtk_1_1TreeModel.html#z973_5">Gtk::TreeModel::get_iter()</a>. These iterators are the primary way of accessing a model and are similar to the iterators used by <a class="el" href="classGFC_1_1Gtk_1_1TextBuffer.html">TextBuffer</a>. They are generally statically allocated on the heap and only used for a short time. The <a class="el" href="classGFC_1_1Gtk_1_1TreeModel.html">TreeModel</a> interface defines a set of operations using them for navigating the model.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z969_1" doxytag="GFC::Gtk::TreeIter::TreeIter" ></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"> GFC::Gtk::TreeIter::TreeIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkTreeIter * </td>
<td class="mdname1" valign="top" nowrap> <em>iter</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new tree iterator from an existing GtkTreeIter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>iter</em> </td><td>A pointer to a GtkTreeIter.</td></tr>
</table>
</dl>
<br>
The <em>iter</em> can be a newly created GtkTreeIter or an existing GtkTreeIter. The <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> object created is a temporary object. It doesn't take over the ownership of GtkTreeIter and GtkTreeIter is not freed by the destructor. </td>
</tr>
</table>
<a class="anchor" name="z969_2" doxytag="GFC::Gtk::TreeIter::TreeIter" ></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"> GFC::Gtk::TreeIter::TreeIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkTreeIter * </td>
<td class="mdname" nowrap> <em>iter</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>copy</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>
Construct a new text iterator from an existing GtkTreeIter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>iter</em> </td><td>A pointer to a GtkTreeIter. </td></tr>
<tr><td></td><td valign=top><em>copy</em> </td><td>Whether the <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> object should make a copy of GtkTreeIter or not.</td></tr>
</table>
</dl>
<br>
The <em>iter</em> can be a newly created GtkTreeIter or an existing GtkTreeIter. If <em>copy</em> is true <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> will make a copy of GtkTreeIter. If <em>copy</em> is false <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> wont make a copy but instead takes over the ownership of GtkTreeIter. Either way, the destructor will free GtkTreeIter when the <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> object is destroyed. This constructor is used by <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z6_0">G::Boxed::wrap()</a> to wrap GtkTreeIter objects in a C++ wrapper. </td>
</tr>
</table>
<a class="anchor" name="z969_3" doxytag="GFC::Gtk::TreeIter::TreeIter" ></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"> GFC::Gtk::TreeIter::TreeIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</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>
Copy constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>src</em> </td><td>The source tree iterator. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z969_5" doxytag="GFC::Gtk::TreeIter::operator=" ></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"> <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a>& GFC::Gtk::TreeIter::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1TreeIter.html">TreeIter</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</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>
Assignment operator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>src</em> </td><td>The source tree iterator. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="treemodel_8hh-source.html">treemodel.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:43 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>
|
