← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcolorselection.xml
4
4
 
5
5
<refentry id="GimpColorSelection">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpColorSelection</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpColorSelection</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
15
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
16
</refnamediv>
17
17
 
18
 
<refsynopsisdiv id="synopsis">
19
 
<title id="synopsis.title">Synopsis</title>
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
20
20
 
21
21
<synopsis>
22
22
 
23
23
 
24
24
 
25
 
            <link linkend="GimpColorSelection-struct">GimpColorSelection</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-color-selection-new">gimp_color_selection_new</link>        (void);
27
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-show-alpha">gimp_color_selection_set_show_alpha</link>
28
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
29
 
                                             <link linkend="gboolean">gboolean</link> show_alpha);
30
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-color-selection-get-show-alpha">gimp_color_selection_get_show_alpha</link>
31
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
32
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-color">gimp_color_selection_set_color</link>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
33
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
34
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-get-color">gimp_color_selection_get_color</link>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
35
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
36
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-set-old-color">gimp_color_selection_set_old_color</link>
37
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
38
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
39
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-get-old-color">gimp_color_selection_get_old_color</link>
40
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
41
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
42
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-reset">gimp_color_selection_reset</link>      (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
43
 
<link linkend="void">void</link>        <link linkend="gimp-color-selection-color-changed">gimp_color_selection_color_changed</link>
44
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
25
                    <link linkend="GimpColorSelection-struct">GimpColorSelection</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-color-selection-new">gimp_color_selection_new</link>            (void);
 
27
<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,
 
28
                                                         <link linkend="gboolean">gboolean</link> show_alpha);
 
29
<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);
 
30
<link linkend="void">void</link>                <link linkend="gimp-color-selection-set-color">gimp_color_selection_set_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-color">gimp_color_selection_get_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-set-old-color">gimp_color_selection_set_old_color</link>  (<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>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
37
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);
 
38
<link linkend="void">void</link>                <link linkend="gimp-color-selection-reset">gimp_color_selection_reset</link>          (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
39
<link linkend="void">void</link>                <link linkend="gimp-color-selection-color-changed">gimp_color_selection_color_changed</link>  (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
 
40
<link linkend="void">void</link>                <link linkend="gimp-color-selection-set-config">gimp_color_selection_set_config</link>     (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
41
                                                         <link linkend="GimpColorConfig">GimpColorConfig</link> *config);
45
42
 
46
43
</synopsis>
47
44
</refsynopsisdiv>
48
45
 
49
 
<refsect1 id="object_hierarchy">
50
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
46
<refsect1 role="object_hierarchy">
 
47
<title role="object_hierarchy.title">Object Hierarchy</title>
51
48
<synopsis>
52
49
 
53
50
  <link linkend="GObject">GObject</link>
64
61
 
65
62
 
66
63
 
67
 
<refsect1 id="impl_interfaces">
68
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
64
<refsect1 role="impl_interfaces">
 
65
<title role="impl_interfaces.title">Implemented Interfaces</title>
69
66
<para>
70
67
GimpColorSelection implements
71
68
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
73
70
</refsect1>
74
71
 
75
72
 
76
 
 
77
 
<refsect1 id="signal_proto">
78
 
<title id="signal_proto.title">Signals</title>
79
 
<synopsis>
80
 
 
81
 
&quot;<link linkend="GimpColorSelection-color-changed">color-changed</link>&quot;
82
 
            <link linkend="void">void</link>        user_function      (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
83
 
                                            <link linkend="gpointer">gpointer</link>            user_data)               : Run first
84
 
</synopsis>
85
 
</refsect1>
86
 
 
87
 
 
88
 
<refsect1 id="desc">
89
 
<title id="desc.title">Description</title>
 
73
<refsect1 role="properties">
 
74
<title role="properties.title">Properties</title>
 
75
<synopsis>
 
76
 
 
77
  &quot;<link linkend="GimpColorSelection--config">config</link>&quot;                   <link linkend="GimpColorConfig">GimpColorConfig</link>       : Write
 
78
</synopsis>
 
79
</refsect1>
 
80
 
 
81
<refsect1 role="signal_proto">
 
82
<title role="signal_proto.title">Signals</title>
 
83
<synopsis>
 
84
 
 
85
  &quot;<link linkend="GimpColorSelection-color-changed">color-changed</link>&quot;                                  : Run First
 
86
</synopsis>
 
87
</refsect1>
 
88
 
 
89
 
 
90
<refsect1 role="desc">
 
91
<title role="desc.title">Description</title>
90
92
<para>
91
93
 
92
94
</para>
93
95
</refsect1>
94
96
 
95
 
<refsect1 id="details">
96
 
<title id="details.title">Details</title>
 
97
<refsect1 role="details">
 
98
<title role="details.title">Details</title>
97
99
<refsect2>
98
100
<title><anchor id="GimpColorSelection-struct" role="struct"/>GimpColorSelection</title>
99
101
<indexterm><primary>GimpColorSelection</primary></indexterm><programlisting>typedef struct _GimpColorSelection GimpColorSelection;</programlisting>
102
104
</para></refsect2>
103
105
<refsect2>
104
106
<title><anchor id="gimp-color-selection-new" role="function"/>gimp_color_selection_new ()</title>
105
 
<indexterm><primary>gimp_color_selection_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_selection_new        (void);</programlisting>
 
107
<indexterm><primary>gimp_color_selection_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_color_selection_new            (void);</programlisting>
106
108
<para>
107
109
Creates a new <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.</para>
108
110
<para>
113
115
</variablelist></refsect2>
114
116
<refsect2>
115
117
<title><anchor id="gimp-color-selection-set-show-alpha" role="function"/>gimp_color_selection_set_show_alpha ()</title>
116
 
<indexterm><primary>gimp_color_selection_set_show_alpha</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_set_show_alpha
117
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
118
 
                                             <link linkend="gboolean">gboolean</link> show_alpha);</programlisting>
 
118
<indexterm><primary>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,
 
119
                                                         <link linkend="gboolean">gboolean</link> show_alpha);</programlisting>
