Files
gimp/devel-docs/libgimp/html/libgimp-gimppatternselect.html
2021-07-18 14:31:43 -04:00

232 lines
11 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimppatternselect: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="prev" href="libgimp-gimppaletteselect.html" title="gimppaletteselect">
<link rel="next" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#libgimp-gimppatternselect.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-selectors.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimppaletteselect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimpui.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimppatternselect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimppatternselect.top_of_page"></a>gimppatternselect</span></h2>
<p>gimppatternselect — Functions providing a pattern selection dialog.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimppatternselect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libgimp-gimppatternselect.html#GimpRunPatternCallback" title="GimpRunPatternCallback ()">*GimpRunPatternCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternselect.html#gimp-pattern-select-new" title="gimp_pattern_select_new ()">gimp_pattern_select_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternselect.html#gimp-pattern-select-destroy" title="gimp_pattern_select_destroy ()">gimp_pattern_select_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternselect.html#gimp-patterns-popup" title="gimp_patterns_popup ()">gimp_patterns_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternselect.html#gimp-patterns-close-popup" title="gimp_patterns_close_popup ()">gimp_patterns_close_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternselect.html#gimp-patterns-set-popup" title="gimp_patterns_set_popup ()">gimp_patterns_set_popup</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimppatternselect.description"></a><h2>Description</h2>
<p>Functions providing a pattern selection dialog.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimppatternselect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GimpRunPatternCallback"></a><h3>GimpRunPatternCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpRunPatternCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><span class="type">gint</span> bpp</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *mask_data</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> dialog_closing</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pattern-select-new"></a><h3>gimp_pattern_select_new ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gimp_pattern_select_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimppatternselect.html#GimpRunPatternCallback" title="GimpRunPatternCallback ()"><span class="type">GimpRunPatternCallback</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pattern-select-destroy"></a><h3>gimp_pattern_select_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pattern_select_destroy (<em class="parameter"><code>const <span class="type">gchar</span> *pattern_callback</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-patterns-popup"></a><h3>gimp_patterns_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_patterns_popup (<em class="parameter"><code>const <span class="type">gchar</span> *pattern_callback</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *popup_title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *initial_pattern</code></em>);</pre>
<p>Invokes the Gimp pattern selection.</p>
<p>This procedure opens the pattern selection dialog.</p>
<div class="refsect3">
<a name="gimp-patterns-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pattern_callback</p></td>
<td class="parameter_description"><p>The callback PDB proc to call when pattern selection is made.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>popup_title</p></td>
<td class="parameter_description"><p>Title of the pattern selection dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>initial_pattern</p></td>
<td class="parameter_description"><p>The name of the pattern to set as the first selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-patterns-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-patterns-close-popup"></a><h3>gimp_patterns_close_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_patterns_close_popup (<em class="parameter"><code>const <span class="type">gchar</span> *pattern_callback</code></em>);</pre>
<p>Close the pattern selection dialog.</p>
<p>This procedure closes an opened pattern selection dialog.</p>
<div class="refsect3">
<a name="gimp-patterns-close-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pattern_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this pop-up.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-patterns-close-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-patterns-set-popup"></a><h3>gimp_patterns_set_popup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_patterns_set_popup (<em class="parameter"><code>const <span class="type">gchar</span> *pattern_callback</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);</pre>
<p>Sets the current pattern in a pattern selection dialog.</p>
<p>Sets the current pattern in a pattern selection dialog.</p>
<div class="refsect3">
<a name="gimp-patterns-set-popup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pattern_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this pop-up.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>The name of the pattern to set as selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-patterns-set-popup.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>