34
34
<th width="100%" align="center">Goffice Reference Manual</th>
35
35
<td><a accesskey="n" href="GogStyledObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
37
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2588575" class="shortcut">Top</a>
39
<a href="#id2615156" class="shortcut">Description</a>
41
<a href="#id2607713" class="shortcut">Object Hierarchy</a>
43
<a href="#id2607750" class="shortcut">Properties</a>
45
<a href="#id2615097" class="shortcut">Signals</a></nobr></td></tr>
37
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2585175" class="shortcut">Top</a>
39
<a href="#id2615144" class="shortcut">Description</a>
41
<a href="#id2605145" class="shortcut">Object Hierarchy</a>
43
<a href="#id2605182" class="shortcut">Properties</a>
45
<a href="#id2615084" class="shortcut">Signals</a></nobr></td></tr>
47
47
<div class="refentry" lang="en">
48
48
<a name="GogObject"></a><div class="titlepage"></div>
49
49
<div class="refnamediv"><table width="100%"><tr>
52
<a name="id2588575"></a><span class="refentrytitle">GogObject</span>
52
<a name="id2585175"></a><span class="refentrytitle">GogObject</span>
54
54
<p>GogObject — Base class for all objects of graph model</p>
174
174
<div class="refsect1" lang="en">
175
<a name="id2615156"></a><h2>Description</h2>
175
<a name="id2615144"></a><h2>Description</h2>
180
180
<div class="refsect1" lang="en">
181
<a name="id2615169"></a><h2>Details</h2>
181
<a name="id2615158"></a><h2>Details</h2>
182
182
<div class="refsect2" lang="en">
183
<a name="id2615179"></a><h3>
183
<a name="id2615167"></a><h3>
184
184
<a name="GogObject-struct"></a>GogObject</h3>
185
<a class="indexterm" name="id2615189"></a><pre class="programlisting">typedef struct _GogObject GogObject;</pre>
185
<a class="indexterm" name="id2615178"></a><pre class="programlisting">typedef struct _GogObject GogObject;</pre>
191
191
<div class="refsect2" lang="en">
192
<a name="id2615203"></a><h3>
192
<a name="id2615192"></a><h3>
193
193
<a name="GOG-PARAM-PERSISTENT:CAPS"></a>GOG_PARAM_PERSISTENT</h3>
194
<a class="indexterm" name="id2615213"></a><pre class="programlisting">#define GOG_PARAM_PERSISTENT (1 << (G_PARAM_USER_SHIFT+0))
194
<a class="indexterm" name="id2615202"></a><pre class="programlisting">#define GOG_PARAM_PERSISTENT (1 << (G_PARAM_USER_SHIFT+0))
238
238
<div class="refsect2" lang="en">
239
<a name="id2615324"></a><h3>
239
<a name="id2615313"></a><h3>
240
240
<a name="GogObjectNamingConv"></a>enum GogObjectNamingConv</h3>
241
<a class="indexterm" name="id2615334"></a><pre class="programlisting">typedef enum {
241
<a class="indexterm" name="id2615324"></a><pre class="programlisting">typedef enum {
242
242
GOG_OBJECT_NAME_BY_ROLE = 1,
243
243
GOG_OBJECT_NAME_BY_TYPE = 2,
244
244
GOG_OBJECT_NAME_MANUALLY = 3
283
283
<div class="refsect2" lang="en">
284
<a name="id2615386"></a><h3>
284
<a name="id2615375"></a><h3>
285
285
<a name="gog-object-dup"></a>gog_object_dup ()</h3>
286
<a class="indexterm" name="id2615396"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_dup (<a href="GogObject.html" title="GogObject">GogObject</a> const *src,
286
<a class="indexterm" name="id2615386"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_dup (<a href="GogObject.html" title="GogObject">GogObject</a> const *src,
287
287
<a href="GogObject.html" title="GogObject">GogObject</a> *new_parent,
288
288
<a href="GogObject.html#GogDataDuplicator">GogDataDuplicator</a> datadup);</pre>
522
522
<div class="refsect2" lang="en">
523
<a name="id2616083"></a><h3>
523
<a name="id2616073"></a><h3>
524
524
<a name="gog-object-get-children"></a>gog_object_get_children ()</h3>
525
<a class="indexterm" name="id2616094"></a><pre class="programlisting">GSList* gog_object_get_children (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
525
<a class="indexterm" name="id2616083"></a><pre class="programlisting">GSList* gog_object_get_children (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
526
526
<a href="GogObject.html#GogObjectRole">GogObjectRole</a> const *filter);</pre>
528
528
The list needs to be Freed</p>
556
556
<div class="refsect2" lang="en">
557
<a name="id2616179"></a><h3>
557
<a name="id2616169"></a><h3>
558
558
<a name="gog-object-get-child-by-role"></a>gog_object_get_child_by_role ()</h3>
559
<a class="indexterm" name="id2616190"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_get_child_by_role (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
559
<a class="indexterm" name="id2616181"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_get_child_by_role (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
560
560
<a href="GogObject.html#GogObjectRole">GogObjectRole</a> const *role);</pre>
562
562
A convenience routine to handle a unique child</p>
627
627
<div class="refsect2" lang="en">
628
<a name="id2616407"></a><h3>
628
<a name="id2616398"></a><h3>
629
629
<a name="gog-object-new-view"></a>gog_object_new_view ()</h3>
630
<a class="indexterm" name="id2616417"></a><pre class="programlisting"><a href="GogView.html" title="GogView">GogView</a>* gog_object_new_view (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
630
<a class="indexterm" name="id2616408"></a><pre class="programlisting"><a href="GogView.html" title="GogView">GogView</a>* gog_object_new_view (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
631
631
<a href="GogView.html" title="GogView">GogView</a> *parent);</pre>
633
633
Creates a new <a href="GogView.html" title="GogView"><span class="type">GogView</span></a> associated to <em class="parameter"><code>obj</code></em>, and sets its parent to <em class="parameter"><code>parent</code></em>.</p>
714
714
<div class="refsect2" lang="en">
715
<a name="id2616669"></a><h3>
715
<a name="id2616660"></a><h3>
716
716
<a name="gog-object-add-by-role"></a>gog_object_add_by_role ()</h3>
717
<a class="indexterm" name="id2616679"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_add_by_role (<a href="GogObject.html" title="GogObject">GogObject</a> *parent,
717
<a class="indexterm" name="id2616670"></a><pre class="programlisting"><a href="GogObject.html" title="GogObject">GogObject</a>* gog_object_add_by_role (<a href="GogObject.html" title="GogObject">GogObject</a> *parent,
718
718
<a href="GogObject.html#GogObjectRole">GogObjectRole</a> const *role,
719
719
<a href="GogObject.html" title="GogObject">GogObject</a> *child);</pre>
863
863
<div class="refsect2" lang="en">
864
<a name="id2617124"></a><h3>
864
<a name="id2617114"></a><h3>
865
865
<a name="gog-object-get-position-flags"></a>gog_object_get_position_flags ()</h3>
866
<a class="indexterm" name="id2617136"></a><pre class="programlisting">GogObjectPosition gog_object_get_position_flags (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
866
<a class="indexterm" name="id2617127"></a><pre class="programlisting">GogObjectPosition gog_object_get_position_flags (<a href="GogObject.html" title="GogObject">GogObject</a> const *obj,
867
867
GogObjectPosition mask);</pre>
869
869
Retrieve position flags of GogObject <em class="parameter"><code>obj</code></em>, masked by <em class="parameter"><code>mask</code></em>.</p>
962
962
<div class="refsect2" lang="en">
963
<a name="id2617469"></a><h3>
963
<a name="id2617467"></a><h3>
964
964
<a name="gog-object-set-manual-position"></a>gog_object_set_manual_position ()</h3>
965
<a class="indexterm" name="id2617483"></a><pre class="programlisting">void gog_object_set_manual_position (<a href="GogObject.html" title="GogObject">GogObject</a> *obj,
965
<a class="indexterm" name="id2617481"></a><pre class="programlisting">void gog_object_set_manual_position (<a href="GogObject.html" title="GogObject">GogObject</a> *obj,
966
966
GogViewAllocation const *pos);</pre>
968
968
set manual position of given object, in points.</p>
989
989
<div class="refsect2" lang="en">
990
<a name="id2617570"></a><h3>
990
<a name="id2617567"></a><h3>
991
991
<a name="gog-object-get-manual-allocation"></a>gog_object_get_manual_allocation ()</h3>
992
<a class="indexterm" name="id2617584"></a><pre class="programlisting">GogViewAllocation gog_object_get_manual_allocation (<a href="GogObject.html" title="GogObject">GogObject</a> *gobj,
992
<a class="indexterm" name="id2617581"></a><pre class="programlisting">GogViewAllocation gog_object_get_manual_allocation (<a href="GogObject.html" title="GogObject">GogObject</a> *gobj,
993
993
GogViewAllocation const *parent_allocation,
994
994
GogViewRequisition const *requisition);</pre>
1161
1161
<div class="refsect2" lang="en">
1162
<a name="id2618097"></a><h3>
1162
<a name="id2618094"></a><h3>
1163
1163
<a name="gog-object-set-parent"></a>gog_object_set_parent ()</h3>
1164
<a class="indexterm" name="id2618110"></a><pre class="programlisting">gboolean gog_object_set_parent (<a href="GogObject.html" title="GogObject">GogObject</a> *child,
1164
<a class="indexterm" name="id2618108"></a><pre class="programlisting">gboolean gog_object_set_parent (<a href="GogObject.html" title="GogObject">GogObject</a> *child,
1165
1165
<a href="GogObject.html" title="GogObject">GogObject</a> *parent,
1166
1166
<a href="GogObject.html#GogObjectRole">GogObjectRole</a> const *role,
1167
1167
unsigned int id);</pre>
1207
1207
<div class="refsect2" lang="en">
1208
<a name="id2618270"></a><h3>
1208
<a name="id2618268"></a><h3>
1209
1209
<a name="gog-object-register-roles"></a>gog_object_register_roles ()</h3>
1210
<a class="indexterm" name="id2618285"></a><pre class="programlisting">void gog_object_register_roles (GogObjectClass *klass,
1210
<a class="indexterm" name="id2618282"></a><pre class="programlisting">void gog_object_register_roles (GogObjectClass *klass,
1211
1211
<a href="GogObject.html#GogObjectRole">GogObjectRole</a> const *roles,
1212
unsigned n_roles );</pre>
1212
unsigned n_roles);</pre>
1260
1260
<div class="refsect1" lang="en">
1261
<a name="id2618448"></a><h2>Property Details</h2>
1261
<a name="id2618445"></a><h2>Property Details</h2>
1262
1262
<div class="refsect2" lang="en">
1263
<a name="id2618459"></a><h3>
1263
<a name="id2618456"></a><h3>
1264
1264
<a name="GogObject--alignment"></a>The <code class="literal">"alignment"</code> property</h3>
1265
<a class="indexterm" name="id2618475"></a><pre class="programlisting"> "alignment" gchararray : Read / Write</pre>
1265
<a class="indexterm" name="id2618472"></a><pre class="programlisting"> "alignment" gchararray : Read / Write</pre>
1266
1266
<p>Alignment flag.</p>
1267
1267
<p>Default value: "fill"</p>
1270
1270
<div class="refsect2" lang="en">
1271
<a name="id2618501"></a><h3>
1271
<a name="id2618498"></a><h3>
1272
1272
<a name="GogObject--anchor"></a>The <code class="literal">"anchor"</code> property</h3>
1273
<a class="indexterm" name="id2618516"></a><pre class="programlisting"> "anchor" gchararray : Read / Write</pre>
1273
<a class="indexterm" name="id2618514"></a><pre class="programlisting"> "anchor" gchararray : Read / Write</pre>
1274
1274
<p>Anchor for manual position.</p>
1275
1275
<p>Default value: "top-left"</p>
1278
1278
<div class="refsect2" lang="en">
1279
<a name="id2618543"></a><h3>
1279
<a name="id2618540"></a><h3>
1280
1280
<a name="GogObject--compass"></a>The <code class="literal">"compass"</code> property</h3>
1281
<a class="indexterm" name="id2618559"></a><pre class="programlisting"> "compass" gchararray : Read / Write</pre>
1281
<a class="indexterm" name="id2618556"></a><pre class="programlisting"> "compass" gchararray : Read / Write</pre>
1282
1282
<p>Compass auto position flags.</p>
1283
1283
<p>Default value: "top"</p>
1286
1286
<div class="refsect2" lang="en">
1287
<a name="id2618585"></a><h3>
1287
<a name="id2618583"></a><h3>
1288
1288
<a name="GogObject--id"></a>The <code class="literal">"id"</code> property</h3>
1289
<a class="indexterm" name="id2618601"></a><pre class="programlisting"> "id" guint : Read / Write</pre>
1289
<a class="indexterm" name="id2618599"></a><pre class="programlisting"> "id" guint : Read / Write</pre>
1290
1290
<p>Object numerical ID.</p>
1291
1291
<p>Allowed values: <= G_MAXINT</p>
1292
1292
<p>Default value: 0</p>
1295
1295
<div class="refsect2" lang="en">
1296
<a name="id2618632"></a><h3>
1296
<a name="id2618629"></a><h3>
1297
1297
<a name="GogObject--is-position-manual"></a>The <code class="literal">"is-position-manual"</code> property</h3>
1298
<a class="indexterm" name="id2618649"></a><pre class="programlisting"> "is-position-manual" gboolean : Read / Write</pre>
1298
<a class="indexterm" name="id2618646"></a><pre class="programlisting"> "is-position-manual" gboolean : Read / Write</pre>
1299
1299
<p>Is position manual.</p>
1300
1300
<p>Default value: FALSE</p>
1303
1303
<div class="refsect2" lang="en">
1304
<a name="id2618675"></a><h3>
1304
<a name="id2618672"></a><h3>
1305
1305
<a name="GogObject--position"></a>The <code class="literal">"position"</code> property</h3>
1306
<a class="indexterm" name="id2618691"></a><pre class="programlisting"> "position" gchararray : Read / Write</pre>
1306
<a class="indexterm" name="id2618689"></a><pre class="programlisting"> "position" gchararray : Read / Write</pre>
1307
1307
<p>Position and size of object, in percentage of parent size.</p>
1308
1308
<p>Default value: "0 0 1 1"</p>
1311
1311
<div class="refsect1" lang="en">
1312
<a name="id2618719"></a><h2>Signal Details</h2>
1312
<a name="id2618717"></a><h2>Signal Details</h2>
1313
1313
<div class="refsect2" lang="en">
1314
<a name="id2618730"></a><h3>
1314
<a name="id2618728"></a><h3>
1315
1315
<a name="GogObject-changed"></a>The <code class="literal">"changed"</code> signal</h3>
1316
<a class="indexterm" name="id2618746"></a><pre class="programlisting">void user_function (<a href="GogObject.html" title="GogObject">GogObject</a> *gogobject,
1316
<a class="indexterm" name="id2618744"></a><pre class="programlisting">void user_function (<a href="GogObject.html" title="GogObject">GogObject</a> *gogobject,
1318
1318
gpointer user_data) : Run Last</pre>