← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimppatterns.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppatterns.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="libgimp-gimppatterns">
 
6
<refmeta>
 
7
<refentrytitle>gimppatterns</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimppatterns</refname><refpurpose>Functions relating to patterns.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-patterns-refresh">gimp_patterns_refresh</link>           (void);
 
23
<link linkend="gchar">gchar</link>**     <link linkend="gimp-patterns-get-list">gimp_patterns_get_list</link>          (const <link linkend="gchar">gchar</link> *filter,
 
24
                                             <link linkend="gint">gint</link> *num_patterns);
 
25
<link linkend="gchar">gchar</link>*      <link linkend="gimp-patterns-get-pattern">gimp_patterns_get_pattern</link>       (<link linkend="gint">gint</link> *width,
 
26
                                             <link linkend="gint">gint</link> *height);
 
27
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-patterns-set-pattern">gimp_patterns_set_pattern</link>       (const <link linkend="gchar">gchar</link> *name);
 
28
<link linkend="gchar">gchar</link>*      <link linkend="gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</link>  (const <link linkend="gchar">gchar</link> *name,
 
29
                                             <link linkend="gint">gint</link> *width,
 
30
                                             <link linkend="gint">gint</link> *height,
 
31
                                             <link linkend="gint">gint</link> *mask_bpp,
 
32
                                             <link linkend="gint">gint</link> *length,
 
33
                                             <link linkend="guint8">guint8</link> **mask_data);
 
34
</synopsis>
 
35
</refsynopsisdiv>
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
<refsect1>
 
46
<title>Description</title>
 
47
<para>
 
48
Functions relating to patterns.
 
49
 
 
50
</para>
 
51
</refsect1>
 
52
 
 
53
<refsect1>
 
54
<title>Details</title>
 
55
<refsect2>
 
56
<title><anchor id="gimp-patterns-refresh"/>gimp_patterns_refresh ()</title>
 
57
<indexterm><primary>gimp_patterns_refresh</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_patterns_refresh           (void);</programlisting>
 
58
<para>
 
59
Refresh current patterns. This function always succeeds.
 
60
</para>
 
61
<para>
 
62
This procedure retrieves all patterns currently in the user's
 
63
pattern path and updates all pattern dialogs accordingly.</para>
 
64
<para>
 
65
 
 
66
</para><variablelist role="params">
 
67
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
68
</simpara></listitem></varlistentry>
 
69
</variablelist></refsect2>
 
70
<refsect2>
 
71
<title><anchor id="gimp-patterns-get-list"/>gimp_patterns_get_list ()</title>
 
72
<indexterm><primary>gimp_patterns_get_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>**     gimp_patterns_get_list          (const <link linkend="gchar">gchar</link> *filter,
 
73
                                             <link linkend="gint">gint</link> *num_patterns);</programlisting>
 
74
<para>
 
75
Retrieve a complete listing of the available patterns.
 
76
</para>
 
77
<para>
 
78
This procedure returns a complete listing of available GIMP
 
79
patterns. Each name returned can be used as input to the
 
80
'gimp_context_set_pattern'.</para>
 
81
<para>
 
82
 
 
83
</para><variablelist role="params">
 
84
<varlistentry><term><parameter>filter</parameter>&nbsp;:</term>
 
85
<listitem><simpara> An optional regular expression used to filter the list.
 
86
</simpara></listitem></varlistentry>
 
87
<varlistentry><term><parameter>num_patterns</parameter>&nbsp;:</term>
 
88
<listitem><simpara> The number of patterns in the pattern list.
 
89
</simpara></listitem></varlistentry>
 
90
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The list of pattern names.
 
91
</simpara></listitem></varlistentry>
 
92
</variablelist></refsect2>
 
93
<refsect2>
 
94
<title><anchor id="gimp-patterns-get-pattern"/>gimp_patterns_get_pattern ()</title>
 
95
<indexterm role="deprecated"><primary>gimp_patterns_get_pattern</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_patterns_get_pattern       (<link linkend="gint">gint</link> *width,
 
96
                                             <link linkend="gint">gint</link> *height);</programlisting>
 
97
<warning><para><literal>gimp_patterns_get_pattern</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
98
<para>
 
99
This procedure is deprecated! Use <link linkend="gimp-context-get-pattern"><function>gimp_context_get_pattern()</function></link>
 
100
instead.</para>
 
101
<para>
 
102
 
 
103
</para><variablelist role="params">
 
104
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
105
<listitem><simpara> The pattern width.
 
106
</simpara></listitem></varlistentry>
 
107
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
108
<listitem><simpara> The pattern height.
 
109
</simpara></listitem></varlistentry>
 
110
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The pattern name.
 
111
</simpara></listitem></varlistentry>
 
112
</variablelist></refsect2>
 
113
<refsect2>
 
114
<title><anchor id="gimp-patterns-set-pattern"/>gimp_patterns_set_pattern ()</title>
 
115
<indexterm role="deprecated"><primary>gimp_patterns_set_pattern</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_patterns_set_pattern       (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
116
<warning><para><literal>gimp_patterns_set_pattern</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
117
<para>
 
118
This procedure is deprecated! Use <link linkend="gimp-context-set-pattern"><function>gimp_context_set_pattern()</function></link> instead.</para>
 
119
<para>
 
120
 
 
121
</para><variablelist role="params">
 
122
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
123
<listitem><simpara> The pattern name.
 
124
</simpara></listitem></varlistentry>
 
125
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist></refsect2>
 
128
<refsect2>
 
129
<title><anchor id="gimp-patterns-get-pattern-data"/>gimp_patterns_get_pattern_data ()</title>
 
130
<indexterm role="deprecated"><primary>gimp_patterns_get_pattern_data</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_patterns_get_pattern_data  (const <link linkend="gchar">gchar</link> *name,
 
131
                                             <link linkend="gint">gint</link> *width,
 
132
                                             <link linkend="gint">gint</link> *height,
 
133
                                             <link linkend="gint">gint</link> *mask_bpp,
 
134
                                             <link linkend="gint">gint</link> *length,
 
135
                                             <link linkend="guint8">guint8</link> **mask_data);</programlisting>
 
136
<warning><para><literal>gimp_patterns_get_pattern_data</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
137
<para>
 
138
This procedure is deprecated! Use <link linkend="gimp-pattern-get-pixels"><function>gimp_pattern_get_pixels()</function></link> instead.</para>
 
139
<para>
 
140
 
 
141
</para><variablelist role="params">
 
142
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
143
<listitem><simpara> The pattern name (\"\" means currently active pattern).
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
146
<listitem><simpara> The pattern width.
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
149
<listitem><simpara> The pattern height.
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><parameter>mask_bpp</parameter>&nbsp;:</term>
 
152
<listitem><simpara> Pattern bytes per pixel.
 
153
</simpara></listitem></varlistentry>
 
154
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 
155
<listitem><simpara> Length of pattern mask data.
 
156
</simpara></listitem></varlistentry>
 
157
<varlistentry><term><parameter>mask_data</parameter>&nbsp;:</term>
 
158
<listitem><simpara> The pattern mask data.
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The pattern name.
 
161
</simpara></listitem></varlistentry>
 
162
</variablelist></refsect2>
 
163
 
 
164
</refsect1>
 
165
 
 
166
 
 
167
 
 
168
 
 
169
</refentry>