← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpbrushselect.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpbrushselect.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="libgimp-gimpbrushselect">
 
6
<refmeta>
 
7
<refentrytitle>gimpbrushselect</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gimpbrushselect</refname><refpurpose>Functions providing a brush selection dialog.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
<link linkend="void">void</link>        (<link linkend="GimpRunBrushCallback">*GimpRunBrushCallback</link>)         (const <link linkend="gchar">gchar</link> *brush_name,
 
23
                                             <link linkend="gdouble">gdouble</link> opacity,
 
24
                                             <link linkend="gint">gint</link> spacing,
 
25
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
 
26
                                             <link linkend="gint">gint</link> width,
 
27
                                             <link linkend="gint">gint</link> height,
 
28
                                             const <link linkend="guchar">guchar</link> *mask_data,
 
29
                                             <link linkend="gboolean">gboolean</link> dialog_closing,
 
30
                                             <link linkend="gpointer">gpointer</link> user_data);
 
31
const <link linkend="gchar">gchar</link>* <link linkend="gimp-brush-select-new">gimp_brush_select_new</link>          (const <link linkend="gchar">gchar</link> *title,
 
32
                                             const <link linkend="gchar">gchar</link> *brush_name,
 
33
                                             <link linkend="gdouble">gdouble</link> opacity,
 
34
                                             <link linkend="gint">gint</link> spacing,
 
35
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
 
36
                                             <link linkend="GimpRunBrushCallback">GimpRunBrushCallback</link> callback,
 
37
                                             <link linkend="gpointer">gpointer</link> data);
 
38
<link linkend="void">void</link>        <link linkend="gimp-brush-select-destroy">gimp_brush_select_destroy</link>       (const <link linkend="gchar">gchar</link> *brush_callback);
 
39
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-popup">gimp_brushes_popup</link>              (const <link linkend="gchar">gchar</link> *brush_callback,
 
40
                                             const <link linkend="gchar">gchar</link> *popup_title,
 
41
                                             const <link linkend="gchar">gchar</link> *initial_brush,
 
42
                                             <link linkend="gdouble">gdouble</link> opacity,
 
43
                                             <link linkend="gint">gint</link> spacing,
 
44
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
 
45
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-close-popup">gimp_brushes_close_popup</link>        (const <link linkend="gchar">gchar</link> *brush_callback);
 
46
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brushes-set-popup">gimp_brushes_set_popup</link>          (const <link linkend="gchar">gchar</link> *brush_callback,
 
47
                                             const <link linkend="gchar">gchar</link> *brush_name,
 
48
                                             <link linkend="gdouble">gdouble</link> opacity,
 
49
                                             <link linkend="gint">gint</link> spacing,
 
50
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);
 
51
</synopsis>
 
52
</refsynopsisdiv>
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
<refsect1>
 
63
<title>Description</title>
 
64
<para>
 
65
Functions providing a brush selection dialog.
 
66
</para>
 
67
</refsect1>
 
68
 
 
69
<refsect1>
 
70
<title>Details</title>
 
71
<refsect2>
 
72
<title><anchor id="GimpRunBrushCallback"/>GimpRunBrushCallback ()</title>
 
