← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glibmm2.4/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/classGlib_1_1Container__Helpers_1_1GListKeeper.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-06-18 12:13:18 UTC
  • mfrom: (1.2.73)
  • Revision ID: package-import@ubuntu.com-20120618121318-88t4ppyo8lq7s4ph
Tags: 2.33.1-0ubuntu1
* New upstream release
* debian/control:
  - Bump build-depends on libglib2.0-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/classGlib_1_1Container__Helpers_1_1GListKeeper.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
 
<title>glibmm: Glib::Container_Helpers::GListKeeper&lt; Tr &gt; Class Template Reference</title>
 
5
<title>glibmm: Glib::Container_Helpers::GListKeeper Class Reference</title>
7
6
 
8
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
8
<link href="/home/murrayc/checkouts/gnome30/glibmm/docs/doxygen.css" rel="stylesheet" type="text/css" />
23
22
  
24
23
  <td style="padding-left: 0.5em;">
25
24
   <div id="projectname">glibmm
26
 
   &#160;<span id="projectnumber">2.32.0</span>
 
25
   &#160;<span id="projectnumber">2.33.1</span>
27
26
   </div>
28
27
   
29
28
  </td>
35
34
</table>
36
35
</div>
37
36
 
38
 
<!-- Generated by Doxygen 1.7.6.1 -->
 
37
<!-- Generated by Doxygen 1.7.5 -->
39
38
  <div id="navrow1" class="tabs">
40
39
    <ul class="tablist">
41
40
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
67
66
<a href="#pub-types">Public Types</a> &#124;
68
67
<a href="#pub-methods">Public Member Functions</a> </div>
69
68
  <div class="headertitle">
70
 
<div class="title">Glib::Container_Helpers::GListKeeper&lt; Tr &gt; Class Template Reference</div> </div>
71
 
</div><!--header-->
 
69
<div class="title">Glib::Container_Helpers::GListKeeper Class Reference</div> </div>
 
70
</div>
72
71
<div class="contents">
73
72
<!-- doxytag: class="Glib::Container_Helpers::GListKeeper" -->
74
73
<p>A keeper class for GList.  <a href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#details">More...</a></p>
79
78
<table class="memberdecls">
80
79
<tr><td colspan="2"><h2><a name="pub-types"></a>
81
80
Public Types</h2></td></tr>
82
 
<tr><td class="memItemLeft" align="right" valign="top">typedef Tr::CppType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a90ac15f84f6b3f055aa651b29f0c5258">CppType</a></td></tr>
83
 
<tr><td class="memItemLeft" align="right" valign="top">typedef Tr::CType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a0a730b0c4ea34673aa944f34ae9ccd88">CType</a></td></tr>
 
81
<tr><td class="memItemLeft" align="right" valign="top">typedef Tr::CppType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a59d9ba249e844314e302ee44462f5c0a">CppType</a></td></tr>
 
82
<tr><td class="memItemLeft" align="right" valign="top">typedef Tr::CType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#abcfafd933ea7c40d19d95a61e594d453">CType</a></td></tr>
84
83
<tr><td colspan="2"><h2><a name="pub-methods"></a>
85
84
Public Member Functions</h2></td></tr>
86
 
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a4207dc51d04222c557591b1c95efa0fc">GListKeeper</a> (const GList* glist, <a class="el" href="group__ContHandles.html#ga64c27560b41710ccf64a3679a3ba3f20">Glib::OwnershipType</a> ownership)</td></tr>
87
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html" title="A keeper class for GList.">GListKeeper</a> holding <em>glist</em>. <a href="#a4207dc51d04222c557591b1c95efa0fc"></a><br/></td></tr>
88
 
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#abddfd000ad4ba2a9e2b7cf0db8254690">GListKeeper</a> (const <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a>&amp; keeper)</td></tr>
89
 
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a2f5fc263abf15d826a4c39b23d39b463">~GListKeeper</a> ()</td></tr>
90
 
