/usr/share/gtk-doc/html/libgda-4.0/GdaTreeManager.html is in libgda-4.0-doc 4.2.8-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaTreeManager</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="trees.html" title="Trees">
<link rel="prev" href="GdaTree.html" title="GdaTree">
<link rel="next" href="GdaTreeNode.html" title="GdaTreeNode">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GdaTree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="trees.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="GdaTreeNode.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaTreeManager.synopsis" class="shortcut">Top</a>
|
<a href="#GdaTreeManager.description" class="shortcut">Description</a>
|
<a href="#GdaTreeManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaTreeManager.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaTreeManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaTreeManager.top_of_page"></a>GdaTreeManager</span></h2>
<p>GdaTreeManager — Base class for all the tree managers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaTreeManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GdaTreeManager.html#GdaTreeManager-struct" title="GdaTreeManager">GdaTreeManager</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * (<a class="link" href="GdaTreeManager.html#GdaTreeManagerNodesFunc" title="GdaTreeManagerNodesFunc ()">*GdaTreeManagerNodesFunc</a>) (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *node</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *children_nodes</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *out_error</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> * <a class="link" href="GdaTreeManager.html#gda-tree-manager-new-with-func" title="gda_tree_manager_new_with_func ()">gda_tree_manager_new_with_func</a> (<em class="parameter"><code><a class="link" href="GdaTreeManager.html#GdaTreeManagerNodesFunc" title="GdaTreeManagerNodesFunc ()"><span class="type">GdaTreeManagerNodesFunc</span></a> update_func</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaTreeManager.html#gda-tree-manager-add-manager" title="gda_tree_manager_add_manager ()">gda_tree_manager_add_manager</a> (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *sub</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="GdaTreeManager.html#gda-tree-manager-get-managers" title="gda_tree_manager_get_managers ()">gda_tree_manager_get_managers</a> (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaTreeManager.html#gda-tree-manager-add-new-node-attribute" title="gda_tree_manager_add_new_node_attribute ()">gda_tree_manager_add_new_node_attribute</a>
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
<a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="returnvalue">GdaTreeNode</span></a> * (<a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()">*GdaTreeManagerNodeFunc</a>) (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaTreeManager.html#gda-tree-manager-set-node-create-func" title="gda_tree_manager_set_node_create_func ()">gda_tree_manager_set_node_create_func</a>
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="type">GdaTreeManagerNodeFunc</span></a> func</code></em>);
<a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="returnvalue">GdaTreeManagerNodeFunc</span></a> <a class="link" href="GdaTreeManager.html#gda-tree-manager-get-node-create-func" title="gda_tree_manager_get_node_create_func ()">gda_tree_manager_get_node_create_func</a>
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>);
<a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="returnvalue">GdaTreeNode</span></a> * <a class="link" href="GdaTreeManager.html#gda-tree-manager-create-node" title="gda_tree_manager_create_node ()">gda_tree_manager_create_node</a> (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GdaTreeManager
+----GdaTreeMgrLdap
+----<a class="link" href="GdaTreeMgrColumns.html" title="GdaTreeMgrColumns">GdaTreeMgrColumns</a>
+----<a class="link" href="GdaTreeMgrLabel.html" title="GdaTreeMgrLabel">GdaTreeMgrLabel</a>
+----<a class="link" href="GdaTreeMgrSchemas.html" title="GdaTreeMgrSchemas">GdaTreeMgrSchemas</a>
+----<a class="link" href="GdaTreeMgrSelect.html" title="GdaTreeMgrSelect">GdaTreeMgrSelect</a>
+----<a class="link" href="GdaTreeMgrTables.html" title="GdaTreeMgrTables">GdaTreeMgrTables</a>
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeManager.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdaTreeManager.html#GdaTreeManager--func" title='The "func" property'>func</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write / Construct
"<a class="link" href="GdaTreeManager.html#GdaTreeManager--recursive" title='The "recursive" property'>recursive</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeManager.description"></a><h2>Description</h2>
<p>
A <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object is responsible for creating nodes in the tree(s) for which it
operates.
</p>
<p>
When creating nodes, a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object can (depending on its implementation), get some
named attributes from the node below which it has to create nodes, using the <a class="link" href="GdaTreeNode.html#gda-tree-node-fetch-attribute" title="gda_tree_node_fetch_attribute ()"><code class="function">gda_tree_node_fetch_attribute()</code></a>
or <a class="link" href="GdaTreeNode.html#gda-tree-node-get-node-attribute" title="gda_tree_node_get_node_attribute ()"><code class="function">gda_tree_node_get_node_attribute()</code></a>. For example the <a class="link" href="GdaTreeMgrColumns.html" title="GdaTreeMgrColumns"><span class="type">GdaTreeMgrColumns</span></a> manager (which creates a node for each column
of a table) needs the table name and the schema in which the table is; both can be specified using an
object's property, or, if not specified that way, are fetched as attributes.
</p>
<p>
The <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> itself is an abstract type (which can't be instantiated). Use an existing sub class or subclass
it yourself.
</p>
</div>
<div class="refsect1">
<a name="GdaTreeManager.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaTreeManager-struct"></a><h3>GdaTreeManager</h3>
<pre class="programlisting">typedef struct _GdaTreeManager GdaTreeManager;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeManagerNodesFunc"></a><h3>GdaTreeManagerNodesFunc ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * (*GdaTreeManagerNodesFunc) (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *node</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *children_nodes</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *out_error</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-new-with-func"></a><h3>gda_tree_manager_new_with_func ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> * gda_tree_manager_new_with_func (<em class="parameter"><code><a class="link" href="GdaTreeManager.html#GdaTreeManagerNodesFunc" title="GdaTreeManagerNodesFunc ()"><span class="type">GdaTreeManagerNodesFunc</span></a> update_func</code></em>);</pre>
<p>
Use this method to create a new <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> if it's more convenient than subclassing; all is needed
is the <em class="parameter"><code>update_func</code></em> function which is responsible for creating or updating the children nodes of a specified <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>update_func</code></em> :</span></p></td>
<td>the function to call when the manager object is requested to create or update its list of
<a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> nodes. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-add-manager"></a><h3>gda_tree_manager_add_manager ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_tree_manager_add_manager (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *sub</code></em>);</pre>
<p>
Adds a sub manager to <em class="parameter"><code>manager</code></em>. Use this method to create the skeleton structure
of a <a class="link" href="GdaTree.html" title="GdaTree"><span class="type">GdaTree</span></a>. Note that a single <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> can be used by several <a class="link" href="GdaTree.html" title="GdaTree"><span class="type">GdaTree</span></a> objects
or several times in the same <a class="link" href="GdaTree.html" title="GdaTree"><span class="type">GdaTree</span></a>'s structure.
</p>
<p>
Please note that it's possible for <em class="parameter"><code>mgr</code></em> and <em class="parameter"><code>sub</code></em> to be the same object, but beware of the possible
infinite recursive behaviour in this case when creating children nodes
(depending on the actual implementation of the <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object to add</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-get-managers"></a><h3>gda_tree_manager_get_managers ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * gda_tree_manager_get_managers (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>);</pre>
<p>
Get the list of sub managers which have already been added using <a class="link" href="GdaTreeManager.html#gda-tree-manager-add-manager" title="gda_tree_manager_add_manager ()"><code class="function">gda_tree_manager_add_manager()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of <span class="type">GdaTreeMenager</span> which should not be modified. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-add-new-node-attribute"></a><h3>gda_tree_manager_add_new_node_attribute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_tree_manager_add_new_node_attribute
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *attribute</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
<p>
Requests that for any new node managed (eg. created) by <em class="parameter"><code>manager</code></em>, a new attribute will be set. This allows
one to customize the attributes of new nodes created by an existing <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>.
</p>
<p>
As a side effect, if <em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the corresponding attribute, if it was set, is unset.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
<td>an attribute name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the attribute's value, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeManagerNodeFunc"></a><h3>GdaTreeManagerNodeFunc ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="returnvalue">GdaTreeNode</span></a> * (*GdaTreeManagerNodeFunc) (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Function which creates a <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> below <em class="parameter"><code>parent</code></em>, using <em class="parameter"><code>manager</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>the <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> which requests a node to be created</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> below which the new node will be placed</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> object (or a subclassed object)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-set-node-create-func"></a><h3>gda_tree_manager_set_node_create_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_tree_manager_set_node_create_func
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="type">GdaTreeManagerNodeFunc</span></a> func</code></em>);</pre>
<p>
Sets the function to be called when a new node is being created by <em class="parameter"><code>manager</code></em>. If <em class="parameter"><code>func</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
then each created node will be a <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> object.
</p>
<p>
Specifying a custom <a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="type">GdaTreeManagerNodeFunc</span></a> function for example allows one to use
specialized sub-classed <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> objects.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> tree manager object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="type">GdaTreeManagerNodeFunc</span></a> function pointer, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-get-node-create-func"></a><h3>gda_tree_manager_get_node_create_func ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="returnvalue">GdaTreeManagerNodeFunc</span></a> gda_tree_manager_get_node_create_func
(<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>);</pre>
<p>
Get the function used by <em class="parameter"><code>manager</code></em> when creating new <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> nodes
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> tree manager object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaTreeManager.html#GdaTreeManagerNodeFunc" title="GdaTreeManagerNodeFunc ()"><span class="type">GdaTreeManagerNodeFunc</span></a> function, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the default function is used</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-manager-create-node"></a><h3>gda_tree_manager_create_node ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="returnvalue">GdaTreeNode</span></a> * gda_tree_manager_create_node (<em class="parameter"><code><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Requests that <em class="parameter"><code>manager</code></em> creates a new <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a>. The new node is not in any
way linked to <em class="parameter"><code>manager</code></em> yet, consider this method as a <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> factory.
</p>
<p>
This method is usually used when implementing a <a class="link" href="GdaTreeManager.html#GdaTreeManagerNodesFunc" title="GdaTreeManagerNodesFunc ()"><span class="type">GdaTreeManagerNodesFunc</span></a> function (to create nodes),
or when subclassing the <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the parent the new node may have, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name given to the new node, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="GdaTreeManager.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaTreeManager--func"></a><h3>The <code class="literal">"func"</code> property</h3>
<pre class="programlisting"> "func" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write / Construct</pre>
<p>
This property specifies the function which needs to be called when the list of <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> nodes
managed has to be updated
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeManager--recursive"></a><h3>The <code class="literal">"recursive"</code> property</h3>
<pre class="programlisting"> "recursive" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>
This property specifies if, when initially creating nodes or updating the list of nodes,
the tree manager shoud also request that each node it has created or updated also
initially create or update their children.
</p>
<p>
This property can typically set to FALSE if the process of creating children nodes is lenghty
and needs to be postponed while an event occurs.
</p>
<p>Default value: TRUE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|