<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>gtkmm: Gtk::TreeModelColumnRecord Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">gtkmm  <span id="projectnumber">3.10.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a></li><li class="navelem"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html">TreeModelColumnRecord</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classGtk_1_1TreeModelColumnRecord-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Gtk::TreeModelColumnRecord Class Reference<div class="ingroups"><a class="el" href="group__TreeView.html">TreeView Classes</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Typedefed as <a class="el" href="classGtk_1_1TreeModel.html#a58f10daabaa507b4c2473c9d1b6fa584">TreeModel::ColumnRecord</a>. <a href="classGtk_1_1TreeModelColumnRecord.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for Gtk::TreeModelColumnRecord:</div> <div class="dyncontent"> <div class="center"><img src="classGtk_1_1TreeModelColumnRecord__inherit__graph.png" border="0" usemap="#Gtk_1_1TreeModelColumnRecord_inherit__map" alt="Inheritance graph"/></div> <map name="Gtk_1_1TreeModelColumnRecord_inherit__map" id="Gtk_1_1TreeModelColumnRecord_inherit__map"> <area shape="rect" id="node2" href="classGtk_1_1ListViewText_1_1TextModelColumns.html" title="Gtk::ListViewText::\lTextModelColumns" alt="" coords="39,81,180,122"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:af0c1c552400694ad0d7e5695f8868d78"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#af0c1c552400694ad0d7e5695f8868d78">TreeModelColumnRecord</a> ()</td></tr> <tr class="separator:af0c1c552400694ad0d7e5695f8868d78"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ebe61558fecbcf761ee01f5ec8c0312"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#a3ebe61558fecbcf761ee01f5ec8c0312">~TreeModelColumnRecord</a> ()</td></tr> <tr class="separator:a3ebe61558fecbcf761ee01f5ec8c0312"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7084fc10fa1abf0d7317558b8462559f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f">add</a> (<a class="el" href="classGtk_1_1TreeModelColumnBase.html">TreeModelColumnBase</a>& column)</td></tr> <tr class="memdesc:a7084fc10fa1abf0d7317558b8462559f"><td class="mdescLeft"> </td><td class="mdescRight">Adds a <a class="el" href="classGtk_1_1TreeModelColumn.html" title="A Gtk::TreeModelColumn describes the C++ type of the data in a model column, and identifies that colu...">TreeModelColumn</a> to this record. <a href="#a7084fc10fa1abf0d7317558b8462559f">More...</a><br/></td></tr> <tr class="separator:a7084fc10fa1abf0d7317558b8462559f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a024f6f44405b1f1c61a7e85d41dafe7d"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#a024f6f44405b1f1c61a7e85d41dafe7d">size</a> () const </td></tr> <tr class="separator:a024f6f44405b1f1c61a7e85d41dafe7d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af56c98a2bce96003a281b4cd831f1139"><td class="memItemLeft" align="right" valign="top">const GType* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#af56c98a2bce96003a281b4cd831f1139">types</a> () const </td></tr> <tr class="separator:af56c98a2bce96003a281b4cd831f1139"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Typedefed as <a class="el" href="classGtk_1_1TreeModel.html#a58f10daabaa507b4c2473c9d1b6fa584">TreeModel::ColumnRecord</a>. </p> <p>Keeps a record of <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumns</a>.</p> <p>ColumnRecord objects are used to setup a new instance of a <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">TreeModel</a> (or rather, a new instance of an implementation of the model, such as <a class="el" href="classGtk_1_1ListStore.html" title="Thist is a list model for use with a Gtk::TreeView widget.">Gtk::ListStore</a> or <a class="el" href="classGtk_1_1TreeStore.html">Gtk::TreeStore</a>). It is convenient to do that by deriving from <a class="el" href="classGtk_1_1TreeModel.html#a58f10daabaa507b4c2473c9d1b6fa584">TreeModel::ColumnRecord</a>: </p> <div class="fragment"><div class="line"><span class="keyword">class </span>MyModelColumns : <span class="keyword">public</span> <a class="code" href="classGtk_1_1TreeModelColumnRecord.html" title="Typedefed as TreeModel::ColumnRecord.">Gtk::TreeModel::ColumnRecord</a></div> <div class="line">{</div> <div class="line"><span class="keyword">public</span>:</div> <div class="line"> <a class="code" href="classGtk_1_1TreeModelColumn.html">Gtk::TreeModelColumn<Glib::ustring></a> filename;</div> <div class="line"> <a class="code" href="classGtk_1_1TreeModelColumn.html">Gtk::TreeModelColumn<Glib::ustring></a> description;</div> <div class="line"> <a class="code" href="classGtk_1_1TreeModelColumn.html" title="A Gtk::TreeModelColumn describes the C++ type of the data in a model column, and identifies that colu...">Gtk::TreeModelColumn< Glib::RefPtr<Gdk::Pixbuf></a> > thumbnail;</div> <div class="line"></div> <div class="line"> MyModelColumns() { <a class="code" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f" title="Adds a TreeModelColumn to this record.">add</a>(filename); <a class="code" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f" title="Adds a TreeModelColumn to this record.">add</a>(description); <a class="code" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f" title="Adds a TreeModelColumn to this record.">add</a>(thumbnail); }</div> <div class="line">};</div> </div><!-- fragment --><p>Whether or not you derive your own ColumnRecord, you need to add the <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumns</a> to the ColumnRecord with the <a class="el" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f" title="Adds a TreeModelColumn to this record.">add()</a> method.</p> <p>A ColumnRecord instance, such as an instance of <code>MyModelColumns</code> should then be passed to <a class="el" href="classGtk_1_1ListStore.html#aaa6c530560f66872482a0650739276c5" title="Instantiate a new ListStore.">ListStore::create()</a> or <a class="el" href="classGtk_1_1TreeStore.html#a65fc563bfbef2f1a31028cd33ff228c0" title="Instantiate a new TreeStore.">TreeStore::create()</a>. The <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumns</a>, such as the members <code>filename</code>, <code>description</code> and <code>thumbnail</code> can then be used with <a class="el" href="classGtk_1_1TreeRow.html#aaf9be9abd2a264e1a562f0e745ad4721" title="Use this to set and get the value of this column of this row.">Gtk::TreeRow::operator[]()</a> to specify the column you're interested in.</p> <p>Neither <a class="el" href="classGtk_1_1TreeModel.html#a58f10daabaa507b4c2473c9d1b6fa584">TreeModel::ColumnRecord</a> nor the <a class="el" href="classGtk_1_1TreeModelColumn.html">TreeModelColumns</a> contain any real data – they merely describe what C++ type is stored in which column of a <a class="el" href="classGtk_1_1TreeModel.html" title="This class defines a generic tree interface for use by the Gtk::TreeView widget.">TreeModel</a>, and save you from having to repeat that type information in several places.</p> <p>Thus <a class="el" href="classGtk_1_1TreeModel.html#a58f10daabaa507b4c2473c9d1b6fa584">TreeModel::ColumnRecord</a> can be made a singleton (as long as you make sure it's instantiated after <a class="el" href="classGtk_1_1Main.html" title="Main application class.">Gtk::Main</a>), even when creating multiple models from it. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="af0c1c552400694ad0d7e5695f8868d78"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gtk::TreeModelColumnRecord::TreeModelColumnRecord </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a3ebe61558fecbcf761ee01f5ec8c0312"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Gtk::TreeModelColumnRecord::~TreeModelColumnRecord </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a7084fc10fa1abf0d7317558b8462559f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gtk::TreeModelColumnRecord::add </td> <td>(</td> <td class="paramtype"><a class="el" href="classGtk_1_1TreeModelColumnBase.html">TreeModelColumnBase</a>& </td> <td class="paramname"><em>column</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Adds a <a class="el" href="classGtk_1_1TreeModelColumn.html" title="A Gtk::TreeModelColumn describes the C++ type of the data in a model column, and identifies that colu...">TreeModelColumn</a> to this record. </p> <p><a class="el" href="classGtk_1_1TreeModelColumnRecord.html#a7084fc10fa1abf0d7317558b8462559f" title="Adds a TreeModelColumn to this record.">add()</a> not only registers the <em>column</em>, but also assigns a column index to it. Once registered, the <a class="el" href="classGtk_1_1TreeModelColumn.html" title="A Gtk::TreeModelColumn describes the C++ type of the data in a model column, and identifies that colu...">TreeModelColumn</a> is final, and you're free to pass it around by value. </p> </div> </div> <a class="anchor" id="a024f6f44405b1f1c61a7e85d41dafe7d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int Gtk::TreeModelColumnRecord::size </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="af56c98a2bce96003a281b4cd831f1139"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GType* Gtk::TreeModelColumnRecord::types </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>gtkmm/treemodelcolumn.h</li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>