← 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/GimpColorButton.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/GimpColorButton.html
58
58
<a name="GimpColorButton.synopsis"></a><h2>Synopsis</h2>
59
59
<pre class="synopsis">
60
60
                    <a class="link" href="GimpColorButton.html#GimpColorButton-struct" title="GimpColorButton">GimpColorButton</a>;
61
 
<a
62
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
63
 
>GtkWidget</a>*          <a class="link" href="GimpColorButton.html#gimp-color-button-new" title="gimp_color_button_new ()">gimp_color_button_new</a>               (const <a
64
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
65
 
>gchar</a> *title,
66
 
                                                         <a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
68
 
>gint</a> width,
69
 
                                                         <a
70
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
71
 
>gint</a> height,
 
61
GtkWidget*          <a class="link" href="GimpColorButton.html#gimp-color-button-new" title="gimp_color_button_new ()">gimp_color_button_new</a>               (const gchar *title,
 
62
                                                         gint width,
 
63
                                                         gint height,
72
64
                                                         const <a
73
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
65
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
74
66
>GimpRGB</a> *color,
75
67
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type);
76
68
void                <a class="link" href="GimpColorButton.html#gimp-color-button-set-color" title="gimp_color_button_set_color ()">gimp_color_button_set_color</a>         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
77
69
                                                         const <a
78
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
70
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
79
71
>GimpRGB</a> *color);
80
72
void                <a class="link" href="GimpColorButton.html#gimp-color-button-get-color" title="gimp_color_button_get_color ()">gimp_color_button_get_color</a>         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
81
73
                                                         <a
82
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
74
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
83
75
>GimpRGB</a> *color);
84
76
void                <a class="link" href="GimpColorButton.html#gimp-color-button-set-update" title="gimp_color_button_set_update ()">gimp_color_button_set_update</a>        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
85
 
                                                         <a
86
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
87
 
>gboolean</a> continuous);
88
 
<a
89
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
90
 
>gboolean</a>            <a class="link" href="GimpColorButton.html#gimp-color-button-get-update" title="gimp_color_button_get_update ()">gimp_color_button_get_update</a>        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
91
 
<a
92
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
93
 
>gboolean</a>            <a class="link" href="GimpColorButton.html#gimp-color-button-has-alpha" title="gimp_color_button_has_alpha ()">gimp_color_button_has_alpha</a>         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
 
77
                                                         gboolean continuous);
 
78
gboolean            <a class="link" href="GimpColorButton.html#gimp-color-button-get-update" title="gimp_color_button_get_update ()">gimp_color_button_get_update</a>        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
 
79
gboolean            <a class="link" href="GimpColorButton.html#gimp-color-button-has-alpha" title="gimp_color_button_has_alpha ()">gimp_color_button_has_alpha</a>         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);
94
80
void                <a class="link" href="GimpColorButton.html#gimp-color-button-set-type" title="gimp_color_button_set_type ()">gimp_color_button_set_type</a>          (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
95
81
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type);
96
82
</pre>
98
84
<div class="refsect1" lang="en">
99
85
<a name="GimpColorButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
100
86
<pre class="synopsis">
101
 
  <a
102
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
103
 
>GObject</a>
104
 
   +----<a
105
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
106
 
>GInitiallyUnowned</a>
107
 
         +----<a
108
 
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
109
 
>GtkObject</a>
110
 
               +----<a
111
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
112
 
>GtkWidget</a>
113
 
                     +----<a
114
 
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
115
 
>GtkContainer</a>
116
 
                           +----<a
117
 
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
118
 
>GtkBin</a>
119
 
                                 +----<a
120
 
href="/usr/share/gtk-doc/html/gtk/GtkButton.html"
121
 
>GtkButton</a>
 
87
  GObject
 
88
   +----GInitiallyUnowned
 
89
         +----GtkObject
 
90
               +----GtkWidget
 
91
                     +----GtkContainer
 
92
                           +----GtkBin
 
93
                                 +----GtkButton
122
94
                                       +----<a class="link" href="GimpButton.html" title="GimpButton">GimpButton</a>
