1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::TreeRow Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1TreeRow.html">TreeRow</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> </div>
50
<div class="headertitle">
51
<h1>Gtk::TreeRow Class Reference<div class="ingroups"><a class="el" href="group__TreeView.html">TreeView Classes</a></div></h1> </div>
53
<div class="contents">
54
<!-- doxytag: class="Gtk::TreeRow" --><!-- doxytag: inherits="Gtk::TreeIter" -->
55
<p>Typedefed as <a class="el" href="classGtk_1_1TreeModel.html#a297c9db68905e82fe7c3fac57f6c4de8">TreeModel::Row</a>. <a href="#_details">More...</a></p>
56
<div class="dynheader">
57
Inheritance diagram for Gtk::TreeRow:</div>
58
<div class="dyncontent">
59
<div class="center"><img src="classGtk_1_1TreeRow__inherit__graph.png" border="0" usemap="#Gtk_1_1TreeRow_inherit__map" alt="Inheritance graph"/></div>
60
<map name="Gtk_1_1TreeRow_inherit__map" id="Gtk_1_1TreeRow_inherit__map">
61
<area shape="rect" id="node2" href="classGtk_1_1TreeIter.html" title="A Gtk::TreeModel::iterator is a reference to a specific node on a specific model." alt="" coords="21,86,115,117"/><area shape="rect" id="node4" href="classGtk_1_1TreeIterBase.html" title="Gtk::TreeIterBase" alt="" coords="5,6,131,37"/></map>
62
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
63
<div class="dynheader">
64
Collaboration diagram for Gtk::TreeRow:</div>
65
<div class="dyncontent">
66
<div class="center"><img src="classGtk_1_1TreeRow__coll__graph.png" border="0" usemap="#Gtk_1_1TreeRow_coll__map" alt="Collaboration graph"/></div>
67
<map name="Gtk_1_1TreeRow_coll__map" id="Gtk_1_1TreeRow_coll__map">
68
<area shape="rect" id="node2" href="classGtk_1_1TreeIter.html" title="A Gtk::TreeModel::iterator is a reference to a specific node on a specific model." alt="" coords="21,86,115,117"/><area shape="rect" id="node4" href="classGtk_1_1TreeIterBase.html" title="Gtk::TreeIterBase" alt="" coords="5,6,131,37"/></map>
69
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
71
<p><a href="classGtk_1_1TreeRow-members.html">List of all members.</a></p>
72
<table class="memberdecls">
73
<tr><td colspan="2"><h2><a name="pub-methods"></a>
74
Public Member Functions</h2></td></tr>
75
<tr><td class="memTemplParams" colspan="2">template<class ColumnType > </td></tr>
76
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreeValueProxy.html">TreeValueProxy</a>< ColumnType > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#ad1880375e2c3b45a6ba69b225dd7f6a4">operator[]</a> (const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& column) const </td></tr>
77
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use this to set and get the value of this <em>column</em> of this row. <a href="#ad1880375e2c3b45a6ba69b225dd7f6a4"></a><br/></td></tr>
78
<tr><td class="memTemplParams" colspan="2">template<class ColumnType > </td></tr>
79
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#ae25785fc6de538f6dd632bb434a5f2ff">set_value</a> (const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& column, const ColumnType& data) const </td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of this <em>column</em> of this row. <a href="#ae25785fc6de538f6dd632bb434a5f2ff"></a><br/></td></tr>
81
<tr><td class="memTemplParams" colspan="2">template<class ColumnType > </td></tr>
82
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#abc6ffaec37d8bde03d94c39218390065">set_value</a> (int column, const ColumnType& data) const </td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use set_value(const TreeModelColumn<>& column, const ColumnType& data) unless you do not know the column type at compile-time. <a href="#abc6ffaec37d8bde03d94c39218390065"></a><br/></td></tr>
84
<tr><td class="memTemplParams" colspan="2">template<class ColumnType > </td></tr>
85
<tr><td class="memTemplItemLeft" align="right" valign="top">ColumnType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a193b7d490eed8f7e25aa70d73d746f6a">get_value</a> (const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& column) const </td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of this <em>column</em> of this row. <a href="#a193b7d490eed8f7e25aa70d73d746f6a"></a><br/></td></tr>
87
<tr><td class="memTemplParams" colspan="2">template<class ColumnType > </td></tr>
88
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a9b1db0af89cc50bb0b16a1daf8d5c5e1">get_value</a> (int column, ColumnType& data) const </td></tr>
89
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use get_value(const TreeModelColumn<>& column) unless you do not know the column type at compile-time. <a href="#a9b1db0af89cc50bb0b16a1daf8d5c5e1"></a><br/></td></tr>
90
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classGtk_1_1TreeNodeChildren.html">TreeNodeChildren</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a334dc0b2d96c219e24de467d3fcbd091">children</a> () const </td></tr>
91
<tr><td class="mdescLeft"> </td><td class="mdescRight">This returns an STL-like container API, for iterating over the rows. <a href="#a334dc0b2d96c219e24de467d3fcbd091"></a><br/></td></tr>
92
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1TreeIter.html">TreeIter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a9d55079617fc05a849af189b657e7679">parent</a> () const </td></tr>
93
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an iterator to the parent row of this row. <a href="#a9d55079617fc05a849af189b657e7679"></a><br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a256d9c1def321f1968c2f01299781e14">operator bool</a> () const </td></tr>
95
<tr><td class="mdescLeft"> </td><td class="mdescRight">Discover whether this is a valid row. <a href="#a256d9c1def321f1968c2f01299781e14"></a><br/></td></tr>
96
<tr><td class="memItemLeft" align="right" valign="top">GtkTreeIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#a70f407de60552e0270ed73471ad07cd1">gobj</a> ()</td></tr>
97
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a70f407de60552e0270ed73471ad07cd1"></a><br/></td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top">const GtkTreeIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeRow.html#aabd78b5aa80816c10b49d51f797ce7b7">gobj</a> () const </td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#aabd78b5aa80816c10b49d51f797ce7b7"></a><br/></td></tr>
101
<hr/><a name="_details"></a><h2>Detailed Description</h2>
102
<div class="textblock"><p>Typedefed as <a class="el" href="classGtk_1_1TreeModel.html#a297c9db68905e82fe7c3fac57f6c4de8">TreeModel::Row</a>. </p>
103
<p>Dereference a <a class="el" href="classGtk_1_1TreeModel.html#a754e74cd833ff30e729f9b8d7daf4d8c">TreeModel::iterator</a> to get the Row. Use operator[] or <a class="el" href="classGtk_1_1TreeRow.html#ae25785fc6de538f6dd632bb434a5f2ff" title="Sets the value of this column of this row.">set_value()</a> and <a class="el" href="classGtk_1_1TreeRow.html#a193b7d490eed8f7e25aa70d73d746f6a" title="Gets the value of this column of this row.">get_value()</a> to access the values in the columns of this row.</p>
104
<p>If the model contains a hierarchy of rows (such as <a class="el" href="classGtk_1_1TreeStore.html">Gtk::TreeStore</a>), then you can access the child rows with <a class="el" href="classGtk_1_1TreeRow.html#a334dc0b2d96c219e24de467d3fcbd091" title="This returns an STL-like container API, for iterating over the rows.">children()</a>.</p>
105
<p>You can use a const <a class="el" href="classGtk_1_1TreeModel.html#a297c9db68905e82fe7c3fac57f6c4de8">TreeModel::Row</a>& for any parameter that takes a const <a class="el" href="classGtk_1_1TreeModel.html#a754e74cd833ff30e729f9b8d7daf4d8c">TreeModel::iterator</a>&. </p>
106
</div><hr/><h2>Member Function Documentation</h2>
107
<a class="anchor" id="a334dc0b2d96c219e24de467d3fcbd091"></a><!-- doxytag: member="Gtk::TreeRow::children" ref="a334dc0b2d96c219e24de467d3fcbd091" args="() const " -->
108
<div class="memitem">
109
<div class="memproto">
110
<table class="memname">
112
<td class="memname">const <a class="el" href="classGtk_1_1TreeNodeChildren.html">TreeNodeChildren</a>& Gtk::TreeRow::children </td>
114
<td class="paramname"></td><td>)</td>
121
<p>This returns an STL-like container API, for iterating over the rows. </p>
122
<p>See also <a class="el" href="classGtk_1_1TreeModel.html#a62142e8a5beffb04a2b643d7f62c890f" title="This returns an STL-like container API, for iterating over the rows.">Gtk::TreeModel::children()</a> for the top-level children. </p>
126
<a class="anchor" id="a9b1db0af89cc50bb0b16a1daf8d5c5e1"></a><!-- doxytag: member="Gtk::TreeRow::get_value" ref="a9b1db0af89cc50bb0b16a1daf8d5c5e1" args="(int column, ColumnType &data) const " -->
127
<div class="memitem">
128
<div class="memproto">
129
<div class="memtemplate">
130
template <class ColumnType > </div>
131
<table class="memname">
133
<td class="memname">void Gtk::TreeRow::get_value </td>
135
<td class="paramtype">int </td>
136
<td class="paramname"><em>column</em>, </td>
139
<td class="paramkey"></td>
141
<td class="paramtype">ColumnType & </td>
142
<td class="paramname"><em>data</em> </td>
147
<td></td><td> const</td>
153
<p>Use get_value(const TreeModelColumn<>& column) unless you do not know the column type at compile-time. </p>
154
<p>If the <em>data</em> output argument is of an inappropriate C++ type then this might fail at runtime. </p>
155
<dl><dt><b>Parameters:</b></dt><dd>
156
<table class="params">
157
<tr><td class="paramname">column</td><td>The number of the column whose value you want to change. </td></tr>
161
<dl class="return"><dt><b>Returns:</b></dt><dd>data An output argument which will contain the value of this column of this row. </dd></dl>
165
<a class="anchor" id="a193b7d490eed8f7e25aa70d73d746f6a"></a><!-- doxytag: member="Gtk::TreeRow::get_value" ref="a193b7d490eed8f7e25aa70d73d746f6a" args="(const TreeModelColumn< ColumnType > &column) const " -->
166
<div class="memitem">
167
<div class="memproto">
168
<div class="memtemplate">
169
template <class ColumnType > </div>
170
<table class="memname">
172
<td class="memname">ColumnType Gtk::TreeRow::get_value </td>
174
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& </td>
175
<td class="paramname"><em>column</em></td><td>)</td>
182
<p>Gets the value of this <em>column</em> of this row. </p>
183
<p>This is a templated method, so the compiler will not allow you to provide an inappropriate type of data for the model column.</p>
184
<p>See also operator[].</p>
185
<dl><dt><b>Parameters:</b></dt><dd>
186
<table class="params">
187
<tr><td class="paramname">column</td><td>The model column. </td></tr>
191
<dl class="return"><dt><b>Returns:</b></dt><dd>The new value to use for this column of this row. </dd></dl>
195
<a class="anchor" id="a70f407de60552e0270ed73471ad07cd1"></a><!-- doxytag: member="Gtk::TreeRow::gobj" ref="a70f407de60552e0270ed73471ad07cd1" args="()" -->
196
<div class="memitem">
197
<div class="memproto">
198
<table class="memname">
200
<td class="memname">GtkTreeIter* Gtk::TreeRow::gobj </td>
202
<td class="paramname"></td><td>)</td>
203
<td><code> [inline]</code></td>
209
<p>Provides access to the underlying C GObject. </p>
211
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeIterBase.html#a1479600863c422429b606e26885fc5ef">Gtk::TreeIterBase</a>.</p>
215
<a class="anchor" id="aabd78b5aa80816c10b49d51f797ce7b7"></a><!-- doxytag: member="Gtk::TreeRow::gobj" ref="aabd78b5aa80816c10b49d51f797ce7b7" args="() const " -->
216
<div class="memitem">
217
<div class="memproto">
218
<table class="memname">
220
<td class="memname">const GtkTreeIter* Gtk::TreeRow::gobj </td>
222
<td class="paramname"></td><td>)</td>
223
<td> const<code> [inline]</code></td>
229
<p>Provides access to the underlying C GObject. </p>
231
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeIterBase.html#a0a9ac6f632e297568fa81c67966fb737">Gtk::TreeIterBase</a>.</p>
235
<a class="anchor" id="a256d9c1def321f1968c2f01299781e14"></a><!-- doxytag: member="Gtk::TreeRow::operator bool" ref="a256d9c1def321f1968c2f01299781e14" args="() const " -->
236
<div class="memitem">
237
<div class="memproto">
238
<table class="memname">
240
<td class="memname">Gtk::TreeRow::operator bool </td>
242
<td class="paramname"></td><td>)</td>
249
<p>Discover whether this is a valid row. </p>
251
<p>Reimplemented from <a class="el" href="classGtk_1_1TreeIter.html#a937201ba3ea794fc6442d5069967a214">Gtk::TreeIter</a>.</p>
255
<a class="anchor" id="ad1880375e2c3b45a6ba69b225dd7f6a4"></a><!-- doxytag: member="Gtk::TreeRow::operator[]" ref="ad1880375e2c3b45a6ba69b225dd7f6a4" args="(const TreeModelColumn< ColumnType > &column) const " -->
256
<div class="memitem">
257
<div class="memproto">
258
<div class="memtemplate">
259
template <class ColumnType > </div>
260
<table class="memname">
262
<td class="memname"><a class="el" href="classGtk_1_1TreeValueProxy.html">TreeValueProxy</a><ColumnType> Gtk::TreeRow::operator[] </td>
264
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& </td>
265
<td class="paramname"><em>column</em></td><td>)</td>
266
<td> const<code> [inline]</code></td>
272
<p>Use this to set and get the value of this <em>column</em> of this row. </p>
273
<p>This is a templated method, so the compiler will not allow you to provide an inappropriate type of data for the model column.</p>
274
<p>This is just a more convient syntax that does the same thing as <a class="el" href="classGtk_1_1TreeRow.html#ae25785fc6de538f6dd632bb434a5f2ff" title="Sets the value of this column of this row.">set_value()</a> and <a class="el" href="classGtk_1_1TreeRow.html#a193b7d490eed8f7e25aa70d73d746f6a" title="Gets the value of this column of this row.">get_value()</a>.</p>
275
<dl><dt><b>Parameters:</b></dt><dd>
276
<table class="params">
277
<tr><td class="paramname">column</td><td>The model column.. </td></tr>
284
<a class="anchor" id="a9d55079617fc05a849af189b657e7679"></a><!-- doxytag: member="Gtk::TreeRow::parent" ref="a9d55079617fc05a849af189b657e7679" args="() const " -->
285
<div class="memitem">
286
<div class="memproto">
287
<table class="memname">
289
<td class="memname"><a class="el" href="classGtk_1_1TreeIter.html">TreeIter</a> Gtk::TreeRow::parent </td>
291
<td class="paramname"></td><td>)</td>
298
<p>Gets an iterator to the parent row of this row. </p>
299
<dl class="return"><dt><b>Returns:</b></dt><dd>An iterator to the parent row. </dd></dl>
303
<a class="anchor" id="ae25785fc6de538f6dd632bb434a5f2ff"></a><!-- doxytag: member="Gtk::TreeRow::set_value" ref="ae25785fc6de538f6dd632bb434a5f2ff" args="(const TreeModelColumn< ColumnType > &column, const ColumnType &data) const " -->
304
<div class="memitem">
305
<div class="memproto">
306
<div class="memtemplate">
307
template <class ColumnType > </div>
308
<table class="memname">
310
<td class="memname">void Gtk::TreeRow::set_value </td>
312
<td class="paramtype">const <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumn</a>< ColumnType >& </td>
313
<td class="paramname"><em>column</em>, </td>
316
<td class="paramkey"></td>
318
<td class="paramtype">const ColumnType & </td>
319
<td class="paramname"><em>data</em> </td>
324
<td></td><td> const</td>
330
<p>Sets the value of this <em>column</em> of this row. </p>
331
<p>This is a templated method, so the compiler will not allow you to provide an inappropriate type of <em>data</em> for the model column.</p>
332
<p>See also operator[].</p>
333
<dl><dt><b>Parameters:</b></dt><dd>
334
<table class="params">
335
<tr><td class="paramname">column</td><td>The model column. </td></tr>
336
<tr><td class="paramname">data</td><td>The new value to use for this column of this row. </td></tr>
343
<a class="anchor" id="abc6ffaec37d8bde03d94c39218390065"></a><!-- doxytag: member="Gtk::TreeRow::set_value" ref="abc6ffaec37d8bde03d94c39218390065" args="(int column, const ColumnType &data) const " -->
344
<div class="memitem">
345
<div class="memproto">
346
<div class="memtemplate">
347
template <class ColumnType > </div>
348
<table class="memname">
350
<td class="memname">void Gtk::TreeRow::set_value </td>
352
<td class="paramtype">int </td>
353
<td class="paramname"><em>column</em>, </td>
356
<td class="paramkey"></td>
358
<td class="paramtype">const ColumnType & </td>
359
<td class="paramname"><em>data</em> </td>
364
<td></td><td> const</td>
370
<p>Use set_value(const TreeModelColumn<>& column, const ColumnType& data) unless you do not know the column type at compile-time. </p>
371
<p>If the <em>data</em> is of an inappropriate C++ type then this might fail at runtime. </p>
372
<dl><dt><b>Parameters:</b></dt><dd>
373
<table class="params">
374
<tr><td class="paramname">column</td><td>The number of the column whose value you want to change. </td></tr>
375
<tr><td class="paramname">data</td><td>The new value to use for this column of this row. </td></tr>
382
<hr/>The documentation for this class was generated from the following file:<ul>
383
<li>gtkmm/treeiter.h</li>
386
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:48 for gtkmm by 
387
<a href="http://www.doxygen.org/index.html">
388
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1TreeRow.html
