← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gimp/karmic-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
https://launchpad.net/bugs/419593
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/GimpColorArea.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpColorArea</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
9
9
<link rel="prev" href="GimpChainButton.html" title="GimpChainButton">
10
10
<link rel="next" href="GimpColorButton.html" title="GimpColorButton">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="GimpColorButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
36
36
</tr>
37
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpColorArea.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#GimpColorArea.description" class="shortcut">Description</a>
40
 
                   | 
41
 
                  <a href="#GimpColorArea.object-hierarchy" class="shortcut">Object Hierarchy</a>
42
 
                   | 
43
 
                  <a href="#GimpColorArea.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
44
 
                   | 
45
 
                  <a href="#GimpColorArea.properties" class="shortcut">Properties</a>
46
 
                   | 
47
 
                  <a href="#GimpColorArea.signals" class="shortcut">Signals</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#GimpColorArea.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#GimpColorArea.description" class="shortcut">Description</a>
 
41
                 | 
 
42
                <a href="#GimpColorArea.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
43
                 | 
 
44
                <a href="#GimpColorArea.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
45
                 | 
 
46
                <a href="#GimpColorArea.properties" class="shortcut">Properties</a>
 
47
                 | 
 
48
                <a href="#GimpColorArea.signals" class="shortcut">Signals</a>
 
49
</td></tr>
48
50
</table>
49
 
<div class="refentry" lang="en">
 
51
<div class="refentry" title="GimpColorArea">
50
52
<a name="GimpColorArea"></a><div class="titlepage"></div>
51
53
<div class="refnamediv"><table width="100%"><tr>
52
54
<td valign="top">
55
57
</td>
56
58
<td valign="top" align="right"><img src="gimp-color-area.png"></td>
57
59
</tr></table></div>
58
 
<div class="refsynopsisdiv">
 
60
<div class="refsynopsisdiv" title="Synopsis">
59
61
<a name="GimpColorArea.synopsis"></a><h2>Synopsis</h2>
60
62
<pre class="synopsis">
61
63
                    <a class="link" href="GimpColorArea.html#GimpColorArea-struct" title="GimpColorArea">GimpColorArea</a>;
62
64
enum                <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a>;
63
65
<a
64
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
65
 
>GtkWidget</a>*          <a class="link" href="GimpColorArea.html#gimp-color-area-new" title="gimp_color_area_new ()">gimp_color_area_new</a>                 (const <a
 
66
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
67
>GtkWidget</a> *         <a class="link" href="GimpColorArea.html#gimp-color-area-new" title="gimp_color_area_new ()">gimp_color_area_new</a>                 (const <a
66
68
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
67
69
>GimpRGB</a> *color,
68
70
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type,
69
71
                                                         <a
70
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
 
72
href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"
71
73
>GdkModifierType</a> drag_mask);
72
74
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-color" title="gimp_color_area_set_color ()">gimp_color_area_set_color</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
73
75
                                                         const <a
88
90
>gboolean</a> draw_border);
89
91
</pre>
90
92
</div>
91
 
<div class="refsect1" lang="en">
 
93
<div class="refsect1" title="Object Hierarchy">
92
94
<a name="GimpColorArea.object-hierarchy"></a><h2>Object Hierarchy</h2>
93
95
<pre class="synopsis">
94
96
  <a
98
100
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
99
101
>GInitiallyUnowned</a>
100
102
         +----<a
101
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
 
103
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
102
104
>GtkObject</a>
103
105
               +----<a
104
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
 
106
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
105
107
>GtkWidget</a>
106
108
                     +----<a
107
 
href="/usr/share/gtk-doc/html/gtk/GtkDrawingArea.html"
 
109
href="http://library.gnome.org/devel/gtk/unstable/GtkDrawingArea.html"
108
110
>GtkDrawingArea</a>
109
111
                           +----GimpColorArea
110
112
</pre>
111
113
</div>
112
 
<div class="refsect1" lang="en">
 