123
95
                                             +----GimpColorButton
124
96
</pre>
133
105
<a name="GimpColorButton.properties"></a><h2>Properties</h2>
134
106
<pre class="synopsis">
135
107
  "<a class="link" href="GimpColorButton.html#GimpColorButton--color" title='The "color" property'>color</a>"                    <a
136
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
108
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
137
109
>GimpRGB</a>*              : Read / Write / Construct
138
 
  "<a class="link" href="GimpColorButton.html#GimpColorButton--continuous-update" title='The "continuous-update" property'>continuous-update</a>"        <a
139
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
140
 
>gboolean</a>              : Read / Write / Construct
141
 
  "<a class="link" href="GimpColorButton.html#GimpColorButton--title" title='The "title" property'>title</a>"                    <a
142
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
143
 
>gchar</a>*                : Read / Write / Construct Only
 
110
  "<a class="link" href="GimpColorButton.html#GimpColorButton--continuous-update" title='The "continuous-update" property'>continuous-update</a>"        gboolean              : Read / Write / Construct
 
111
  "<a class="link" href="GimpColorButton.html#GimpColorButton--title" title='The "title" property'>title</a>"                    gchar*                : Read / Write / Construct Only
144
112
  "<a class="link" href="GimpColorButton.html#GimpColorButton--type" title='The "type" property'>type</a>"                     <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a>     : Read / Write / Construct
145
113
</pre>
146
114
</div>
175
143
<hr>
176
144
<div class="refsect2" lang="en">
177
145
<a name="gimp-color-button-new"></a><h3>gimp_color_button_new ()</h3>
178
 
<pre class="programlisting"><a
179
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
180
 
>GtkWidget</a>*          gimp_color_button_new               (const <a
181
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
182
 
>gchar</a> *title,
183
 
                                                         <a
184
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
185
 
>gint</a> width,
186
 
                                                         <a
187
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
188
 
>gint</a> height,
 
146
<pre class="programlisting">GtkWidget*          gimp_color_button_new               (const gchar *title,
 
147
                                                         gint width,
 
148
                                                         gint height,
189
149
                                                         const <a
190
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
150
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
191
151
>GimpRGB</a> *color,
192
152
                                                         <a class="link" href="GimpColorArea.html#GimpColorAreaType" title="enum GimpColorAreaType">GimpColorAreaType</a> type);</pre>
193
153
<p>
223
183
<tr>
224
184
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
225
185
<td> A pointer to a <a
226
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
186
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
227
187
><span class="type">GimpRGB</span></a> color.
228
188
</td>
229
189
</tr>
245
205
<a name="gimp-color-button-set-color"></a><h3>gimp_color_button_set_color ()</h3>
246
206
<pre class="programlisting">void                gimp_color_button_set_color         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
247
207
                                                         const <a
248
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
208
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
249
209
>GimpRGB</a> *color);</pre>
250
210
<p>
251
211
Sets the <em class="parameter"><code>button</code></em> to the given <em class="parameter"><code>color</code></em>.</p>
263
223
<tr>
264
224
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
265
225
<td> Pointer to the new <a
266
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
226
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
267
227
><span class="type">GimpRGB</span></a> color.
268
228
</td>
269
229
</tr>
275
235
<a name="gimp-color-button-get-color"></a><h3>gimp_color_button_get_color ()</h3>
276
236
<pre class="programlisting">void                gimp_color_button_get_color         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
277
237
                                                         <a
278
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
238
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
279
239
>GimpRGB</a> *color);</pre>
280
240
<p>
281
241
Retrieves the currently set color from the <em class="parameter"><code>button</code></em>.</p>
293
253
<tr>
294
254
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
295
255
<td> Pointer to a <a
296
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
256
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
297
257
><span class="type">GimpRGB</span></a> struct used to return the color.
298
258
</td>
299
259
</tr>
304
264
<div class="refsect2" lang="en">
305
265
<a name="gimp-color-button-set-update"></a><h3>gimp_color_button_set_update ()</h3>
306
266
<pre class="programlisting">void                gimp_color_button_set_update        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button,
307
 
                                                         <a
