summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimp/html/libgimp-gimpbrushmenu.html
blob: 5e8c0336209a88cdbaf7411159b1607a32660f09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbrushmenu: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-gimpmenu.html" title="gimpmenu">
<link rel="next" href="libgimp-gimpfontmenu.html" title="gimpfontmenu">
<meta name="generator" content="GTK-Doc V1.32 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp-gimpbrushmenu.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimpmenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpfontmenu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpbrushmenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpbrushmenu.top_of_page"></a>gimpbrushmenu</span></h2>
<p>gimpbrushmenu — A widget for selecting brushes.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-new" title="gimp_brush_select_widget_new ()">gimp_brush_select_widget_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-close" title="gimp_brush_select_widget_close ()">gimp_brush_select_widget_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-set" title="gimp_brush_select_widget_set ()">gimp_brush_select_widget_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.description"></a><h2>Description</h2>
<p>A widget for selecting brushes.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpbrushmenu.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-brush-select-widget-new"></a><h3>gimp_brush_select_widget_new ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gimp_brush_select_widget_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                              <em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
                              <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                              <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                              <em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>,
                              <em class="parameter"><code><a class="link" href="libgimp-gimpbrushselect.html#GimpRunBrushCallback" title="GimpRunBrushCallback ()"><span class="type">GimpRunBrushCallback</span></a> callback</code></em>,
                              <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_new</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Creates a new <a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> that completely controls the selection of
a <span class="type">GimpBrush</span>. This widget is suitable for placement in a table in
a plug-in dialog.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>Title of the dialog to use or <code class="literal">NULL</code> to use the default title.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>Initial brush name or <code class="literal">NULL</code> to use current selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>Initial opacity. -1 means to use current opacity.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>Initial spacing. -1 means to use current spacing.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>Initial paint mode.  -1 means to use current paint mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>A function to call when the selected brush changes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>A pointer to arbitrary data to be used in the call to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-brush-select-widget-new.returns"></a><h4>Returns</h4>
<p> A <a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> that you can use in your UI.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-widget-close"></a><h3>gimp_brush_select_widget_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_brush_select_widget_close (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_close</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Closes the popup window associated with <em class="parameter"><code>widget</code></em>
.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-close.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>A brush select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-brush-select-widget-set"></a><h3>gimp_brush_select_widget_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_brush_select_widget_set (<em class="parameter"><code><a href="https://developer.gnome.org/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> *widget</code></em>,
                              <em class="parameter"><code>const <span class="type">gchar</span> *brush_name</code></em>,
                              <em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
                              <em class="parameter"><code><span class="type">gint</span> spacing</code></em>,
                              <em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_brush_select_widget_set</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets the current brush and other values for the brush select
widget.  Calls the callback function if one was supplied in the
call to <a class="link" href="libgimp-gimpbrushmenu.html#gimp-brush-select-widget-new" title="gimp_brush_select_widget_new ()"><code class="function">gimp_brush_select_widget_new()</code></a>.</p>
<div class="refsect3">
<a name="gimp-brush-select-widget-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>A brush select widget.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>brush_name</p></td>
<td class="parameter_description"><p>Brush name to set; <code class="literal">NULL</code> means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>Opacity to set. -1.0 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>spacing</p></td>
<td class="parameter_description"><p>Spacing to set. -1 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>Paint mode to set.  -1 means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>