← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/GimpColorArea.html
59
59
<pre class="synopsis">
60
60
                    <a class="link" href="GimpColorArea.html#GimpColorArea-struct" title="GimpColorArea">GimpColorArea</a>;
61
61
enum                <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a>;
62
 
<a
63
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
64
 
>GtkWidget</a>*          <a class="link" href="GimpColorArea.html#gimp-color-area-new" title="gimp_color_area_new ()">gimp_color_area_new</a>                 (const <a
65
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
62
GtkWidget*          <a class="link" href="GimpColorArea.html#gimp-color-area-new" title="gimp_color_area_new ()">gimp_color_area_new</a>                 (const <a
 
63
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
66
64
>GimpRGB</a> *color,
67
65
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type,
68
 
                                                         <a
69
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
70
 
>GdkModifierType</a> drag_mask);
 
66
                                                         GdkModifierType drag_mask);
71
67
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,
72
68
                                                         const <a
73
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
69
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
74
70
>GimpRGB</a> *color);
75
71
void                <a class="link" href="GimpColorArea.html#gimp-color-area-get-color" title="gimp_color_area_get_color ()">gimp_color_area_get_color</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
76
72
                                                         <a
77
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
73
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
78
74
>GimpRGB</a> *color);
79
 
<a
80
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
81
 
>gboolean</a>            <a class="link" href="GimpColorArea.html#gimp-color-area-has-alpha" title="gimp_color_area_has_alpha ()">gimp_color_area_has_alpha</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
 
75
gboolean            <a class="link" href="GimpColorArea.html#gimp-color-area-has-alpha" title="gimp_color_area_has_alpha ()">gimp_color_area_has_alpha</a>           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);
82
76
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-type" title="gimp_color_area_set_type ()">gimp_color_area_set_type</a>            (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
83
77
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type);
84
78
void                <a class="link" href="GimpColorArea.html#gimp-color-area-set-draw-border" title="gimp_color_area_set_draw_border ()">gimp_color_area_set_draw_border</a>     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
85
 
                                                         <a
86
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
87
 
>gboolean</a> draw_border);
 
79
                                                         gboolean draw_border);
88
80
</pre>
89
81
</div>
90
82
<div class="refsect1" lang="en">
91
83
<a name="GimpColorArea.object-hierarchy"></a><h2>Object Hierarchy</h2>
92
84
<pre class="synopsis">
93
 
  <a
94
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
95
 
>GObject</a>
96
 
   +----<a
97
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
98
 
>GInitiallyUnowned</a>
99
 
         +----<a
100
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
101
 
>GtkObject</a>
102
 
               +----<a
103
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
104
 
>GtkWidget</a>
105
 
                     +----<a
106
 
href="/usr/share/gtk-doc/html/gtk/GtkDrawingArea.html"
107
 
>GtkDrawingArea</a>
 
85
  GObject
 
86
   +----GInitiallyUnowned
 
87
         +----GtkObject
 
88
               +----GtkWidget
 
89
                     +----GtkDrawingArea
108
90
                           +----GimpColorArea
109
91
</pre>
110
92
</div>
118
100
<a name="GimpColorArea.properties"></a><h2>Properties</h2>
119
101
<pre class="synopsis">
120
102
  "<a class="link" href="GimpColorArea.html#GimpColorArea--color" title='The "color" property'>color</a>"                    <a
121
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
103
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
122
104
>GimpRGB</a>*              : Read / Write / Construct
123
 
  "<a class="link" href="GimpColorArea.html#GimpColorArea--drag-mask" title='The "drag-mask" property'>drag-mask</a>"                <a
124
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
125
 
>GdkModifierType</a>       : Write / Construct Only
126
 
  "<a class="link" href="GimpColorArea.html#GimpColorArea--draw-border" title='The "draw-border" property'>draw-border</a>"              <a
127
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
128
 
>gboolean</a>              : Read / Write
 
105
  "<a class="link" href="GimpColorArea.html#GimpColorArea--drag-mask" title='The "drag-mask" property'>drag-mask</a>"                GdkModifierType       : Write / Construct Only
 
106
  "<a class="link" href="GimpColorArea.html#GimpColorArea--draw-border" title='The "draw-border" property'>draw-border</a>"              gboolean              : Read / Write
129
107
  "<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
130
108
</pre>
131
109
</div>
167
145
<hr>
168
146
<div class="refsect2" lang="en">
169
147
<a name="gimp-color-area-new"></a><h3>gimp_color_area_new ()</h3>
170
 
<pre class="programlisting"><a
171
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
172
 
>GtkWidget</a>*          gimp_color_area_new                 (const <a
173
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
148
<pre class="programlisting">GtkWidget*          gimp_color_area_new                 (const <a
 
149
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
174
150
>GimpRGB</a> *color,
175
151
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type,
176
 
                                                         <a
177
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
178
 
>GdkModifierType</a> drag_mask);</pre>
 
152
                                                         GdkModifierType drag_mask);</pre>
