/usr/share/gtk-doc/html/libgda-4.0/libgda-4.0-Attributes-manager.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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Attributes manager</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="misc.html" title="Miscellaneous">
<link rel="prev" href="libgda-4.0-Logging.html" title="Logging">
<link rel="next" href="part_tools.html" title="Part III. GDA Tools">
<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="libgda-4.0-Logging.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="misc.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="part_tools.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgda-4.0-Attributes-manager.synopsis" class="shortcut">Top</a>
|
<a href="#libgda-4.0-Attributes-manager.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgda-4.0-Attributes-manager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgda-4.0-Attributes-manager.top_of_page"></a>Attributes manager</span></h2>
<p>Attributes manager — Manager for lists of attributes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgda-4.0-Attributes-manager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-NAME:CAPS" title="GDA_ATTRIBUTE_NAME">GDA_ATTRIBUTE_NAME</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-DESCRIPTION:CAPS" title="GDA_ATTRIBUTE_DESCRIPTION">GDA_ATTRIBUTE_DESCRIPTION</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-AUTO-INCREMENT:CAPS" title="GDA_ATTRIBUTE_AUTO_INCREMENT">GDA_ATTRIBUTE_AUTO_INCREMENT</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-NUMERIC-PRECISION:CAPS" title="GDA_ATTRIBUTE_NUMERIC_PRECISION">GDA_ATTRIBUTE_NUMERIC_PRECISION</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-NUMERIC-SCALE:CAPS" title="GDA_ATTRIBUTE_NUMERIC_SCALE">GDA_ATTRIBUTE_NUMERIC_SCALE</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-IS-DEFAULT:CAPS" title="GDA_ATTRIBUTE_IS_DEFAULT">GDA_ATTRIBUTE_IS_DEFAULT</a>
#define <a class="link" href="libgda-4.0-Attributes-manager.html#GDA-ATTRIBUTE-TREE-NODE-UNKNOWN-CHILDREN:CAPS" title="GDA_ATTRIBUTE_TREE_NODE_UNKNOWN_CHILDREN">GDA_ATTRIBUTE_TREE_NODE_UNKNOWN_CHILDREN</a>
<a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager">GdaAttributesManager</a>;
<span class="returnvalue">void</span> (<a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerSignal" title="GdaAttributesManagerSignal ()">*GdaAttributesManagerSignal</a>) (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()">*GdaAttributesManagerFunc</a>) (<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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="returnvalue">GdaAttributesManager</span></a> * <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-new" title="gda_attributes_manager_new ()">gda_attributes_manager_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> for_objects</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerSignal" title="GdaAttributesManagerSignal ()"><span class="type">GdaAttributesManagerSignal</span></a> signal_func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> signal_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-free" title="gda_attributes_manager_free ()">gda_attributes_manager_free</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-set" title="gda_attributes_manager_set ()">gda_attributes_manager_set</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</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>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-set-full" title="gda_attributes_manager_set_full ()">gda_attributes_manager_set_full</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-get" title="gda_attributes_manager_get ()">gda_attributes_manager_get</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-copy" title="gda_attributes_manager_copy ()">gda_attributes_manager_copy</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *from_mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *from</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *to_mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *to</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-clear" title="gda_attributes_manager_clear ()">gda_attributes_manager_clear</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-foreach" title="gda_attributes_manager_foreach ()">gda_attributes_manager_foreach</a> (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgda-4.0-Attributes-manager.description"></a><h2>Description</h2>
<p>
The <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> manages lists of named values (attributes) for the benefit of
others (objects or resources for which only a pointer is known). It is used internally by <span class="application">Libgda</span>
whenever an object or a simple structure may have several attributes.
</p>
<p>
The features are similar to those of the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set-data"><GTKDOCLINK HREF="g-object-set-data"><code class="function">g_object_set_data()</code></a></GTKDOCLINK> and similar
but with the following major differences:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>it works with GObject objects and also with simple pointers to data</p></li>
<li class="listitem"><p>attributes names are considered static (they are not copied) and so they must either be static strings
or allocated strings which exist (unchanged) while an attribute uses it as name</p></li>
<li class="listitem"><p>it is possible to iterate through the attributes</p></li>
<li class="listitem"><p>the associated values are expected to be <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> values</p></li>
</ul></div>
<p>
</p>
<p>
Attibute names can be any string, but <span class="application">Libgda</span> reserves some for its own usage, see below.
</p>
<p>
The <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> implements its own locking mechanism so it is thread-safe.
</p>
</div>
<div class="refsect1">
<a name="libgda-4.0-Attributes-manager.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-NAME:CAPS"></a><h3>GDA_ATTRIBUTE_NAME</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_NAME "__gda_attr_name" /* G_TYPE_STRING */
</pre>
<p>
The corresponding attribute is the name of the object it refers to (value has a G_TYPE_STRING type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-DESCRIPTION:CAPS"></a><h3>GDA_ATTRIBUTE_DESCRIPTION</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_DESCRIPTION "__gda_attr_descr" /* G_TYPE_STRING */
</pre>
<p>
The corresponding attribute is the description of the object it refers to (value has a G_TYPE_STRING type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-AUTO-INCREMENT:CAPS"></a><h3>GDA_ATTRIBUTE_AUTO_INCREMENT</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_AUTO_INCREMENT "__gda_attr_autoinc" /* G_TYPE_BOOLEAN */
</pre>
<p>
The corresponding attribute specifies if the object it refers to is auto incremented (value has a G_TYPE_BOOLEAN type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-NUMERIC-PRECISION:CAPS"></a><h3>GDA_ATTRIBUTE_NUMERIC_PRECISION</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_NUMERIC_PRECISION "__gda_attr_numeric_precision" /* G_TYPE_INT */
</pre>
<p>
The corresponding attribute is the number of significant digits of the object it refers to (value has a G_TYPE_INT type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-NUMERIC-SCALE:CAPS"></a><h3>GDA_ATTRIBUTE_NUMERIC_SCALE</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_NUMERIC_SCALE "__gda_attr_numeric_scale" /* G_TYPE_INT */
</pre>
<p>
The corresponding attribute is the number of significant digits to the right of the decimal point of the object it refers to (value has a G_TYPE_INT type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-IS-DEFAULT:CAPS"></a><h3>GDA_ATTRIBUTE_IS_DEFAULT</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_IS_DEFAULT "__gda_attr_is_default" /* G_TYPE_BOOLEAN */
</pre>
<p>
The corresponding attribute specifies if the object it refers to has its value to default (value has a G_TYPE_BOOLEAN type).
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDA-ATTRIBUTE-TREE-NODE-UNKNOWN-CHILDREN:CAPS"></a><h3>GDA_ATTRIBUTE_TREE_NODE_UNKNOWN_CHILDREN</h3>
<pre class="programlisting">#define GDA_ATTRIBUTE_TREE_NODE_UNKNOWN_CHILDREN "__gda_attr_tnuchild"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaAttributesManager"></a><h3>GdaAttributesManager</h3>
<pre class="programlisting">typedef struct _GdaAttributesManager GdaAttributesManager;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaAttributesManagerSignal"></a><h3>GdaAttributesManagerSignal ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GdaAttributesManagerSignal) (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaAttributesManagerFunc"></a><h3>GdaAttributesManagerFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GdaAttributesManagerFunc) (<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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-new"></a><h3>gda_attributes_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="returnvalue">GdaAttributesManager</span></a> * gda_attributes_manager_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> for_objects</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerSignal" title="GdaAttributesManagerSignal ()"><span class="type">GdaAttributesManagerSignal</span></a> signal_func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> signal_data</code></em>);</pre>
<p>
Creates a new <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>, which can store (name, value) attributes for pointers or GObject objects
(in the latter case, the attributes are destroyed when objects are also destroyed).
</p>
<p>
Free-function: gda_attributes_manager_free
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>for_objects</code></em> :</span></p></td>
<td>set to TRUE if attributes will be set on objects.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>signal_func</code></em> :</span></p></td>
<td>a function to be called whenever an attribute changes on an object (if <em class="parameter"><code>for_objects</code></em> is TRUE), or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>signal_data</code></em> :</span></p></td>
<td>user data passed as last argument of <em class="parameter"><code>signal_func</code></em> when it is called</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-free"></a><h3>gda_attributes_manager_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_free (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>);</pre>
<p>
Frees all the resssources managed by <em class="parameter"><code>mgr</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>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-set"></a><h3>gda_attributes_manager_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_set (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</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>
Associates an attribute named <em class="parameter"><code>att_name</code></em> to <em class="parameter"><code>ptr</code></em>, with the value <em class="parameter"><code>value</code></em>. Any previous association is replaced by
this one, and 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 association is removed.
</p>
<p>
Note: <em class="parameter"><code>att_name</code></em> is *not* copied, so it should be a string which exists as long as <em class="parameter"><code>mgr</code></em> exists.
Libgda provides several predefined names for common attributes,
see this section.
</p>
<p>
If <em class="parameter"><code>att_name</code></em> needs to be freed when not used anymore, then use <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-set-full" title="gda_attributes_manager_set_full ()"><code class="function">gda_attributes_manager_set_full()</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>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td>a pointer to the resources to which the attribute will apply</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>att_name</code></em> :</span></p></td>
<td>an attribute's name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, 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/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-set-full"></a><h3>gda_attributes_manager_set_full ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_set_full (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
<p>
Does the same as <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-set" title="gda_attributes_manager_set ()"><code class="function">gda_attributes_manager_set()</code></a> except that <em class="parameter"><code>destroy</code></em> is called when <em class="parameter"><code>att_name</code></em> needs
to be freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td>a pointer to the resources to which the attribute will apply</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>att_name</code></em> :</span></p></td>
<td>an attribute's name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>function called when <em class="parameter"><code>att_name</code></em> has to be freed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-get"></a><h3>gda_attributes_manager_get ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> * gda_attributes_manager_get (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</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> *att_name</code></em>);</pre>
<p>
Retrieves the value of an attribute previously set using <a class="link" href="libgda-4.0-Attributes-manager.html#gda-attributes-manager-set" title="gda_attributes_manager_set ()"><code class="function">gda_attributes_manager_set()</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>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td>a pointer to the resources to which the attribute will apply</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>att_name</code></em> :</span></p></td>
<td>an attribute's name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</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> if the attribute is not set. <span class="annotation">[tranfer none]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-copy"></a><h3>gda_attributes_manager_copy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_copy (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *from_mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *from</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *to_mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *to</code></em>);</pre>
<p>
For each attribute set for <em class="parameter"><code>from</code></em> (in <em class="parameter"><code>from_mgr</code></em>), set the same attribute to <em class="parameter"><code>to</code></em> (in <em class="parameter"><code>to_mgr</code></em>). <em class="parameter"><code>from_mgr</code></em> and
<em class="parameter"><code>to_mgr</code></em> can be equal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>from_mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td>
<td>a pointer from which attributes are copied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>to_mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>to</code></em> :</span></p></td>
<td>a pointer to which attributes are copied</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-clear"></a><h3>gda_attributes_manager_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_clear (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>);</pre>
<p>
Remove all the attributes managed by <em class="parameter"><code>mgr</code></em> for the <em class="parameter"><code>ptr</code></em> resource.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td>a pointer to the resources for which all the attributes will be removed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-attributes-manager-foreach"></a><h3>gda_attributes_manager_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_attributes_manager_foreach (<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a> *mgr</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> ptr</code></em>,
<em class="parameter"><code><a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for every attribute set to <em class="parameter"><code>ptr</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>mgr</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManager" title="GdaAttributesManager"><span class="type">GdaAttributesManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ptr</code></em> :</span></p></td>
<td>a pointer to the resources for which all the attributes used</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <a class="link" href="libgda-4.0-Attributes-manager.html#GdaAttributesManagerFunc" title="GdaAttributesManagerFunc ()"><span class="type">GdaAttributesManagerFunc</span></a> function. <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"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data to be passed as last argument of <em class="parameter"><code>func</code></em> each time it is called. <span class="annotation">[<a href="http://foldoc.org/closure"><span class="acronym">closure</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|