File: GimpColorButton.html

package info (click to toggle)
gimp 2.2.6-1sarge4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 97,088 kB
  • ctags: 43,756
  • sloc: ansic: 525,782; xml: 36,543; lisp: 9,851; sh: 9,007; makefile: 7,974; python: 2,622; perl: 2,589; yacc: 520; lex: 334
file content (176 lines) | stat: -rw-r--r-- 17,652 bytes parent folder | download
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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpColorButton</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="GimpColorArea.html" title="GimpColorArea"><link rel="next" href="GimpColorHexEntry.html" title="GimpColorHexEntry"><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="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></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">GimpColorButton</span></h2><p>GimpColorButton &#8212; Widget for selecting a color from a simple button.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



            <a href="GimpColorButton.html#GimpColorButton-struct">GimpColorButton</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  <a href="GimpColorButton.html#gimp-color-button-new">gimp_color_button_new</a>           (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> 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,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> continuous);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <a href="GimpColorButton.html#gimp-color-button-get-update">gimp_color_button_get_update</a>    (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <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="id2581251"></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/GtkContainer.html"
>GtkContainer</a>
                     +----<a
href="../gtk/GtkBin.html"
>GtkBin</a>
                           +----<a
href="../gtk/GtkButton.html"
>GtkButton</a>
                                 +----<a href="GimpButton.html" title="GimpButton">GimpButton</a>
                                       +----GimpColorButton
</pre></div><div class="refsect1" lang="en"><a name="id2581299"></a><h2>Implemented Interfaces</h2><p>
GimpColorButton implements
 AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2581313"></a><h2>Signal Prototypes</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,
                                            <a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2581345"></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="id2581364"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2581369"></a><h3><a name="GimpColorButton-struct"></a>GimpColorButton</h3><a class="indexterm" name="id2581377"></a><pre class="programlisting">typedef struct _GimpColorButton GimpColorButton;</pre><p>

</p></div><hr><div class="refsect2" lang="en"><a name="id2577038"></a><h3><a name="gimp-color-button-new"></a>gimp_color_button_new ()</h3><a class="indexterm" name="id2577046"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>*  gimp_color_button_new           (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> 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"><i class="parameter"><tt>title</tt></i>:</span></td><td> String that will be used as title for the color_selector.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i>:</span></td><td> Width of the colorpreview in pixels.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i>:</span></td><td> Height of the colorpreview in pixels.
</td></tr><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> color.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</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="id2577188"></a><h3><a name="gimp-color-button-set-color"></a>gimp_color_button_set_color ()</h3><a class="indexterm" name="id2577197"></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 <i class="parameter"><tt>button</tt></i> to the given <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>button</tt></i>:</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"><i class="parameter"><tt>color</tt></i>:</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="id2577270"></a><h3><a name="gimp-color-button-get-color"></a>gimp_color_button_get_color ()</h3><a class="indexterm" name="id2577278"></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 <i class="parameter"><tt>button</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>button</tt></i>:</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"><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 used to return the color.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2564302"></a><h3><a name="gimp-color-button-set-update"></a>gimp_color_button_set_update ()</h3><a class="indexterm" name="id2564311"></a><pre class="programlisting">void        gimp_color_button_set_update    (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
                                             <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> continuous);</pre><p>
When set to <a
href="../glib/glib-Standard-Macros.html#TRUE--CAPS"
><span class="type">TRUE</span></a>, the <i class="parameter"><tt>button</tt></i> 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"><i class="parameter"><tt>button</tt></i>:</span></td><td>     A <a href="GimpColorButton.html" title="GimpColorButton"><span class="type">GimpColorButton</span></a> widget.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>continuous</tt></i>:</span></td><td> The new setting of the <i class="parameter"><tt>continuous_update</tt></i> property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2564387"></a><h3><a name="gimp-color-button-get-update"></a>gimp_color_button_get_update ()</h3><a class="indexterm" name="id2564398"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gimp_color_button_get_update    (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre><p>
Returns the color button's <i class="parameter"><tt>continuous_update</tt></i> property.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>button</tt></i>:</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 <i class="parameter"><tt>continuous_update</tt></i> property.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2564458"></a><h3><a name="gimp-color-button-has-alpha"></a>gimp_color_button_has_alpha ()</h3><a class="indexterm" name="id2564467"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gimp_color_button_has_alpha     (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre><p>
Checks whether the <i class="parameter"><tt>buttons</tt></i> shows transparency information.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>button</tt></i>:</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> <tt class="literal">TRUE</tt> if the <i class="parameter"><tt>button</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="id2583250"></a><h3><a name="gimp-color-button-set-type"></a>gimp_color_button_set_type ()</h3><a class="indexterm" name="id2583260"></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 <i class="parameter"><tt>button</tt></i> to the given <i class="parameter"><tt>type</tt></i>. See also <a href="GimpColorArea.html#gimp-color-area-set-type"><tt class="function">gimp_color_area_set_type()</tt></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>button</tt></i>:</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"><i class="parameter"><tt>type</tt></i>:</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="id2583340"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2583346"></a><h3><a name="GimpColorButton-color-changed"></a>The "color-changed" signal</h3><pre class="programlisting">void        user_function                  (<a href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *gimpcolorbutton,
                                            <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>gimpcolorbutton</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 class="refsect1" lang="en"><a name="id2583407"></a><h2>See Also</h2><p>
<span class="type">libgimpcolor-gimpcolorspace</span>
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpColorArea.html"><b>&lt;&lt;GimpColorArea</b></a></td><td align="right"><a accesskey="n" href="GimpColorHexEntry.html"><b>GimpColorHexEntry&gt;&gt;</b></a></td></tr></table></body></html>