119
120
<para>
120
121
Sets the <parameter>show_alpha</parameter> property of the <parameter>selection</parameter> widget.</para>
121
122
<para>
130
131
</variablelist></refsect2>
131
132
<refsect2>
132
133
<title><anchor id="gimp-color-selection-get-show-alpha" role="function"/>gimp_color_selection_get_show_alpha ()</title>
133
 
<indexterm><primary>gimp_color_selection_get_show_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_color_selection_get_show_alpha
134
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
 
134
<indexterm><primary>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>
135
135
<para>
136
136
Returns the <parameter>selection</parameter>'s <parameter>show_alpha</parameter> property.</para>
137
137
<para>
145
145
</variablelist></refsect2>
146
146
<refsect2>
147
147
<title><anchor id="gimp-color-selection-set-color" role="function"/>gimp_color_selection_set_color ()</title>
148
 
<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,
149
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
148
<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,
 
149
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
150
150
<para>
151
151
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to the new <parameter>color</parameter>.</para>
152
152
<para>
161
161
</variablelist></refsect2>
162
162
<refsect2>
163
163
<title><anchor id="gimp-color-selection-get-color" role="function"/>gimp_color_selection_get_color ()</title>
164
 
<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,
165
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
164
<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,
 
165
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
166
166
<para>
167
167
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color.</para>
168
168
<para>
177
177
</variablelist></refsect2>
178
178
<refsect2>
179
179
<title><anchor id="gimp-color-selection-set-old-color" role="function"/>gimp_color_selection_set_old_color ()</title>
180
 
<indexterm><primary>gimp_color_selection_set_old_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_set_old_color
181
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
182
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
180
<indexterm><primary>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,
 
181
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
183
182
<para>
184
183
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
185
184
<para>
194
193
</variablelist></refsect2>
195
194
<refsect2>
196
195
<title><anchor id="gimp-color-selection-get-old-color" role="function"/>gimp_color_selection_get_old_color ()</title>
197
 
<indexterm><primary>gimp_color_selection_get_old_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_get_old_color
198
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
199
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
196
<indexterm><primary>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,
 
197
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
200
198
<para>
201
199
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
202
200
<para>
211
209
</variablelist></refsect2>
212
210
<refsect2>
213
211
<title><anchor id="gimp-color-selection-reset" role="function"/>gimp_color_selection_reset ()</title>
214
 
<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>
 
212
<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>
215
213
<para>
216
214
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to its old color.</para>
217
215
<para>
223
221
</variablelist></refsect2>
224
222
<refsect2>
225
223
<title><anchor id="gimp-color-selection-color-changed" role="function"/>gimp_color_selection_color_changed ()</title>
226
 
<indexterm><primary>gimp_color_selection_color_changed</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_selection_color_changed
227
 
                                            (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
 
224
<indexterm><primary>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>
228
225
<para>
229
 
Emits the "color_changed" signal.</para>
 
226
Emits the "color-changed" signal.</para>
230
227
<para>
231
228
 
232
229
</para><variablelist role="params">
234
231
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
235
232
</simpara></listitem></varlistentry>
236
233
</variablelist></refsect2>
237
 
 
238
 
</refsect1>
239
 
 
240
 
<refsect1 id="signals">
241
 
<title id="signals.title">Signal Details</title>
 
234
<refsect2>
 
235
<title><anchor id="gimp-color-selection-set-config" role="function" condition="since:GIMP 2.4"/>gimp_color_selection_set_config ()</title>
 
236
<indexterm role="GIMP 2.4"><primary>gimp_color_selection_set_config</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_selection_set_config     (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
 
237
                                                         <link linkend="GimpColorConfig">GimpColorConfig</link> *config);</programlisting>
 
238
<para>
 
239
Sets the color management configuration to use with this color selection.</para>
 
240
<para>
 
241
 
 
242
</para><variablelist role="params">
 
243
<varlistentry><term><parameter>selection</parameter>&nbsp;:</term>
 
244
<listitem><simpara>
 
245
</simpara></listitem></varlistentry>
 
246
<varlistentry><term><parameter>config</parameter>&nbsp;:</term>
 
247
<listitem><simpara>
 
248
</simpara></listitem></varlistentry>
 
249
</variablelist><para role="since">Since  GIMP 2.4
 
250
</para></refsect2>
 
251
 
 
252
</refsect1>
 
253
<refsect1 role="property_details">
 
254
<title role="property_details.title">Property Details</title>
 
255
<refsect2><title><anchor id="GimpColorSelection--config"/>The &quot;<literal>config</literal>&quot; property</title>
 
256
<indexterm><primary>GimpColorSelection:config</primary></indexterm><programlisting>  &quot;config&quot;                   <link linkend="GimpColorConfig">GimpColorConfig</link>       : Write</programlisting>
 
257
<para></para></refsect2>
 
258
 
 
259
</refsect1>
 
260
 
 
261
<refsect1 role="signals">
 
262
<title role="signals.title">Signal Details</title>
242
263
<refsect2><title><anchor id="GimpColorSelection-color-changed"/>The &quot;color-changed&quot; signal</title>
243
 
<indexterm><primary>GimpColorSelection::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
244
 
                                            <link linkend="gpointer">gpointer</link>            user_data)               : Run first</programlisting>
 
264
<indexterm><primary>GimpColorSelection::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
 
265
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run First</programlisting>
245
266
<para>
246
267
 
247
268
</para><variablelist role="params">