<tr><td class="memItemLeft" align="right" valign="top">GList*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a4091150e8dbfbdf5c55addf13293972c">data</a> () const </td></tr>
91
 
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets data the keeper holds. <a href="#a4091150e8dbfbdf5c55addf13293972c"></a><br/></td></tr>
 
85
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#adfdce64d0c4125bc2e06c2c5a3450c62">GListKeeper</a> (const GList* glist, <a class="el" href="group__ContHandles.html#ga64c27560b41710ccf64a3679a3ba3f20">Glib::OwnershipType</a> ownership)</td></tr>
 
86
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html" title="A keeper class for GList.">GListKeeper</a> holding <em>glist</em>. <a href="#adfdce64d0c4125bc2e06c2c5a3450c62"></a><br/></td></tr>
 
87
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a23cd1b6528a618ee62d3b74a4207006b">GListKeeper</a> (const <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a>&amp; keeper)</td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#aaa6a8f25d403a9d8c9de052c01fcb480">~GListKeeper</a> ()</td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">GList*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a86b59e9ff57c7b10288a4ee62e5a7a84">data</a> () const </td></tr>
 
90
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets data the keeper holds. <a href="#a86b59e9ff57c7b10288a4ee62e5a7a84"></a><br/></td></tr>
92
91
</table>
93
92
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
94
 
<div class="textblock"><h3>template&lt;typename Tr&gt;<br/>
95
 
class Glib::Container_Helpers::GListKeeper&lt; Tr &gt;</h3>
96
 
 
97
 
<p>A keeper class for GList. </p>
 
93
<div class="textblock"><p>A keeper class for GList. </p>
98
94
<p>Primarily used by C++ wrappers like gtkmm.</p>
99
95
<p>Its main purpose is to free its data when they are not needed. What will be destroyed depends on passed ownership upon construction.</p>
100
 
