<!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"/>
<title>libcollection: Additional iterator flags</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libcollection <span id="projectnumber">0.1.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> </div>
<div class="headertitle">
<div class="title">Additional iterator flags</div> </div>
<div class="ingroups"><a class="el" href="group__traverseconst.html">Constants defining traverse modes</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__moreiterflag.html#ga81e9a3c29d038571e4b52ab685f9b417">COL_TRAVERSE_SHOWSUB</a>   0x00010000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Include headers of sub collections. <a href="#ga81e9a3c29d038571e4b52ab685f9b417"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__moreiterflag.html#gae304668f4d234fdb2b83682be14c8155">COL_TRAVERSE_ONLYSUB</a>   0x00020000</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Show sub collections. <a href="#gae304668f4d234fdb2b83682be14c8155"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<dl class="note"><dt><b>Note:</b></dt><dd>NOTE: These flags ignored by traverse functions and can be used only in the iterator. </dd></dl>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gae304668f4d234fdb2b83682be14c8155"></a><!-- doxytag: member="collection.h::COL_TRAVERSE_ONLYSUB" ref="gae304668f4d234fdb2b83682be14c8155" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_TRAVERSE_ONLYSUB   0x00020000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Show sub collections. </p>
<p>Show the header of the sub collection instead of the reference. Flag is ignored if the <a class="el" href="group__traverseconst.html#ga9a36a2d0b7033b6de38179204e0d6e4b">COL_TRAVERSE_ONELEVEL</a> flag is specified and not ignored. Flag is ignored is also ignored if the FLAT flag is specified. </p>
</div>
</div>
<a class="anchor" id="ga81e9a3c29d038571e4b52ab685f9b417"></a><!-- doxytag: member="collection.h::COL_TRAVERSE_SHOWSUB" ref="ga81e9a3c29d038571e4b52ab685f9b417" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COL_TRAVERSE_SHOWSUB   0x00010000</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Include headers of sub collections. </p>
<p>When one collection is embedded or referenced by another collection there are two names we can be interested in. The name of the property that defines the reference and the name of the embedded collection. It is recommended that they be the same, however there may be cases when the name of the referencing property and referenced collection should be different. By default only the name of the referencing property is returned while iterating through the collection and its sub collections. Specifying this flag would cause the names of the collection (header elements) be included into the iteration process.</p>
<p>Flag is ignored if the <a class="el" href="group__traverseconst.html#ga9a36a2d0b7033b6de38179204e0d6e4b">COL_TRAVERSE_ONELEVEL</a> flag is specified and not ignored. Flag is ignored is also ignored if the FLAT flag is specified. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for libcollection by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