179
153
<p>
180
154
Creates a new <a class="link" href="GimpColorArea.html" title="GimpColorArea"><span class="type">GimpColorArea</span></a> widget.
181
155
</p>
191
165
<tr>
192
166
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
193
167
<td>     A pointer to a <a
194
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
168
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
195
169
><span class="type">GimpRGB</span></a> struct.
196
170
</td>
197
171
</tr>
218
192
<a name="gimp-color-area-set-color"></a><h3>gimp_color_area_set_color ()</h3>
219
193
<pre class="programlisting">void                gimp_color_area_set_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
220
194
                                                         const <a
221
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
195
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
222
196
>GimpRGB</a> *color);</pre>
223
197
<p>
224
198
Sets <em class="parameter"><code>area</code></em> to a different <em class="parameter"><code>color</code></em>.</p>
236
210
<tr>
237
211
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
238
212
<td> Pointer to a <a
239
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
213
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
240
214
><span class="type">GimpRGB</span></a> struct that defines the new color.
241
215
</td>
242
216
</tr>
248
222
<a name="gimp-color-area-get-color"></a><h3>gimp_color_area_get_color ()</h3>
249
223
<pre class="programlisting">void                gimp_color_area_get_color           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
250
224
                                                         <a
251
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
225
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
252
226
>GimpRGB</a> *color);</pre>
253
227
<p>
254
228
Retrieves the current color of the <em class="parameter"><code>area</code></em>.</p>
266
240
<tr>
267
241
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
268
242
<td> Pointer to a <a
269
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
243
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
270
244
><span class="type">GimpRGB</span></a> struct that is used to return the color.
271
245
</td>
272
246
</tr>
276
250
<hr>
277
251
<div class="refsect2" lang="en">
278
252
<a name="gimp-color-area-has-alpha"></a><h3>gimp_color_area_has_alpha ()</h3>
279
 
<pre class="programlisting"><a
280
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
281
 
>gboolean</a>            gimp_color_area_has_alpha           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
 
253
<pre class="programlisting">gboolean            gimp_color_area_has_alpha           (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area);</pre>
282
254
<p>
283
255
Checks whether the <em class="parameter"><code>area</code></em> shows transparency information. This is determined
284
256
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>
295
267
</tr>
296
268
<tr>
297
269
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
298
 
<td> <a
299
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
300
 
><code class="literal">TRUE</code></a> if <em class="parameter"><code>area</code></em> shows transparency information, <a
301
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
302
 
><code class="literal">FALSE</code></a> otherwise.
 
270
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>area</code></em> shows transparency information, <code class="literal">FALSE</code> otherwise.
303
271
</td>
304
272
</tr>
305
273
</tbody>
337
305
<div class="refsect2" lang="en">
338
306
<a name="gimp-color-area-set-draw-border"></a><h3>gimp_color_area_set_draw_border ()</h3>
339
307
<pre class="programlisting">void                gimp_color_area_set_draw_border     (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *area,
340
 
                                                         <a
341
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
342
 
>gboolean</a> draw_border);</pre>
 
308
                                                         gboolean draw_border);</pre>
343
309
<p>
344
310
The <em class="parameter"><code>area</code></em> can draw a thin border in the foreground color around
345
311
itself.  This function allows to toggle this behaviour on and
369
335
<div class="refsect2" lang="en">
370
336
<a name="GimpColorArea--color"></a><h3>The <code class="literal">"color"</code> property</h3>
371
337
<pre class="programlisting">  "color"                    <a
372
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
338
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
373
339
>GimpRGB</a>*              : Read / Write / Construct</pre>
374
340
<p>
375
341
The color displayed in the color area.</p>
382
348
<hr>
383
349
<div class="refsect2" lang="en">
384
350
<a name="GimpColorArea--drag-mask"></a><h3>The <code class="literal">"drag-mask"</code> property</h3>
385
 
<pre class="programlisting">  "drag-mask"                <a
386
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkModifierType"
387
 
>GdkModifierType</a>       : Write / Construct Only</pre>
 
351
<pre class="programlisting">  "drag-mask"                GdkModifierType       : Write / Construct Only</pre>
388
352
<p></p>
389
353
</div>
390
354
<hr>
391
355
<div class="refsect2" lang="en">
392
356
<a name="GimpColorArea--draw-border"></a><h3>The <code class="literal">"draw-border"</code> property</h3>
393
 
<pre class="programlisting">  "draw-border"              <a
394
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
395
 
>gboolean</a>              : Read / Write</pre>
 
357
<pre class="programlisting">  "draw-border"              gboolean              : Read / Write</pre>
396
358
<p>
397
359
Whether to draw a thin border in the foreground color around the area.</p>
398
360
<p>
421
383
<div class="refsect2" lang="en">
422
384
<a name="GimpColorArea-color-changed"></a><h3>The <code class="literal">"color-changed"</code> signal</h3>
423
385
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpColorArea.html" title="GimpColorArea">GimpColorArea</a> *gimpcolorarea,
424
 
                                                        <a
425
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
426
 
>gpointer</a>       user_data)          : Run First</pre>
 
386
                                                        gpointer       user_data)          : Run First</pre>
427
387
<p>
428
388
 
429
389
</p>