← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimppatterns.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimppatterns</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
8
<link rel="up" href="libgimp-data.html" title="Data Objects">
9
9
<link rel="prev" href="libgimp-gimppattern.html" title="gimppattern">
10
10
<link rel="next" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-selectors.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2625655" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2641745" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2639864" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2692727" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimppatterns"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2625655"></a><span class="refentrytitle">gimppatterns</span>
 
43
<a name="id2641745"></a><span class="refentrytitle">gimppatterns</span>
41
44
</h2>
42
45
<p>gimppatterns &#8212; Functions relating to patterns.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gboolean    <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a>           (void);
53
 
gchar**     <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a>          (const gchar *filter,
54
 
                                             gint *num_patterns);
55
 
gchar*      <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a>       (gint *width,
56
 
                                             gint *height);
57
 
gboolean    <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a>       (const gchar *name);
58
 
gchar*      <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a>  (const gchar *name,
59
 
                                             gint *width,
60
 
                                             gint *height,
61
 
                                             gint *mask_bpp,
62
 
                                             gint *length,
63
 
                                             guint8 **mask_data);
 
55
gboolean            <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a>               (void);
 
56
gchar**             <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a>              (const gchar *filter,
 
57
                                                         gint *num_patterns);
 
58
gchar*              <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a>           (gint *width,
 
59
                                                         gint *height);
 
60
gboolean            <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a>           (const gchar *name);
 
61
gchar*              <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a>      (const gchar *name,
 
62
                                                         gint *width,
 
63
                                                         gint *height,
 
64
                                                         gint *mask_bpp,
 
65
                                                         gint *length,
 
66
                                                         guint8 **mask_data);
64
67
</pre>
65
68
</div>
66
69
<div class="refsect1" lang="en">
67
 
<a name="id2639864"></a><h2>Description</h2>
 
70
<a name="id2692727"></a><h2>Description</h2>
68
71
<p>
69
72
Functions relating to patterns.
70
73
 
71
74
</p>
72
75
</div>
73
76
<div class="refsect1" lang="en">
74
 
<a name="id2639880"></a><h2>Details</h2>
 
77
<a name="id2692743"></a><h2>Details</h2>
75
78
<div class="refsect2" lang="en">
76
 
<a name="id2639890"></a><h3>
 
79
<a name="id2692753"></a><h3>
77
80
<a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3>
78
 
<a class="indexterm" name="id2639901"></a><pre class="programlisting">gboolean    gimp_patterns_refresh           (void);</pre>
 
81
<a class="indexterm" name="id2692764"></a><pre class="programlisting">gboolean            gimp_patterns_refresh               (void);</pre>
79
82
<p>
80
83
Refresh current patterns. This function always succeeds.
81
84
</p>
88
91
<div class="variablelist"><table border="0">
89
92
<col align="left" valign="top">
90
93
<tbody><tr>
91
 
<td>
92
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
94
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
93
95
<td> TRUE on success.
94
96
</td>
95
97
</tr></tbody>
97
99
</div>
98
100
<hr>
99
101
<div class="refsect2" lang="en">
100
 
<a name="id2639537"></a><h3>
 
102
<a name="id2692810"></a><h3>
101
103
<a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3>
102
 
<a class="indexterm" name="id2639548"></a><pre class="programlisting">gchar**     gimp_patterns_get_list          (const gchar *filter,
103
 
                                             gint *num_patterns);</pre>
 
104
<a class="indexterm" name="id2694815"></a><pre class="programlisting">gchar**             gimp_patterns_get_list              (const gchar *filter,
 
105
                                                         gint *num_patterns);</pre>
104
106
<p>
105
107
Retrieve a complete listing of the available patterns.
106
108
</p>
107
109
<p>
108
110
This procedure returns a complete listing of available GIMP
109
111
patterns. Each name returned can be used as input to the
110
 
'gimp_context_set_pattern'.</p>
 
112
<a href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a>.</p>
111
113
<p>
112
114
 
113
115
</p>
115
117
<col align="left" valign="top">
116
118
<tbody>
117
119
<tr>
118
 
<td>
119
 
<span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
 
120
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
120
121
<td> An optional regular expression used to filter the list.
121
122
</td>
122
123
</tr>
123
124
<tr>
124
 
<td>
125
 
<span class="term"><em class="parameter"><code>num_patterns</code></em>&#160;:</span></td>
 
125
<td><span class="term"><em class="parameter"><code>num_patterns</code></em>&#160;:</span></td>
126
126
<td> The number of patterns in the pattern list.
127
127
</td>
128
128
</tr>
129
129
<tr>
130
 
