← Back to branch summary

~ubuntu-branches/ubuntu/breezy/gimp/breezy

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpcolorselection.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-10-04 19:04:46 UTC
  • Revision ID: james.westby@ubuntu.com-20051004190446-ukh32kwk56s4sjhu
Tags: upstream-2.2.8
Import upstream version 2.2.8

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcolorselection.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="GimpColorSelection">
 
6
<refmeta>
 
7
<refentrytitle>GimpColorSelection</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpColorSelection</refname><refpurpose>Widget for doing a color selection.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
            <link linkend="GimpColorSelection-struct">GimpColorSelection</link>;
 
23
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-color-selection-new">gimp_color_selection_new</link>        (void);
 
24
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-show-alpha">gimp_color_selection_set_show_alpha</link>
 
25
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
26
                                             <link linkend="gboolean">gboolean</link> show_alpha);
 
27
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-color-selection-get-show-alpha">gimp_color_selection_get_show_alpha</link>
 
28
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
29
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-color">gimp_color_selection_set_color</link>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
30
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
 
31
<link linkend="void">void</link>        <link linkend="gimp-color-selection-get-color">gimp_color_selection_get_color</link>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
32
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
 
33
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-old-color">gimp_color_selection_set_old_color</link>
 
34
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
35
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
 
36
<link linkend="void">void</link>        <link linkend="gimp-color-selection-get-old-color">gimp_color_selection_get_old_color</link>
 
37
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
38
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
 
39
<link linkend="void">void</link>        <link linkend="gimp-color-selection-reset">gimp_color_selection_reset</link>      (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
40
<link linkend="void">void</link>        <link linkend="gimp-color-selection-color-changed">gimp_color_selection_color_changed</link>
 
41
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
42
 
 
43
</synopsis>
 
44
</refsynopsisdiv>
 
45
 
 
46
<refsect1>
 
47
<title>Object Hierarchy</title>
 
48
<synopsis>
 
49
 
 
50
  <link linkend="GObject">GObject</link>
 
51
   +----<link linkend="GtkObject">GtkObject</link>
 
52
         +----<link linkend="GtkWidget">GtkWidget</link>
 
53
               +----<link linkend="GtkContainer">GtkContainer</link>
 
54
                     +----<link linkend="GtkBox">GtkBox</link>
 
55
                           +----<link linkend="GtkVBox">GtkVBox</link>
 
56
                                 +----GimpColorSelection
 
57
</synopsis>
 
58
 
 
59
</refsect1>
 
60
 
 
61
 
 
62
 
 
63
<refsect1>
 
64
<title>Implemented Interfaces</title>
 
65
<para>
 
66
GimpColorSelection implements
 
67
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
68
 
 
69
</refsect1>
 
70
 
 
71
 
 
72
 
 
73
<refsect1>
 
74
<title>Signal Prototypes</title>
 
75
<synopsis>
 
76
 
 
77
&quot;<link linkend="GimpColorSelection-color-changed">color-changed</link>&quot;
 
78
            <link linkend="void">void</link>        user_function      (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
 
79
                                            <link linkend="gpointer">gpointer</link> user_data);
 
80
</synopsis>
 
81
</refsect1>
 
82
 
 
83
 
 
84
<refsect1>
 
85
<title>Description</title>
 
86
<para>
 
87
 
 
88
</para>
 
89
</refsect1>
 
90
 
 
91
<refsect1>
 
92
<title>Details</title>
 
93
<refsect2>
 
94
<title><anchor id="GimpColorSelection-struct"/>GimpColorSelection</title>
 
95
<indexterm><primary>GimpColorSelection</primary></indexterm><programlisting>typedef struct _GimpColorSelection GimpColorSelection;</programlisting>
 
96
<para>
 
97
 
 
98
</para></refsect2>
 
99
<refsect2>
 
100
<title><anchor id="gimp-color-selection-new"/>gimp_color_selection_new ()</title>
 
101
<indexterm><primary>gimp_color_selection_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_selection_new        (void);</programlisting>
 
102
<para>
 
103
Creates a new <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.</para>
 
104
<para>
 
105
 
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
108
</simpara></listitem></varlistentry>
 
109
</variablelist></refsect2>
 
110
<refsect2>
 
111
<title><anchor id="gimp-color-selection-set-show-alpha"/>gimp_color_selection_set_show_alpha ()</title>
 
112
<indexterm><primary>gimp_color_selection_set_show_alpha</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_set_show_alpha
 
113
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
114
                                             <link linkend="gboolean">gboolean</link> show_alpha);</programlisting>
 
115
<para>
 
116
Sets the <parameter>show_alpha</parameter> property of the <parameter>selection</parameter> widget.</para>
 
117
<para>
 
118
 
 
119
</para><variablelist role="params">
 
120
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
121
<listitem><simpara>  A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
122
</simpara></listitem></varlistentry>
 
123
<varlistentry><term><parameter>show_alpha</parameter>&nbsp;:</term>
 
