4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>GimpColorArea</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 Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
9
9
<link rel="prev" href="GimpChainButton.html" title="GimpChainButton">
10
10
<link rel="next" href="GimpColorButton.html" title="GimpColorButton">
11
<meta name="generator" content="GTK-Doc V1.6 (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
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
15
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
15
16
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
16
17
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
17
18
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
18
19
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
19
20
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
20
21
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
22
<link rel="index" href="libgimpwidgets-index.html" title="Index">
23
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
24
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
25
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
22
27
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
28
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
33
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
29
34
<td><a accesskey="n" href="GimpColorButton.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="#top_of_page" class="shortcut">Top</a>
33
<a href="#desc" class="shortcut">Description</a>
35
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
37
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
36
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2587792" class="shortcut">Top</a>
38
<a href="#id2509631" class="shortcut">Description</a>
40
<a href="#id2577408" class="shortcut">Object Hierarchy</a>
42
<a href="#id2509519" class="shortcut">Implemented Interfaces</a>
44
<a href="#id2509540" class="shortcut">Properties</a>
46
<a href="#id2509606" class="shortcut">Signals</a></nobr></td></tr>
39
48
<div class="refentry" lang="en">
40
49
<a name="GimpColorArea"></a><div class="titlepage"></div>
41
50
<div class="refnamediv"><table width="100%"><tr>
43
<h2><span class="refentrytitle"><a name="top_of_page"></a>GimpColorArea</span></h2>
53
<a name="id2587792"></a><span class="refentrytitle">GimpColorArea</span>
44
55
<p>GimpColorArea — Displays a GimpRGB color, optionally with alpha-channel.</p>
46
<td valign="top" align="right"></td>
57
<td valign="top" align="right"><img src="gimp-color-area.png"></td>
47
58
</tr></table></div>
48
59
<div class="refsynopsisdiv">
49
<a name="synopsis"></a><h2>Synopsis</h2>
50
61
<pre class="synopsis">
54
<a href="GimpColorArea.html#GimpColorArea-struct">GimpColorArea</a>;
55
enum <a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>;
56
GtkWidget* <a href="GimpColorArea.html#gimp-color-area-new">gimp_color_area_new</a> (const <a
65
<a href="GimpColorArea.html#GimpColorArea-struct">GimpColorArea</a>;
66
enum <a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>;
67
GtkWidget* <a href="GimpColorArea.html#gimp-color-area-new">gimp_color_area_new</a> (const <a
57
68
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
58
69
>GimpRGB</a> *color,
59
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
60
GdkModifierType drag_mask);
61
void <a href="GimpColorArea.html#gimp-color-area-set-color">gimp_color_area_set_color</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
63
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
65
void <a href="GimpColorArea.html#gimp-color-area-get-color">gimp_color_area_get_color</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
67
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
69
gboolean <a href="GimpColorArea.html#gimp-color-area-has-alpha">gimp_color_area_has_alpha</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
70
void <a href="GimpColorArea.html#gimp-color-area-set-type">gimp_color_area_set_type</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
71
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
72
void <a href="GimpColorArea.html#gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
73
gboolean draw_border);
70
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
71
GdkModifierType drag_mask);
72
void <a href="GimpColorArea.html#gimp-color-area-set-color">gimp_color_area_set_color</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
74
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
76
void <a href="GimpColorArea.html#gimp-color-area-get-color">gimp_color_area_get_color</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
78
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
80
gboolean <a href="GimpColorArea.html#gimp-color-area-has-alpha">gimp_color_area_has_alpha</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
81
void <a href="GimpColorArea.html#gimp-color-area-set-type">gimp_color_area_set_type</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
82
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
83
void <a href="GimpColorArea.html#gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
84
gboolean draw_border);
77
88
<div class="refsect1" lang="en">
78
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
89
<a name="id2577408"></a><h2>Object Hierarchy</h2>
79
90
<pre class="synopsis">
89
100
<div class="refsect1" lang="en">
90
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
101
<a name="id2509519"></a><h2>Implemented Interfaces</h2>
92
103
GimpColorArea implements
93
104
AtkImplementorIface.</p>
95
106
<div class="refsect1" lang="en">
96
<a name="signal_proto"></a><h2>Signals</h2>
97
<pre class="synopsis">
99
"<a href="GimpColorArea.html#GimpColorArea-color-changed">color-changed</a>"
100
void user_function (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
101
gpointer user_data) : Run first
104
<div class="refsect1" lang="en">
105
<a name="desc"></a><h2>Description</h2>
107
<a name="id2509540"></a><h2>Properties</h2>
108
<pre class="synopsis">
110
"<a href="GimpColorArea.html#GimpColorArea--color">color</a>" <a
111
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
112
>GimpRGB</a> : Read / Write / Construct
113
"<a href="GimpColorArea.html#GimpColorArea--drag-mask">drag-mask</a>" GdkModifierType : Write / Construct Only
114
"<a href="GimpColorArea.html#GimpColorArea--draw-border">draw-border</a>" gboolean : Read / Write
115
"<a href="GimpColorArea.html#GimpColorArea--type">type</a>" <a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> : Read / Write / Construct
118
<div class="refsect1" lang="en">
119
<a name="id2509606"></a><h2>Signals</h2>
120
<pre class="synopsis">
122
"<a href="GimpColorArea.html#GimpColorArea-color-changed">color-changed</a>" : Run First
125
<div class="refsect1" lang="en">
126
<a name="id2509631"></a><h2>Description</h2>
110
131
<div class="refsect1" lang="en">
111
<a name="details"></a><h2>Details</h2>
132
<a name="id2594704"></a><h2>Details</h2>
112
133
<div class="refsect2" lang="en">
113
<a name="id2523362"></a><h3>
134
<a name="id2594715"></a><h3>
114
135
<a name="GimpColorArea-struct"></a>GimpColorArea</h3>
115
<a class="indexterm" name="id2523373"></a><pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre>
136
<a class="indexterm" name="id2594727"></a><pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre>
121
142
<div class="refsect2" lang="en">
122
<a name="id2523389"></a><h3>
143
<a name="id2594743"></a><h3>
123
144
<a name="GimpColorAreaType"></a>enum GimpColorAreaType</h3>
124
<a class="indexterm" name="id2541548"></a><pre class="programlisting">typedef enum
145
<a class="indexterm" name="id2594755"></a><pre class="programlisting">typedef enum
126
147
GIMP_COLOR_AREA_FLAT = 0,
127
148
GIMP_COLOR_AREA_SMALL_CHECKS,
136
157
<div class="refsect2" lang="en">
137
<a name="id2541565"></a><h3>
158
<a name="id2594773"></a><h3>
138
159
<a name="gimp-color-area-new"></a>gimp_color_area_new ()</h3>
139
<a class="indexterm" name="id2541578"></a><pre class="programlisting">GtkWidget* gimp_color_area_new (const <a
160
<a class="indexterm" name="id2594785"></a><pre class="programlisting">GtkWidget* gimp_color_area_new (const <a
140
161
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
141
162
>GimpRGB</a> *color,
142
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
143
GdkModifierType drag_mask);</pre>
163
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
164
GdkModifierType drag_mask);</pre>
145
166
Creates a new <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
154
175
<col align="left" valign="top">
158
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
178
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
159
179
<td> A pointer to a <a
160
180
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
161
181
><span class="type">GimpRGB</span></a> struct.
166
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
185
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
167
186
<td> The type of color area to create.
172
<span class="term"><em class="parameter"><code>drag_mask</code></em> :</span></td>
190
<td><span class="term"><em class="parameter"><code>drag_mask</code></em> :</span></td>
173
191
<td> The event_mask that should trigger drags.
178
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
195
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
179
196
<td> Pointer to the new <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
186
203
<div class="refsect2" lang="en">
187
<a name="id2541706"></a><h3>
204
<a name="id2594915"></a><h3>
188
205
<a name="gimp-color-area-set-color"></a>gimp_color_area_set_color ()</h3>
189
<a class="indexterm" name="id2541717"></a><pre class="programlisting">void gimp_color_area_set_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
206
<a class="indexterm" name="id2594926"></a><pre class="programlisting">void gimp_color_area_set_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
191
208
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
192
209
>GimpRGB</a> *color);</pre>
219
234
<div class="refsect2" lang="en">
220
<a name="id2527379"></a><h3>
235
<a name="id2567966"></a><h3>
221
236
<a name="gimp-color-area-get-color"></a>gimp_color_area_get_color ()</h3>
222
<a class="indexterm" name="id2527390"></a><pre class="programlisting">void gimp_color_area_get_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
237
<a class="indexterm" name="id2567978"></a><pre class="programlisting">void gimp_color_area_get_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
224
239
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
225
240
>GimpRGB</a> *color);</pre>
252
265
<div class="refsect2" lang="en">
253
<a name="id2527482"></a><h3>
266
<a name="id2568069"></a><h3>
254
267
<a name="gimp-color-area-has-alpha"></a>gimp_color_area_has_alpha ()</h3>
255
<a class="indexterm" name="id2527493"></a><pre class="programlisting">gboolean gimp_color_area_has_alpha (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
268
<a class="indexterm" name="id2568080"></a><pre class="programlisting">gboolean gimp_color_area_has_alpha (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
257
270
Checks whether the <em class="parameter"><code>area</code></em> shows transparency information. This is determined
258
271
via the <em class="parameter"><code>area</code></em>'s <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>.</p>
281
292
<div class="refsect2" lang="en">
282
<a name="id2527606"></a><h3>
293
<a name="id2601492"></a><h3>
283
294
<a name="gimp-color-area-set-type"></a>gimp_color_area_set_type ()</h3>
284
<a class="indexterm" name="id2527617"></a><pre class="programlisting">void gimp_color_area_set_type (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
285
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre>
295
<a class="indexterm" name="id2601503"></a><pre class="programlisting">void gimp_color_area_set_type (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
296
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre>
287
298
Allows to change the type of <em class="parameter"><code>area</code></em>. The <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a> determines
288
299
whether the widget shows transparency information and chooses the size of
312
321
<div class="refsect2" lang="en">
313
<a name="id2566575"></a><h3>
322
<a name="id2601593"></a><h3>
314
323
<a name="gimp-color-area-set-draw-border"></a>gimp_color_area_set_draw_border ()</h3>
315
<a class="indexterm" name="id2566588"></a><pre class="programlisting">void gimp_color_area_set_draw_border (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
316
gboolean draw_border);</pre>
324
<a class="indexterm" name="id2601606"></a><pre class="programlisting">void gimp_color_area_set_draw_border (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
325
gboolean draw_border);</pre>
318
327
The <em class="parameter"><code>area</code></em> can draw a thin border in the foreground color around
319
328
itself. This function allows to toggle this behaviour on and
343
350
<div class="refsect1" lang="en">
344
<a name="signals"></a><h2>Signal Details</h2>
345
<div class="refsect2" lang="en">
346
<a name="id2566686"></a><h3>
351
<a name="id2601695"></a><h2>Property Details</h2>
352
<div class="refsect2" lang="en">
353
<a name="id2601706"></a><h3>
354
<a name="GimpColorArea--color"></a>The "<code class="literal">color</code>" property</h3>
355
<a class="indexterm" name="id2601720"></a><pre class="programlisting"> "color" <a
356
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
357
>GimpRGB</a> : Read / Write / Construct</pre>
359
The color displayed in the color area.</p>
367
<div class="refsect2" lang="en">
368
<a name="id2601753"></a><h3>
369
<a name="GimpColorArea--drag-mask"></a>The "<code class="literal">drag-mask</code>" property</h3>
370
<a class="indexterm" name="id2601767"></a><pre class="programlisting"> "drag-mask" GdkModifierType : Write / Construct Only</pre>
374
<div class="refsect2" lang="en">
375
<a name="id2601788"></a><h3>
376
<a name="GimpColorArea--draw-border"></a>The "<code class="literal">draw-border</code>" property</h3>
377
<a class="indexterm" name="id2601802"></a><pre class="programlisting"> "draw-border" gboolean : Read / Write</pre>
379
Whether to draw a thin border in the foreground color around the area.</p>
383
<p>Default value: FALSE</p>
388
<div class="refsect2" lang="en">
389
<a name="id2601838"></a><h3>
390
<a name="GimpColorArea--type"></a>The "<code class="literal">type</code>" property</h3>
391
<a class="indexterm" name="id2601853"></a><pre class="programlisting"> "type" <a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> : Read / Write / Construct</pre>
393
The type of the color area.</p>
397
<p>Default value: GIMP_COLOR_AREA_FLAT</p>
402
<div class="refsect1" lang="en">
403
<a name="id2601891"></a><h2>Signal Details</h2>
404
<div class="refsect2" lang="en">
405
<a name="id2601902"></a><h3>
347
406
<a name="GimpColorArea-color-changed"></a>The "color-changed" signal</h3>
348
<a class="indexterm" name="id2566694"></a><pre class="programlisting">void user_function (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
349
gpointer user_data) : Run first</pre>
407
<a class="indexterm" name="id2601910"></a><pre class="programlisting">void user_function (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
408
gpointer user_data) : Run First</pre>
added
removed
devel-docs/libgimpwidgets/html/GimpColorArea.html