<td>
131
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
130
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
132
131
<td> The list of pattern names.
133
132
</td>
134
133
</tr>
137
136
</div>
138
137
<hr>
139
138
<div class="refsect2" lang="en">
140
 
<a name="id2639636"></a><h3>
 
139
<a name="id2694912"></a><h3>
141
140
<a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3>
142
 
<a class="indexterm" name="id2639649"></a><pre class="programlisting">gchar*      gimp_patterns_get_pattern       (gint *width,
143
 
                                             gint *height);</pre>
 
141
<a class="indexterm" name="id2694925"></a><pre class="programlisting">gchar*              gimp_patterns_get_pattern           (gint *width,
 
142
                                                         gint *height);</pre>
144
143
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
145
144
<h3 class="title">Warning</h3>
146
145
<p><code class="literal">gimp_patterns_get_pattern</code> is deprecated and should not be used in newly-written code.</p>
155
154
<col align="left" valign="top">
156
155
<tbody>
157
156
<tr>
158
 
<td>
159
 
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
157
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
160
158
<td> The pattern width.
161
159
</td>
162
160
</tr>
163
161
<tr>
164
 
<td>
165
 
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
162
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
166
163
<td> The pattern height.
167
164
</td>
168
165
</tr>
169
166
<tr>
170
 
<td>
171
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
167
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
172
168
<td> The pattern name.
173
169
</td>
174
170
</tr>
177
173
</div>
178
174
<hr>
179
175
<div class="refsect2" lang="en">
180
 
<a name="id2640192"></a><h3>
 
176
<a name="id2700648"></a><h3>
181
177
<a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3>
182
 
<a class="indexterm" name="id2640206"></a><pre class="programlisting">gboolean    gimp_patterns_set_pattern       (const gchar *name);</pre>
 
178
<a class="indexterm" name="id2700661"></a><pre class="programlisting">gboolean            gimp_patterns_set_pattern           (const gchar *name);</pre>
183
179
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
184
180
<h3 class="title">Warning</h3>
185
181
<p><code class="literal">gimp_patterns_set_pattern</code> is deprecated and should not be used in newly-written code.</p>
193
189
<col align="left" valign="top">
194
190
<tbody>
195
191
<tr>
196
 
<td>
197
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
192
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
198
193
<td> The pattern name.
199
194
</td>
200
195
</tr>
201
196
<tr>
202
 
<td>
203
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
197
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
204
198
<td> TRUE on success.
205
199
</td>
206
200
</tr>
209
203
</div>
210
204
<hr>
211
205
<div class="refsect2" lang="en">
212
 
<a name="id2640285"></a><h3>
 
206
<a name="id2700741"></a><h3>
213
207
<a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3>
214
 
<a class="indexterm" name="id2640298"></a><pre class="programlisting">gchar*      gimp_patterns_get_pattern_data  (const gchar *name,
215
 
                                             gint *width,
216
 
                                             gint *height,
217
 
                                             gint *mask_bpp,
218
 
                                             gint *length,
219
 
                                             guint8 **mask_data);</pre>
 
208
<a class="indexterm" name="id2700755"></a><pre class="programlisting">gchar*              gimp_patterns_get_pattern_data      (const gchar *name,
 
209
                                                         gint *width,
 
210
                                                         gint *height,
 
211
                                                         gint *mask_bpp,
 
212
                                                         gint *length,
 
213
                                                         guint8 **mask_data);</pre>
220
214
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
221
215
<h3 class="title">Warning</h3>
222
216
<p><code class="literal">gimp_patterns_get_pattern_data</code> is deprecated and should not be used in newly-written code.</p>
230
224
<col align="left" valign="top">
231
225
<tbody>
232
226
<tr>
233
 
<td>
234
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
227
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
235
228
<td> The pattern name (\"\" means currently active pattern).
236
229
</td>
237
230
</tr>
238
231
<tr>
239
 
<td>
240
 
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
232
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
241
233
<td> The pattern width.
242
234
</td>
243
235
</tr>
244
236
<tr>
245
 
<td>
246
 
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
237
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
247
238
<td> The pattern height.
248
239
</td>
249
240
</tr>
250
241
<tr>
251
 
<td>
252
 
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
 
242
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
253
243
<td> Pattern bytes per pixel.
254
244
</td>
255
245
</tr>
256
246
<tr>
257
 
<td>
258
 
<span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
 
247
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
259
248
<td> Length of pattern mask data.
260
249
</td>
261
250
</tr>
262
251
<tr>
263
 
<td>
264
 
<span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
 
252
<td><span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
265
253
<td> The pattern mask data.
266
254
</td>
267
255
</tr>
268
256
<tr>
269
 
<td>
270
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
257
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
271
258
<td> The pattern name.
272
259
</td>
273
260
</tr>