← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/gimp/gutsy

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/GimpColorArea.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-09-30 18:06:49 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20070930180649-f647f0cxj32tgyn3
Tags: 2.4.0~rc3-1ubuntu1
* Resynchronized with Debian.
* Remaining Ubuntu changes:
  - 02_help-message.patch, 03_gimp.desktop.in.in.patch: Distro changes.
  - Weave i18n magic in the rules file.
  - Munge Maintainer field as per spec.
* Ubuntu changes dropped:
  - 10_dont_show_wizard.patch: Unused, upstream doesn't call it anymore.
  - Use dh_icons.
* Disabled the print plugin, and removed the Conflicts/Replaces on
  gimp-print.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/GimpColorArea.html
33
33
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
34
34
<td><a accesskey="n" href="GimpColorButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
35
35
</tr>
36
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2575573" class="shortcut">Top</a>
37
 
                  &#160;|&#160;
38
 
                  <a href="#id2587387" class="shortcut">Description</a>
39
 
                  &#160;|&#160;
40
 
                  <a href="#id2584411" class="shortcut">Object Hierarchy</a>
41
 
                  &#160;|&#160;
42
 
                  <a href="#id2581773" class="shortcut">Implemented Interfaces</a>
43
 
                  &#160;|&#160;
44
 
                  <a href="#id2581801" class="shortcut">Properties</a>
45
 
                  &#160;|&#160;
46
 
                  <a href="#id2581866" class="shortcut">Signals</a></nobr></td></tr>
 
36
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2599640" class="shortcut">Top</a>
 
37
                  &#160;|&#160;
 
38
                  <a href="#id2596653" class="shortcut">Description</a>
 
39
                  &#160;|&#160;
 
40
                  <a href="#id2586264" class="shortcut">Object Hierarchy</a>
 
41
                  &#160;|&#160;
 
42
                  <a href="#id2573725" class="shortcut">Implemented Interfaces</a>
 
43
                  &#160;|&#160;
 
44
                  <a href="#id2573753" class="shortcut">Properties</a>
 
45
                  &#160;|&#160;
 
46
                  <a href="#id2573818" class="shortcut">Signals</a></nobr></td></tr>
47
47
</table>
48
48
<div class="refentry" lang="en">
49
49
<a name="GimpColorArea"></a><div class="titlepage"></div>
50
50
<div class="refnamediv"><table width="100%"><tr>
51
51
<td valign="top">
52
52
<h2>
53
 
<a name="id2575573"></a><span class="refentrytitle">GimpColorArea</span>
 
53
<a name="id2599640"></a><span class="refentrytitle">GimpColorArea</span>
54
54
</h2>
55
55
<p>GimpColorArea &#8212; Displays a GimpRGB color, optionally with alpha-channel.</p>
56
56
</td>
64
64
 
65
65
                    <a class="link" href="GimpColorArea.html#GimpColorArea-struct">GimpColorArea</a>;
66
66
enum                <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>;
67
 
GtkWidget*          <a class="link" href="GimpColorArea.html#gimp-color-area-new">gimp_color_area_new</a>                 (const <a
 
67
<a
 
68
href="../gtk/GtkWidget.html"
 
69
>GtkWidget</a>*          <a class="link" href="GimpColorArea.html#gimp-color-area-new">gimp_color_area_new</a>                 (const <a
68
70
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
69
71
>GimpRGB</a> *color,
70
72
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
71
 
                                                         GdkModifierType drag_mask);
 
73
                                                         <a
 
74
href="../gdk/gdk-Windows.html#GdkModifierType"
 
75
>GdkModifierType</a> drag_mask);
72
76
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-color">gimp_color_area_set_color</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
73
77
                                                         const <a
74
78
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
77
81
                                                         <a
78
82
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
79
83
>GimpRGB</a> *color);
80
 
gboolean            <a class="link" href="GimpColorArea.html#gimp-color-area-has-alpha">gimp_color_area_has_alpha</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
 
84
<a
 
85
href="../glib/glib-Basic-Types.html#gboolean"
 
86
>gboolean</a>            <a class="link" href="GimpColorArea.html#gimp-color-area-has-alpha">gimp_color_area_has_alpha</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
81
87
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-type">gimp_color_area_set_type</a>            (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
82
88
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);
83
89
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</a>     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
84
 
                                                         gboolean draw_border);
 
90
                                                         <a
 
91
href="../glib/glib-Basic-Types.html#gboolean"
 
92
>gboolean</a> draw_border);
85
93
 
86
94
</pre>
87
95
</div>
88
96
<div class="refsect1" lang="en">
89
 
