← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/xml/go-pattern.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/go-pattern.xml
4
4
<!ENTITY version SYSTEM "version.xml">
5
5
]
6
6
>
7
 
<refentry id="goffice-GoPattern">
 
7
<refentry id="goffice-06-go-pattern">
8
8
<refmeta>
9
 
<refentrytitle role="top_of_page" id="goffice-GoPattern.top_of_page">GoPattern</refentrytitle>
 
9
<refentrytitle role="top_of_page" id="goffice-06-go-pattern.top_of_page">go-pattern</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>
15
 
<refname>GoPattern</refname>
 
15
<refname>go-pattern</refname>
16
16
<refpurpose></refpurpose>
17
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
18
18
</refnamediv>
19
19
 
20
 
<refsynopsisdiv id="goffice-GoPattern.synopsis" role="synopsis">
 
20
<refsynopsisdiv id="goffice-06-go-pattern.synopsis" role="synopsis">
21
21
<title role="synopsis.title">Synopsis</title>
22
22
 
23
23
<synopsis>
24
24
                    <link linkend="GOPattern">GOPattern</link>;
25
25
enum                <link linkend="GOPatternType">GOPatternType</link>;
26
26
<link linkend="GOPatternType">GOPatternType</link>       <link linkend="go-pattern-from-str">go_pattern_from_str</link>                 (<link linkend="char">char</link> const *name);
27
 
<link linkend="char">char</link>const   *         <link linkend="go-pattern-as-str">go_pattern_as_str</link>                   (<link linkend="GOPatternType">GOPatternType</link> pattern);
 
27
<link linkend="char">char</link> const  *        <link linkend="go-pattern-as-str">go_pattern_as_str</link>                   (<link linkend="GOPatternType">GOPatternType</link> pattern);
28
28
<link linkend="gboolean">gboolean</link>            <link linkend="go-pattern-is-solid">go_pattern_is_solid</link>                 (<link linkend="GOPattern">GOPattern</link> const *pat,
29
29
                                                         <link linkend="GOColor">GOColor</link> *color);
30
30
<link linkend="void">void</link>                <link linkend="go-pattern-set-solid">go_pattern_set_solid</link>                (<link linkend="GOPattern">GOPattern</link> *pat,
31
31
                                                         <link linkend="GOColor">GOColor</link> fore);
32
 
<link linkend="guint8">guint8</link>const       *      <link linkend="go-pattern-get-pattern">go_pattern_get_pattern</link>              (<link linkend="GOPattern">GOPattern</link> const *pat);
33
 