73
<indexterm><primary>GimpRunBrushCallback</primary></indexterm><programlisting><link linkend="void">void</link>        (*GimpRunBrushCallback)         (const <link linkend="gchar">gchar</link> *brush_name,
 
74
                                             <link linkend="gdouble">gdouble</link> opacity,
 
75
                                             <link linkend="gint">gint</link> spacing,
 
76
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
 
77
                                             <link linkend="gint">gint</link> width,
 
78
                                             <link linkend="gint">gint</link> height,
 
79
                                             const <link linkend="guchar">guchar</link> *mask_data,
 
80
                                             <link linkend="gboolean">gboolean</link> dialog_closing,
 
81
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
82
<para>
 
83
 
 
84
</para><variablelist role="params">
 
85
<varlistentry><term><parameter>brush_name</parameter>&nbsp;:</term>
 
86
<listitem><simpara>
 
87
</simpara></listitem></varlistentry>
 
88
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
 
89
<listitem><simpara>
 
90
</simpara></listitem></varlistentry>
 
91
<varlistentry><term><parameter>spacing</parameter>&nbsp;:</term>
 
92
<listitem><simpara>
 
93
</simpara></listitem></varlistentry>
 
94
<varlistentry><term><parameter>paint_mode</parameter>&nbsp;:</term>
 
95
<listitem><simpara>
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
98
<listitem><simpara>
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
101
<listitem><simpara>
 
102
</simpara></listitem></varlistentry>
 
103
<varlistentry><term><parameter>mask_data</parameter>&nbsp;:</term>
 
104
<listitem><simpara>
 
105
</simpara></listitem></varlistentry>
 
106
<varlistentry><term><parameter>dialog_closing</parameter>&nbsp;:</term>
 
107
<listitem><simpara>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
110
<listitem><simpara>
 
111
 
 
112
 
 
113
</simpara></listitem></varlistentry>
 
114
</variablelist></refsect2>
 
115
<refsect2>
 
116
<title><anchor id="gimp-brush-select-new"/>gimp_brush_select_new ()</title>
 
117
<indexterm><primary>gimp_brush_select_new</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_brush_select_new          (const <link linkend="gchar">gchar</link> *title,
 
118
                                             const <link linkend="gchar">gchar</link> *brush_name,
 
119
                                             <link linkend="gdouble">gdouble</link> opacity,
 
120
                                             <link linkend="gint">gint</link> spacing,
 
121
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode,
 
122
                                             <link linkend="GimpRunBrushCallback">GimpRunBrushCallback</link> callback,
 
123
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
 
124
<para>
 
125
 
 
126
</para><variablelist role="params">
 
127
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
128
<listitem><simpara>
 
129
</simpara></listitem></varlistentry>
 
130
<varlistentry><term><parameter>brush_name</parameter>&nbsp;:</term>
 
131
<listitem><simpara>
 
132
</simpara></listitem></varlistentry>
 
133
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
 
134
<listitem><simpara>
 
135
</simpara></listitem></varlistentry>
 
136
<varlistentry><term><parameter>spacing</parameter>&nbsp;:</term>
 
137
<listitem><simpara>
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><parameter>paint_mode</parameter>&nbsp;:</term>
 
140
<listitem><simpara>
 
141
</simpara></listitem></varlistentry>
 
142
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
143
<listitem><simpara>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
146
<listitem><simpara>
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
149
 
 
150
 
 
151
</simpara></listitem></varlistentry>
 
152
</variablelist></refsect2>
 
153
<refsect2>
 
154
<title><anchor id="gimp-brush-select-destroy"/>gimp_brush_select_destroy ()</title>
 
155
<indexterm><primary>gimp_brush_select_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_brush_select_destroy       (const <link linkend="gchar">gchar</link> *brush_callback);</programlisting>
 
156
<para>
 
157
 
 
158
</para><variablelist role="params">
 
159
<varlistentry><term><parameter>brush_callback</parameter>&nbsp;:</term>
 
160
<listitem><simpara>
 
161
 
 
162
 
 
163
</simpara></listitem></varlistentry>
 
164
</variablelist></refsect2>
 
165
<refsect2>
 
166
<title><anchor id="gimp-brushes-popup"/>gimp_brushes_popup ()</title>
 
167
<indexterm><primary>gimp_brushes_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_popup              (const <link linkend="gchar">gchar</link> *brush_callback,
 
168
                                             const <link linkend="gchar">gchar</link> *popup_title,
 
169
                                             const <link linkend="gchar">gchar</link> *initial_brush,
 
170
                                             <link linkend="gdouble">gdouble</link> opacity,
 
171
                                             <link linkend="gint">gint</link> spacing,
 
172
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
 
173
<para>
 
174
Invokes the Gimp brush selection.
 
175
</para>
 
176
<para>
 
177
This procedure popups the brush selection dialog.</para>
 
178
<para>
 
179
 
 
180
</para><variablelist role="params">
 
181
<varlistentry><term><parameter>brush_callback</parameter>&nbsp;:</term>
 
182
<listitem><simpara> The callback PDB proc to call when brush selection is made.
 
183
</simpara></listitem></varlistentry>
 
184
<varlistentry><term><parameter>popup_title</parameter>&nbsp;:</term>
 
185
<listitem><simpara> Title to give the brush popup window.
 
186
</simpara></listitem></varlistentry>
 
187
<varlistentry><term><parameter>initial_brush</parameter>&nbsp;:</term>
 
188
<listitem><simpara> The name of the brush to set as the first selected.
 
189
</simpara></listitem></varlistentry>
 
190
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
 
191
<listitem><simpara> The initial opacity of the brush.
 
192
</simpara></listitem></varlistentry>
 
193
<varlistentry><term><parameter>spacing</parameter>&nbsp;:</term>
 
194
<listitem><simpara> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
 
195
</simpara></listitem></varlistentry>
 
196
<varlistentry><term><parameter>paint_mode</parameter>&nbsp;:</term>
 
197
<listitem><simpara> The initial paint mode.
 
198
</simpara></listitem></varlistentry>
 
199
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
200
</simpara></listitem></varlistentry>
 
201
</variablelist></refsect2>
 
202
<refsect2>
 
203
<title><anchor id="gimp-brushes-close-popup"/>gimp_brushes_close_popup ()</title>
 
204
<indexterm><primary>gimp_brushes_close_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_close_popup        (const <link linkend="gchar">gchar</link> *brush_callback);</programlisting>
 
205
<para>
 
206
Popdown the Gimp brush selection.
 
207
</para>
 
208
<para>
 
209
This procedure closes an opened brush selection dialog.</para>
 
210
<para>
 
211
 
 
212
</para><variablelist role="params">
 
213
<varlistentry><term><parameter>brush_callback</parameter>&nbsp;:</term>
 
214
<listitem><simpara> The name of the callback registered for this popup.
 
215
</simpara></listitem></varlistentry>
 
216
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
217
</simpara></listitem></varlistentry>
 
218
</variablelist></refsect2>
 
219
<refsect2>
 
220
<title><anchor id="gimp-brushes-set-popup"/>gimp_brushes_set_popup ()</title>
 
221
<indexterm><primary>gimp_brushes_set_popup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brushes_set_popup          (const <link linkend="gchar">gchar</link> *brush_callback,
 
222
                                             const <link linkend="gchar">gchar</link> *brush_name,
 
223
                                             <link linkend="gdouble">gdouble</link> opacity,
 
224
                                             <link linkend="gint">gint</link> spacing,
 
225
                                             <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> paint_mode);</programlisting>
 
226
<para>
 
227
Sets the current brush selection in a popup.
 
228
</para>
 
229
<para>
 
230
Sets the current brush selection in a popup.</para>
 
231
<para>
 
232
 
 
233
</para><variablelist role="params">
 
234
<varlistentry><term><parameter>brush_callback</parameter>&nbsp;:</term>
 
235
<listitem><simpara> The name of the callback registered for this popup.
 
236
</simpara></listitem></varlistentry>
 
237
<varlistentry><term><parameter>brush_name</parameter>&nbsp;:</term>
 
238
<listitem><simpara> The name of the brush to set as selected.
 
239
</simpara></listitem></varlistentry>
 
240
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
 
241
<listitem><simpara> The initial opacity of the brush.
 
242
</simpara></listitem></varlistentry>
 
243
<varlistentry><term><parameter>spacing</parameter>&nbsp;:</term>
 
244
<listitem><simpara> The initial spacing of the brush (if &lt; 0 then use brush default spacing).
 
245
</simpara></listitem></varlistentry>
 
246
<varlistentry><term><parameter>paint_mode</parameter>&nbsp;:</term>
 
247
<listitem><simpara> The initial paint mode.
 
248
</simpara></listitem></varlistentry>
 
249
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
250
</simpara></listitem></varlistentry>
 
251
</variablelist></refsect2>
 
252
 
 
253
</refsect1>
 
254
 
 
255
 
 
256
 
 
257
 
 
258
</refentry>