<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::gui::IGUITreeView Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1gui.html">gui</a>::<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html">IGUITreeView</a>
</div>
<div class="contents">
<h1>irr::gui::IGUITreeView Class Reference</h1><!-- doxytag: class="irr::gui::IGUITreeView" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
<p>Default tree view GUI element.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="_i_g_u_i_tree_view_8h_source.html">IGUITreeView.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for irr::gui::IGUITreeView:</div>
<div class="dynsection">
<div class="center">
<img src="classirr_1_1gui_1_1_i_g_u_i_tree_view.png" usemap="#irr::gui::IGUITreeView_map" alt=""/>
<map id="irr::gui::IGUITreeView_map" name="irr::gui::IGUITreeView_map">
<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
<area href="classirr_1_1_i_event_receiver.html" alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
<area href="classirr_1_1_i_reference_counted.html" alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24"/>
</map>
</div>
</div>
<p><a href="classirr_1_1gui_1_1_i_g_u_i_tree_view-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#a337b850f96abaecf7dae44f810f3bbed">getImageLeftOfIcon</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if the Image is left of the icon. Default is true. <a href="#a337b850f96abaecf7dae44f810f3bbed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image_list.html">IGUIImageList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#aeae0fa8b33064209ddc604aec45d461c">getImageList</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the image list which is used for the nodes. <a href="#aeae0fa8b33064209ddc604aec45d461c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#acddfaf6a9b418100d0ec42df52874765">getLastEventNode</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the node which is associated to the last event. <a href="#acddfaf6a9b418100d0ec42df52874765"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#a4f03b904367e362ddc4413c46974d32f">getLinesVisible</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the tree lines are visible <a href="#a4f03b904367e362ddc4413c46974d32f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#ad423c84a07a969c786902bf29d736033">getRoot</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the root node (not visible) from the tree. <a href="#ad423c84a07a969c786902bf29d736033"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#abcdbd869a9e4b6a67ddb94aa4c058c2d">getSelected</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the selected node of the tree or 0 if none is selected <a href="#abcdbd869a9e4b6a67ddb94aa4c058c2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#a43d973d611542ad77c659167f14aae0d">IGUITreeView</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > rectangle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a43d973d611542ad77c659167f14aae0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#a07707331410d7792557c81c90ef4a09b">setIconFont</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> *font)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the font which should be used as icon font. <a href="#a07707331410d7792557c81c90ef4a09b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#afb011310d69f466ed6a4955d0c7d3697">setImageLeftOfIcon</a> (bool bLeftOf)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets if the image is left of the icon. Default is true. <a href="#afb011310d69f466ed6a4955d0c7d3697"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#aaa55170154f44d17e2a8129368c1a010">setImageList</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image_list.html">IGUIImageList</a> *imageList)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the image list which should be used for the image and selected image of every node. <a href="#aaa55170154f44d17e2a8129368c1a010"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view.html#a7894df49d2f0f3d20e9e998ab1cac373">setLinesVisible</a> (bool visible)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets if the tree lines are visible <a href="#a7894df49d2f0f3d20e9e998ab1cac373"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Default tree view GUI element. </p>
<p>Displays a windows like tree buttons to expand/collaps the child nodes of an node and optional tree lines. Each node consits of an text, an icon text and a void pointer for user data. </p>
<p>Definition at line <a class="el" href="_i_g_u_i_tree_view_8h_source.html#l00197">197</a> of file <a class="el" href="_i_g_u_i_tree_view_8h_source.html">IGUITreeView.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a43d973d611542ad77c659167f14aae0d"></a><!-- doxytag: member="irr::gui::IGUITreeView::IGUITreeView" ref="a43d973d611542ad77c659167f14aae0d" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">irr::gui::IGUITreeView::IGUITreeView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> * </td>
<td class="paramname"> <em>environment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * </td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> > </td>
<td class="paramname"> <em>rectangle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>constructor </p>
<p>Definition at line <a class="el" href="_i_g_u_i_tree_view_8h_source.html#l00201">201</a> of file <a class="el" href="_i_g_u_i_tree_view_8h_source.html">IGUITreeView.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a337b850f96abaecf7dae44f810f3bbed"></a><!-- doxytag: member="irr::gui::IGUITreeView::getImageLeftOfIcon" ref="a337b850f96abaecf7dae44f810f3bbed" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUITreeView::getImageLeftOfIcon </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns if the Image is left of the icon. Default is true. </p>
</div>
</div>
<a class="anchor" id="aeae0fa8b33064209ddc604aec45d461c"></a><!-- doxytag: member="irr::gui::IGUITreeView::getImageList" ref="aeae0fa8b33064209ddc604aec45d461c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image_list.html">IGUIImageList</a>* irr::gui::IGUITreeView::getImageList </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the image list which is used for the nodes. </p>
</div>
</div>
<a class="anchor" id="acddfaf6a9b418100d0ec42df52874765"></a><!-- doxytag: member="irr::gui::IGUITreeView::getLastEventNode" ref="acddfaf6a9b418100d0ec42df52874765" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a>* irr::gui::IGUITreeView::getLastEventNode </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the node which is associated to the last event. </p>
<p>This pointer is only valid inside the OnEvent call! </p>
</div>
</div>
<a class="anchor" id="a4f03b904367e362ddc4413c46974d32f"></a><!-- doxytag: member="irr::gui::IGUITreeView::getLinesVisible" ref="a4f03b904367e362ddc4413c46974d32f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUITreeView::getLinesVisible </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns true if the tree lines are visible </p>
</div>
</div>
<a class="anchor" id="ad423c84a07a969c786902bf29d736033"></a><!-- doxytag: member="irr::gui::IGUITreeView::getRoot" ref="ad423c84a07a969c786902bf29d736033" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a>* irr::gui::IGUITreeView::getRoot </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the root node (not visible) from the tree. </p>
</div>
</div>
<a class="anchor" id="abcdbd869a9e4b6a67ddb94aa4c058c2d"></a><!-- doxytag: member="irr::gui::IGUITreeView::getSelected" ref="abcdbd869a9e4b6a67ddb94aa4c058c2d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_tree_view_node.html">IGUITreeViewNode</a>* irr::gui::IGUITreeView::getSelected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the selected node of the tree or 0 if none is selected </p>
</div>
</div>
<a class="anchor" id="a07707331410d7792557c81c90ef4a09b"></a><!-- doxytag: member="irr::gui::IGUITreeView::setIconFont" ref="a07707331410d7792557c81c90ef4a09b" args="(IGUIFont *font)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUITreeView::setIconFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_font.html">IGUIFont</a> * </td>
<td class="paramname"> <em>font</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the font which should be used as icon font. </p>
<p>This font is set to the Irrlicht engine built-in-font by default. Icons can be displayed in front of every list item. An icon is a string, displayed with the icon font. When using the build-in-font of the Irrlicht engine as icon font, the icon strings defined in GUIIcons.h can be used. </p>
</div>
</div>
<a class="anchor" id="afb011310d69f466ed6a4955d0c7d3697"></a><!-- doxytag: member="irr::gui::IGUITreeView::setImageLeftOfIcon" ref="afb011310d69f466ed6a4955d0c7d3697" args="(bool bLeftOf)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUITreeView::setImageLeftOfIcon </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>bLeftOf</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets if the image is left of the icon. Default is true. </p>
</div>
</div>
<a class="anchor" id="aaa55170154f44d17e2a8129368c1a010"></a><!-- doxytag: member="irr::gui::IGUITreeView::setImageList" ref="aaa55170154f44d17e2a8129368c1a010" args="(IGUIImageList *imageList)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUITreeView::setImageList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_image_list.html">IGUIImageList</a> * </td>
<td class="paramname"> <em>imageList</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the image list which should be used for the image and selected image of every node. </p>
<p>The default is 0 (no images). </p>
</div>
</div>
<a class="anchor" id="a7894df49d2f0f3d20e9e998ab1cac373"></a><!-- doxytag: member="irr::gui::IGUITreeView::setLinesVisible" ref="a7894df49d2f0f3d20e9e998ab1cac373" args="(bool visible)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUITreeView::setLinesVisible </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>visible</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets if the tree lines are visible </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>visible</em> </td><td>true for visible, false for invisible </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_g_u_i_tree_view_8h_source.html">IGUITreeView.h</a></li>
</ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2010 by Nikolaus Gebhardt. Generated
on Sun Oct 24 12:42:05 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.6.2)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
