<!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>glibmm: Glib::VariantIter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.2 -->
<div class="navigation" id="top">
<div 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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div 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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceGlib.html">Glib</a> </li>
<li><a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Glib::VariantIter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Glib::VariantIter" -->
<p><a class="el" href="classGlib_1_1VariantIter.html" title="VariantIter - An opaque data structure used to iterate through VariantBase containers such as arrays...">VariantIter</a> - An opaque data structure used to iterate through <a class="el" href="classGlib_1_1VariantBase.html" title="This is the base class for all Variant types.">VariantBase</a> containers such as arrays. <a href="#_details">More...</a></p>
<p><code>#include <glibmm/variantiter.h></code></p>
<p><a href="classGlib_1_1VariantIter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#ad2b942a346f4e627f8d506d56d2f6ca9">VariantIter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a3740e672ee31321f23cc25d100d521cd">VariantIter</a> (GVariantIter* castitem, bool make_a_copy=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a0900264d5dc894f33cf4725c01ae4c2e">VariantIter</a> (const <a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#ae3904f860aa1c241e7bd2732b03819e4">operator=</a> (const <a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a024996a3ba3b4b80a23e4e71b8db0b1e">~VariantIter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GVariantIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#aefb89b951a1e173003a0124a872dd10d">gobj</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GVariantIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#af105c662414cfff282ea7658ee51c75f">gobj</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GVariantIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a212196095dd77ce13cc99c1b9e9aff9a">gobj_copy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <a href="#a212196095dd77ce13cc99c1b9e9aff9a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a3c6536a04708e394d5a4f484ab47a126">VariantIter</a> (const <a class="el" href="classGlib_1_1VariantBase.html">VariantBase</a>& variant)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">gsize </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a52a5d50c12bafc2cc6d1dba74926c631">get_n_children</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Queries the number of child items in the container that we are iterating over. <a href="#a52a5d50c12bafc2cc6d1dba74926c631"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#aaa597dd59e369c4a8bcf7e15e48568e2">next_value</a> (<a class="el" href="classGlib_1_1VariantBase.html">VariantBase</a>&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01191.html#ga1c9e781d8d15a3814a601f471797c825">value</a>)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GVariantIter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a8c9f77e7a61fa4d0a580e2e6560f880d">gobject_</a></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1VariantIter.html">Glib::VariantIter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1VariantIter.html#a7c11a76e7facaa1f56e32af7661bd012">wrap</a> (GVariantIter* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a7c11a76e7facaa1f56e32af7661bd012"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classGlib_1_1VariantIter.html" title="VariantIter - An opaque data structure used to iterate through VariantBase containers such as arrays...">VariantIter</a> - An opaque data structure used to iterate through <a class="el" href="classGlib_1_1VariantBase.html" title="This is the base class for all Variant types.">VariantBase</a> containers such as arrays. </p>
<dl class="since_2_28"><dt><b><a class="el" href="since_2_28.html#_since_2_28000051">Since glibmm 2.28:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad2b942a346f4e627f8d506d56d2f6ca9"></a><!-- doxytag: member="Glib::VariantIter::VariantIter" ref="ad2b942a346f4e627f8d506d56d2f6ca9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::VariantIter::VariantIter </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3740e672ee31321f23cc25d100d521cd"></a><!-- doxytag: member="Glib::VariantIter::VariantIter" ref="a3740e672ee31321f23cc25d100d521cd" args="(GVariantIter *castitem, bool make_a_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::VariantIter::VariantIter </td>
<td>(</td>
<td class="paramtype">GVariantIter * </td>
<td class="paramname"> <em>castitem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>make_a_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0900264d5dc894f33cf4725c01ae4c2e"></a><!-- doxytag: member="Glib::VariantIter::VariantIter" ref="a0900264d5dc894f33cf4725c01ae4c2e" args="(const VariantIter &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::VariantIter::VariantIter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& </td>
<td class="paramname"> <em>src</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a024996a3ba3b4b80a23e4e71b8db0b1e"></a><!-- doxytag: member="Glib::VariantIter::~VariantIter" ref="a024996a3ba3b4b80a23e4e71b8db0b1e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::VariantIter::~VariantIter </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3c6536a04708e394d5a4f484ab47a126"></a><!-- doxytag: member="Glib::VariantIter::VariantIter" ref="a3c6536a04708e394d5a4f484ab47a126" args="(const VariantBase &variant)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::VariantIter::VariantIter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1VariantBase.html">VariantBase</a>& </td>
<td class="paramname"> <em>variant</em> )</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a52a5d50c12bafc2cc6d1dba74926c631"></a><!-- doxytag: member="Glib::VariantIter::get_n_children" ref="a52a5d50c12bafc2cc6d1dba74926c631" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gsize Glib::VariantIter::get_n_children </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Queries the number of child items in the container that we are iterating over. </p>
<p>This is the total number of items -- not the number of items remaining.</p>
<p>This function might be useful for preallocation of arrays.</p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000018">Since glibmm 2.24:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of children in the container. </dd></dl>
</div>
</div>
<a class="anchor" id="aefb89b951a1e173003a0124a872dd10d"></a><!-- doxytag: member="Glib::VariantIter::gobj" ref="aefb89b951a1e173003a0124a872dd10d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GVariantIter* Glib::VariantIter::gobj </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af105c662414cfff282ea7658ee51c75f"></a><!-- doxytag: member="Glib::VariantIter::gobj" ref="af105c662414cfff282ea7658ee51c75f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GVariantIter* Glib::VariantIter::gobj </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a212196095dd77ce13cc99c1b9e9aff9a"></a><!-- doxytag: member="Glib::VariantIter::gobj_copy" ref="a212196095dd77ce13cc99c1b9e9aff9a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GVariantIter* Glib::VariantIter::gobj_copy </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="aaa597dd59e369c4a8bcf7e15e48568e2"></a><!-- doxytag: member="Glib::VariantIter::next_value" ref="aaa597dd59e369c4a8bcf7e15e48568e2" args="(VariantBase &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Glib::VariantIter::next_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGlib_1_1VariantBase.html">VariantBase</a>& </td>
<td class="paramname"> <em>value</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae3904f860aa1c241e7bd2732b03819e4"></a><!-- doxytag: member="Glib::VariantIter::operator=" ref="ae3904f860aa1c241e7bd2732b03819e4" args="(const VariantIter &src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& Glib::VariantIter::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGlib_1_1VariantIter.html">VariantIter</a>& </td>
<td class="paramname"> <em>src</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7c11a76e7facaa1f56e32af7661bd012"></a><!-- doxytag: member="Glib::VariantIter::wrap" ref="a7c11a76e7facaa1f56e32af7661bd012" args="(GVariantIter *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1VariantIter.html">Glib::VariantIter</a> wrap </td>
<td>(</td>
<td class="paramtype">GVariantIter * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a8c9f77e7a61fa4d0a580e2e6560f880d"></a><!-- doxytag: member="Glib::VariantIter::gobject_" ref="a8c9f77e7a61fa4d0a580e2e6560f880d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GVariantIter* <a class="el" href="classGlib_1_1VariantIter.html#a8c9f77e7a61fa4d0a580e2e6560f880d">Glib::VariantIter::gobject_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Apr 5 2011 16:07:14 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
