4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpbrushselect</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
8
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
9
<link rel="prev" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
9
<link rel="prev" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">
10
10
<link rel="next" href="libgimp-gimpfontselect.html" title="gimpfontselect">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
14
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
20
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">
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
24
27
<tr valign="middle">
25
<td><a accesskey="p" href="libgimp-selectors.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
28
<td><a accesskey="p" href="GimpPatternSelectButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
26
29
<td><a accesskey="u" href="libgimp-selectors.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
27
30
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimpfontselect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2584574" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2569711" class="shortcut">Top</a>
33
<a href="#id2647652" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2702473" class="shortcut">Description</a></nobr></td></tr>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpbrushselect"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2584574"></a><span class="refentrytitle">gimpbrushselect</span>
43
<a name="id2569711"></a><span class="refentrytitle">gimpbrushselect</span>
42
45
<p>gimpbrushselect — Functions providing a brush selection dialog.</p>
52
void (<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">*GimpRunBrushCallback</a>) (const gchar *brush_name,
55
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
58
const guchar *mask_data,
59
gboolean dialog_closing,
61
const gchar* <a href="libgimp-gimpbrushselect.html#gimp-brush-select-new">gimp_brush_select_new</a> (const gchar *title,
62
const gchar *brush_name,
65
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
66
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
68
void <a href="libgimp-gimpbrushselect.html#gimp-brush-select-destroy">gimp_brush_select_destroy</a> (const gchar *brush_callback);
69
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-popup">gimp_brushes_popup</a> (const gchar *brush_callback,
70
const gchar *popup_title,
71
const gchar *initial_brush,
74
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
75
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-close-popup">gimp_brushes_close_popup</a> (const gchar *brush_callback);
76
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-set-popup">gimp_brushes_set_popup</a> (const gchar *brush_callback,
77
const gchar *brush_name,
80
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
55
void (<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">*GimpRunBrushCallback</a>) (const gchar *brush_name,
58
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
61
const guchar *mask_data,
62
gboolean dialog_closing,
64
const gchar* <a href="libgimp-gimpbrushselect.html#gimp-brush-select-new">gimp_brush_select_new</a> (const gchar *title,
65
const gchar *brush_name,
68
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
69
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
71
void <a href="libgimp-gimpbrushselect.html#gimp-brush-select-destroy">gimp_brush_select_destroy</a> (const gchar *brush_callback);
72
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-popup">gimp_brushes_popup</a> (const gchar *brush_callback,
73
const gchar *popup_title,
74
const gchar *initial_brush,
77
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
78
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-close-popup">gimp_brushes_close_popup</a> (const gchar *brush_callback);
79
gboolean <a href="libgimp-gimpbrushselect.html#gimp-brushes-set-popup">gimp_brushes_set_popup</a> (const gchar *brush_callback,
80
const gchar *brush_name,
83
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
83
86
<div class="refsect1" lang="en">
84
<a name="id2647652"></a><h2>Description</h2>
87
<a name="id2702473"></a><h2>Description</h2>
86
89
Functions providing a brush selection dialog.
89
92
<div class="refsect1" lang="en">
90
<a name="id2647669"></a><h2>Details</h2>
93
<a name="id2702490"></a><h2>Details</h2>
91
94
<div class="refsect2" lang="en">
92
<a name="id2647680"></a><h3>
95
<a name="id2702500"></a><h3>
93
96
<a name="GimpRunBrushCallback"></a>GimpRunBrushCallback ()</h3>
94
<a class="indexterm" name="id2647691"></a><pre class="programlisting">void (*GimpRunBrushCallback) (const gchar *brush_name,
97
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
100
const guchar *mask_data,
101
gboolean dialog_closing,
102
gpointer user_data);</pre>
97
<a class="indexterm" name="id2702511"></a><pre class="programlisting">void (*GimpRunBrushCallback) (const gchar *brush_name,
100
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
103
const guchar *mask_data,
104
gboolean dialog_closing,
105
gpointer user_data);</pre>
107
110
<col align="left" valign="top">
111
<span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
117
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
123
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
129
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
135
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
141
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
147
<span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
153
<span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></td>
159
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
113
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
118
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
123
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
128
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
133
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
138
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
143
<td><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
148
<td><span class="term"><em class="parameter"><code>dialog_closing</code></em> :</span></td>
153
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
169
163
<div class="refsect2" lang="en">
170
<a name="id2631686"></a><h3>
164
<a name="id2704769"></a><h3>
171
165
<a name="gimp-brush-select-new"></a>gimp_brush_select_new ()</h3>
172
<a class="indexterm" name="id2631698"></a><pre class="programlisting">const gchar* gimp_brush_select_new (const gchar *title,
173
const gchar *brush_name,
176
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
177
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
178
gpointer data);</pre>
166
<a class="indexterm" name="id2704781"></a><pre class="programlisting">const gchar* gimp_brush_select_new (const gchar *title,
167
const gchar *brush_name,
170
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
171
<a href="libgimp-gimpbrushselect.html#GimpRunBrushCallback">GimpRunBrushCallback</a> callback,
172
gpointer data);</pre>
183
177
<col align="left" valign="top">
187
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
193
<span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
199
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
205
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
211
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
217
<span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
223
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
229
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
180
<td><span class="term"><em class="parameter"><code>title</code></em> :</span></td>
185
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
190
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
195
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
200
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
205
<td><span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
210
<td><span class="term"><em class="parameter"><code>data</code></em> :</span></td>
215
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
239
225
<div class="refsect2" lang="en">
240
<a name="id2631880"></a><h3>
226
<a name="id2705230"></a><h3>
241
227
<a name="gimp-brush-select-destroy"></a>gimp_brush_select_destroy ()</h3>
242
<a class="indexterm" name="id2631891"></a><pre class="programlisting">void gimp_brush_select_destroy (const gchar *brush_callback);</pre>
228
<a class="indexterm" name="id2705241"></a><pre class="programlisting">void gimp_brush_select_destroy (const gchar *brush_callback);</pre>
246
232
<div class="variablelist"><table border="0">
247
233
<col align="left" valign="top">
250
<span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
235
<td><span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
259
244
<div class="refsect2" lang="en">
260
<a name="id2631937"></a><h3>
245
<a name="id2705286"></a><h3>
261
246
<a name="gimp-brushes-popup"></a>gimp_brushes_popup ()</h3>
262
<a class="indexterm" name="id2631949"></a><pre class="programlisting">gboolean gimp_brushes_popup (const gchar *brush_callback,
263
const gchar *popup_title,
264
const gchar *initial_brush,
267
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
247
<a class="indexterm" name="id2705297"></a><pre class="programlisting">gboolean gimp_brushes_popup (const gchar *brush_callback,
248
const gchar *popup_title,
249
const gchar *initial_brush,
252
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
269
254
Invokes the Gimp brush selection.
272
This procedure popups the brush selection dialog.</p>
257
This procedure opens the brush selection dialog.</p>
277
262
<col align="left" valign="top">
281
<span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
265
<td><span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
282
266
<td> The callback PDB proc to call when brush selection is made.
287
<span class="term"><em class="parameter"><code>popup_title</code></em> :</span></td>
288
<td> Title to give the brush popup window.
270
<td><span class="term"><em class="parameter"><code>popup_title</code></em> :</span></td>
271
<td> Title of the brush selection dialog.
293
<span class="term"><em class="parameter"><code>initial_brush</code></em> :</span></td>
275
<td><span class="term"><em class="parameter"><code>initial_brush</code></em> :</span></td>
294
276
<td> The name of the brush to set as the first selected.
299
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
280
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
300
281
<td> The initial opacity of the brush.
305
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
285
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
306
286
<td> The initial spacing of the brush (if < 0 then use brush default spacing).
311
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
290
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
312
291
<td> The initial paint mode.
317
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
295
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
318
296
<td> TRUE on success.
325
303
<div class="refsect2" lang="en">
326
<a name="id2648919"></a><h3>
304
<a name="id2708675"></a><h3>
327
305
<a name="gimp-brushes-close-popup"></a>gimp_brushes_close_popup ()</h3>
328
<a class="indexterm" name="id2648930"></a><pre class="programlisting">gboolean gimp_brushes_close_popup (const gchar *brush_callback);</pre>
306
<a class="indexterm" name="id2708685"></a><pre class="programlisting">gboolean gimp_brushes_close_popup (const gchar *brush_callback);</pre>
330
Popdown the Gimp brush selection.
308
Close the brush selection dialog.
333
311
This procedure closes an opened brush selection dialog.</p>
356
332
<div class="refsect2" lang="en">
357
<a name="id2648987"></a><h3>
333
<a name="id2708744"></a><h3>
358
334
<a name="gimp-brushes-set-popup"></a>gimp_brushes_set_popup ()</h3>
359
<a class="indexterm" name="id2648998"></a><pre class="programlisting">gboolean gimp_brushes_set_popup (const gchar *brush_callback,
360
const gchar *brush_name,
363
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
335
<a class="indexterm" name="id2708754"></a><pre class="programlisting">gboolean gimp_brushes_set_popup (const gchar *brush_callback,
336
const gchar *brush_name,
339
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
365
Sets the current brush selection in a popup.
341
Sets the current brush in a brush selection dialog.
368
Sets the current brush selection in a popup.</p>
344
Sets the current brush in a brush selection dialog.</p>
373
349
<col align="left" valign="top">
377
<span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
378
<td> The name of the callback registered for this popup.
352
<td><span class="term"><em class="parameter"><code>brush_callback</code></em> :</span></td>
353
<td> The name of the callback registered for this pop-up.
383
<span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
357
<td><span class="term"><em class="parameter"><code>brush_name</code></em> :</span></td>
384
358
<td> The name of the brush to set as selected.
389
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
362
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
390
363
<td> The initial opacity of the brush.
395
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
367
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
396
368
<td> The initial spacing of the brush (if < 0 then use brush default spacing).
401
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
372
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
402
373
<td> The initial paint mode.
407
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
377
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
408
378
<td> TRUE on success.