← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/goffice/jaunty-updates

« back to all changes in this revision

Viewing changes to docs/reference/xml/gog-style.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gauvain Pocentek
  • Date: 2008-11-09 18:10:54 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20081109181054-uazweo6uci8h7bc5
Tags: 0.6.5-1ubuntu1
* Merge from debian unstable, remaining changes:
  - call intltool-update -p in debian/rules
  - libgoffice-gtk-0-6 is a transitional package
  - libgoffice-0-6 conflicts with libgoffice-gtk-0-6 (<< 0.6.3-1ubuntu2)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/gog-style.xml
4
4
<!ENTITY version SYSTEM "version.xml">
5
5
]
6
6
>
7
 
<refentry id="GogStyle">
 
7
<refentry id="goffice-06-gog-style">
8
8
<refmeta>
9
 
<refentrytitle role="top_of_page" id="GogStyle.top_of_page">GogStyle</refentrytitle>
 
9
<refentrytitle role="top_of_page" id="goffice-06-gog-style.top_of_page">GogStyle</refentrytitle>
10
10
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>GOFFICE Library</refmiscinfo>
 
11
<refmiscinfo>GOFFICE-0.6 Library</refmiscinfo>
12
12
</refmeta>
13
13
 
14
14
<refnamediv>
17
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
18
</refnamediv>
19
19
 
20
 
<refsynopsisdiv id="GogStyle.synopsis" role="synopsis">
 
20
<refsynopsisdiv id="goffice-06-gog-style.synopsis" role="synopsis">
21
21
<title role="synopsis.title">Synopsis</title>
22
 
 
 
22
<anchor id="GogStyle"/>
23
23
<synopsis>
24
 
                    <link linkend="GogStyle-struct">GogStyle</link>;
 
24
#define             <link linkend="GOG-STYLE-TYPE:CAPS">GOG_STYLE_TYPE</link>
 
25
#define             <link linkend="GOG-STYLE:CAPS">GOG_STYLE</link>                           (o)
 
26
#define             <link linkend="IS-GOG-STYLE:CAPS">IS_GOG_STYLE</link>                        (o)
 
27
<link linkend="GType">GType</link>               <link linkend="gog-style-get-type">gog_style_get_type</link>                  (void);
25
28
enum                <link linkend="GogStyleFlag">GogStyleFlag</link>;
26
29
enum                <link linkend="GogFillStyle">GogFillStyle</link>;
27
30
enum                <link linkend="GogImageType">GogImageType</link>;
28
31
                    <link linkend="GogStyleLine">GogStyleLine</link>;
29
32
                    <link linkend="GogStyleMark">GogStyleMark</link>;
30
 
<link linkend="GogStyle">GogStyle</link>*           <link linkend="gog-style-new">gog_style_new</link>                       (void);
31
 
<link linkend="GogStyle">GogStyle</link>*           <link linkend="gog-style-dup">gog_style_dup</link>                       (<link linkend="GogStyle">GogStyle</link> const *style);
 
33
                    <link linkend="GogStyle-struct">GogStyle</link>;
 
34
<link linkend="GogStyle">GogStyle</link> *          <link linkend="gog-style-new">gog_style_new</link>                       (void);
 
35
<link linkend="GogStyle">GogStyle</link> *          <link linkend="gog-style-dup">gog_style_dup</link>                       (<link linkend="GogStyle">GogStyle</link> const *style);
32
36
<link linkend="void">void</link>                <link linkend="gog-style-assign">gog_style_assign</link>                    (<link linkend="GogStyle">GogStyle</link> *dst,
33
37
                                                         <link linkend="GogStyle">GogStyle</link> const *src);
34
38
<link linkend="void">void</link>                <link linkend="gog-style-apply-theme">gog_style_apply_theme</link>               (<link linkend="GogStyle">GogStyle</link> *dst,
35
39
                                                         <link linkend="GogStyle">GogStyle</link> const *src);
 
40
<link linkend="GOMarker">GOMarker</link> const *    <link linkend="gog-style-get-marker">gog_style_get_marker</link>                (<link linkend="GogStyle">GogStyle</link> *style);
36
41
<link linkend="void">void</link>                <link linkend="gog-style-set-marker">gog_style_set_marker</link>                (<link linkend="GogStyle">GogStyle</link> *style,
37
42
                                                         <link linkend="GOMarker">GOMarker</link> *marker);
