← 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/gimpcolorbutton.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/gimpcolorbutton.xml
4
4
 
5
5
<refentry id="GimpColorButton">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpColorButton</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpColorButton</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="GimpColorButton-struct">GimpColorButton</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-color-button-new">gimp_color_button_new</link>           (const <link linkend="gchar">gchar</link> *title,
27
 
                                             <link linkend="gint">gint</link> width,
28
 
                                             <link linkend="gint">gint</link> height,
29
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color,
30
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
31
 
<link linkend="void">void</link>        <link linkend="gimp-color-button-set-color">gimp_color_button_set_color</link>     (<link linkend="GimpColorButton">GimpColorButton</link> *button,
32
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
33
 
<link linkend="void">void</link>        <link linkend="gimp-color-button-get-color">gimp_color_button_get_color</link>     (<link linkend="GimpColorButton">GimpColorButton</link> *button,
34
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
35
 
<link linkend="void">void</link>        <link linkend="gimp-color-button-set-update">gimp_color_button_set_update</link>    (<link linkend="GimpColorButton">GimpColorButton</link> *button,
36
 
                                             <link linkend="gboolean">gboolean</link> continuous);
37
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-color-button-get-update">gimp_color_button_get_update</link>    (<link linkend="GimpColorButton">GimpColorButton</link> *button);
38
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-color-button-has-alpha">gimp_color_button_has_alpha</link>     (<link linkend="GimpColorButton">GimpColorButton</link> *button);
39
 
<link linkend="void">void</link>        <link linkend="gimp-color-button-set-type">gimp_color_button_set_type</link>      (<link linkend="GimpColorButton">GimpColorButton</link> *button,
40
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
 
25
                    <link linkend="GimpColorButton-struct">GimpColorButton</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-color-button-new">gimp_color_button_new</link>               (const <link linkend="gchar">gchar</link> *title,
 
27
                                                         <link linkend="gint">gint</link> width,
 
28
                                                         <link linkend="gint">gint</link> height,
 
29
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
 
30
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
 
31
<link linkend="void">void</link>                <link linkend="gimp-color-button-set-color">gimp_color_button_set_color</link>         (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
32
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);
 
33
<link linkend="void">void</link>                <link linkend="gimp-color-button-get-color">gimp_color_button_get_color</link>         (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
34
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);
 
35
<link linkend="void">void</link>                <link linkend="gimp-color-button-set-update">gimp_color_button_set_update</link>        (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
36
                                                         <link linkend="gboolean">gboolean</link> continuous);
 
37
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-color-button-get-update">gimp_color_button_get_update</link>        (<link linkend="GimpColorButton">GimpColorButton</link> *button);
 
38
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-color-button-has-alpha">gimp_color_button_has_alpha</link>         (<link linkend="GimpColorButton">GimpColorButton</link> *button);
 
39
<link linkend="void">void</link>                <link linkend="gimp-color-button-set-type">gimp_color_button_set_type</link>          (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
40
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
41
41
 
42
42
</synopsis>
43
43
</refsynopsisdiv>
44
44
 
45
 
<refsect1 id="object_hierarchy">
46
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
45
<refsect1 role="object_hierarchy">
 
46
<title role="object_hierarchy.title">Object Hierarchy</title>
47
47
<synopsis>
48
48
 
49
49
  <link linkend="GObject">GObject</link>
61
61
 
62
62
 
63
63
 
64
 
<refsect1 id="impl_interfaces">
65
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
64
<refsect1 role="impl_interfaces">
 
65
<title role="impl_interfaces.title">Implemented Interfaces</title>
66
66
<para>
67
67
GimpColorButton implements
68
68
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
70
70
</refsect1>
71
71
 
72
72
 
73
 
 
74
 
<refsect1 id="signal_proto">
75
 
<title id="signal_proto.title">Signals</title>
76
 
<synopsis>
77
 
 
78
 
&quot;<link linkend="GimpColorButton-color-changed">color-changed</link>&quot;
79
 
            <link linkend="void">void</link>        user_function      (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
80
 
                                            <link linkend="gpointer">gpointer</link>         user_data)            : Run first
81
 
</synopsis>
82
 
</refsect1>
83
 
 
84
 
 
85
 
<refsect1 id="desc">
86
 
<title id="desc.title">Description</title>
 
73
<refsect1 role="properties">
 
74
<title role="properties.title">Properties</title>
 
75
<synopsis>
 
76
 
 
77
  &quot;<link linkend="GimpColorButton--color">color</link>&quot;                    <link linkend="GimpRGB">GimpRGB</link>               : Read / Write / Construct
 
78
  &quot;<link linkend="GimpColorButton--continuous-update">continuous-update</link>&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
 
79
  &quot;<link linkend="GimpColorButton--title">title</link>&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only
 
80
  &quot;<link linkend="GimpColorButton--type">type</link>&quot;                     <link linkend="GimpColorAreaType">GimpColorAreaType</link>     : Read / Write / Construct
 
81
</synopsis>
 
82
</refsect1>
 
83
 
 
84
<refsect1 role="signal_proto">
 
85
<title role="signal_proto.title">Signals</title>
 
86
<synopsis>
 
87
 
 
88
  &quot;<link linkend="GimpColorButton-color-changed">color-changed</link>&quot;                                  : Run First
 
89
</synopsis>
 
90
</refsect1>
 
91
 
 
92
 
 
93
<refsect1 role="desc">
 
94
<title role="desc.title">Description</title>
87
95
<para>
88
96
This widget provides a simple button with a preview showing the
89
97
color.
96
104
</para>
97
105
</refsect1>
98
106
 
99
 
<refsect1 id="details">
100
 
<title id="details.title">Details</title>
 
107
<refsect1 role="details">
 
108
<title role="details.title">Details</title>
101
109
<refsect2>
102
110
<title><anchor id="GimpColorButton-struct" role="struct"/>GimpColorButton</title>
103
111
<indexterm><primary>GimpColorButton</primary></indexterm><programlisting>typedef struct _GimpColorButton GimpColorButton;</programlisting>
106
114
</para></refsect2>
107
115
<refsect2>
108
116
<title><anchor id="gimp-color-button-new" role="function"/>gimp_color_button_new ()</title>
109
 
<indexterm><primary>gimp_color_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_button_new           (const <link linkend="gchar">gchar</link> *title,
110
 
                                             <link linkend="gint">gint</link> width,
111
 
                                             <link linkend="gint">gint</link> height,
112
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color,
113
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
 
117
<indexterm><primary>gimp_color_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_color_button_new               (const <link linkend="gchar">gchar</link> *title,
 
118
                                                         <link linkend="gint">gint</link> width,
 
119
                                                         <link linkend="gint">gint</link> height,
 
120
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
 
121
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
114
122
<para>
115
123
Creates a new <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
116
124
</para>
118
126
This returns a button with a preview showing the color.
119
127
When the button is clicked a GtkColorSelectionDialog is opened.
120
128
If the user changes the color the new color is written into the
121
 
array that was used to pass the initial color and the "color_changed"
 
129
array that was used to pass the initial color and the "color-changed"
122
130
signal is emitted.</para>
123
131
<para>
124
132
 
143
151
</variablelist></refsect2>
144
152
<refsect2>
145
153
<title><anchor id="gimp-color-button-set-color" role="function"/>gimp_color_button_set_color ()</title>
146
 
<indexterm><primary>gimp_color_button_set_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_button_set_color     (<link linkend="GimpColorButton">GimpColorButton</link> *button,
147
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
154
<indexterm><primary>gimp_color_button_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_button_set_color         (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
155
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
148
156
<para>
149
157
Sets the <parameter>button</parameter> to the given <parameter>color</parameter>.</para>
150
158
<para>
159
167
</variablelist></refsect2>
160
168
<refsect2>
161
169
<title><anchor id="gimp-color-button-get-color" role="function"/>gimp_color_button_get_color ()</title>
162
 
<indexterm><primary>gimp_color_button_get_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_button_get_color     (<link linkend="GimpColorButton">GimpColorButton</link> *button,
163
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
170
<indexterm><primary>gimp_color_button_get_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_button_get_color         (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
171
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
164
172
<para>
165
173
Retrieves the currently set color from the <parameter>button</parameter>.</para>
166
174
<para>
175
183
</variablelist></refsect2>
176
184
<refsect2>
177
185
<title><anchor id="gimp-color-button-set-update" role="function"/>gimp_color_button_set_update ()</title>
178
 
<indexterm><primary>gimp_color_button_set_update</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_button_set_update    (<link linkend="GimpColorButton">GimpColorButton</link> *button,
179
 
                                             <link linkend="gboolean">gboolean</link> continuous);</programlisting>
 
186
<indexterm><primary>gimp_color_button_set_update</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_button_set_update        (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
187
                                                         <link linkend="gboolean">gboolean</link> continuous);</programlisting>
180
188
<para>
181
 
When set to <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the <parameter>button</parameter> will emit the "color_changed"
 
189
When set to <link linkend="TRUE:CAPS"><type>TRUE</type></link>, the <parameter>button</parameter> will emit the "color-changed"
182
190
continuously while the color is changed in the color selection
183
191
dialog.</para>
184
192
<para>
193
201
</variablelist></refsect2>
194
202
<refsect2>
195
203
<title><anchor id="gimp-color-button-get-update" role="function"/>gimp_color_button_get_update ()</title>
196
 
<indexterm><primary>gimp_color_button_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_color_button_get_update    (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
 
204
<indexterm><primary>gimp_color_button_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_color_button_get_update        (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
197
205
<para>
198
206
Returns the color button's <parameter>continuous_update</parameter> property.</para>
199
207
<para>
207
215
</variablelist></refsect2>
208
216
<refsect2>
209
217
<title><anchor id="gimp-color-button-has-alpha" role="function"/>gimp_color_button_has_alpha ()</title>
210
 
<indexterm><primary>gimp_color_button_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_color_button_has_alpha     (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
 
218
<indexterm><primary>gimp_color_button_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_color_button_has_alpha         (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
211
219
<para>
212
220
Checks whether the <parameter>buttons</parameter> shows transparency information.</para>
213
221
<para>
222
230
</variablelist></refsect2>
223
231
<refsect2>
224
232
<title><anchor id="gimp-color-button-set-type" role="function"/>gimp_color_button_set_type ()</title>
225
 
<indexterm><primary>gimp_color_button_set_type</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_button_set_type      (<link linkend="GimpColorButton">GimpColorButton</link> *button,
226
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
 
233
<indexterm><primary>gimp_color_button_set_type</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_button_set_type          (<link linkend="GimpColorButton">GimpColorButton</link> *button,
 
234
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
227
235
<para>
228
236
Sets the <parameter>button</parameter> to the given <parameter>type</parameter>. See also <link linkend="gimp-color-area-set-type"><function>gimp_color_area_set_type()</function></link>.</para>
229
237
<para>
238
246
</variablelist></refsect2>
239
247
 
240
248
</refsect1>
241
 
 
242
 
<refsect1 id="signals">
243
 
<title id="signals.title">Signal Details</title>
 
249
<refsect1 role="property_details">
 
250
<title role="property_details.title">Property Details</title>
 
251
<refsect2><title><anchor id="GimpColorButton--color"/>The &quot;<literal>color</literal>&quot; property</title>
 
252
<indexterm role="GIMP 2.4"><primary>GimpColorButton:color</primary></indexterm><programlisting>  &quot;color&quot;                    <link linkend="GimpRGB">GimpRGB</link>               : Read / Write / Construct</programlisting>
 
253
<para>
 
254
The color displayed in the button's color area.</para>
 
255
<para>
 
256
 
 
257
</para><para>Since  GIMP 2.4
 
258
</para>
 
259
</refsect2>
 
260
<refsect2><title><anchor id="GimpColorButton--continuous-update"/>The &quot;<literal>continuous-update</literal>&quot; property</title>
 
261
<indexterm role="GIMP 2.4"><primary>GimpColorButton:continuous-update</primary></indexterm><programlisting>  &quot;continuous-update&quot;        <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
262
<para>
 
263
The update policy of the color button.</para>
 
264
<para>
 
265
 
 
266
</para><para>Default value: FALSE</para>
 
267
<para>Since  GIMP 2.4
 
268
</para>
 
269
</refsect2>
 
270
<refsect2><title><anchor id="GimpColorButton--title"/>The &quot;<literal>title</literal>&quot; property</title>
 
271
<indexterm role="GIMP 2.4"><primary>GimpColorButton:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct Only</programlisting>
 
272
<para>
 
273
The title to be used for the color selection dialog.</para>
 
274
<para>
 
275
 
 
276
</para><para>Default value: NULL</para>
 
277
<para>Since  GIMP 2.4
 
278
</para>
 
279
</refsect2>
 
280
<refsect2><title><anchor id="GimpColorButton--type"/>The &quot;<literal>type</literal>&quot; property</title>
 
281
<indexterm role="GIMP 2.4"><primary>GimpColorButton:type</primary></indexterm><programlisting>  &quot;type&quot;                     <link linkend="GimpColorAreaType">GimpColorAreaType</link>     : Read / Write / Construct</programlisting>
 
282
<para>
 
283
The type of the button's color area.</para>
 
284
<para>
 
285
 
 
286
</para><para>Default value: GIMP_COLOR_AREA_FLAT</para>
 
287
<para>Since  GIMP 2.4
 
288
</para>
 
289
</refsect2>
 
290
 
 
291
</refsect1>
 
292
 
 
293
<refsect1 role="signals">
 
294
<title role="signals.title">Signal Details</title>
244
295
<refsect2><title><anchor id="GimpColorButton-color-changed"/>The &quot;color-changed&quot; signal</title>
245
 
<indexterm><primary>GimpColorButton::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
246
 
                                            <link linkend="gpointer">gpointer</link>         user_data)            : Run first</programlisting>
 
296
<indexterm><primary>GimpColorButton::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
 
297
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run First</programlisting>
247
298
<para>
248
299
 
249
300
</para><variablelist role="params">