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
|
<?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="GimpColorButton">
<refmeta>
<refentrytitle role="top_of_page" id="GimpColorButton.top_of_page">GimpColorButton</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpColorButton</refname>
<refpurpose>Widget for selecting a color from a simple button.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="GimpColorButton.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpColorButton-struct">GimpColorButton</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-button-new">gimp_color_button_new</link> (const <link linkend="gchar">gchar</link> *title,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
<link linkend="void">void</link> <link linkend="gimp-color-button-set-color">gimp_color_button_set_color</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="void">void</link> <link linkend="gimp-color-button-get-color">gimp_color_button_get_color</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="void">void</link> <link linkend="gimp-color-button-set-update">gimp_color_button_set_update</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="gboolean">gboolean</link> continuous);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-button-get-update">gimp_color_button_get_update</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-button-has-alpha">gimp_color_button_has_alpha</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button);
<link linkend="void">void</link> <link linkend="gimp-color-button-set-type">gimp_color_button_set_type</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GimpColorButton.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="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkButton">GtkButton</link>
+----<link linkend="GimpButton">GimpButton</link>
+----GimpColorButton
</synopsis>
</refsect1>
<refsect1 id="GimpColorButton.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpColorButton implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="GimpColorButton.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpColorButton--color">color</link>" <link linkend="GimpRGB">GimpRGB</link>* : Read / Write / Construct
"<link linkend="GimpColorButton--continuous-update">continuous-update</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
"<link linkend="GimpColorButton--title">title</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
"<link linkend="GimpColorButton--type">type</link>" <link linkend="GimpColorAreaType">GimpColorAreaType</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="GimpColorButton.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpColorButton-color-changed">color-changed</link>" : Run First
</synopsis>
</refsect1>
<refsect1 id="GimpColorButton.description" role="desc">
<title role="desc.title">Description</title>
<para>
This widget provides a simple button with a preview showing the
color.
</para>
<para>
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.
</para>
</refsect1>
<refsect1 id="GimpColorButton.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpColorButton-struct" role="struct">
<title>GimpColorButton</title>
<indexterm zone="GimpColorButton-struct"><primary>GimpColorButton</primary></indexterm><programlisting>typedef struct _GimpColorButton GimpColorButton;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gimp-color-button-new" role="function">
<title>gimp_color_button_new ()</title>
<indexterm zone="gimp-color-button-new"><primary>gimp_color_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_button_new (const <link linkend="gchar">gchar</link> *title,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height,
const <link linkend="GimpRGB">GimpRGB</link> *color,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
<para>
Creates a new <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> String that will be used as title for the color_selector.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> Width of the colorpreview in pixels.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> Height of the colorpreview in pixels.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> A pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> color.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-set-color" role="function">
<title>gimp_color_button_set_color ()</title>
<indexterm zone="gimp-color-button-set-color"><primary>gimp_color_button_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_color (<link linkend="GimpColorButton">GimpColorButton</link> *button,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Sets the <parameter>button</parameter> to the given <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> Pointer to the new <link linkend="GimpRGB"><type>GimpRGB</type></link> color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-get-color" role="function">
<title>gimp_color_button_get_color ()</title>
<indexterm zone="gimp-color-button-get-color"><primary>gimp_color_button_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_get_color (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Retrieves the currently set color from the <parameter>button</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct used to return the color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-set-update" role="function">
<title>gimp_color_button_set_update ()</title>
<indexterm zone="gimp-color-button-set-update"><primary>gimp_color_button_set_update</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_update (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="gboolean">gboolean</link> continuous);</programlisting>
<para>
When set to <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the <parameter>button</parameter> will emit the "color-changed"
continuously while the color is changed in the color selection
dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> A <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>continuous</parameter> :</term>
<listitem><simpara> The new setting of the <parameter>continuous_update</parameter> property.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-get-update" role="function">
<title>gimp_color_button_get_update ()</title>
<indexterm zone="gimp-color-button-get-update"><primary>gimp_color_button_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_button_get_update (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
<para>
Returns the color button's <parameter>continuous_update</parameter> property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> A <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>continuous_update</parameter> property.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-has-alpha" role="function">
<title>gimp_color_button_has_alpha ()</title>
<indexterm zone="gimp-color-button-has-alpha"><primary>gimp_color_button_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_button_has_alpha (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
<para>
Checks whether the <parameter>buttons</parameter> shows transparency information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>button</parameter> shows transparency information, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-color-button-set-type" role="function">
<title>gimp_color_button_set_type ()</title>
<indexterm zone="gimp-color-button-set-type"><primary>gimp_color_button_set_type</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_type (<link linkend="GimpColorButton">GimpColorButton</link> *button,
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
<para>
Sets the <parameter>button</parameter> to the given <parameter>type</parameter>. See also <link linkend="gimp-color-area-set-type"><function>gimp_color_area_set_type()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>button</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the new <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="GimpColorButton.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GimpColorButton--color"><title>The <literal>"color"</literal> property</title>
<indexterm zone="GimpColorButton--color" role="GIMP 2.4"><primary>GimpColorButton:color</primary></indexterm><programlisting> "color" <link linkend="GimpRGB">GimpRGB</link>* : Read / Write / Construct</programlisting>
<para>
The color displayed in the button's color area.</para>
<para>
</para><para>Since GIMP 2.4
</para>
</refsect2>
<refsect2 id="GimpColorButton--continuous-update"><title>The <literal>"continuous-update"</literal> property</title>
<indexterm zone="GimpColorButton--continuous-update" role="GIMP 2.4"><primary>GimpColorButton:continuous-update</primary></indexterm><programlisting> "continuous-update" <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para>
The update policy of the color button.</para>
<para>
</para><para>Default value: FALSE</para>
<para>Since GIMP 2.4
</para>
</refsect2>
<refsect2 id="GimpColorButton--title"><title>The <literal>"title"</literal> property</title>
<indexterm zone="GimpColorButton--title" role="GIMP 2.4"><primary>GimpColorButton:title</primary></indexterm><programlisting> "title" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>
The title to be used for the color selection dialog.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since GIMP 2.4
</para>
</refsect2>
<refsect2 id="GimpColorButton--type"><title>The <literal>"type"</literal> property</title>
<indexterm zone="GimpColorButton--type" role="GIMP 2.4"><primary>GimpColorButton:type</primary></indexterm><programlisting> "type" <link linkend="GimpColorAreaType">GimpColorAreaType</link> : Read / Write / Construct</programlisting>
<para>
The type of the button's color area.</para>
<para>
</para><para>Default value: GIMP_COLOR_AREA_FLAT</para>
<para>Since GIMP 2.4
</para>
</refsect2>
</refsect1>
<refsect1 id="GimpColorButton.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GimpColorButton-color-changed"><title>The <literal>"color-changed"</literal> signal</title>
<indexterm zone="GimpColorButton-color-changed"><primary>GimpColorButton::color-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpcolorbutton</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>
<refsect1 id="GimpColorButton.see-also">
<title>See Also</title>
<para>
<link linkend="libgimpcolor-gimpcolorspace"><type>libgimpcolor-gimpcolorspace</type></link>
</para>
</refsect1>
</refentry>
|
