8
8
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
9
9
<link rel="prev" href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">
10
10
<link rel="next" href="libgimp-gimpbrushselect.html" title="gimpbrushselect">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
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-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
24
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
26
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
27
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
35
23
<tr><td colspan="5" class="shortcuts">
36
24
<a href="#GimpPatternSelectButton.synopsis" class="shortcut">Top</a>
38
<a href="#GimpPatternSelectButton.description" class="shortcut">Description</a>
40
<a href="#GimpPatternSelectButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
42
<a href="#GimpPatternSelectButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
44
<a href="#GimpPatternSelectButton.properties" class="shortcut">Properties</a>
46
<a href="#GimpPatternSelectButton.signals" class="shortcut">Signals</a>
26
<a href="#GimpPatternSelectButton.description" class="shortcut">Description</a>
28
<a href="#GimpPatternSelectButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GimpPatternSelectButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GimpPatternSelectButton.properties" class="shortcut">Properties</a>
34
<a href="#GimpPatternSelectButton.signals" class="shortcut">Signals</a>
49
37
<div class="refentry" title="GimpPatternSelectButton">
57
45
</tr></table></div>
58
46
<div class="refsynopsisdiv" title="Synopsis">
59
47
<a name="GimpPatternSelectButton.synopsis"></a><h2>Synopsis</h2>
60
<pre class="synopsis">
61
<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct" title="GimpPatternSelectButton">GimpPatternSelectButton</a>;
63
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
64
>GtkWidget</a> * <a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new" title="gimp_pattern_select_button_new ()">gimp_pattern_select_button_new</a> (const <a
65
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
68
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
69
>gchar</a> *pattern_name);
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
72
>gchar</a> * <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>
73
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);
74
void <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>
75
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
77
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
78
>gchar</a> *pattern_name);
48
<pre class="synopsis"> <a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-struct" title="GimpPatternSelectButton">GimpPatternSelectButton</a>;
49
<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
50
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);
51
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <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>
52
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>);
53
<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>
54
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>,
55
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);
81
58
<div class="refsect1" title="Object Hierarchy">
82
59
<a name="GimpPatternSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
83
60
<pre class="synopsis">
85
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
88
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
89
>GInitiallyUnowned</a>
91
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
94
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
97
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
100
href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html"
103
href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html"
61
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
62
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
63
+----<a href="/usr/share/gtk-doc/html/gtk/GtkObject.html">GtkObject</a>
64
+----<a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html">GtkWidget</a>
65
+----<a href="/usr/share/gtk-doc/html/gtk/GtkContainer.html">GtkContainer</a>
66
+----<a href="/usr/share/gtk-doc/html/gtk/GtkBox.html">GtkBox</a>
67
+----<a href="/usr/share/gtk-doc/html/gtk/GtkHBox.html">GtkHBox</a>
105
68
+----<a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
106
69
+----GimpPatternSelectButton
110
73
<a name="GimpPatternSelectButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
112
75
GimpPatternSelectButton implements
114
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
115
>GtkBuildable</a>, AtkImplementorIface and <a
116
href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable"
117
>GtkOrientable</a>.</p>
76
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a> and <a href="/usr/share/gtk-doc/html/gtk/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
119
78
<div class="refsect1" title="Properties">
120
79
<a name="GimpPatternSelectButton.properties"></a><h2>Properties</h2>
121
80
<pre class="synopsis">
122
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title='The "pattern-name" property'>pattern-name</a>" <a
123
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
124
>gchar</a>* : Read / Write
125
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title='The "title" property'>title</a>" <a
126
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
127
>gchar</a>* : Read / Write / Construct Only
81
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title='The "pattern-name" property'>pattern-name</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
82
"<a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title='The "title" property'>title</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only
130
85
<div class="refsect1" title="Signals">
150
105
<div class="refsect2" title="gimp_pattern_select_button_new ()">
151
106
<a name="gimp-pattern-select-button-new"></a><h3>gimp_pattern_select_button_new ()</h3>
152
<pre class="programlisting"><a
153
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
154
>GtkWidget</a> * gimp_pattern_select_button_new (const <a
155
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
158
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
159
>gchar</a> *pattern_name);</pre>
107
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gimp_pattern_select_button_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
108
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);</pre>
162
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
163
><span class="type">GtkWidget</span></a> that completely controls the selection of
110
Creates a new <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> that completely controls the selection of
164
111
a pattern. This widget is suitable for placement in a table in a
168
114
<div class="variablelist"><table border="0">
169
115
<col align="left" valign="top">
172
118
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
173
<td> Title of the dialog to use or <a
174
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
175
><code class="literal">NULL</code></a> to use the default title.
119
<td>Title of the dialog to use or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default title.
179
123
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
180
<td> Initial pattern name or <a
181
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
182
><code class="literal">NULL</code></a> to use current selection.
124
<td>Initial pattern name or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use current selection.
186
128
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
188
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
189
><span class="type">GtkWidget</span></a> that you can use in your UI.
129
<td> A <a href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> that you can use in your UI.
198
138
<div class="refsect2" title="gimp_pattern_select_button_get_pattern ()">
199
139
<a name="gimp-pattern-select-button-get-pattern"></a><h3>gimp_pattern_select_button_get_pattern ()</h3>
200
<pre class="programlisting">const <a
201
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
202
>gchar</a> * gimp_pattern_select_button_get_pattern
203
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button);</pre>
205
Retrieves the name of currently selected pattern.</p>
140
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_pattern_select_button_get_pattern
141
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>);</pre>
143
Retrieves the name of currently selected pattern.
208
145
<div class="variablelist"><table border="0">
209
146
<col align="left" valign="top">
212
149
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
213
<td> A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
150
<td>A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
227
164
<div class="refsect2" title="gimp_pattern_select_button_set_pattern ()">
228
165
<a name="gimp-pattern-select-button-set-pattern"></a><h3>gimp_pattern_select_button_set_pattern ()</h3>
229
<pre class="programlisting">void gimp_pattern_select_button_set_pattern
230
(<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *button,
232
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
233
>gchar</a> *pattern_name);</pre>
235
Sets the current pattern for the pattern select button.</p>
166
<pre class="programlisting"><span class="returnvalue">void</span> gimp_pattern_select_button_set_pattern
167
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>,
168
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);</pre>
170
Sets the current pattern for the pattern select button.
238
172
<div class="variablelist"><table border="0">
239
173
<col align="left" valign="top">
242
176
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
243
<td> A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
177
<td>A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a>
247
181
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
248
<td> Pattern name to set; <a
249
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
250
><code class="literal">NULL</code></a> means no change.
182
<td>Pattern name to set; <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> means no change.
259
191
<a name="GimpPatternSelectButton.property-details"></a><h2>Property Details</h2>
260
192
<div class="refsect2" title='The "pattern-name" property'>
261
193
<a name="GimpPatternSelectButton--pattern-name"></a><h3>The <code class="literal">"pattern-name"</code> property</h3>
262
<pre class="programlisting"> "pattern-name" <a
263
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
264
>gchar</a>* : Read / Write</pre>
266
The name of the currently selected pattern.</p>
194
<pre class="programlisting"> "pattern-name" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
196
The name of the currently selected pattern.
269
198
<p>Default value: NULL</p>
270
<p>Since GIMP 2.4</p>
199
<p class="since">Since GIMP 2.4</p>
273
202
<div class="refsect2" title='The "title" property'>
274
203
<a name="GimpPatternSelectButton--title"></a><h3>The <code class="literal">"title"</code> property</h3>
275
<pre class="programlisting"> "title" <a
276
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
277
>gchar</a>* : Read / Write / Construct Only</pre>
279
The title to be used for the pattern selection popup dialog.</p>
204
<pre class="programlisting"> "title" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre>
206
The title to be used for the pattern selection popup dialog.
282
208
<p>Default value: "Pattern Selection"</p>
283
<p>Since GIMP 2.4</p>
209
<p class="since">Since GIMP 2.4</p>
286
212
<div class="refsect1" title="Signal Details">
287
213
<a name="GimpPatternSelectButton.signal-details"></a><h2>Signal Details</h2>
288
214
<div class="refsect2" title='The "pattern-set" signal'>
289
215
<a name="GimpPatternSelectButton-pattern-set"></a><h3>The <code class="literal">"pattern-set"</code> signal</h3>
290
<pre class="programlisting">void user_function (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">GimpPatternSelectButton</a> *widget,
292
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
293
>gchar</a> *pattern_name,
295
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
298
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
301
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
304
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
305
>gpointer</a> mask_data,
307
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
308
>gboolean</a> dialog_closing,
310
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
311
>gpointer</a> user_data) : Run First</pre>
313
The ::pattern-set signal is emitted when the user selects a pattern.</p>
216
<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,
217
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name,
218
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width,
219
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height,
220
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp,
221
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> mask_data,
222
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dialog_closing,
223
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First</pre>
225
The ::pattern-set signal is emitted when the user selects a pattern.
316
227
<div class="variablelist"><table border="0">
317
228
<col align="left" valign="top">
320
231
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
321
<td> the object which received the signal.
232
<td>the object which received the signal.
325
236
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
326
<td> the name of the currently selected pattern.
237
<td>the name of the currently selected pattern.
330
241
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
331
<td> width of the pattern
242
<td>width of the pattern
335
246
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
336
<td> height of the pattern
247
<td>height of the pattern
340
251
<td><p><span class="term"><em class="parameter"><code>bpp</code></em> :</span></p></td>
341
<td> bpp of the pattern
252
<td>bpp of the pattern
345
256
<td><p><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></p></td>
346
<td> pattern mask data
257
<td>pattern mask data
350
261
<td><p><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></p></td>
351
<td> whether the dialog was closed or not.
262
<td>whether the dialog was closed or not.