277 lines
14 KiB
HTML
277 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GimpPatternSelectButton</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
||
<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="GimpPaletteSelectButton.html" title="GimpPaletteSelect">
|
||
<link rel="next" href="libgimp-gimpbrushselect.html" title="gimpbrushselect">
|
||
<meta name="generator" content="GTK-Doc V1.18 (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="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">
|
||
<a href="#GimpPatternSelectButton.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#GimpPatternSelectButton.description" class="shortcut">Description</a>
|
||
|
|
||
<a href="#GimpPatternSelectButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
||
|
|
||
<a href="#GimpPatternSelectButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
||
|
|
||
<a href="#GimpPatternSelectButton.properties" class="shortcut">Properties</a>
|
||
|
|
||
<a href="#GimpPatternSelectButton.signals" class="shortcut">Signals</a>
|
||
</td></tr>
|
||
</table>
|
||
<div class="refentry">
|
||
<a name="GimpPatternSelectButton"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GimpPatternSelectButton.top_of_page"></a>GimpPatternSelectButton</span></h2>
|
||
<p>GimpPatternSelectButton — A button which pops up a pattern select dialog.</p>
|
||
</td>
|
||
<td valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsynopsisdiv">
|
||
<a name="GimpPatternSelectButton.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis"> <a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct" title="GimpPatternSelectButton">GimpPatternSelectButton</a>;
|
||
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new" title="gimp_pattern_select_button_new ()">gimp_pattern_select_button_new</a> (<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>);
|
||
const <span class="returnvalue">gchar</span> * <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern" title="gimp_pattern_select_button_get_pattern ()">gimp_pattern_select_button_get_pattern</a>
|
||
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>);
|
||
<span class="returnvalue">void</span> <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-set-pattern" title="gimp_pattern_select_button_set_pattern ()">gimp_pattern_select_button_set_pattern</a>
|
||
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="synopsis">
|
||
GObject
|
||
+----GInitiallyUnowned
|
||
+----GtkObject
|
||
+----GtkWidget
|
||
+----GtkContainer
|
||
+----GtkBox
|
||
+----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
|
||
+----GimpPatternSelectButton
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GimpPatternSelectButton implements
|
||
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.properties"></a><h2>Properties</h2>
|
||
<pre class="synopsis">
|
||
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title='The "pattern-name" property'>pattern-name</a>" <span class="type">gchar</span>* : Read / Write
|
||
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title='The "title" property'>title</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.signals"></a><h2>Signals</h2>
|
||
<pre class="synopsis">
|
||
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-pattern-set" title='The "pattern-set" signal'>pattern-set</a>" : <code class="literal">Run First</code>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.description"></a><h2>Description</h2>
|
||
<p>
|
||
A button which pops up a pattern select dialog.
|
||
</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.details"></a><h2>Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GimpPatternSelectButton-struct"></a><h3>GimpPatternSelectButton</h3>
|
||
<pre class="programlisting">typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</pre>
|
||
<p>
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-pattern-select-button-new"></a><h3>gimp_pattern_select_button_new ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gimp_pattern_select_button_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>);</pre>
|
||
<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="variablelist"><table border="0" class="variablelist">
|
||
<colgroup>
|
||
<col align="left" valign="top">
|
||
<col>
|
||
</colgroup>
|
||
<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 <code class="literal">NULL</code> 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 <code class="literal">NULL</code> to use current selection.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>A <span class="type">GtkWidget</span> 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">
|
||
<a name="gimp-pattern-select-button-get-pattern"></a><h3>gimp_pattern_select_button_get_pattern ()</h3>
|
||
<pre class="programlisting">const <span class="returnvalue">gchar</span> * gimp_pattern_select_button_get_pattern
|
||
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>);</pre>
|
||
<p>
|
||
Retrieves the name of currently selected pattern.
|
||
</p>
|
||
<div class="variablelist"><table border="0" class="variablelist">
|
||
<colgroup>
|
||
<col align="left" valign="top">
|
||
<col>
|
||
</colgroup>
|
||
<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">
|
||
<a name="gimp-pattern-select-button-set-pattern"></a><h3>gimp_pattern_select_button_set_pattern ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span> gimp_pattern_select_button_set_pattern
|
||
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>,
|
||
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);</pre>
|
||
<p>
|
||
Sets the current pattern for the pattern select button.
|
||
</p>
|
||
<div class="variablelist"><table border="0" class="variablelist">
|
||
<colgroup>
|
||
<col align="left" valign="top">
|
||
<col>
|
||
</colgroup>
|
||
<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; <code class="literal">NULL</code> means no change.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GimpPatternSelectButton--pattern-name"></a><h3>The <code class="literal">"pattern-name"</code> property</h3>
|
||
<pre class="programlisting"> "pattern-name" <span class="type">gchar</span>* : Read / Write</pre>
|
||
<p>
|
||
The name of the currently selected pattern.
|
||
</p>
|
||
<p>Default value: NULL</p>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="GimpPatternSelectButton--title"></a><h3>The <code class="literal">"title"</code> property</h3>
|
||
<pre class="programlisting"> "title" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
|
||
<p>
|
||
The title to be used for the pattern selection popup dialog.
|
||
</p>
|
||
<p>Default value: "Pattern Selection"</p>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GimpPatternSelectButton.signal-details"></a><h2>Signal Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GimpPatternSelectButton-pattern-set"></a><h3>The <code class="literal">"pattern-set"</code> signal</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *widget,
|
||
<span class="type">gchar</span> *pattern_name,
|
||
<span class="type">gint</span> width,
|
||
<span class="type">gint</span> height,
|
||
<span class="type">gint</span> bpp,
|
||
<span class="type">gpointer</span> mask_data,
|
||
<span class="type">gboolean</span> dialog_closing,
|
||
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
|
||
<p>
|
||
The ::pattern-set signal is emitted when the user selects a pattern.
|
||
</p>
|
||
<div class="variablelist"><table border="0" class="variablelist">
|
||
<colgroup>
|
||
<col align="left" valign="top">
|
||
<col>
|
||
</colgroup>
|
||
<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 class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.18</div>
|
||
</body>
|
||
</html> |