<p>The most common usage of Glib::GListKeeper is getting its data when converting <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00938.html">std::vector</a> to a GList*: </p>
101
 
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> G::Temp::do_something(<span class="keyword">const</span> <a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00938.html">std::vector&lt;int&gt;</a>&amp; v)
 
96
<p>The most common usage of Glib::GListKeeper is getting its data when converting <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00970.html">std::vector</a> to a GList*: </p>
 
97
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> G::Temp::do_something(<span class="keyword">const</span> <a class="codeRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00970.html">std::vector&lt;int&gt;</a>&amp; v)
102
98
 {
103
 
   g_temp_do_something(gobj(), <a class="code" href="classGlib_1_1ListHandler.html" title="A utility for converting between std::vector and GList.">Glib::ListHandler&lt;int&gt;::vector_to_list</a>(v).<a class="code" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a4091150e8dbfbdf5c55addf13293972c" title="Gets data the keeper holds.">data</a>());
 
99
   g_temp_do_something(gobj(), <a class="code" href="classGlib_1_1ListHandler.html" title="A utility for converting between std::vector and GList.">Glib::ListHandler&lt;int&gt;::vector_to_list</a>(v).<a class="code" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a86b59e9ff57c7b10288a4ee62e5a7a84" title="Gets data the keeper holds.">data</a>());
104
100
 }
105
 
</pre></div><p> Variables of this class are seldom defined directly - it is mostly used as a temporary variable returned by <a class="el" href="classGlib_1_1ListHandler.html#aa3f1c38cb301fa89706d517744b813a1">Glib::ListHandler::vector_to_list()</a>.</p>
106
 
<p>Note that the usage above is correct with regards to C++ standard point 12.2.3. That means that data returned by <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a4091150e8dbfbdf5c55addf13293972c" title="Gets data the keeper holds.">data()</a> method is valid through whole g_temp_do_something function and is destroyed, when this function returns. </p>
 
101
</pre></div><p> Variables of this class are seldom defined directly - it is mostly used as a temporary variable returned by <a class="el" href="classGlib_1_1ListHandler.html#a62b4ad5ad07478e19fcb75511def04b1">Glib::ListHandler::vector_to_list()</a>.</p>
 
102
<p>Note that the usage above is correct with regards to C++ standard point 12.2.3. That means that data returned by <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a86b59e9ff57c7b10288a4ee62e5a7a84" title="Gets data the keeper holds.">data()</a> method is valid through whole g_temp_do_something function and is destroyed, when this function returns. </p>
107
103
</div><hr/><h2>Member Typedef Documentation</h2>
108
 
<a class="anchor" id="a90ac15f84f6b3f055aa651b29f0c5258"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::CppType" ref="a90ac15f84f6b3f055aa651b29f0c5258" args="" -->
 
104
<a class="anchor" id="a59d9ba249e844314e302ee44462f5c0a"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::CppType" ref="a59d9ba249e844314e302ee44462f5c0a" args="" -->
109
105
<div class="memitem">
110
106
<div class="memproto">
111
 
<div class="memtemplate">
112
 
template &lt;typename Tr &gt; </div>
113
107
      <table class="memname">
114
108
        <tr>
115
 
          <td class="memname">typedef Tr::CppType <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a90ac15f84f6b3f055aa651b29f0c5258">CppType</a></td>
 
109
          <td class="memname">typedef Tr::CppType <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a59d9ba249e844314e302ee44462f5c0a">Glib::Container_Helpers::GListKeeper::CppType</a></td>
116
110
        </tr>
117
111
      </table>
118
112
</div>
120
114
 
121
115
</div>
122
116
</div>
123
 
<a class="anchor" id="a0a730b0c4ea34673aa944f34ae9ccd88"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::CType" ref="a0a730b0c4ea34673aa944f34ae9ccd88" args="" -->
 
117
<a class="anchor" id="abcfafd933ea7c40d19d95a61e594d453"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::CType" ref="abcfafd933ea7c40d19d95a61e594d453" args="" -->
124
118
<div class="memitem">
125
119
<div class="memproto">
126
 
<div class="memtemplate">
127
 
template &lt;typename Tr &gt; </div>
128
120
      <table class="memname">
129
121
        <tr>
130
 
          <td class="memname">typedef Tr::CType <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a0a730b0c4ea34673aa944f34ae9ccd88">CType</a></td>
 
122
          <td class="memname">typedef Tr::CType <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#abcfafd933ea7c40d19d95a61e594d453">Glib::Container_Helpers::GListKeeper::CType</a></td>
131
123
        </tr>
132
124
      </table>
133
125
</div>
136
128
</div>
137
129
</div>
138
130
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
139
 
<a class="anchor" id="a4207dc51d04222c557591b1c95efa0fc"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::GListKeeper" ref="a4207dc51d04222c557591b1c95efa0fc" args="(const GList *glist, Glib::OwnershipType ownership)" -->
 
131
<a class="anchor" id="adfdce64d0c4125bc2e06c2c5a3450c62"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::GListKeeper" ref="adfdce64d0c4125bc2e06c2c5a3450c62" args="(const GList *glist, Glib::OwnershipType ownership)" -->
140
132
<div class="memitem">
141
133
<div class="memproto">
142
 
<div class="memtemplate">
143
 
template &lt;typename Tr &gt; </div>
144
134
      <table class="memname">
145
135
        <tr>
146
 
          <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a> </td>
 
136
          <td class="memname">Glib::Container_Helpers::GListKeeper::GListKeeper </td>
147
137
          <td>(</td>
148
138
          <td class="paramtype">const GList *&#160;</td>
149
139
          <td class="paramname"><em>glist</em>, </td>
173
163
<li>
174
164
<a class="el" href="group__ContHandles.html#gga64c27560b41710ccf64a3679a3ba3f20a2a6d6bfadc36f9eda31af79d32928c6a">Glib::OWNERSHIP_DEEP</a> - keeper will destroy data and container it holds. </li>
175
165
</ul>
176
 
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
166
<dl><dt><b>Parameters:</b></dt><dd>
177
167
  <table class="params">
178
168
    <tr><td class="paramname">glist</td><td>- GList* to hold. </td></tr>
179
169
    <tr><td class="paramname">ownership</td><td>- ownership definition. </td></tr>
183
173
 
184
174
</div>
185
175
</div>
186
 
<a class="anchor" id="abddfd000ad4ba2a9e2b7cf0db8254690"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::GListKeeper" ref="abddfd000ad4ba2a9e2b7cf0db8254690" args="(const GListKeeper &amp;keeper)" -->
 
176
<a class="anchor" id="a23cd1b6528a618ee62d3b74a4207006b"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::GListKeeper" ref="a23cd1b6528a618ee62d3b74a4207006b" args="(const GListKeeper &amp;keeper)" -->
187
177
<div class="memitem">
188
178
<div class="memproto">
189
 
<div class="memtemplate">
190
 
template &lt;typename Tr &gt; </div>
191
179
      <table class="memname">
192
180
        <tr>
193
 
          <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a> </td>
 
181
          <td class="memname">Glib::Container_Helpers::GListKeeper::GListKeeper </td>
194
182
          <td>(</td>
195
 
          <td class="paramtype">const <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a>&lt; Tr &gt;&amp;&#160;</td>
 
183
          <td class="paramtype">const <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a>&amp;&#160;</td>
196
184
          <td class="paramname"><em>keeper</em></td><td>)</td>
197
185
          <td><code> [inline]</code></td>
198
186
        </tr>
202
190
 
203
191
</div>
204
192
</div>
205
 
<a class="anchor" id="a2f5fc263abf15d826a4c39b23d39b463"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::~GListKeeper" ref="a2f5fc263abf15d826a4c39b23d39b463" args="()" -->
 
193
<a class="anchor" id="aaa6a8f25d403a9d8c9de052c01fcb480"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::~GListKeeper" ref="aaa6a8f25d403a9d8c9de052c01fcb480" args="()" -->
206
194
<div class="memitem">
207
195
<div class="memproto">
208
 
<div class="memtemplate">
209
 
template &lt;typename Tr &gt; </div>
210
196
      <table class="memname">
211
197
        <tr>
212
 
          <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::~<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">GListKeeper</a> </td>
 
198
          <td class="memname">Glib::Container_Helpers::GListKeeper::~GListKeeper </td>
213
199
          <td>(</td>
214
200
          <td class="paramname"></td><td>)</td>
215
201
          <td></td>
221
207
</div>
222
208
</div>
223
209
<hr/><h2>Member Function Documentation</h2>
224
 
<a class="anchor" id="a4091150e8dbfbdf5c55addf13293972c"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::data" ref="a4091150e8dbfbdf5c55addf13293972c" args="() const " -->
 
210
<a class="anchor" id="a86b59e9ff57c7b10288a4ee62e5a7a84"></a><!-- doxytag: member="Glib::Container_Helpers::GListKeeper::data" ref="a86b59e9ff57c7b10288a4ee62e5a7a84" args="() const " -->
225
211
<div class="memitem">
226
212
<div class="memproto">
227
 
<div class="memtemplate">
228
 
template &lt;typename Tr &gt; </div>
229
213
      <table class="memname">
230
214
        <tr>
231
 
          <td class="memname">GList* <a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html">Glib::Container_Helpers::GListKeeper</a>&lt; Tr &gt;::<a class="el" href="classGlib_1_1Container__Helpers_1_1GListKeeper.html#a4091150e8dbfbdf5c55addf13293972c">data</a> </td>
 
215
          <td class="memname">GList* Glib::Container_Helpers::GListKeeper::data </td>
232
216
          <td>(</td>
233
217
          <td class="paramname"></td><td>)</td>
234
218
          <td> const<code> [inline]</code></td>
243
227
 
244
228
</div>
245
229
</div>
246
 
</div><!-- contents -->
 
230
</div>
247
231
 
248
232
 
249
233
<hr class="footer"/><address class="footer"><small>
250
 
Generated on Tue Apr 10 2012 14:20:40 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
 
234
Generated on Tue Jun 12 2012 09:21:32 for glibmm by &#160;<a href="http://www.doxygen.org/index.html">
251
235
<img class="footer" src="doxygen.png" alt="doxygen"/>
252
 
</a> 1.7.6.1
 
236
</a> 1.7.5
253
237
</small></address>
254
238
 
255
239
</body>