<link linkend="xmlChar">xmlChar</link>*            <link linkend="go-pattern-get-svg-path">go_pattern_get_svg_path</link>             (<link linkend="GOPattern">GOPattern</link> const *pattern,
 
32
<link linkend="guint8">guint8</link> const      *     <link linkend="go-pattern-get-pattern">go_pattern_get_pattern</link>              (<link linkend="GOPattern">GOPattern</link> const *pat);
 
33
<link linkend="xmlChar">xmlChar</link> *           <link linkend="go-pattern-get-svg-path">go_pattern_get_svg_path</link>             (<link linkend="GOPattern">GOPattern</link> const *pattern,
34
34
                                                         <link linkend="double">double</link> *width,
35
35
                                                         <link linkend="double">double</link> *height);
36
 
<link linkend="cairo-pattern-t">cairo_pattern_t</link>*    <link linkend="go-pattern-create-cairo-pattern">go_pattern_create_cairo_pattern</link>     (<link linkend="GOPattern">GOPattern</link> const *pattern,
 
36
<link linkend="cairo-pattern-t">cairo_pattern_t</link> *   <link linkend="go-pattern-create-cairo-pattern">go_pattern_create_cairo_pattern</link>     (<link linkend="GOPattern">GOPattern</link> const *pattern,
37
37
                                                         <link linkend="cairo-t">cairo_t</link> *cr);
38
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="go-pattern-selector-new">go_pattern_selector_new</link>             (<link linkend="GOPatternType">GOPatternType</link> initial_type,
39
 
                                                         <link linkend="GOPatternType">GOPatternType</link> default_type);
40
 
<link linkend="void">void</link>                <link linkend="go-pattern-selector-set-colors">go_pattern_selector_set_colors</link>      (<link linkend="GOSelector">GOSelector</link> *selector,
41
 
                                                         <link linkend="GOColor">GOColor</link> foreground,
42
 
                                                         <link linkend="GOColor">GOColor</link> background);
43
38
</synopsis>
44
39
</refsynopsisdiv>
45
40
 
51
46
 
52
47
 
53
48
 
54
 
<refsect1 id="goffice-GoPattern.description" role="desc">
 
49
<refsect1 id="goffice-06-go-pattern.description" role="desc">
55
50
<title role="desc.title">Description</title>
56
51
<para>
57
52
 
58
53
</para>
59
54
</refsect1>
60
55
 
61
 
<refsect1 id="goffice-GoPattern.details" role="details">
 
56
<refsect1 id="goffice-06-go-pattern.details" role="details">
62
57
<title role="details.title">Details</title>
63
58
<refsect2 id="GOPattern" role="struct">
64
59
<title>GOPattern</title>
119
114
</variablelist></refsect2>
120
115
<refsect2 id="go-pattern-as-str" role="function">
121
116
<title>go_pattern_as_str ()</title>
122
 
<indexterm zone="go-pattern-as-str"><primary>go_pattern_as_str</primary></indexterm><programlisting><link linkend="char">char</link>const       *         go_pattern_as_str                   (<link linkend="GOPatternType">GOPatternType</link> pattern);</programlisting>
 
117
<indexterm zone="go-pattern-as-str"><primary>go_pattern_as_str</primary></indexterm><programlisting><link linkend="char">char</link> const      *        go_pattern_as_str                   (<link linkend="GOPatternType">GOPatternType</link> pattern);</programlisting>
123
118
<para>
124
119
 
125
120
</para><variablelist role="params">
137
132
                                                         <link linkend="GOColor">GOColor</link> *color);</programlisting>
138
133
<para>
139
134
</para>
140
 
<variablelist role="params">
 
135
<para>
 
136
 
 
137
</para><variablelist role="params">
141
138
<varlistentry><term><parameter>pat</parameter>&nbsp;:</term>
142
139
<listitem><simpara> <link linkend="GOPattern"><type>GOPattern</type></link>
143
140
</simpara></listitem></varlistentry>
154
151
                                                         <link linkend="GOColor">GOColor</link> fore);</programlisting>
155
152
<para>
156
153
Makes <parameter>pat</parameter> a solid pattern with colour <parameter>fore</parameter>.</para>
157
 
<variablelist role="params">
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
158
157
<varlistentry><term><parameter>pat</parameter>&nbsp;:</term>
159
158
<listitem><simpara> a <link linkend="GOPattern"><type>GOPattern</type></link>
160
159
</simpara></listitem></varlistentry>
164
163
</variablelist></refsect2>
165
164
<refsect2 id="go-pattern-get-pattern" role="function">
166
165
<title>go_pattern_get_pattern ()</title>
167
 
<indexterm zone="go-pattern-get-pattern"><primary>go_pattern_get_pattern</primary></indexterm><programlisting><link linkend="guint8">guint8</link>const         *      go_pattern_get_pattern              (<link linkend="GOPattern">GOPattern</link> const *pat);</programlisting>
 
166
<indexterm zone="go-pattern-get-pattern"><primary>go_pattern_get_pattern</primary></indexterm><programlisting><link linkend="guint8">guint8</link> const        *     go_pattern_get_pattern              (<link linkend="GOPattern">GOPattern</link> const *pat);</programlisting>
168
167
<para>
169
168
 
170
169
</para><variablelist role="params">
178
177
</variablelist></refsect2>
179
178
<refsect2 id="go-pattern-get-svg-path" role="function">
180
179
<title>go_pattern_get_svg_path ()</title>
181
 
