← 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/gimpcolorarea.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/gimpcolorarea.xml
4
4
 
5
5
<refentry id="GimpColorArea">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpColorArea</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpColorArea</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="GimpColorArea-struct">GimpColorArea</link>;
26
 
enum        <link linkend="GimpColorAreaType">GimpColorAreaType</link>;
27
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-color-area-new">gimp_color_area_new</link>             (const <link linkend="GimpRGB">GimpRGB</link> *color,
28
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
29
 
                                             <link linkend="GdkModifierType">GdkModifierType</link> drag_mask);
30
 
<link linkend="void">void</link>        <link linkend="gimp-color-area-set-color">gimp_color_area_set_color</link>       (<link linkend="GimpColorArea">GimpColorArea</link> *area,
31
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);
32
 
<link linkend="void">void</link>        <link linkend="gimp-color-area-get-color">gimp_color_area_get_color</link>       (<link linkend="GimpColorArea">GimpColorArea</link> *area,
33
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);
34
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-color-area-has-alpha">gimp_color_area_has_alpha</link>       (<link linkend="GimpColorArea">GimpColorArea</link> *area);
35
 
<link linkend="void">void</link>        <link linkend="gimp-color-area-set-type">gimp_color_area_set_type</link>        (<link linkend="GimpColorArea">GimpColorArea</link> *area,
36
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
37
 
<link linkend="void">void</link>        <link linkend="gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
38
 
                                             <link linkend="gboolean">gboolean</link> draw_border);
 
25
                    <link linkend="GimpColorArea-struct">GimpColorArea</link>;
 
26
enum                <link linkend="GimpColorAreaType">GimpColorAreaType</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-color-area-new">gimp_color_area_new</link>                 (const <link linkend="GimpRGB">GimpRGB</link> *color,
 
28
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
 
29
                                                         <link linkend="GdkModifierType">GdkModifierType</link> drag_mask);
 
30
<link linkend="void">void</link>                <link linkend="gimp-color-area-set-color">gimp_color_area_set_color</link>           (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
31
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);
 
32
<link linkend="void">void</link>                <link linkend="gimp-color-area-get-color">gimp_color_area_get_color</link>           (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
33
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);
 
34
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-color-area-has-alpha">gimp_color_area_has_alpha</link>           (<link linkend="GimpColorArea">GimpColorArea</link> *area);
 
35
<link linkend="void">void</link>                <link linkend="gimp-color-area-set-type">gimp_color_area_set_type</link>            (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
36
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
 
37
<link linkend="void">void</link>                <link linkend="gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</link>     (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
38
                                                         <link linkend="gboolean">gboolean</link> draw_border);
39
39
 
40
40
</synopsis>
41
41
</refsynopsisdiv>
42
42
 
43
 
<refsect1 id="object_hierarchy">
44
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
43
<refsect1 role="object_hierarchy">
 
44
<title role="object_hierarchy.title">Object Hierarchy</title>
45
45
<synopsis>
46
46
 
47
47
  <link linkend="GObject">GObject</link>
56
56
 
57
57
 
58
58
 
59
 
<refsect1 id="impl_interfaces">
60
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
59
<refsect1 role="impl_interfaces">
 
60
<title role="impl_interfaces.title">Implemented Interfaces</title>
61
61
<para>
62
62
GimpColorArea implements
63
63
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
65
65
</refsect1>
66
66
 
67
67
 
68
 
 
69
 
<refsect1 id="signal_proto">
70
 
<title id="signal_proto.title">Signals</title>
71
 
<synopsis>
72
 
 
73
 
&quot;<link linkend="GimpColorArea-color-changed">color-changed</link>&quot;
74
 
            <link linkend="void">void</link>        user_function      (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
75
 
                                            <link linkend="gpointer">gpointer</link>       user_data)          : Run first
76
 
</synopsis>
77
 
</refsect1>
78
 
 
79
 
 
80
 
<refsect1 id="desc">
81
 
<title id="desc.title">Description</title>
 
68
<refsect1 role="properties">
 
69
<title role="properties.title">Properties</title>
 
70
<synopsis>
 
71
 
 
72
  &quot;<link linkend="GimpColorArea--color">color</link>&quot;                    <link linkend="GimpRGB">GimpRGB</link>               : Read / Write / Construct
 
73
  &quot;<link linkend="GimpColorArea--drag-mask">drag-mask</link>&quot;                <link linkend="GdkModifierType">GdkModifierType</link>       : Write / Construct Only
 
