/usr/share/gtk-doc/html/libgda-4.0/GdaTreeMgrTables.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaTreeMgrTables</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="GdaTreeMgrSchemas.html" title="GdaTreeMgrSchemas">
<link rel="next" href="GdaTreeMgrColumns.html" title="GdaTreeMgrColumns">
<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="GdaTreeMgrSchemas.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="GdaTreeMgrColumns.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaTreeMgrTables.synopsis" class="shortcut">Top</a>
|
<a href="#GdaTreeMgrTables.description" class="shortcut">Description</a>
|
<a href="#GdaTreeMgrTables.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaTreeMgrTables.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaTreeMgrTables"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaTreeMgrTables.top_of_page"></a>GdaTreeMgrTables</span></h2>
<p>GdaTreeMgrTables — a tree manager which creates a node for each table in a schema</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaTreeMgrTables.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables-struct" title="struct GdaTreeMgrTables">GdaTreeMgrTables</a>;
<a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> * <a class="link" href="GdaTreeMgrTables.html#gda-tree-mgr-tables-new" title="gda_tree_mgr_tables_new ()">gda_tree_mgr_tables_new</a> (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</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> *schema</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeMgrTables.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>
+----<a class="link" href="GdaTreeManager.html" title="GdaTreeManager">GdaTreeManager</a>
+----GdaTreeMgrTables
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeMgrTables.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables--connection" title='The "connection" property'>connection</a>" <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>* : Read / Write / Construct Only
"<a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables--meta-store" title='The "meta-store" property'>meta-store</a>" <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a>* : Read / Write / Construct Only
"<a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables--schema" title='The "schema" property'>schema</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GdaTreeMgrTables.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaTreeMgrTables.html" title="GdaTreeMgrTables"><span class="type">GdaTreeMgrTables</span></a> is a <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object which creates a node for
each table in a database schema.
</p>
<p>
It uses the <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> associated to a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> to get the tables list
in database schema; it's up to the
caller to make sure the data in the <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> is up to date.
</p>
<p>
The <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> to be used needs to be specified when the object is created. The
schema can however be specified when the object is created, and if not, is
fetched from the <a class="link" href="GdaTreeNode.html" title="GdaTreeNode"><span class="type">GdaTreeNode</span></a> below which the nodes will be placed (using
<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>).
</p>
</div>
<div class="refsect1">
<a name="GdaTreeMgrTables.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaTreeMgrTables-struct"></a><h3>struct GdaTreeMgrTables</h3>
<pre class="programlisting">struct GdaTreeMgrTables;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-tree-mgr-tables-new"></a><h3>gda_tree_mgr_tables_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="returnvalue">GdaTreeManager</span></a> * gda_tree_mgr_tables_new (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</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> *schema</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object which will add one tree node for each table found in the
<em class="parameter"><code>schema</code></em> if it is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, or for each table visible by default in <em class="parameter"><code>cnc</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>cnc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>a schema name 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="GdaTreeManager.html" title="GdaTreeManager"><span class="type">GdaTreeManager</span></a> object. <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="GdaTreeMgrTables.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaTreeMgrTables--connection"></a><h3>The <code class="literal">"connection"</code> property</h3>
<pre class="programlisting"> "connection" <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>* : Read / Write / Construct Only</pre>
<p>
Defines the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> to display information for. Necessary upon construction unless
the <a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables--meta-store" title='The "meta-store" property'><span class="type">"meta-store"</span></a> property is specified instead.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeMgrTables--meta-store"></a><h3>The <code class="literal">"meta-store"</code> property</h3>
<pre class="programlisting"> "meta-store" <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a>* : Read / Write / Construct Only</pre>
<p>
Defines the <a class="link" href="GdaMetaStore.html" title="GdaMetaStore"><span class="type">GdaMetaStore</span></a> to extract information from. Necessary upon construction unless
the <a class="link" href="GdaTreeMgrTables.html#GdaTreeMgrTables--connection" title='The "connection" property'><span class="type">"connection"</span></a> property is specified instead. This property has
priority over the GdaTreeMgrTables:connection property.
</p>
<p class="since">Since 4.2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaTreeMgrTables--schema"></a><h3>The <code class="literal">"schema"</code> property</h3>
<pre class="programlisting"> "schema" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>
If no set, then the table name will be fetched from the parent node using the "schema" attribute. If not
found that way, then the list of visible tables (tables which can be identified without having to specify
a schema) will be used
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|