114
<div class="refsect1" title="Implemented Interfaces">
113
115
<a name="GimpColorArea.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
114
116
<p>
115
117
GimpColorArea implements
116
 
 AtkImplementorIface and  <a
117
 
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
118
 
>GtkBuildable</a>.</p>
 
118
 <a
 
119
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
 
120
>GtkBuildable</a> and  AtkImplementorIface.</p>
119
121
</div>
120
 
<div class="refsect1" lang="en">
 
122
<div class="refsect1" title="Properties">
121
123
<a name="GimpColorArea.properties"></a><h2>Properties</h2>
122
124
<pre class="synopsis">
123
125
  "<a class="link" href="GimpColorArea.html#GimpColorArea--color" title='The "color" property'>color</a>"                    <a
124
126
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
125
127
>GimpRGB</a>*              : Read / Write / Construct
126
128
  "<a class="link" href="GimpColorArea.html#GimpColorArea--drag-mask" title='The "drag-mask" property'>drag-mask</a>"                <a
127
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
 
129
href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"
128
130
>GdkModifierType</a>       : Write / Construct Only
129
131
  "<a class="link" href="GimpColorArea.html#GimpColorArea--draw-border" title='The "draw-border" property'>draw-border</a>"              <a
130
132
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
132
134
  "<a class="link" href="GimpColorArea.html#GimpColorArea--type" title='The "type" property'>type</a>"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct
133
135
</pre>
134
136
</div>
135
 
<div class="refsect1" lang="en">
 
137
<div class="refsect1" title="Signals">
136
138
<a name="GimpColorArea.signals"></a><h2>Signals</h2>
137
139
<pre class="synopsis">
138
140
  "<a class="link" href="GimpColorArea.html#GimpColorArea-color-changed" title='The "color-changed" signal'>color-changed</a>"                                  : Run First
139
141
</pre>
140
142
</div>
141
 
<div class="refsect1" lang="en">
 
143
<div class="refsect1" title="Description">
142
144
<a name="GimpColorArea.description"></a><h2>Description</h2>
143
145
<p>
144
 
 
145
146
</p>
146
147
</div>
147
 
<div class="refsect1" lang="en">
 
148
<div class="refsect1" title="Details">
148
149
<a name="GimpColorArea.details"></a><h2>Details</h2>
149
 
<div class="refsect2" lang="en">
 
150
<div class="refsect2" title="GimpColorArea">
150
151
<a name="GimpColorArea-struct"></a><h3>GimpColorArea</h3>
151
152
<pre class="programlisting">typedef struct _GimpColorArea GimpColorArea;</pre>
152
153
<p>
153
 
 
154
154
</p>
155
155
</div>
156
156
<hr>
157
 
<div class="refsect2" lang="en">
 
157
<div class="refsect2" title="enum GimpColorAreaType">
158
158
<a name="GimpColorAreaType"></a><h3>enum GimpColorAreaType</h3>
159
159
<pre class="programlisting">typedef enum
160
160
{
164
164
} GimpColorAreaType;
165
165
</pre>
166
166
<p>
167
 
 
168
167
</p>
169
168
</div>
170
169
<hr>
171
 
<div class="refsect2" lang="en">
 
170
<div class="refsect2" title="gimp_color_area_new ()">
172
171
<a name="gimp-color-area-new"></a><h3>gimp_color_area_new ()</h3>
173
172
<pre class="programlisting"><a
174
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
175
 