<a name="id2584411"></a><h2>Object Hierarchy</h2>
 
97
<a name="id2586264"></a><h2>Object Hierarchy</h2>
90
98
<pre class="synopsis">
91
99
 
92
 
  GObject
93
 
   +----GInitiallyUnowned
94
 
         +----GtkObject
95
 
               +----GtkWidget
96
 
                     +----GtkDrawingArea
 
100
  <a
 
101
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
102
>GObject</a>
 
103
   +----<a
 
104
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
 
105
>GInitiallyUnowned</a>
 
106
         +----<a
 
107
href="../gtk/GtkObject.html"
 
108
>GtkObject</a>
 
109
               +----<a
 
110
href="../gtk/GtkWidget.html"
 
111
>GtkWidget</a>
 
112
                     +----<a
 
113
href="../gtk/GtkDrawingArea.html"
 
114
>GtkDrawingArea</a>
97
115
                           +----GimpColorArea
98
116
</pre>
99
117
</div>
100
118
<div class="refsect1" lang="en">
101
 
<a name="id2581773"></a><h2>Implemented Interfaces</h2>
 
119
<a name="id2573725"></a><h2>Implemented Interfaces</h2>
102
120
<p>
103
121
GimpColorArea implements
104
122
 AtkImplementorIface and  GtkBuildable.</p>
105
123
</div>
106
124
<div class="refsect1" lang="en">
107
 
<a name="id2581801"></a><h2>Properties</h2>
 
125
<a name="id2573753"></a><h2>Properties</h2>
108
126
<pre class="synopsis">
109
127
 
110
128
  "<a class="link" href="GimpColorArea.html#GimpColorArea--color">color</a>"                    <a
111
129
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
112
130
>GimpRGB</a>               : Read / Write / Construct
113
 
  "<a class="link" href="GimpColorArea.html#GimpColorArea--drag-mask">drag-mask</a>"                GdkModifierType       : Write / Construct Only
114
 
  "<a class="link" href="GimpColorArea.html#GimpColorArea--draw-border">draw-border</a>"              gboolean              : Read / Write
 
131
  "<a class="link" href="GimpColorArea.html#GimpColorArea--drag-mask">drag-mask</a>"                <a
 
132
href="../gdk/gdk-Windows.html#GdkModifierType"
 
133
>GdkModifierType</a>       : Write / Construct Only
 
134
  "<a class="link" href="GimpColorArea.html#GimpColorArea--draw-border">draw-border</a>"              <a
 
135
href="../glib/glib-Basic-Types.html#gboolean"
 
136
>gboolean</a>              : Read / Write
115
137
  "<a class="link" href="GimpColorArea.html#GimpColorArea--type">type</a>"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct
116
138
</pre>
117
139
</div>
118
140
<div class="refsect1" lang="en">
119
 
<a name="id2581866"></a><h2>Signals</h2>
 
141
<a name="id2573818"></a><h2>Signals</h2>
120
142
<pre class="synopsis">
121
143
 
122
144
  "<a class="link" href="GimpColorArea.html#GimpColorArea-color-changed">color-changed</a>"                                  : Run First
123
145
</pre>
124
146
</div>
125
147
<div class="refsect1" lang="en">
126
 
<a name="id2587387"></a><h2>Description</h2>
 
148
<a name="id2596653"></a><h2>Description</h2>
127
149
<p>
128
150
 
129
151
</p>
130
152
</div>
131
153
<div class="refsect1" lang="en">
132
 
<a name="id2587403"></a><h2>Details</h2>
 
154
<a name="id2596669"></a><h2>Details</h2>
133
155
<div class="refsect2" lang="en">
134
 
<a name="id2587414"></a><h3>
 
156
<a name="id2596679"></a><h3>
135
157
<a name="GimpColorArea-struct"></a>GimpColorArea</h3>
136
 
<a class="indexterm" name="id2587425"></a><pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre>
 
158
<a class="indexterm" name="id2596691"></a><pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre>
137
159
<p>
138
160
 
139
161
</p>
140
162
</div>
141
163
<hr>
142
164
<div class="refsect2" lang="en">
143
 
<a name="id2587442"></a><h3>
 
165
<a name="id2596707"></a><h3>
144
166
<a name="GimpColorAreaType"></a>enum GimpColorAreaType</h3>
145
 
<a class="indexterm" name="id2587454"></a><pre class="programlisting">typedef enum
 
