389 lines
15 KiB
HTML
389 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GimpPatternSelectButton</title>
|
|
<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-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="prev" href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">
|
|
<link rel="next" href="libgimp-gimpbrushselect.html" title="gimpbrushselect">
|
|
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
|
|
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
|
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-index-deprecated.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">
|
|
<td><a accesskey="p" href="GimpPaletteSelectButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-selectors.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-gimpbrushselect.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="#id2605867" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2724122" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2591093" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2724032" class="shortcut">Implemented Interfaces</a>
|
|
 | 
|
|
<a href="#id2724058" class="shortcut">Properties</a>
|
|
 | 
|
|
<a href="#id2724098" class="shortcut">Signals</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="GimpPatternSelectButton"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2605867"></a><span class="refentrytitle">GimpPatternSelectButton</span>
|
|
</h2>
|
|
<p>GimpPatternSelectButton</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct">GimpPatternSelectButton</a>;
|
|
<a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>* <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new">gimp_pattern_select_button_new</a> (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *title,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *pattern_name);
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</a>
|
|
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);
|
|
void <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-set-pattern">gimp_pattern_select_button_set_pattern</a>
|
|
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *pattern_name);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2591093"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
|
|
>GObject</a>
|
|
+----<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
|
|
>GInitiallyUnowned</a>
|
|
+----<a
|
|
href="../gtk/GtkObject.html"
|
|
>GtkObject</a>
|
|
+----<a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>
|
|
+----<a
|
|
href="../gtk/GtkContainer.html"
|
|
>GtkContainer</a>
|
|
+----<a
|
|
href="../gtk/GtkBox.html"
|
|
>GtkBox</a>
|
|
+----<a
|
|
href="../gtk/GtkHBox.html"
|
|
>GtkHBox</a>
|
|
+----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
|
|
+----GimpPatternSelectButton
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2724032"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpPatternSelectButton implements
|
|
AtkImplementorIface and GtkBuildable.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2724058"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name">pattern-name</a>" <a
|
|
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
|
>gchararray</a> : Read / Write
|
|
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title">title</a>" <a
|
|
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
|
>gchararray</a> : Read / Write / Construct Only
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2724098"></a><h2>Signals</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-pattern-set">pattern-set</a>" : Run First
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2724122"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2724138"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2724148"></a><h3>
|
|
<a name="GimpPatternSelectButton-struct"></a>GimpPatternSelectButton</h3>
|
|
<a class="indexterm" name="id2724159"></a><pre class="programlisting">typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2724175"></a><h3>
|
|
<a name="gimp-pattern-select-button-new"></a>gimp_pattern_select_button_new ()</h3>
|
|
<a class="indexterm" name="id2724188"></a><pre class="programlisting"><a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>* gimp_pattern_select_button_new (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *title,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *pattern_name);</pre>
|
|
<p>
|
|
Creates a new <a
|
|
href="../gtk/GtkWidget.html"
|
|
><span class="type">GtkWidget</span></a> that completely controls the selection of
|
|
a pattern. This widget is suitable for placement in a table in a
|
|
plug-in dialog.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
|
|
<td> Title of the dialog to use or <a
|
|
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
|
><code class="literal">NULL</code></a> to use the default title.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
|
|
<td> Initial pattern name or <a
|
|
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
|
><code class="literal">NULL</code></a> to use current selection.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> A <a
|
|
href="../gtk/GtkWidget.html"
|
|
><span class="type">GtkWidget</span></a> that you can use in your UI.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2719591"></a><h3>
|
|
<a name="gimp-pattern-select-button-get-pattern"></a>gimp_pattern_select_button_get_pattern ()</h3>
|
|
<a class="indexterm" name="id2719604"></a><pre class="programlisting">const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* gimp_pattern_select_button_get_pattern
|
|
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);</pre>
|
|
<p>
|
|
Retrieves the name of currently selected pattern.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
|
|
<td> A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> an internal copy of the pattern name which must not be freed.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2719680"></a><h3>
|
|
<a name="gimp-pattern-select-button-set-pattern"></a>gimp_pattern_select_button_set_pattern ()</h3>
|
|
<a class="indexterm" name="id2719696"></a><pre class="programlisting">void gimp_pattern_select_button_set_pattern
|
|
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *pattern_name);</pre>
|
|
<p>
|
|
Sets the current pattern for the pattern select button.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
|
|
<td> A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
|
|
<td> Pattern name to set; <a
|
|
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
|
><code class="literal">NULL</code></a> means no change.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2710586"></a><h2>Property Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2710596"></a><h3>
|
|
<a name="GimpPatternSelectButton--pattern-name"></a>The "<code class="literal">pattern-name</code>" property</h3>
|
|
<a class="indexterm" name="id2710612"></a><pre class="programlisting"> "pattern-name" <a
|
|
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
|
>gchararray</a> : Read / Write</pre>
|
|
<p>
|
|
The name of the currently selected pattern.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>Default value: NULL</p>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2710646"></a><h3>
|
|
<a name="GimpPatternSelectButton--title"></a>The "<code class="literal">title</code>" property</h3>
|
|
<a class="indexterm" name="id2710660"></a><pre class="programlisting"> "title" <a
|
|
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
|
|
>gchararray</a> : Read / Write / Construct Only</pre>
|
|
<p>
|
|
The title to be used for the pattern selection popup dialog.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>Default value: "Pattern Selection"</p>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2710696"></a><h2>Signal Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2710706"></a><h3>
|
|
<a name="GimpPatternSelectButton-pattern-set"></a>The "pattern-set" signal</h3>
|
|
<a class="indexterm" name="id2710714"></a><pre class="programlisting">void user_function (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *widget,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *pattern_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> bpp,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gpointer"
|
|
>gpointer</a> mask_data,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> dialog_closing,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gpointer"
|
|
>gpointer</a> user_data) : Run First</pre>
|
|
<p>
|
|
The ::pattern-set signal is emitted when the user selects a pattern.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
|
|
<td> the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
|
|
<td> the name of the currently selected pattern.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> width of the pattern
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> height of the pattern
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>bpp</code></em> :</span></p></td>
|
|
<td> bpp of the pattern
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></p></td>
|
|
<td> pattern mask data
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></p></td>
|
|
<td> whether the dialog was closed or not.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|