124
<listitem><simpara> The new <parameter>show_alpha</parameter> setting.
 
125
</simpara></listitem></varlistentry>
 
126
</variablelist></refsect2>
 
127
<refsect2>
 
128
<title><anchor id="gimp-color-selection-get-show-alpha"/>gimp_color_selection_get_show_alpha ()</title>
 
129
<indexterm><primary>gimp_color_selection_get_show_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_color_selection_get_show_alpha
 
130
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
 
131
<para>
 
132
Returns the <parameter>selection</parameter>'s <parameter>show_alpha</parameter> property.</para>
 
133
<para>
 
134
 
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
137
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
138
</simpara></listitem></varlistentry>
 
139
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> has alpha controls.
 
140
</simpara></listitem></varlistentry>
 
141
</variablelist></refsect2>
 
142
<refsect2>
 
143
<title><anchor id="gimp-color-selection-set-color"/>gimp_color_selection_set_color ()</title>
 
144
<indexterm><primary>gimp_color_selection_set_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_set_color  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
145
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
146
<para>
 
147
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to the new <parameter>color</parameter>.</para>
 
148
<para>
 
149
 
 
150
</para><variablelist role="params">
 
151
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
152
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
153
</simpara></listitem></varlistentry>
 
154
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
 
155
<listitem><simpara>     The <parameter>color</parameter> to set as current color.
 
156
</simpara></listitem></varlistentry>
 
157
</variablelist></refsect2>
 
158
<refsect2>
 
159
<title><anchor id="gimp-color-selection-get-color"/>gimp_color_selection_get_color ()</title>
 
160
<indexterm><primary>gimp_color_selection_get_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_get_color  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
161
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
162
<para>
 
163
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color.</para>
 
164
<para>
 
165
 
 
166
</para><variablelist role="params">
 
167
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
168
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
 
171
<listitem><simpara>     Return location for the <parameter>selection</parameter>'s current <parameter>color</parameter>.
 
172
</simpara></listitem></varlistentry>
 
173
</variablelist></refsect2>
 
174
<refsect2>
 
175
<title><anchor id="gimp-color-selection-set-old-color"/>gimp_color_selection_set_old_color ()</title>
 
176
<indexterm><primary>gimp_color_selection_set_old_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_set_old_color
 
177
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
178
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
179
<para>
 
180
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
 
181
<para>
 
182
 
 
183
</para><variablelist role="params">
 
184
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
185
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
186
</simpara></listitem></varlistentry>
 
187
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
 
188
<listitem><simpara>     The <parameter>color</parameter> to set as old color.
 
189
</simpara></listitem></varlistentry>
 
190
</variablelist></refsect2>
 
191
<refsect2>
 
192
<title><anchor id="gimp-color-selection-get-old-color"/>gimp_color_selection_get_old_color ()</title>
 
193
<indexterm><primary>gimp_color_selection_get_old_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_get_old_color
 
194
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
195
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
196
<para>
 
197
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
 
198
<para>
 
199
 
 
200
</para><variablelist role="params">
 
201
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
202
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>color</parameter>&nbsp;:</term>
 
205
<listitem><simpara>     Return location for the <parameter>selection</parameter>'s old <parameter>color</parameter>.
 
206
</simpara></listitem></varlistentry>
 
207
</variablelist></refsect2>
 
208
<refsect2>
 
209
<title><anchor id="gimp-color-selection-reset"/>gimp_color_selection_reset ()</title>
 
210
<indexterm><primary>gimp_color_selection_reset</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_reset      (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
 
211
<para>
 
212
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to its old color.</para>
 
213
<para>
 
214
 
 
215
</para><variablelist role="params">
 
216
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
217
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
218
</simpara></listitem></varlistentry>
 
219
</variablelist></refsect2>
 
220
<refsect2>
 
221
<title><anchor id="gimp-color-selection-color-changed"/>gimp_color_selection_color_changed ()</title>
 
222
<indexterm><primary>gimp_color_selection_color_changed</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_color_changed
 
223
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
 
224
<para>
 
225
Emits the "color_changed" signal.</para>
 
226
<para>
 
227
 
 
228
</para><variablelist role="params">
 
229
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
230
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
 
231
</simpara></listitem></varlistentry>
 
232
</variablelist></refsect2>
 
233
 
 
234
</refsect1>
 
235
 
 
236
<refsect1>
 
237
<title>Signals</title>
 
238
<refsect2><title><anchor id="GimpColorSelection-color-changed"/>The &quot;color-changed&quot; signal</title>
 
239
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
 
240
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
241
<para>
 
242
 
 
243
</para><variablelist role="params">
 
244
<varlistentry><term><parameter>gimpcolorselection</parameter>&nbsp;:</term>
 
245
<listitem><simpara>the object which received the signal.
 
246
 
 
247
</simpara></listitem></varlistentry>
 
248
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
249
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
250
</variablelist></refsect2>
 
251
</refsect1>
 
252
 
 
253
 
 
254
 
 
255
</refentry>