74
  &quot;<link linkend="GimpColorArea--draw-border">draw-border</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write
 
75
  &quot;<link linkend="GimpColorArea--type">type</link>&quot;                     <link linkend="GimpColorAreaType">GimpColorAreaType</link>     : Read / Write / Construct
 
76
</synopsis>
 
77
</refsect1>
 
78
 
 
79
<refsect1 role="signal_proto">
 
80
<title role="signal_proto.title">Signals</title>
 
81
<synopsis>
 
82
 
 
83
  &quot;<link linkend="GimpColorArea-color-changed">color-changed</link>&quot;                                  : Run First
 
84
</synopsis>
 
85
</refsect1>
 
86
 
 
87
 
 
88
<refsect1 role="desc">
 
89
<title role="desc.title">Description</title>
82
90
<para>
83
91
 
84
92
</para>
85
93
</refsect1>
86
94
 
87
 
<refsect1 id="details">
88
 
<title id="details.title">Details</title>
 
95
<refsect1 role="details">
 
96
<title role="details.title">Details</title>
89
97
<refsect2>
90
98
<title><anchor id="GimpColorArea-struct" role="struct"/>GimpColorArea</title>
91
99
<indexterm><primary>GimpColorArea</primary></indexterm><programlisting>typedef struct _GimpColorArea GimpColorArea;</programlisting>
106
114
</para></refsect2>
107
115
<refsect2>
108
116
<title><anchor id="gimp-color-area-new" role="function"/>gimp_color_area_new ()</title>
109
 
<indexterm><primary>gimp_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_color_area_new             (const <link linkend="GimpRGB">GimpRGB</link> *color,
110
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
111
 
                                             <link linkend="GdkModifierType">GdkModifierType</link> drag_mask);</programlisting>
 
117
<indexterm><primary>gimp_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_color_area_new                 (const <link linkend="GimpRGB">GimpRGB</link> *color,
 
118
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
 
119
                                                         <link linkend="GdkModifierType">GdkModifierType</link> drag_mask);</programlisting>
112
120
<para>
113
121
Creates a new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
114
122
</para>
132
140
</variablelist></refsect2>
133
141
<refsect2>
134
142
<title><anchor id="gimp-color-area-set-color" role="function"/>gimp_color_area_set_color ()</title>
135
 