308
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
309
 
>gboolean</a> continuous);</pre>
 
267
                                                         gboolean continuous);</pre>
310
268
<p>
311
 
When set to <a
312
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
313
 
><span class="type">TRUE</span></a>, the <em class="parameter"><code>button</code></em> will emit the "color-changed"
 
269
When set to <span class="type">TRUE</span>, the <em class="parameter"><code>button</code></em> will emit the "color-changed"
314
270
continuously while the color is changed in the color selection
315
271
dialog.</p>
316
272
<p>
335
291
<hr>
336
292
<div class="refsect2" lang="en">
337
293
<a name="gimp-color-button-get-update"></a><h3>gimp_color_button_get_update ()</h3>
338
 
<pre class="programlisting"><a
339
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
340
 
>gboolean</a>            gimp_color_button_get_update        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
 
294
<pre class="programlisting">gboolean            gimp_color_button_get_update        (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
341
295
<p>
342
296
Returns the color button's <em class="parameter"><code>continuous_update</code></em> property.</p>
343
297
<p>
362
316
<hr>
363
317
<div class="refsect2" lang="en">
364
318
<a name="gimp-color-button-has-alpha"></a><h3>gimp_color_button_has_alpha ()</h3>
365
 
<pre class="programlisting"><a
366
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
367
 
>gboolean</a>            gimp_color_button_has_alpha         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
 
319
<pre class="programlisting">gboolean            gimp_color_button_has_alpha         (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *button);</pre>
368
320
<p>
369
321
Checks whether the <em class="parameter"><code>buttons</code></em> shows transparency information.</p>
370
322
<p>
380
332
</tr>
381
333
<tr>
382
334
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
383
 
<td> <a
384
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
385
 
><code class="literal">TRUE</code></a> if the <em class="parameter"><code>button</code></em> shows transparency information, <a
386
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
387
 
><code class="literal">FALSE</code></a>
 
335
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>button</code></em> shows transparency information, <code class="literal">FALSE</code>
388
336
otherwise.
389
337
</td>
390
338
</tr>
423
371
<div class="refsect2" lang="en">
424
372
<a name="GimpColorButton--color"></a><h3>The <code class="literal">"color"</code> property</h3>
425
373
<pre class="programlisting">  "color"                    <a
426
 
href="/usr/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
 
374
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
427
375
>GimpRGB</a>*              : Read / Write / Construct</pre>
428
376
<p>
429
377
The color displayed in the button's color area.</p>
436
384
<hr>
437
385
<div class="refsect2" lang="en">
438
386
<a name="GimpColorButton--continuous-update"></a><h3>The <code class="literal">"continuous-update"</code> property</h3>
439
 
<pre class="programlisting">  "continuous-update"        <a
440
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
441
 
>gboolean</a>              : Read / Write / Construct</pre>
 
387
<pre class="programlisting">  "continuous-update"        gboolean              : Read / Write / Construct</pre>
442
388
<p>
443
389
The update policy of the color button.</p>
444
390
<p>
451
397
<hr>
452
398
<div class="refsect2" lang="en">
453
399
<a name="GimpColorButton--title"></a><h3>The <code class="literal">"title"</code> property</h3>
454
 
<pre class="programlisting">  "title"                    <a
455
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
456
 
>gchar</a>*                : Read / Write / Construct Only</pre>
 
400
<pre class="programlisting">  "title"                    gchar*                : Read / Write / Construct Only</pre>
457
401
<p>
458
402
The title to be used for the color selection dialog.</p>
459
403
<p>
482
426
<div class="refsect2" lang="en">
483
427
<a name="GimpColorButton-color-changed"></a><h3>The <code class="literal">"color-changed"</code> signal</h3>
484
428
<pre class="programlisting">void                user_function                      (<a class="link" href="GimpColorButton.html" title="GimpColorButton">GimpColorButton</a> *gimpcolorbutton,
485
 
                                                        <a
486
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
487
 
>gpointer</a>         user_data)            : Run First</pre>
 
429
                                                        gpointer         user_data)            : Run First</pre>
488
430
<p>
489
431
 
490
432
</p>