>GtkWidget</a>*          gimp_color_area_new                 (const <a
 
173
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
 
174
>GtkWidget</a> *         gimp_color_area_new                 (const <a
176
175
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
177
176
>GimpRGB</a> *color,
178
177
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type,
179
178
                                                         <a
180
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
 
179
href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"
181
180
>GdkModifierType</a> drag_mask);</pre>
182
181
<p>
183
182
Creates a new <a class="link" href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
186
185
This returns a preview area showing the color. It handles color
187
186
DND. If the color changes, the "color_changed" signal is emitted.</p>
188
187
<p>
189
 
 
190
188
</p>
191
189
<div class="variablelist"><table border="0">
192
190
<col align="left" valign="top">
217
215
</table></div>
218
216
</div>
219
217
<hr>
220
 
<div class="refsect2" lang="en">
 
218
<div class="refsect2" title="gimp_color_area_set_color ()">
221
219
<a name="gimp-color-area-set-color"></a><h3>gimp_color_area_set_color ()</h3>
222
220
<pre class="programlisting">void                gimp_color_area_set_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
223
221
                                                         const <a
226
224
<p>
227
225
Sets <em class="parameter"><code>area</code></em> to a different <em class="parameter"><code>color</code></em>.</p>
228
226
<p>
229
 
 
230
227
</p>
231
228
<div class="variablelist"><table border="0">
232
229
<col align="left" valign="top">
247
244
</table></div>
248
245
</div>
249
246
<hr>
250
 
<div class="refsect2" lang="en">
 
247
<div class="refsect2" title="gimp_color_area_get_color ()">
251
248
<a name="gimp-color-area-get-color"></a><h3>gimp_color_area_get_color ()</h3>
252
249
<pre class="programlisting">void                gimp_color_area_get_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
253
250
                                                         <a
256
253
<p>
257
254
Retrieves the current color of the <em class="parameter"><code>area</code></em>.</p>
258
255
<p>
259
 
 
260
256
</p>
261
257
<div class="variablelist"><table border="0">
262
258
<col align="left" valign="top">
277
273
</table></div>
278
274
</div>
279
275
<hr>
280
 
<div class="refsect2" lang="en">
 
276
<div class="refsect2" title="gimp_color_area_has_alpha ()">
281
277
<a name="gimp-color-area-has-alpha"></a><h3>gimp_color_area_has_alpha ()</h3>
282
278
<pre class="programlisting"><a
283
279
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
286
282
Checks whether the <em class="parameter"><code>area</code></em> shows transparency information. This is determined
287
283
via the <em class="parameter"><code>area</code></em>'s <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType"><span class="type">GimpColorAreaType</span></a>.</p>
288
284
<p>
289
 
 
290
285
</p>
291
286
<div class="variablelist"><table border="0">
292
287
<col align="left" valign="top">
299
294
<tr>
300
295
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
301
296
<td> <a
302
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
 
297
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
303
298
><code class="literal">TRUE</code></a> if <em class="parameter"><code>area</code></em> shows transparency information, <a
304
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"
 
299
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
305
300
><code class="literal">FALSE</code></a> otherwise.
306
301
</td>
307
302
</tr>
309
304
</table></div>
310
305
</div>
311
306
<hr>
312
 
<div class="refsect2" lang="en">
 
307
<div class="refsect2" title="gimp_color_area_set_type ()">
313
308
<a name="gimp-color-area-set-type"></a><h3>gimp_color_area_set_type ()</h3>
314
309
<pre class="programlisting">void                gimp_color_area_set_type            (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
315
310
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type);</pre>
318
313
whether the widget shows transparency information and chooses the size of
319
314
the checkerboard used to do that.</p>
320
315
<p>
321
 
 
322
316
</p>
323
317
<div class="variablelist"><table border="0">
324
318
<col align="left" valign="top">
337
331
</table></div>
338
332
</div>
339
333
<hr>
340
 
<div class="refsect2" lang="en">
 
334
<div class="refsect2" title="gimp_color_area_set_draw_border ()">
341
335
<a name="gimp-color-area-set-draw-border"></a><h3>gimp_color_area_set_draw_border ()</h3>
342
336
<pre class="programlisting">void                gimp_color_area_set_draw_border     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
343
337
                                                         <a
348
342
itself.  This function allows to toggle this behaviour on and
349
343
off. The default is not draw a border.</p>
350
344
<p>
351
 
 
352
345
</p>
353
346
<div class="variablelist"><table border="0">
354
347
<col align="left" valign="top">
367
360
</table></div>
368
361
</div>
369
362
</div>
370
 
<div class="refsect1" lang="en">
 
363
<div class="refsect1" title="Property Details">
371
364
<a name="GimpColorArea.property-details"></a><h2>Property Details</h2>
372
 
<div class="refsect2" lang="en">
 
365
<div class="refsect2" title='The "color" property'>
373
366
<a name="GimpColorArea--color"></a><h3>The <code class="literal">"color"</code> property</h3>
374
367
<pre class="programlisting">  "color"                    <a
375
368
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
377
370
<p>
378
371
The color displayed in the color area.</p>
379
372
<p>
380
 
 
381
 
</p>
382
 
<p>Since  GIMP 2.4
383
 
</p>
 
373
</p>
 
374
<p>Since GIMP 2.4</p>
384
375
</div>
385
376
<hr>
386
 
<div class="refsect2" lang="en">
 
377
<div class="refsect2" title='The "drag-mask" property'>
387
378
<a name="GimpColorArea--drag-mask"></a><h3>The <code class="literal">"drag-mask"</code> property</h3>
388
379
<pre class="programlisting">  "drag-mask"                <a
389
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
 
380
href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"
390
381
>GdkModifierType</a>       : Write / Construct Only</pre>
391
382
<p></p>
392
383
</div>
393
384
<hr>
394
 
<div class="refsect2" lang="en">
 
385
<div class="refsect2" title='The "draw-border" property'>
395
386
<a name="GimpColorArea--draw-border"></a><h3>The <code class="literal">"draw-border"</code> property</h3>
396
387
<pre class="programlisting">  "draw-border"              <a
397
388
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
399
390
<p>
400
391
Whether to draw a thin border in the foreground color around the area.</p>
401
392
<p>
402
 
 
403
393
</p>
404
394
<p>Default value: FALSE</p>
405
 
<p>Since  GIMP 2.4
406
 
</p>
 
395
<p>Since GIMP 2.4</p>
407
396
</div>
408
397
<hr>
409
 
<div class="refsect2" lang="en">
 
398
<div class="refsect2" title='The "type" property'>
410
399
<a name="GimpColorArea--type"></a><h3>The <code class="literal">"type"</code> property</h3>
411
400
<pre class="programlisting">  "type"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct</pre>
412
401
<p>
413
402
The type of the color area.</p>
414
403
<p>
415
 
 
416
404
</p>
417
405
<p>Default value: GIMP_COLOR_AREA_FLAT</p>
418
 
<p>Since  GIMP 2.4
419
 
</p>
420
 
</div>
421
 
</div>
422
 
<div class="refsect1" lang="en">
 
406
<p>Since GIMP 2.4</p>
 
407
</div>
 
408
</div>
 
409
<div class="refsect1" title="Signal Details">
423
410
<a name="GimpColorArea.signal-details"></a><h2>Signal Details</h2>
424
 
<div class="refsect2" lang="en">
 
411
<div class="refsect2" title='The "color-changed" signal'>
425
412
<a name="GimpColorArea-color-changed"></a><h3>The <code class="literal">"color-changed"</code> signal</h3>
426
413
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
427
414
                                                        <a
428
415
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
429
416
>gpointer</a>       user_data)          : Run First</pre>
430
417
<p>
431
 
 
432
418
</p>
433
419
<div class="variablelist"><table border="0">
434
420
<col align="left" valign="top">
436
422
<tr>
437
423
<td><p><span class="term"><em class="parameter"><code>gimpcolorarea</code></em> :</span></p></td>
438
424
<td>the object which received the signal.
439
 
 
440
425
</td>
441
426
</tr>
442
427
<tr>
450
435
</div>
451
436
<div class="footer">
452
437
<hr>
453
 
          Generated by GTK-Doc V1.10</div>
 
438
          Generated by GTK-Doc V1.11</div>
454
439
</body>
455
440
</html>