167
<a class="indexterm" name="id2596720"></a><pre class="programlisting">typedef enum
146
168
{
147
169
  GIMP_COLOR_AREA_FLAT = 0,
148
170
  GIMP_COLOR_AREA_SMALL_CHECKS,
155
177
</div>
156
178
<hr>
157
179
<div class="refsect2" lang="en">
158
 
<a name="id2587472"></a><h3>
 
180
<a name="id2596737"></a><h3>
159
181
<a name="gimp-color-area-new"></a>gimp_color_area_new ()</h3>
160
 
<a class="indexterm" name="id2587484"></a><pre class="programlisting">GtkWidget*          gimp_color_area_new                 (const <a
 
182
<a class="indexterm" name="id2596750"></a><pre class="programlisting"><a
 
183
href="../gtk/GtkWidget.html"
 
184
>GtkWidget</a>*          gimp_color_area_new                 (const <a
161
185
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
162
186
>GimpRGB</a> *color,
163
187
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type,
164
 
                                                         GdkModifierType drag_mask);</pre>
 
188
                                                         <a
 
189
href="../gdk/gdk-Windows.html#GdkModifierType"
 
190
>GdkModifierType</a> drag_mask);</pre>
165
191
<p>
166
192
Creates a new <a class="link" href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
167
193
</p>
201
227
</div>
202
228
<hr>
203
229
<div class="refsect2" lang="en">
204
 
<a name="id2587614"></a><h3>
 
230
<a name="id2596879"></a><h3>
205
231
<a name="gimp-color-area-set-color"></a>gimp_color_area_set_color ()</h3>
206
 
<a class="indexterm" name="id2587625"></a><pre class="programlisting">void                gimp_color_area_set_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
 
232
<a class="indexterm" name="id2596890"></a><pre class="programlisting">void                gimp_color_area_set_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
207
233
                                                         const <a
208
234
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
209
235
>GimpRGB</a> *color);</pre>
232
258
</div>
233
259
<hr>
234
260
<div class="refsect2" lang="en">
235
 
<a name="id2582334"></a><h3>
 
261
<a name="id2584807"></a><h3>
236
262
<a name="gimp-color-area-get-color"></a>gimp_color_area_get_color ()</h3>
237
 
<a class="indexterm" name="id2582345"></a><pre class="programlisting">void                gimp_color_area_get_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
 
263
<a class="indexterm" name="id2584818"></a><pre class="programlisting">void                gimp_color_area_get_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
238
264
                                                         <a
239
265
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
240
266
>GimpRGB</a> *color);</pre>
263
289
</div>
264
290
<hr>
265
291
<div class="refsect2" lang="en">
266
 
<a name="id2582436"></a><h3>
 
292
<a name="id2584909"></a><h3>
267
293
<a name="gimp-color-area-has-alpha"></a>gimp_color_area_has_alpha ()</h3>
268
 
<a class="indexterm" name="id2582447"></a><pre class="programlisting">gboolean            gimp_color_area_has_alpha           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
 
294
<a class="indexterm" name="id2584920"></a><pre class="programlisting"><a
 
295
href="../glib/glib-Basic-Types.html#gboolean"
 
296
>gboolean</a>            gimp_color_area_has_alpha           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
269
297
<p>
270
298
Checks whether the <em class="parameter"><code>area</code></em> shows transparency information. This is determined
271
299
via the <em class="parameter"><code>area</code></em>'s <a class="link" href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>.</p>
282
310
</tr>
283
311
<tr>
284
312
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
285
 
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>area</code></em> shows transparency information, <code class="literal">FALSE</code> otherwise.
 
313
<td> <a
 
314
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
 
315
><code class="literal">TRUE</code></a> if <em class="parameter"><code>area</code></em> shows transparency information, <a
 
316
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
 
317
><code class="literal">FALSE</code></a> otherwise.
286
318
</td>
287
319
</tr>
288
320
</tbody>
290
322
</div>
291
323
<hr>
292
324
<div class="refsect2" lang="en">
293
 
<a name="id2618899"></a><h3>
 
325
<a name="id2618886"></a><h3>
294
326
<a name="gimp-color-area-set-type"></a>gimp_color_area_set_type ()</h3>
295
 
<a class="indexterm" name="id2618910"></a><pre class="programlisting">void                gimp_color_area_set_type            (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
 
327
<a class="indexterm" name="id2618897"></a><pre class="programlisting">void                gimp_color_area_set_type            (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
296
328
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a> type);</pre>
297
329
<p>
298
330
Allows to change the type of <em class="parameter"><code>area</code></em>. The <a class="link" href="GimpColorArea.html#GimpColorAreaType"><span class="type">GimpColorAreaType</span></a> determines
319
351
</div>
320
352
<hr>
321
353
<div class="refsect2" lang="en">
322
 
<a name="id2618999"></a><h3>
 
354
<a name="id2618988"></a><h3>
323
355
<a name="gimp-color-area-set-draw-border"></a>gimp_color_area_set_draw_border ()</h3>
324
 
<a class="indexterm" name="id2619013"></a><pre class="programlisting">void                gimp_color_area_set_draw_border     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
325
 
                                                         gboolean draw_border);</pre>
 