38
43
<link linkend="void">void</link>                <link linkend="gog-style-set-font-desc">gog_style_set_font_desc</link>             (<link linkend="GogStyle">GogStyle</link> *style,
52
57
<link linkend="gboolean">gboolean</link>            <link linkend="gog-style-is-outline-visible">gog_style_is_outline_visible</link>        (<link linkend="GogStyle">GogStyle</link> const *style);
53
58
<link linkend="gboolean">gboolean</link>            <link linkend="gog-style-is-fill-visible">gog_style_is_fill_visible</link>           (<link linkend="GogStyle">GogStyle</link> const *style);
54
59
<link linkend="void">void</link>                <link linkend="gog-style-force-auto">gog_style_force_auto</link>                (<link linkend="GogStyle">GogStyle</link> *style);
 
60
<link linkend="void">void</link>                <link linkend="gog-style-populate-editor">gog_style_populate_editor</link>           (<link linkend="GogStyle">GogStyle</link> *style,
 
61
                                                         <link linkend="GogEditor">GogEditor</link> *editor,
 
62
                                                         <link linkend="GogStyle">GogStyle</link> *default_style,
 
63
                                                         <link linkend="GOCmdContext">GOCmdContext</link> *cc,
 
64
                                                         <link linkend="GObject">GObject</link> *object_with_style,
 
65
                                                         <link linkend="gboolean">gboolean</link> watch_for_external_change);
55
66
<link linkend="gpointer">gpointer</link>            <link linkend="gog-style-get-editor">gog_style_get_editor</link>                (<link linkend="GogStyle">GogStyle</link> *style,
56
67
                                                         <link linkend="GogStyle">GogStyle</link> *default_style,
57
68
                                                         <link linkend="GOCmdContext">GOCmdContext</link> *cc,
58
69
                                                         <link linkend="GObject">GObject</link> *object_with_style);
59
 
<link linkend="void">void</link>                <link linkend="gog-style-populate-editor">gog_style_populate_editor</link>           (<link linkend="GogStyle">GogStyle</link> *style,
60
 
                                                         <link linkend="GogEditor">GogEditor</link> *editor,
61
 
                                                         <link linkend="GogStyle">GogStyle</link> *default_style,
62
 
                                                         <link linkend="GOCmdContext">GOCmdContext</link> *cc,
63
 
                                                         <link linkend="GObject">GObject</link> *object_with_style,
64
 
                                                         <link linkend="gboolean">gboolean</link> watch_for_external_change);
65
 
<link linkend="cairo-pattern-t">cairo_pattern_t</link>*    <link linkend="gog-style-create-cairo-pattern">gog_style_create_cairo_pattern</link>      (<link linkend="GogStyle">GogStyle</link> const *style,
 
70
<link linkend="cairo-pattern-t">cairo_pattern_t</link> *   <link linkend="gog-style-create-cairo-pattern">gog_style_create_cairo_pattern</link>      (<link linkend="GogStyle">GogStyle</link> const *style,
66
71
                                                         <link linkend="cairo-t">cairo_t</link> *cr);
67
 
<link linkend="GOMarker">GOMarker</link>const *     <link linkend="gog-style-get-marker">gog_style_get_marker</link>                (<link linkend="GogStyle">GogStyle</link> *style);
68
72
</synopsis>
69
73
</refsynopsisdiv>
70
74
 
71
 
<refsect1 id="GogStyle.object-hierarchy" role="object_hierarchy">
 
75
<refsect1 id="goffice-06-gog-style.object-hierarchy" role="object_hierarchy">
72
76
<title role="object_hierarchy.title">Object Hierarchy</title>
73
77
<synopsis>
74
78
  <link linkend="GObject">GObject</link>
79
83
 
80
84
 
81
85
 
82
 
<refsect1 id="GogStyle.implemented-interfaces" role="impl_interfaces">
 
86
<refsect1 id="goffice-06-gog-style.implemented-interfaces" role="impl_interfaces">
83
87
<title role="impl_interfaces.title">Implemented Interfaces</title>
84
88
<para>
85
89
GogStyle implements
91
95
 
92
96
 
93
97
 
94
 
<refsect1 id="GogStyle.description" role="desc">
 
98
<refsect1 id="goffice-06-gog-style.description" role="desc">
95
99
<title role="desc.title">Description</title>
96
100
<para>
97
101
 
98
102
</para>
99
103
</refsect1>
100
104
 
101
 
<refsect1 id="GogStyle.details" role="details">
 
105
<refsect1 id="goffice-06-gog-style.details" role="details">
102
106
<title role="details.title">Details</title>
103
 
<refsect2 id="GogStyle-struct" role="struct">
104
 
<title>GogStyle</title>
105
 
<indexterm zone="GogStyle-struct"><primary>GogStyle</primary></indexterm><programlisting>typedef struct _GogStyle GogStyle;</programlisting>
 
107
<refsect2 id="GOG-STYLE-TYPE:CAPS" role="macro">
 
108
<title>GOG_STYLE_TYPE</title>
 
109
<indexterm zone="GOG-STYLE-TYPE:CAPS"><primary>GOG_STYLE_TYPE</primary></indexterm><programlisting>#define GOG_STYLE_TYPE       (gog_style_get_type ())
 
110
</programlisting>
106
111
<para>
107
112
 
108
113
</para></refsect2>
 
114
<refsect2 id="GOG-STYLE:CAPS" role="macro">
 
115
<title>GOG_STYLE()</title>
 
116
<indexterm zone="GOG-STYLE:CAPS"><primary>GOG_STYLE</primary></indexterm><programlisting>#define GOG_STYLE(o)   (G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_STYLE_TYPE, GogStyle))
 
117
</programlisting>
 
118
<para>
 
119
 
 
120
</para><variablelist role="params">
 
121
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
 
122
<listitem><simpara>
 
123
 
 
124
 
 
125
</simpara></listitem></varlistentry>
 
126
</variablelist></refsect2>
 
127
<refsect2 id="IS-GOG-STYLE:CAPS" role="macro">
 
128
<title>IS_GOG_STYLE()</title>
 
129
<indexterm zone="IS-GOG-STYLE:CAPS"><primary>IS_GOG_STYLE</primary></indexterm><programlisting>#define IS_GOG_STYLE(o)  (G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_STYLE_TYPE))
 
130
</programlisting>
 
131
<para>
 
132
 
 
133
</para><variablelist role="params">
 
134
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
 
135
<listitem><simpara>
 
136
 
 
137
 
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist></refsect2>
 
140
<refsect2 id="gog-style-get-type" role="function">
 
141
<title>gog_style_get_type ()</title>
 
142
<indexterm zone="gog-style-get-type"><primary>gog_style_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               gog_style_get_type                  (void);</programlisting>
 
143
<para>
 
144
 
 
145
</para><variablelist role="params">
 
146
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
147
 
 
148
 
 
149
</simpara></listitem></varlistentry>
 
150
</variablelist></refsect2>
109
151
<refsect2 id="GogStyleFlag" role="enum">
110
152
<title>enum GogStyleFlag</title>
111
153
<indexterm zone="GogStyleFlag"><primary>GogStyleFlag</primary></indexterm><programlisting>typedef enum {
176
218
<para>
177
219
 
178
220
</para></refsect2>
 
221
<refsect2 id="GogStyle-struct" role="struct">
 
222
<title>GogStyle</title>
 
223
<indexterm zone="GogStyle-struct"><primary>GogStyle</primary></indexterm><programlisting>typedef struct _GogStyle GogStyle;</programlisting>
 
224
<para>
 
225
 
 
226
</para></refsect2>
179
227
<refsect2 id="gog-style-new" role="function">
180
228
<title>gog_style_new ()</title>
181
 
<indexterm zone="gog-style-new"><primary>gog_style_new</primary></indexterm><programlisting><link linkend="GogStyle">GogStyle</link>*           gog_style_new                       (void);</programlisting>
 
229
<indexterm zone="gog-style-new"><primary>gog_style_new</primary></indexterm><programlisting><link linkend="GogStyle">GogStyle</link> *          gog_style_new                       (void);</programlisting>
182
230
<para>
183
231
 
184
232
</para><variablelist role="params">
189
237
</variablelist></refsect2>
190
238
<refsect2 id="gog-style-dup" role="function">
191
239
<title>gog_style_dup ()</title>
192
 
<indexterm zone="gog-style-dup"><primary>gog_style_dup</primary></indexterm><programlisting><link linkend="GogStyle">GogStyle</link>*           gog_style_dup                       (<link linkend="GogStyle">GogStyle</link> const *style);</programlisting>
 
240
<indexterm zone="gog-style-dup"><primary>gog_style_dup</primary></indexterm><programlisting><link linkend="GogStyle">GogStyle</link> *          gog_style_dup                       (<link linkend="GogStyle">GogStyle</link> const *style);</programlisting>
193
241
<para>
194
242
Duplicates <parameter>style</parameter>.</para>
195
 
<variablelist role="params">
 
243
<para>
 
244
 
 
245
</para><variablelist role="params">
196
246
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
197
247
<listitem><simpara> a source <link linkend="GogStyle"><type>GogStyle</type></link>
198
248
</simpara></listitem></varlistentry>
222
272
<para>
223
273
Merge the attributes from <parameter>src</parameter> onto the elements of <parameter>dst</parameter> that were not user
224
274
assigned (is_auto)</para>
225
 
<variablelist role="params">
 
275
<para>
 
276
 
 
277
</para><variablelist role="params">
226
278
<varlistentry><term><parameter>dst</parameter>&nbsp;:</term>
227
279
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
228
280
</simpara></listitem></varlistentry>
230
282
<listitem><simpara>  <link linkend="GogStyle"><type>GogStyle</type></link>
231
283
</simpara></listitem></varlistentry>
232
284
</variablelist></refsect2>
 
285
<refsect2 id="gog-style-get-marker" role="function">
 
286
<title>gog_style_get_marker ()</title>
 
287
<indexterm zone="gog-style-get-marker"><primary>gog_style_get_marker</primary></indexterm><programlisting><link linkend="GOMarker">GOMarker</link> const *    gog_style_get_marker                (<link linkend="GogStyle">GogStyle</link> *style);</programlisting>
 
288
<para>
 
289
Accessor for <parameter>style</parameter>::marker, without referencing it.</para>
 
290
<para>
 
291
 
 
292
</para><variablelist role="params">
 
293
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
 
294
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
 
295
</simpara></listitem></varlistentry>
 
296
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the style <link linkend="GOMarker"><type>GOMarker</type></link>.
 
297
</simpara></listitem></varlistentry>
 
298
</variablelist></refsect2>
233
299
<refsect2 id="gog-style-set-marker" role="function">
234
300
<title>gog_style_set_marker ()</title>
235
301
<indexterm zone="gog-style-set-marker"><primary>gog_style_set_marker</primary></indexterm><programlisting><link linkend="void">void</link>                gog_style_set_marker                (<link linkend="GogStyle">GogStyle</link> *style,
236
302
                                                         <link linkend="GOMarker">GOMarker</link> *marker);</programlisting>
237
303
<para>
238
304
Absorb a reference to <parameter>marker</parameter> and assign it to <parameter>style</parameter>.</para>
239
 
<variablelist role="params">
 
305
<para>
 
306
 
 
307
</para><variablelist role="params">
240
308
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
241
309
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
242
310
</simpara></listitem></varlistentry>
298
366
                                                         <link linkend="char">char</link> *filename);</programlisting>
299
367
<para>
300
368
absorb the string and eventually free it.</para>
301
 
<variablelist role="params">
 
369
<para>
 
370
 
 
371
</para><variablelist role="params">
302
372
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
303
373
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
304
374
</simpara></listitem></varlistentry>
313
383
<para>
314
384
Set text rotation angle in degrees. Valid values are in the range
315
385
[-180.0° , 180.0°].</para>
316
 
<variablelist role="params">
 
386
<para>
 
387
 
 
388
</para><variablelist role="params">
317
389
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
318
390
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
319
391
</simpara></listitem></varlistentry>
407
479
 
408
480
</simpara></listitem></varlistentry>
409
481
</variablelist></refsect2>
410
 
<refsect2 id="gog-style-get-editor" role="function">
411
 
<title>gog_style_get_editor ()</title>
412
 
<indexterm zone="gog-style-get-editor"><primary>gog_style_get_editor</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gog_style_get_editor                (<link linkend="GogStyle">GogStyle</link> *style,
413
 
                                                         <link linkend="GogStyle">GogStyle</link> *default_style,
414
 
                                                         <link linkend="GOCmdContext">GOCmdContext</link> *cc,
415
 
                                                         <link linkend="GObject">GObject</link> *object_with_style);</programlisting>
416
 
<para>
417
 
 
418
 
</para><variablelist role="params">
419
 
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
420
 
<listitem><simpara>
421
 
</simpara></listitem></varlistentry>
422
 
<varlistentry><term><parameter>default_style</parameter>&nbsp;:</term>
423
 
<listitem><simpara>
424
 
</simpara></listitem></varlistentry>
425
 
<varlistentry><term><parameter>cc</parameter>&nbsp;:</term>
426
 
<listitem><simpara>
427
 
</simpara></listitem></varlistentry>
428
 
<varlistentry><term><parameter>object_with_style</parameter>&nbsp;:</term>
429
 
<listitem><simpara>
430
 
</simpara></listitem></varlistentry>
431
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
432
 
 
433
 
 
434
 
</simpara></listitem></varlistentry>
435
 
</variablelist></refsect2>
436
482
<refsect2 id="gog-style-populate-editor" role="function">
437
483
<title>gog_style_populate_editor ()</title>
438
484
<indexterm zone="gog-style-populate-editor"><primary>gog_style_populate_editor</primary></indexterm><programlisting><link linkend="void">void</link>                gog_style_populate_editor           (<link linkend="GogStyle">GogStyle</link> *style,
465
511
 
466
512
</simpara></listitem></varlistentry>
467
513
</variablelist></refsect2>
 
514
<refsect2 id="gog-style-get-editor" role="function">
 
515
<title>gog_style_get_editor ()</title>
 
516
<indexterm zone="gog-style-get-editor"><primary>gog_style_get_editor</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gog_style_get_editor                (<link linkend="GogStyle">GogStyle</link> *style,
 
517
                                                         <link linkend="GogStyle">GogStyle</link> *default_style,
 
518
                                                         <link linkend="GOCmdContext">GOCmdContext</link> *cc,
 
519
                                                         <link linkend="GObject">GObject</link> *object_with_style);</programlisting>
 
520
<para>
 
521
 
 
522
</para><variablelist role="params">
 
523
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
 
524
<listitem><simpara>
 
525
</simpara></listitem></varlistentry>
 
526
<varlistentry><term><parameter>default_style</parameter>&nbsp;:</term>
 
527
<listitem><simpara>
 
528
</simpara></listitem></varlistentry>
 
529
<varlistentry><term><parameter>cc</parameter>&nbsp;:</term>
 
530
<listitem><simpara>
 
531
</simpara></listitem></varlistentry>
 
532
<varlistentry><term><parameter>object_with_style</parameter>&nbsp;:</term>
 
533
<listitem><simpara>
 
534
</simpara></listitem></varlistentry>
 
535
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
536
 
 
537
 
 
538
</simpara></listitem></varlistentry>
 
539
</variablelist></refsect2>
468
540
<refsect2 id="gog-style-create-cairo-pattern" role="function">
469
541
<title>gog_style_create_cairo_pattern ()</title>
470
 
<indexterm zone="gog-style-create-cairo-pattern"><primary>gog_style_create_cairo_pattern</primary></indexterm><programlisting><link linkend="cairo-pattern-t">cairo_pattern_t</link>*    gog_style_create_cairo_pattern      (<link linkend="GogStyle">GogStyle</link> const *style,
 
542
<indexterm zone="gog-style-create-cairo-pattern"><primary>gog_style_create_cairo_pattern</primary></indexterm><programlisting><link linkend="cairo-pattern-t">cairo_pattern_t</link> *   gog_style_create_cairo_pattern      (<link linkend="GogStyle">GogStyle</link> const *style,
471
543
                                                         <link linkend="cairo-t">cairo_t</link> *cr);</programlisting>
472
544
<para>
473
545
Create a cairo_patern_t using the current style settings for filling.
474
546
A pattern will be created only if the style has the corresponding field
475
547
and if it is not set to a none constant.</para>
476
 
<variablelist role="params">
 
548
<para>
 
549
 
 
550
</para><variablelist role="params">
477
551
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
478
552
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
479
553
</simpara></listitem></varlistentry>
483
557
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the pattern or NULL if it could not be created.
484
558
</simpara></listitem></varlistentry>
485
559
</variablelist></refsect2>
486
 
<refsect2 id="gog-style-get-marker" role="function">
487
 
<title>gog_style_get_marker ()</title>
488
 
<indexterm zone="gog-style-get-marker"><primary>gog_style_get_marker</primary></indexterm><programlisting><link linkend="GOMarker">GOMarker</link>const *     gog_style_get_marker                (<link linkend="GogStyle">GogStyle</link> *style);</programlisting>
489
 
<para>
490
 
Accessor for <parameter>style</parameter>::marker, without referencing it.</para>
491
 
<variablelist role="params">
492
 
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
493
 
<listitem><simpara> <link linkend="GogStyle"><type>GogStyle</type></link>
494
 
</simpara></listitem></varlistentry>
495
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the style <link linkend="GOMarker"><type>GOMarker</type></link>.
496
 
</simpara></listitem></varlistentry>
497
 
</variablelist></refsect2>
498
560
 
499
561
</refsect1>
500
562