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

186 lines
8.9 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>gimppatternmenu: 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="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-gimppalettemenu.html" title="gimppalettemenu">
<link rel="next" href="GimpProcBrowserDialog.html" title="GimpProcBrowserDialog">
<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-gimppatternmenu.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="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimppalettemenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpProcBrowserDialog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimppatternmenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimppatternmenu.top_of_page"></a>gimppatternmenu</span></h2>
<p>gimppatternmenu — A widget for selecting patterns.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimppatternmenu.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">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-new" title="gimp_pattern_select_widget_new ()">gimp_pattern_select_widget_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-gimppatternmenu.html#gimp-pattern-select-widget-close" title="gimp_pattern_select_widget_close ()">gimp_pattern_select_widget_close</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-gimppatternmenu.html#gimp-pattern-select-widget-set" title="gimp_pattern_select_widget_set ()">gimp_pattern_select_widget_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimppatternmenu.description"></a><h2>Description</h2>
<p>A widget for selecting patterns.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimppatternmenu.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-pattern-select-widget-new"></a><h3>gimp_pattern_select_widget_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_pattern_select_widget_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 class="warning"><p><code class="literal">gimp_pattern_select_widget_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
a pattern. This widget is suitable for placement in a table in a
plug-in dialog.</p>
<div class="refsect3">
<a name="gimp-pattern-select-widget-new.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>title</p></td>
<td class="parameter_description"><p>Title of the dialog to use or <code class="literal">NULL</code> to use the default title.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>Initial pattern name or <code class="literal">NULL</code> to use current selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>A function to call when the selected pattern changes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A pointer to arbitrary data to be used in the call to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pattern-select-widget-new.returns"></a><h4>Returns</h4>
<p> A <span class="type">GtkWidget</span> that you can use in your UI.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pattern-select-widget-close"></a><h3>gimp_pattern_select_widget_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pattern_select_widget_close (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_pattern_select_widget_close</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Closes the popup window associated with <em class="parameter"><code>widget</code></em>
.</p>
<div class="refsect3">
<a name="gimp-pattern-select-widget-close.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>widget</p></td>
<td class="parameter_description"><p>A pattern select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pattern-select-widget-set"></a><h3>gimp_pattern_select_widget_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pattern_select_widget_set (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_pattern_select_widget_set</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets the current pattern for the pattern select widget. Calls the
callback function if one was supplied in the call to
<a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-new" title="gimp_pattern_select_widget_new ()"><code class="function">gimp_pattern_select_widget_new()</code></a>.</p>
<div class="refsect3">
<a name="gimp-pattern-select-widget-set.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>widget</p></td>
<td class="parameter_description"><p>A pattern select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>Pattern name to set. NULL means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>