<indexterm><primary>gimp_color_area_set_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_area_set_color       (<link linkend="GimpColorArea">GimpColorArea</link> *area,
136
 
                                             const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
143
<indexterm><primary>gimp_color_area_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_area_set_color           (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
144
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
137
145
<para>
138
146
Sets <parameter>area</parameter> to a different <parameter>color</parameter>.</para>
139
147
<para>
148
156
</variablelist></refsect2>
149
157
<refsect2>
150
158
<title><anchor id="gimp-color-area-get-color" role="function"/>gimp_color_area_get_color ()</title>
151
 
<indexterm><primary>gimp_color_area_get_color</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_area_get_color       (<link linkend="GimpColorArea">GimpColorArea</link> *area,
152
 
                                             <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
 
159
<indexterm><primary>gimp_color_area_get_color</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_area_get_color           (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
160
                                                         <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
153
161
<para>
154
162
Retrieves the current color of the <parameter>area</parameter>.</para>
155
163
<para>
164
172
</variablelist></refsect2>
165
173
<refsect2>
166
174
<title><anchor id="gimp-color-area-has-alpha" role="function"/>gimp_color_area_has_alpha ()</title>
167
 
<indexterm><primary>gimp_color_area_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_color_area_has_alpha       (<link linkend="GimpColorArea">GimpColorArea</link> *area);</programlisting>
 
175
<indexterm><primary>gimp_color_area_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_color_area_has_alpha           (<link linkend="GimpColorArea">GimpColorArea</link> *area);</programlisting>
168
176
<para>
169
177
Checks whether the <parameter>area</parameter> shows transparency information. This is determined
170
178
via the <parameter>area</parameter>'s <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>.</para>
179
187
</variablelist></refsect2>
180
188
<refsect2>
181
189
<title><anchor id="gimp-color-area-set-type" role="function"/>gimp_color_area_set_type ()</title>
182
 
<indexterm><primary>gimp_color_area_set_type</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_area_set_type        (<link linkend="GimpColorArea">GimpColorArea</link> *area,
183
 
                                             <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
 
190
<indexterm><primary>gimp_color_area_set_type</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_area_set_type            (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
191
                                                         <link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
184
192
<para>
185
193
Allows to change the type of <parameter>area</parameter>. The <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link> determines
186
194
whether the widget shows transparency information and chooses the size of
197
205
</variablelist></refsect2>
198
206
<refsect2>
199
207
<title><anchor id="gimp-color-area-set-draw-border" role="function"/>gimp_color_area_set_draw_border ()</title>
200
 
<indexterm><primary>gimp_color_area_set_draw_border</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_color_area_set_draw_border (<link linkend="GimpColorArea">GimpColorArea</link> *area,
201
 
                                             <link linkend="gboolean">gboolean</link> draw_border);</programlisting>
 
208
<indexterm><primary>gimp_color_area_set_draw_border</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_color_area_set_draw_border     (<link linkend="GimpColorArea">GimpColorArea</link> *area,
 
209
                                                         <link linkend="gboolean">gboolean</link> draw_border);</programlisting>
202
210
<para>
203
211
The <parameter>area</parameter> can draw a thin border in the foreground color around
204
212
itself.  This function allows to toggle this behaviour on and
215
223
</variablelist></refsect2>
216
224
 
217
225
</refsect1>
218
 
 
219
 
<refsect1 id="signals">
220
 
<title id="signals.title">Signal Details</title>
 
226
<refsect1 role="property_details">
 
227
<title role="property_details.title">Property Details</title>
 
228
<refsect2><title><anchor id="GimpColorArea--color"/>The &quot;<literal>color</literal>&quot; property</title>
 
229
<indexterm role="GIMP 2.4"><primary>GimpColorArea:color</primary></indexterm><programlisting>  &quot;color&quot;                    <link linkend="GimpRGB">GimpRGB</link>               : Read / Write / Construct</programlisting>
 
230
<para>
 
231
The color displayed in the color area.</para>
 
232
<para>
 
233
 
 
234
</para><para>Since  GIMP 2.4
 
235
</para>
 
236
</refsect2>
 
237
<refsect2><title><anchor id="GimpColorArea--drag-mask"/>The &quot;<literal>drag-mask</literal>&quot; property</title>
 
238
<indexterm><primary>GimpColorArea:drag-mask</primary></indexterm><programlisting>  &quot;drag-mask&quot;                <link linkend="GdkModifierType">GdkModifierType</link>       : Write / Construct Only</programlisting>
 
239
<para></para></refsect2>
 
240
<refsect2><title><anchor id="GimpColorArea--draw-border"/>The &quot;<literal>draw-border</literal>&quot; property</title>
 
241
<indexterm role="GIMP 2.4"><primary>GimpColorArea:draw-border</primary></indexterm><programlisting>  &quot;draw-border&quot;              <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
242
<para>
 
243
Whether to draw a thin border in the foreground color around the area.</para>
 
244
<para>
 
245
 
 
246
</para><para>Default value: FALSE</para>
 
247
<para>Since  GIMP 2.4
 
248
</para>
 
249
</refsect2>
 
250
<refsect2><title><anchor id="GimpColorArea--type"/>The &quot;<literal>type</literal>&quot; property</title>
 
251
<indexterm role="GIMP 2.4"><primary>GimpColorArea:type</primary></indexterm><programlisting>  &quot;type&quot;                     <link linkend="GimpColorAreaType">GimpColorAreaType</link>     : Read / Write / Construct</programlisting>
 
252
<para>
 
253
The type of the color area.</para>
 
254
<para>
 
255
 
 
256
</para><para>Default value: GIMP_COLOR_AREA_FLAT</para>
 
257
<para>Since  GIMP 2.4
 
258
</para>
 
259
</refsect2>
 
260
 
 
261
</refsect1>
 
262
 
 
263
<refsect1 role="signals">
 
264
<title role="signals.title">Signal Details</title>
221
265
<refsect2><title><anchor id="GimpColorArea-color-changed"/>The &quot;color-changed&quot; signal</title>
222
 
<indexterm><primary>GimpColorArea::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
223
 
                                            <link linkend="gpointer">gpointer</link>       user_data)          : Run first</programlisting>
 
266
<indexterm><primary>GimpColorArea::color-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
 
267
                                                        <link linkend="gpointer">gpointer</link>       user_data)          : Run First</programlisting>
224
268
<para>
225
269
 
226
270
</para><variablelist role="params">