callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
devel-docs/libgimp/html/libgimp-gimppatterns.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppatterns</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-gimppattern.html" title="gimppattern">
@ -31,16 +31,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-selectors.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2619410" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2577312" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2691979" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2711872" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppatterns"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2619410"></a><span class="refentrytitle">gimppatterns</span>
<a name="id2577312"></a><span class="refentrytitle">gimppatterns</span>
</h2>
<p>gimppatterns &#8212; Functions relating to patterns.</p>
</td>
@ -52,67 +52,33 @@
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_patterns);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *length,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **mask_data);
gboolean <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
gchar** <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const gchar *filter,
gint *num_patterns);
gchar* <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (gint *width,
gint *height);
gboolean <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const gchar *name);
gchar* <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a> (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *length,
guint8 **mask_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2691979"></a><h2>Description</h2>
<a name="id2711872"></a><h2>Description</h2>
<p>
Functions relating to patterns.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2691994"></a><h2>Details</h2>
<a name="id2711887"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2692004"></a><h3>
<a name="id2711898"></a><h3>
<a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3>
<a class="indexterm" name="id2692016"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_patterns_refresh (void);</pre>
<a class="indexterm" name="id2711909"></a><pre class="programlisting">gboolean gimp_patterns_refresh (void);</pre>
<p>
Refresh current patterns. This function always succeeds.
</p>
@ -125,7 +91,7 @@ pattern path and updates all pattern dialogs accordingly.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -133,23 +99,17 @@ pattern path and updates all pattern dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2693003"></a><h3>
<a name="id2711954"></a><h3>
<a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3>
<a class="indexterm" name="id2693014"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** gimp_patterns_get_list (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_patterns);</pre>
<a class="indexterm" name="id2711966"></a><pre class="programlisting">gchar** gimp_patterns_get_list (const gchar *filter,
gint *num_patterns);</pre>
<p>
Retrieve a complete listing of the available patterns.
</p>
<p>
This procedure returns a complete listing of available GIMP
patterns. Each name returned can be used as input to the
<a href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a>.</p>
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a>.</p>
<p>
</p>
@ -157,17 +117,17 @@ patterns. Each name returned can be used as input to the
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></p></td>
<td> An optional regular expression used to filter the list.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>num_patterns</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>num_patterns</code></em>&#160;:</span></p></td>
<td> The number of patterns in the pattern list.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The list of pattern names.
</td>
</tr>
@ -176,22 +136,16 @@ patterns. Each name returned can be used as input to the
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2694300"></a><h3>
<a name="id2710840"></a><h3>
<a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3>
<a class="indexterm" name="id2694314"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_patterns_get_pattern (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);</pre>
<a class="indexterm" name="id2710853"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern (gint *width,
gint *height);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_get_pattern</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-pattern"><code class="function">gimp_context_get_pattern()</code></a>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpcontext.html#gimp-context-get-pattern"><code class="function">gimp_context_get_pattern()</code></a>
instead.</p>
<p>
@ -200,17 +154,17 @@ instead.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The pattern name.
</td>
</tr>
@ -219,19 +173,15 @@ instead.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2694415"></a><h3>
<a name="id2718117"></a><h3>
<a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3>
<a class="indexterm" name="id2694428"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_patterns_set_pattern (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<a class="indexterm" name="id2718130"></a><pre class="programlisting">gboolean gimp_patterns_set_pattern (const gchar *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_set_pattern</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a> instead.</p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a> instead.</p>
<p>
</p>
@ -239,12 +189,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The pattern name.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -253,34 +203,20 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2692206"></a><h3>
<a name="id2718211"></a><h3>
<a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3>
<a class="indexterm" name="id2692219"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_patterns_get_pattern_data (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *length,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **mask_data);</pre>
<a class="indexterm" name="id2718224"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern_data (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *length,
guint8 **mask_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_get_pattern_data</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimppattern.html#gimp-pattern-get-pixels"><code class="function">gimp_pattern_get_pixels()</code></a> instead.</p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimppattern.html#gimp-pattern-get-pixels"><code class="function">gimp_pattern_get_pixels()</code></a> instead.</p>
<p>
</p>
@ -288,37 +224,37 @@ This procedure is deprecated! Use <a href="libgimp-gimppattern.html#gimp-pattern
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The pattern name (\"\" means currently active pattern).
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></p></td>
<td> Pattern bytes per pixel.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></p></td>
<td> Length of pattern mask data.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></p></td>
<td> The pattern mask data.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The pattern name.
</td>
</tr>