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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpColorArea">
<refmeta>
<refentrytitle role="top_of_page" id="GimpColorArea.top_of_page">GimpColorArea</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpColorArea</refname>
<refpurpose>Displays a GimpRGB color, optionally with alpha-channel.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GimpColorArea.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpColorArea-struct">GimpColorArea</link>;
enum <link linkend="GimpColorAreaType">GimpColorAreaType</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-area-new">gimp_color_area_new</link> (const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
<link linkend="GdkModifierType">GdkModifierType</link> drag_mask);
<link linkend="void">void</link> <link linkend="gimp-color-area-set-color">gimp_color_area_set_color</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="void">void</link> <link linkend="gimp-color-area-get-color">gimp_color_area_get_color</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-area-has-alpha">gimp_color_area_has_alpha</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area);
<link linkend="void">void</link> <link linkend="gimp-color-area-set-type">gimp_color_area_set_type</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
<link linkend="void">void</link> <link linkend="gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="gboolean">gboolean</link> draw_border);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GimpColorArea.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
+----GimpColorArea
</synopsis>
</refsect1>
<refsect1 id="GimpColorArea.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpColorArea implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="GimpColorArea.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpColorArea--color">color</link>" <link linkend="GimpRGB">GimpRGB</link>* : Read / Write / Construct
"<link linkend="GimpColorArea--drag-mask">drag-mask</link>" <link linkend="GdkModifierType">GdkModifierType</link> : Write / Construct Only
"<link linkend="GimpColorArea--draw-border">draw-border</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="GimpColorArea--type">type</link>" <link linkend="GimpColorAreaType">GimpColorAreaType</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="GimpColorArea.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpColorArea-color-changed">color-changed</link>" : Run First
</synopsis>
</refsect1>
<refsect1 id="GimpColorArea.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GimpColorArea.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpColorArea-struct" role="struct">
<title>GimpColorArea</title>
<indexterm zone="GimpColorArea-struct"><primary>GimpColorArea</primary></indexterm><programlisting>typedef struct _GimpColorArea GimpColorArea;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GimpColorAreaType" role="enum">
<title>enum GimpColorAreaType</title>
<indexterm zone="GimpColorAreaType"><primary>GimpColorAreaType</primary></indexterm><programlisting>typedef enum
{
GIMP_COLOR_AREA_FLAT = 0,
GIMP_COLOR_AREA_SMALL_CHECKS,
GIMP_COLOR_AREA_LARGE_CHECKS
} GimpColorAreaType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-color-area-new" role="function">
<title>gimp_color_area_new ()</title>
<indexterm zone="gimp-color-area-new"><primary>gimp_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_area_new (const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
<link linkend="GdkModifierType">GdkModifierType</link> drag_mask);</programlisting>
<para>
Creates a new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
</para>
<para>
This returns a preview area showing the color. It handles color
DND. If the color changes, the "color_changed" signal is emitted.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> A pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> The type of color area to create.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drag_mask</parameter> :</term>
<listitem><simpara> The event_mask that should trigger drags.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-area-set-color" role="function">
<title>gimp_color_area_set_color ()</title>
<indexterm zone="gimp-color-area-set-color"><primary>gimp_color_area_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_color (<link linkend="GimpColorArea">GimpColorArea</link> *area,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Sets <parameter>area</parameter> to a different <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct that defines the new color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-area-get-color" role="function">
<title>gimp_color_area_get_color ()</title>
<indexterm zone="gimp-color-area-get-color"><primary>gimp_color_area_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_get_color (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Retrieves the current color of the <parameter>area</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct that is used to return the color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-area-has-alpha" role="function">
<title>gimp_color_area_has_alpha ()</title>
<indexterm zone="gimp-color-area-has-alpha"><primary>gimp_color_area_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_area_has_alpha (<link linkend="GimpColorArea">GimpColorArea</link> *area);</programlisting>
<para>
Checks whether the <parameter>area</parameter> shows transparency information. This is determined
via the <parameter>area</parameter>'s <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>area</parameter> shows transparency information, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-area-set-type" role="function">
<title>gimp_color_area_set_type ()</title>
<indexterm zone="gimp-color-area-set-type"><primary>gimp_color_area_set_type</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_type (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
<para>
Allows to change the type of <parameter>area</parameter>. The <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link> determines
whether the widget shows transparency information and chooses the size of
the checkerboard used to do that.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> A <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-area-set-draw-border" role="function">
<title>gimp_color_area_set_draw_border ()</title>
<indexterm zone="gimp-color-area-set-draw-border"><primary>gimp_color_area_set_draw_border</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_draw_border (<link linkend="GimpColorArea">GimpColorArea</link> *area,
<link linkend="gboolean">gboolean</link> draw_border);</programlisting>
<para>
The <parameter>area</parameter> can draw a thin border in the foreground color around
itself. This function allows to toggle this behaviour on and
off. The default is not draw a border.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>area</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>draw_border</parameter> :</term>
<listitem><simpara> whether to draw a border or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GimpColorArea.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GimpColorArea--color"><title>The <literal>"color"</literal> property</title>
<indexterm zone="GimpColorArea--color" role="GIMP 2.4"><primary>GimpColorArea:color</primary></indexterm><programlisting> "color" <link linkend="GimpRGB">GimpRGB</link>* : Read / Write / Construct</programlisting>
<para>
The color displayed in the color area.</para>
<para>
</para><para>Since GIMP 2.4
</para>
</refsect2>
<refsect2 id="GimpColorArea--drag-mask"><title>The <literal>"drag-mask"</literal> property</title>
<indexterm zone="GimpColorArea--drag-mask"><primary>GimpColorArea:drag-mask</primary></indexterm><programlisting> "drag-mask" <link linkend="GdkModifierType">GdkModifierType</link> : Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2 id="GimpColorArea--draw-border"><title>The <literal>"draw-border"</literal> property</title>
<indexterm zone="GimpColorArea--draw-border" role="GIMP 2.4"><primary>GimpColorArea:draw-border</primary></indexterm><programlisting> "draw-border" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>
Whether to draw a thin border in the foreground color around the area.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since GIMP 2.4
</para>
</refsect2>
<refsect2 id="GimpColorArea--type"><title>The <literal>"type"</literal> property</title>
<indexterm zone="GimpColorArea--type" role="GIMP 2.4"><primary>GimpColorArea:type</primary></indexterm><programlisting> "type" <link linkend="GimpColorAreaType">GimpColorAreaType</link> : Read / Write / Construct</programlisting>
<para>
The type of the color area.</para>
<para>
</para><para>Default value: GIMP_COLOR_AREA_FLAT</para>
<para>Since GIMP 2.4
</para>
</refsect2>
</refsect1>
<refsect1 id="GimpColorArea.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GimpColorArea-color-changed"><title>The <literal>"color-changed"</literal> signal</title>
<indexterm zone="GimpColorArea-color-changed"><primary>GimpColorArea::color-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpcolorarea</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