<indexterm zone="go-pattern-get-svg-path"><primary>go_pattern_get_svg_path</primary></indexterm><programlisting><link linkend="xmlChar">xmlChar</link>*            go_pattern_get_svg_path             (<link linkend="GOPattern">GOPattern</link> const *pattern,
 
180
<indexterm zone="go-pattern-get-svg-path"><primary>go_pattern_get_svg_path</primary></indexterm><programlisting><link linkend="xmlChar">xmlChar</link> *           go_pattern_get_svg_path             (<link linkend="GOPattern">GOPattern</link> const *pattern,
182
181
                                                         <link linkend="double">double</link> *width,
183
182
                                                         <link linkend="double">double</link> *height);</programlisting>
184
183
<para>
188
187
<para>
189
188
If width != NULL, returns pattern width.
190
189
If height != NULL, returns pattern height.</para>
191
 
<variablelist role="params">
 
190
<para>
 
191
 
 
192
</para><variablelist role="params">
192
193
<varlistentry><term><parameter>pattern</parameter>&nbsp;:</term>
193
194
<listitem><simpara> a <link linkend="GOPattern"><type>GOPattern</type></link>
194
195
</simpara></listitem></varlistentry>
203
204
</variablelist></refsect2>
204
205
<refsect2 id="go-pattern-create-cairo-pattern" role="function">
205
206
<title>go_pattern_create_cairo_pattern ()</title>
206
 
<indexterm zone="go-pattern-create-cairo-pattern"><primary>go_pattern_create_cairo_pattern</primary></indexterm><programlisting><link linkend="cairo-pattern-t">cairo_pattern_t</link>*    go_pattern_create_cairo_pattern     (<link linkend="GOPattern">GOPattern</link> const *pattern,
 
207
<indexterm zone="go-pattern-create-cairo-pattern"><primary>go_pattern_create_cairo_pattern</primary></indexterm><programlisting><link linkend="cairo-pattern-t">cairo_pattern_t</link> *   go_pattern_create_cairo_pattern     (<link linkend="GOPattern">GOPattern</link> const *pattern,
207
208
                                                         <link linkend="cairo-t">cairo_t</link> *cr);</programlisting>
208
209
<para>
209
210
Creates a cairo pattern object corresponding to <parameter>pattern</parameter> parameters. The returned
210
211
surface must be freed after use, using cairo_pattern_destroy.</para>
211
 
<variablelist role="params">
 
212
<para>
 
213
 
 
214
</para><variablelist role="params">
212
215
<varlistentry><term><parameter>pattern</parameter>&nbsp;:</term>
213
216
<listitem><simpara> a <link linkend="GOPattern"><type>GOPattern</type></link>
214
217
</simpara></listitem></varlistentry>
220
223
 
221
224
</simpara></listitem></varlistentry>
222
225
</variablelist></refsect2>
223
 
<refsect2 id="go-pattern-selector-new" role="function">
224
 
<title>go_pattern_selector_new ()</title>
225
 
<indexterm zone="go-pattern-selector-new"><primary>go_pattern_selector_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          go_pattern_selector_new             (<link linkend="GOPatternType">GOPatternType</link> initial_type,
226
 
                                                         <link linkend="GOPatternType">GOPatternType</link> default_type);</programlisting>
227
 
<para>
228
 
Creates a new pattern selector.</para>
229
 
<variablelist role="params">
230
 
<varlistentry><term><parameter>initial_type</parameter>&nbsp;:</term>
231
 
<listitem><simpara> pattern type initially selected
232
 
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><parameter>default_type</parameter>&nbsp;:</term>
234
 
<listitem><simpara> automatic pattern type
235
 
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GtkWidget"><type>GtkWidget</type></link>.
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist></refsect2>
239
 
<refsect2 id="go-pattern-selector-set-colors" role="function">
240
 
<title>go_pattern_selector_set_colors ()</title>
241
 
<indexterm zone="go-pattern-selector-set-colors"><primary>go_pattern_selector_set_colors</primary></indexterm><programlisting><link linkend="void">void</link>                go_pattern_selector_set_colors      (<link linkend="GOSelector">GOSelector</link> *selector,
242
 
                                                         <link linkend="GOColor">GOColor</link> foreground,
243
 
                                                         <link linkend="GOColor">GOColor</link> background);</programlisting>
244
 
<para>
245
 
Updates swatch colors of <parameter>selector</parameter>.</para>
246
 
<variablelist role="params">
247
 
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
248
 
<listitem><simpara> a pattern <link linkend="GOSelector"><type>GOSelector</type></link>
249
 
</simpara></listitem></varlistentry>
250
 
<varlistentry><term><parameter>foreground</parameter>&nbsp;:</term>
251
 
<listitem><simpara> foreground color
252
 
</simpara></listitem></varlistentry>
253
 
<varlistentry><term><parameter>background</parameter>&nbsp;:</term>
254
 
<listitem><simpara> background color
255
 
</simpara></listitem></varlistentry>
256
 
</variablelist></refsect2>
257
226
 
258
227
</refsect1>
259
228