1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
<title>GimpPatternSelectButton</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
9
<link rel="prev" href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">
10
<link rel="next" href="libgimp-gimpbrushselect.html" title="gimpbrushselect">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
<link rel="index" href="libgimp-index.html" title="Index">
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
<td><a accesskey="p" href="GimpPaletteSelectButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
29
<td><a accesskey="u" href="libgimp-selectors.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
30
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
32
<td><a accesskey="n" href="libgimp-gimpbrushselect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2569710" class="shortcut">Top</a>
36
<a href="#id2694339" class="shortcut">Description</a>
38
<a href="#id2595414" class="shortcut">Object Hierarchy</a>
40
<a href="#id2702335" class="shortcut">Implemented Interfaces</a>
42
<a href="#id2702355" class="shortcut">Properties</a>
44
<a href="#id2702396" class="shortcut">Signals</a></nobr></td></tr>
46
<div class="refentry" lang="en">
47
<a name="GimpPatternSelectButton"></a><div class="titlepage"></div>
48
<div class="refnamediv"><table width="100%"><tr>
51
<a name="id2569710"></a><span class="refentrytitle">GimpPatternSelectButton</span>
53
<p>GimpPatternSelectButton</p>
55
<td valign="top" align="right"></td>
57
<div class="refsynopsisdiv">
59
<pre class="synopsis">
63
<a href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct">GimpPatternSelectButton</a>;
64
GtkWidget* <a href="GimpPatternSelectButton.html#gimp-pattern-select-button-new">gimp_pattern_select_button_new</a> (const gchar *title,
65
const gchar *pattern_name);
66
const gchar* <a href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</a>
67
(<a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);
68
void <a href="GimpPatternSelectButton.html#gimp-pattern-select-button-set-pattern">gimp_pattern_select_button_set_pattern</a>
69
(<a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
70
const gchar *pattern_name);
74
<div class="refsect1" lang="en">
75
<a name="id2595414"></a><h2>Object Hierarchy</h2>
76
<pre class="synopsis">
79
+----GInitiallyUnowned
85
+----<a href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
86
+----GimpPatternSelectButton
89
<div class="refsect1" lang="en">
90
<a name="id2702335"></a><h2>Implemented Interfaces</h2>
92
GimpPatternSelectButton implements
93
AtkImplementorIface.</p>
95
<div class="refsect1" lang="en">
96
<a name="id2702355"></a><h2>Properties</h2>
97
<pre class="synopsis">
99
"<a href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name">pattern-name</a>" gchararray : Read / Write
100
"<a href="GimpPatternSelectButton.html#GimpPatternSelectButton--title">title</a>" gchararray : Read / Write / Construct Only
103
<div class="refsect1" lang="en">
104
<a name="id2702396"></a><h2>Signals</h2>
105
<pre class="synopsis">
107
"<a href="GimpPatternSelectButton.html#GimpPatternSelectButton-pattern-set">pattern-set</a>" : Run First
110
<div class="refsect1" lang="en">
111
<a name="id2694339"></a><h2>Description</h2>
116
<div class="refsect1" lang="en">
117
<a name="id2694355"></a><h2>Details</h2>
118
<div class="refsect2" lang="en">
119
<a name="id2694366"></a><h3>
120
<a name="GimpPatternSelectButton-struct"></a>GimpPatternSelectButton</h3>
121
<a class="indexterm" name="id2694377"></a><pre class="programlisting">typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</pre>
127
<div class="refsect2" lang="en">
128
<a name="id2694393"></a><h3>
129
<a name="gimp-pattern-select-button-new"></a>gimp_pattern_select_button_new ()</h3>
130
<a class="indexterm" name="id2694406"></a><pre class="programlisting">GtkWidget* gimp_pattern_select_button_new (const gchar *title,
131
const gchar *pattern_name);</pre>
133
Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
134
a pattern. This widget is suitable for placement in a table in a
139
<div class="variablelist"><table border="0">
140
<col align="left" valign="top">
143
<td><span class="term"><em class="parameter"><code>title</code></em> :</span></td>
144
<td> Title of the dialog to use or <code class="literal">NULL</code> to use the default title.
148
<td><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></td>
149
<td> Initial pattern name or <code class="literal">NULL</code> to use current selection.
153
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
154
<td> A <span class="type">GtkWidget</span> that you can use in your UI.
160
<p class="since">Since GIMP 2.4
164
<div class="refsect2" lang="en">
165
<a name="id2706110"></a><h3>
166
<a name="gimp-pattern-select-button-get-pattern"></a>gimp_pattern_select_button_get_pattern ()</h3>
167
<a class="indexterm" name="id2706124"></a><pre class="programlisting">const gchar* gimp_pattern_select_button_get_pattern
168
(<a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);</pre>
170
Retrieves the name of currently selected pattern.</p>
174
<div class="variablelist"><table border="0">
175
<col align="left" valign="top">
178
<td><span class="term"><em class="parameter"><code>button</code></em> :</span></td>
179
<td> A <a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
183
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
184
<td> an internal copy of the pattern name which must not be freed.
190
<p class="since">Since GIMP 2.4
194
<div class="refsect2" lang="en">
195
<a name="id2706201"></a><h3>
196
<a name="gimp-pattern-select-button-set-pattern"></a>gimp_pattern_select_button_set_pattern ()</h3>
197
<a class="indexterm" name="id2706216"></a><pre class="programlisting">void gimp_pattern_select_button_set_pattern
198
(<a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
199
const gchar *pattern_name);</pre>
201
Sets the current pattern for the pattern select button.</p>
205
<div class="variablelist"><table border="0">
206
<col align="left" valign="top">
209
<td><span class="term"><em class="parameter"><code>button</code></em> :</span></td>
210
<td> A <a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
214
<td><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></td>
215
<td> Pattern name to set; <code class="literal">NULL</code> means no change.
220
<p class="since">Since GIMP 2.4
224
<div class="refsect1" lang="en">
225
<a name="id2706311"></a><h2>Property Details</h2>
226
<div class="refsect2" lang="en">
227
<a name="id2706321"></a><h3>
228
<a name="GimpPatternSelectButton--pattern-name"></a>The "<code class="literal">pattern-name</code>" property</h3>
229
<a class="indexterm" name="id2701167"></a><pre class="programlisting"> "pattern-name" gchararray : Read / Write</pre>
231
The name of the currently selected pattern.</p>
235
<p>Default value: NULL</p>
240
<div class="refsect2" lang="en">
241
<a name="id2701201"></a><h3>
242
<a name="GimpPatternSelectButton--title"></a>The "<code class="literal">title</code>" property</h3>
243
<a class="indexterm" name="id2701215"></a><pre class="programlisting"> "title" gchararray : Read / Write / Construct Only</pre>
245
The title to be used for the pattern selection popup dialog.</p>
249
<p>Default value: "Pattern Selection"</p>
254
<div class="refsect1" lang="en">
255
<a name="id2701251"></a><h2>Signal Details</h2>
256
<div class="refsect2" lang="en">
257
<a name="id2701261"></a><h3>
258
<a name="GimpPatternSelectButton-pattern-set"></a>The "pattern-set" signal</h3>
259
<a class="indexterm" name="id2701269"></a><pre class="programlisting">void user_function (<a href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *widget,
265
gboolean dialog_closing,
266
gpointer user_data) : Run First</pre>
268
The ::pattern-set signal is emitted when the user selects a pattern.</p>
272
<div class="variablelist"><table border="0">
273
<col align="left" valign="top">
276
<td><span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
277
<td> the object which received the signal.
281
<td><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></td>
282
<td> the name of the currently selected pattern.
286
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
287
<td> width of the pattern
291
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
292
<td> height of the pattern
296
<td><span class="term"><em class="parameter"><code>bpp</code></em> :</span></td>
297
<td> bpp of the pattern
301
<td><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
302
<td> pattern mask data
306
<td><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></td>
307
<td> whether the dialog was closed or not.
311
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
312
<td>user data set when the signal handler was connected.</td>
added
removed
devel-docs/libgimp/html/GimpPatternSelectButton.html
