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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpColorArea</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="prev" href="GimpChainButton.html" title="GimpChainButton"><link rel="next" href="GimpColorButton.html" title="GimpColorButton"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="PartI.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="PartII.GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="PartIII.GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="PartVI.Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="GimpChainButton.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="GimpColorButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="GimpColorArea"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpColorArea</span></h2><p>GimpColorArea — Displays a GimpRGB color, optionally with alpha-channel.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<a href="GimpColorArea.html#GimpColorArea-struct">GimpColorArea</a>;
enum <a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GimpColorArea.html#gimp-color-area-new">gimp_color_area_new</a> (const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
<a
href="../gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> drag_mask);
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,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
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,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GimpColorArea.html#gimp-color-area-has-alpha">gimp_color_area_has_alpha</a> (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
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,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
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,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> draw_border);
</pre></div><div class="refsect1" lang="en"><a name="id2538130"></a><h2>Object Hierarchy</h2><pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkDrawingArea.html"
>GtkDrawingArea</a>
+----GimpColorArea
</pre></div><div class="refsect1" lang="en"><a name="id2570744"></a><h2>Implemented Interfaces</h2><p>
GimpColorArea implements
AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2570758"></a><h2>Signal Prototypes</h2><pre class="synopsis">
"<a href="GimpColorArea.html#GimpColorArea-color-changed">color-changed</a>"
void user_function (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2570789"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2570798"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2570804"></a><h3><a name="GimpColorArea-struct"></a>GimpColorArea</h3><a class="indexterm" name="id2570812"></a><pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2570823"></a><h3><a name="GimpColorAreaType"></a>enum GimpColorAreaType</h3><a class="indexterm" name="id2570831"></a><pre class="programlisting">typedef enum
{
GIMP_COLOR_AREA_FLAT = 0,
GIMP_COLOR_AREA_SMALL_CHECKS,
GIMP_COLOR_AREA_LARGE_CHECKS
} GimpColorAreaType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2570843"></a><h3><a name="gimp-color-area-new"></a>gimp_color_area_new ()</h3><a class="indexterm" name="id2570851"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* gimp_color_area_new (const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
<a
href="../gdk/gdk-Windows.html#GdkModifierType"
>GdkModifierType</a> drag_mask);</pre><p>
Creates a new <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
</p><p>
This returns a preview area showing the color. It handles color
DND. If the color changes, 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"><i class="parameter"><tt>color</tt></i>:</span></td><td> A pointer to a <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> struct.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</span></td><td> The type of color area to create.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>drag_mask</tt></i>:</span></td><td> The event_mask that should trigger drags.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> Pointer to the new <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579261"></a><h3><a name="gimp-color-area-set-color"></a>gimp_color_area_set_color ()</h3><a class="indexterm" name="id2579269"></a><pre class="programlisting">void gimp_color_area_set_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
const <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre><p>
Sets <i class="parameter"><tt>area</tt></i> to a different <i class="parameter"><tt>color</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>area</tt></i>:</span></td><td> Pointer to a <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i>:</span></td><td> Pointer to a <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> struct that defines the new color.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579342"></a><h3><a name="gimp-color-area-get-color"></a>gimp_color_area_get_color ()</h3><a class="indexterm" name="id2579351"></a><pre class="programlisting">void gimp_color_area_get_color (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
<a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre><p>
Retrieves the current color of the <i class="parameter"><tt>area</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>area</tt></i>:</span></td><td> Pointer to a <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i>:</span></td><td> Pointer to a <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
><span class="type">GimpRGB</span></a> struct that is used to return the color.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2579423"></a><h3><a name="gimp-color-area-has-alpha"></a>gimp_color_area_has_alpha ()</h3><a class="indexterm" name="id2547588"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_color_area_has_alpha (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre><p>
Checks whether the <i class="parameter"><tt>area</tt></i> shows transparency information. This is determined
via the <i class="parameter"><tt>area</tt></i>'s <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>area</tt></i>:</span></td><td> Pointer to a <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a>.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>area</tt></i> shows transparency information, <tt class="literal">FALSE</tt> otherwise.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2547665"></a><h3><a name="gimp-color-area-set-type"></a>gimp_color_area_set_type ()</h3><a class="indexterm" name="id2547673"></a><pre class="programlisting">void gimp_color_area_set_type (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
<a href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre><p>
Allows to change the type of <i class="parameter"><tt>area</tt></i>. The <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a> determines
whether the widget shows transparency information and chooses the size of
the checkerboard used to do that.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>area</tt></i>:</span></td><td> Pointer to a <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</span></td><td> A <a href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2547752"></a><h3><a name="gimp-color-area-set-draw-border"></a>gimp_color_area_set_draw_border ()</h3><a class="indexterm" name="id2547760"></a><pre class="programlisting">void gimp_color_area_set_draw_border (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> draw_border);</pre><p>
The <i class="parameter"><tt>area</tt></i> 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.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>area</tt></i>:</span></td><td> Pointer to a <a href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>draw_border</tt></i>:</span></td><td> whether to draw a border or not
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2547829"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2547835"></a><h3><a name="GimpColorArea-color-changed"></a>The "color-changed" signal</h3><pre class="programlisting">void user_function (<a href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimpcolorarea</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpChainButton.html"><b><<GimpChainButton</b></a></td><td align="right"><a accesskey="n" href="GimpColorButton.html"><b>GimpColorButton>></b></a></td></tr></table></body></html>
|
