← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

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