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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpColorButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpColorArea.html" title="GimpColorArea">
<link rel="next" href="GimpColorHexEntry.html" title="GimpColorHexEntry">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="GimpColorArea.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpColorHexEntry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a>
 | 
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpColorButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>GimpColorButton</span></h2>
<p>GimpColorButton — Widget for selecting a color from a simple button.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpColorButton.html#GimpColorButton-struct">GimpColorButton</a>;
GtkWidget* <a href="GimpColorButton.html#gimp-color-button-new">gimp_color_button_new</a> (const gchar *title,
gint width,
gint height,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
void <a href="GimpColorButton.html#gimp-color-button-set-color">gimp_color_button_set_color</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
void <a href="GimpColorButton.html#gimp-color-button-get-color">gimp_color_button_get_color</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
void <a href="GimpColorButton.html#gimp-color-button-set-update">gimp_color_button_set_update</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
gboolean continuous);
gboolean <a href="GimpColorButton.html#gimp-color-button-get-update">gimp_color_button_get_update</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
gboolean <a href="GimpColorButton.html#gimp-color-button-has-alpha">gimp_color_button_has_alpha</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
void <a href="GimpColorButton.html#gimp-color-button-set-type">gimp_color_button_set_type</a> (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBin
+----GtkButton
+----<a href="GimpButton.html" title="GimpButton">GimpButton</a>
+----GimpColorButton
</pre>
</div>
<div class="refsect1" lang="en">
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpColorButton implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="signal_proto"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpColorButton.html#GimpColorButton-color-changed">color-changed</a>"
void user_function (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *gimpcolorbutton,
gpointer user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
This widget provides a simple button with a preview showing the
color.
</p>
<p>
On click a GtkColorSelectionDialog is opened. Additionally the button
supports Drag and Drop and has a right-click menu that allows to choose
the color from the current FG or BG color. If the user changes the
color, the "color_changed" signal is emitted.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2541299"></a><h3>
<a name="GimpColorButton-struct"></a>GimpColorButton</h3>
<a class="indexterm" name="id2541310"></a><pre class="programlisting">typedef struct _GimpColorButton GimpColorButton;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2541326"></a><h3>
<a name="gimp-color-button-new"></a>gimp_color_button_new ()</h3>
<a class="indexterm" name="id2541337"></a><pre class="programlisting">GtkWidget* gimp_color_button_new (const gchar *title,
gint width,
gint height,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre>
<p>
Creates a new <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a> widget.
</p>
<p>
This returns a button with a preview showing the color.
When the button is clicked a GtkColorSelectionDialog is opened.
If the user changes the color the new color is written into the
array that was used to pass the initial color and the "color_changed"
signal is emitted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>title</code></em> :</span></td>
<td> String that will be used as title for the color_selector.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> Width of the colorpreview in pixels.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> Height of the colorpreview in pixels.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
<td> A pointer to a <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> color.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to the new <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2541511"></a><h3>
<a name="gimp-color-button-set-color"></a>gimp_color_button_set_color ()</h3>
<a class="indexterm" name="id2541522"></a><pre class="programlisting">void gimp_color_button_set_color (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre>
<p>
Sets the <em class="parameter"><code>button</code></em> to the given <em class="parameter"><code>color</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> Pointer to a <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
<td> Pointer to the new <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> color.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2522578"></a><h3>
<a name="gimp-color-button-get-color"></a>gimp_color_button_get_color ()</h3>
<a class="indexterm" name="id2522590"></a><pre class="programlisting">void gimp_color_button_get_color (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre>
<p>
Retrieves the currently set color from the <em class="parameter"><code>button</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> Pointer to a <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
<td> Pointer to a <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> struct used to return the color.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2522681"></a><h3>
<a name="gimp-color-button-set-update"></a>gimp_color_button_set_update ()</h3>
<a class="indexterm" name="id2522693"></a><pre class="programlisting">void gimp_color_button_set_update (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
gboolean continuous);</pre>
<p>
When set to <span class="type">TRUE</span>, the <em class="parameter"><code>button</code></em> will emit the "color_changed"
continuously while the color is changed in the color selection
dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> A <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>continuous</code></em> :</span></td>
<td> The new setting of the <em class="parameter"><code>continuous_update</code></em> property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567969"></a><h3>
<a name="gimp-color-button-get-update"></a>gimp_color_button_get_update ()</h3>
<a class="indexterm" name="id2567982"></a><pre class="programlisting">gboolean gimp_color_button_get_update (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
<p>
Returns the color button's <em class="parameter"><code>continuous_update</code></em> property.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> A <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a> widget.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the <em class="parameter"><code>continuous_update</code></em> property.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568055"></a><h3>
<a name="gimp-color-button-has-alpha"></a>gimp_color_button_has_alpha ()</h3>
<a class="indexterm" name="id2568067"></a><pre class="programlisting">gboolean gimp_color_button_has_alpha (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
<p>
Checks whether the <em class="parameter"><code>buttons</code></em> shows transparency information.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> Pointer to a <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>button</code></em> shows transparency information, <code class="literal">FALSE</code>
otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568166"></a><h3>
<a name="gimp-color-button-set-type"></a>gimp_color_button_set_type ()</h3>
<a class="indexterm" name="id2568178"></a><pre class="programlisting">void gimp_color_button_set_type (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre>
<p>
Sets the <em class="parameter"><code>button</code></em> to the given <em class="parameter"><code>type</code></em>. See also <a href="GimpColorArea.html#gimp-color-area-set-type"><code class="function">gimp_color_area_set_type()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> Pointer to a <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> the new <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="signals"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2568297"></a><h3>
<a name="GimpColorButton-color-changed"></a>The "color-changed" signal</h3>
<a class="indexterm" name="id2568306"></a><pre class="programlisting">void user_function (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *gimpcolorbutton,
gpointer user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>gimpcolorbutton</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2568376"></a><h2>See Also</h2>
<p>
<span class="type">libgimpcolor-gimpcolorspace</span>
</p>
</div>
</div>
</body>
</html>
|