356
<a class="indexterm" name="id2619002"></a><pre class="programlisting">void                gimp_color_area_set_draw_border     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
 
357
                                                         <a
 
358
href="../glib/glib-Basic-Types.html#gboolean"
 
359
>gboolean</a> draw_border);</pre>
326
360
<p>
327
361
The <em class="parameter"><code>area</code></em> can draw a thin border in the foreground color around
328
362
itself.  This function allows to toggle this behaviour on and
348
382
</div>
349
383
</div>
350
384
<div class="refsect1" lang="en">
351
 
<a name="id2619102"></a><h2>Property Details</h2>
 
385
<a name="id2619091"></a><h2>Property Details</h2>
352
386
<div class="refsect2" lang="en">
353
 
<a name="id2619113"></a><h3>
 
387
<a name="id2619102"></a><h3>
354
388
<a name="GimpColorArea--color"></a>The "<code class="literal">color</code>" property</h3>
355
 
<a class="indexterm" name="id2619126"></a><pre class="programlisting">  "color"                    <a
 
389
<a class="indexterm" name="id2619116"></a><pre class="programlisting">  "color"                    <a
356
390
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
357
391
>GimpRGB</a>               : Read / Write / Construct</pre>
358
392
<p>
365
399
</div>
366
400
<hr>
367
401
<div class="refsect2" lang="en">
368
 
<a name="id2619160"></a><h3>
 
402
<a name="id2619149"></a><h3>
369
403
<a name="GimpColorArea--drag-mask"></a>The "<code class="literal">drag-mask</code>" property</h3>
370
 
<a class="indexterm" name="id2619173"></a><pre class="programlisting">  "drag-mask"                GdkModifierType       : Write / Construct Only</pre>
 
404
<a class="indexterm" name="id2619162"></a><pre class="programlisting">  "drag-mask"                <a
 
405
href="../gdk/gdk-Windows.html#GdkModifierType"
 
406
>GdkModifierType</a>       : Write / Construct Only</pre>
371
407
<p></p>
372
408
</div>
373
409
<hr>
374
410
<div class="refsect2" lang="en">
375
 
<a name="id2602836"></a><h3>
 
411
<a name="id2619184"></a><h3>
376
412
<a name="GimpColorArea--draw-border"></a>The "<code class="literal">draw-border</code>" property</h3>
377
 
<a class="indexterm" name="id2619188"></a><pre class="programlisting">  "draw-border"              gboolean              : Read / Write</pre>
 
413
<a class="indexterm" name="id2607272"></a><pre class="programlisting">  "draw-border"              <a
 
414
href="../glib/glib-Basic-Types.html#gboolean"
 
415
>gboolean</a>              : Read / Write</pre>
378
416
<p>
379
417
Whether to draw a thin border in the foreground color around the area.</p>
380
418
<p>
386
424
</div>
387
425
<hr>
388
426
<div class="refsect2" lang="en">
389
 
<a name="id2619221"></a><h3>
 
427
<a name="id2619213"></a><h3>
390
428
<a name="GimpColorArea--type"></a>The "<code class="literal">type</code>" property</h3>
391
 
<a class="indexterm" name="id2619234"></a><pre class="programlisting">  "type"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct</pre>
 
429
<a class="indexterm" name="id2619225"></a><pre class="programlisting">  "type"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct</pre>
392
430
<p>
393
431
The type of the color area.</p>
394
432
<p>
400
438
</div>
401
439
</div>
402
440
<div class="refsect1" lang="en">
403
 
<a name="id2619268"></a><h2>Signal Details</h2>
 
441
<a name="id2619259"></a><h2>Signal Details</h2>
404
442
<div class="refsect2" lang="en">
405
 
<a name="id2619277"></a><h3>
 
443
<a name="id2619269"></a><h3>
406
444
<a name="GimpColorArea-color-changed"></a>The "color-changed" signal</h3>
407
 
<a class="indexterm" name="id2619285"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
408
 
                                                        gpointer       user_data)          : Run First</pre>
 
445
<a class="indexterm" name="id2619276"></a><pre class="programlisting">void                user_function                      (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
 
446
                                                        <a
 
447
href="../glib/glib-Basic-Types.html#gpointer"
 
448
>gpointer</a>       user_data)          : Run First</pre>
409
449
<p>
410
450
 
411
451
</p>