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

Imported Upstream version 2.3.6

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:18:19 -04:00
parent 7802c3a9cb
commit de5dc4f4c2
3129 changed files with 762016 additions and 525609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,14 +1,13 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<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.68.1">
<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">
<link rel="next" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
@ -18,27 +17,24 @@
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimp-gimppattern.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<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="#id2559342" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2671383" class="shortcut">Description</a></nobr></td></tr>
</table>
</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="id2559342"></a><span class="refentrytitle">gimppatterns</span>
</h2>
<h2><span class="refentrytitle">gimppatterns</span></h2>
<p>gimppatterns &#8212; Functions relating to patterns.</p>
</td>
<td valign="top" align="right"></td>
@ -49,33 +45,33 @@
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
gchar** <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const gchar *filter,
gint *num_patterns);
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (gint *width,
gint *height);
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const gchar *name);
gchar* <a 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);
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
gchar** <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const gchar *filter,
gint *num_patterns);
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (gint *width,
gint *height);
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const gchar *name);
gchar* <a 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="id2671383"></a><h2>Description</h2>
<a name="id2625950"></a><h2>Description</h2>
<p>
Functions relating to patterns.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2671398"></a><h2>Details</h2>
<a name="id2625961"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2671409"></a><h3>
<a name="id2625967"></a><h3>
<a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3>
<a class="indexterm" name="id2671420"></a><pre class="programlisting">gboolean gimp_patterns_refresh (void);</pre>
<a class="indexterm" name="id2625976"></a><pre class="programlisting">gboolean gimp_patterns_refresh (void);</pre>
<p>
Refresh current patterns. This function always succeeds.
</p>
@ -88,7 +84,8 @@ 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>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -96,17 +93,17 @@ pattern path and updates all pattern dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2674951"></a><h3>
<a name="id2626021"></a><h3>
<a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3>
<a class="indexterm" name="id2674962"></a><pre class="programlisting">gchar** gimp_patterns_get_list (const gchar *filter,
gint *num_patterns);</pre>
<a class="indexterm" name="id2626030"></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
'gimp_context_set_pattern'.</p>
'gimp-context-set-pattern'.</p>
<p>
</p>
@ -114,17 +111,20 @@ 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>
<span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></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>
<span class="term"><em class="parameter"><code>num_patterns</code></em>&#160;:</span></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>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The list of pattern names.
</td>
</tr>
@ -133,10 +133,10 @@ patterns. Each name returned can be used as input to the
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2675051"></a><h3>
<a name="id2639578"></a><h3>
<a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3>
<a class="indexterm" name="id2675064"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern (gint *width,
gint *height);</pre>
<a class="indexterm" name="id2639586"></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>
@ -151,17 +151,20 @@ instead.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The pattern name.
</td>
</tr>
@ -170,9 +173,9 @@ instead.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671924"></a><h3>
<a name="id2627097"></a><h3>
<a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3>
<a class="indexterm" name="id2671938"></a><pre class="programlisting">gboolean gimp_patterns_set_pattern (const gchar *name);</pre>
<a class="indexterm" name="id2627106"></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>
@ -186,12 +189,14 @@ 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>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The pattern name.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -200,14 +205,14 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2672380"></a><h3>
<a name="id2627185"></a><h3>
<a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3>
<a class="indexterm" name="id2672394"></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>
<a class="indexterm" name="id2627194"></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>
@ -221,37 +226,44 @@ 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>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></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>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td> Pattern bytes per pixel.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td>
<span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></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>
<span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
<td> The pattern mask data.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The pattern name.
</td>
</tr>
@ -260,5 +272,9 @@ This procedure is deprecated! Use <a href="libgimp-gimppattern.html#gimp-pattern
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimp-gimppattern.html"><b>&lt;&lt;&#160;gimppattern</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-selectors.html"><b>Controlling the Core's Selection Dialogs&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>