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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/GimpPreviewArea.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:
33
33
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
34
34
<td><a accesskey="n" href="GimpPreview.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="#id2587166" class="shortcut">Top</a>
37
 
                  &#160;|&#160;
38
 
                  <a href="#id2635380" class="shortcut">Description</a>
39
 
                  &#160;|&#160;
40
 
                  <a href="#id2635262" class="shortcut">Object Hierarchy</a>
41
 
                  &#160;|&#160;
42
 
                  <a href="#id2635310" class="shortcut">Implemented Interfaces</a>
43
 
                  &#160;|&#160;
44
 
                  <a href="#id2635338" class="shortcut">Properties</a></nobr></td></tr>
 
36
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2592950" class="shortcut">Top</a>
 
37
                  &#160;|&#160;
 
38
                  <a href="#id2640987" class="shortcut">Description</a>
 
39
                  &#160;|&#160;
 
40
                  <a href="#id2635701" class="shortcut">Object Hierarchy</a>
 
41
                  &#160;|&#160;
 
42
                  <a href="#id2635750" class="shortcut">Implemented Interfaces</a>
 
43
                  &#160;|&#160;
 
44
                  <a href="#id2635778" class="shortcut">Properties</a></nobr></td></tr>
45
45
</table>
46
46
<div class="refentry" lang="en">
47
47
<a name="GimpPreviewArea"></a><div class="titlepage"></div>
48
48
<div class="refnamediv"><table width="100%"><tr>
49
49
<td valign="top">
50
50
<h2>
51
 
<a name="id2587166"></a><span class="refentrytitle">GimpPreviewArea</span>
 
51
<a name="id2592950"></a><span class="refentrytitle">GimpPreviewArea</span>
52
52
</h2>
53
53
<p>GimpPreviewArea &#8212; A general purpose preview widget which caches its pixel data.</p>
54
54
</td>
61
61
 
62
62
 
63
63
                    <a class="link" href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
64
 
GtkWidget*          <a class="link" href="GimpPreviewArea.html#gimp-preview-area-new">gimp_preview_area_new</a>               (void);
 
64
<a
 
65
href="../gtk/GtkWidget.html"
 
66
>GtkWidget</a>*          <a class="link" href="GimpPreviewArea.html#gimp-preview-area-new">gimp_preview_area_new</a>               (void);
65
67
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw">gimp_preview_area_draw</a>              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
66
 
                                                         gint x,
67
 
                                                         gint y,
68
 
                                                         gint width,
69
 
                                                         gint height,
 
68
                                                         <a
 
69
href="../glib/glib-Basic-Types.html#gint"
 
70
>gint</a> x,
 
71
                                                         <a
 
72
href="../glib/glib-Basic-Types.html#gint"
 
73
>gint</a> y,
 
74
                                                         <a
 
75
href="../glib/glib-Basic-Types.html#gint"
 
76
>gint</a> width,
 
77
                                                         <a
 
78
href="../glib/glib-Basic-Types.html#gint"
 
79
>gint</a> height,
70
80
                                                         <a
71
81
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
72
82
>GimpImageType</a> type,
73
 
                                                         const guchar *buf,
74
 
                                                         gint rowstride);
 
83
                                                         const <a
 
84
href="../glib/glib-Basic-Types.html#guchar"
 
85
>guchar</a> *buf,
 
86
                                                         <a
 
87
href="../glib/glib-Basic-Types.html#gint"
 
88
>gint</a> rowstride);
75
89
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a>              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
76
 
                                                         gint x,
77
 
                                                         gint y,
78
 
                                                         gint width,
79
 
                                                         gint height,
80
 
                                                         guchar red,
81
 
                                                         guchar green,
82
 
                                                         guchar blue);
 
90
                                                         <a
 
91
href="../glib/glib-Basic-Types.html#gint"
 
92
>gint</a> x,
 
93
                                                         <a
 
94
href="../glib/glib-Basic-Types.html#gint"
 
95
>gint</a> y,
 
96
                                                         <a
 
97
href="../glib/glib-Basic-Types.html#gint"
 
98
>gint</a> width,
 
99
                                                         <a
 
100
href="../glib/glib-Basic-Types.html#gint"
 
101
>gint</a> height,
 
102
                                                         <a
 
103
href="../glib/glib-Basic-Types.html#guchar"
 
104
>guchar</a> red,
 
105
                                                         <a
 
106
href="../glib/glib-Basic-Types.html#guchar"
 
107
>guchar</a> green,
 
108
                                                         <a
 
109
href="../glib/glib-Basic-Types.html#guchar"
 
110
>guchar</a> blue);
83
111
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a>             (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
84
 
                                                         gint x,
85
 
                                                         gint y,
86
 
                                                         gint width,
87
 
                                                         gint height,
 
112
                                                         <a
 
113
href="../glib/glib-Basic-Types.html#gint"
 
114
>gint</a> x,
 
115
                                                         <a
 
116
href="../glib/glib-Basic-Types.html#gint"
 
117
>gint</a> y,
 
118
                                                         <a
 
119
href="../glib/glib-Basic-Types.html#gint"
 
120
>gint</a> width,
 
121
                                                         <a
 
122
href="../glib/glib-Basic-Types.html#gint"
 
123
>gint</a> height,
88
124
                                                         <a
89
125
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
90
126
>GimpImageType</a> type,
91
 
                                                         const guchar *buf1,
92
 
                                                         gint rowstride1,
93
 
                                                         const guchar *buf2,
94
 
                                                         gint rowstride2,
95
 
                                                         guchar opacity);
 
127
                                                         const <a
 
128
href="../glib/glib-Basic-Types.html#guchar"
 
129
>guchar</a> *buf1,
 
130
                                                         <a
 
131
href="../glib/glib-Basic-Types.html#gint"
 
132
>gint</a> rowstride1,
 
133
                                                         const <a
 
134
href="../glib/glib-Basic-Types.html#guchar"
 
135
>guchar</a> *buf2,
 
136
                                                         <a
 
137
href="../glib/glib-Basic-Types.html#gint"
 
138
>gint</a> rowstride2,
 
139
                                                         <a
 
140
href="../glib/glib-Basic-Types.html#guchar"
 
141
>guchar</a> opacity);
96
142
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a>              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
97
 
                                                         gint x,
98
 
                                                         gint y,
99
 
                                                         gint width,
100
 
                                                         gint height,
 
143
                                                         <a
 
144
href="../glib/glib-Basic-Types.html#gint"
 
145
>gint</a> x,
 
146
                                                         <a
 
147
href="../glib/glib-Basic-Types.html#gint"
 
148
>gint</a> y,
 
149
                                                         <a
 
150
href="../glib/glib-Basic-Types.html#gint"
 
151
>gint</a> width,
 
152
                                                         <a
 
153
href="../glib/glib-Basic-Types.html#gint"
 
154
>gint</a> height,
101
155
                                                         <a
102
156
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
103
157
>GimpImageType</a> type,
104
 
                                                         const guchar *buf1,
105
 
                                                         gint rowstride1,
106
 
                                                         const guchar *buf2,
107
 
                                                         gint rowstride2,
108
 
                                                         const guchar *mask,
109
 
                                                         gint rowstride_mask);
 
158
                                                         const <a
 
159
href="../glib/glib-Basic-Types.html#guchar"
 
160
>guchar</a> *buf1,
 
161
                                                         <a
 
162
href="../glib/glib-Basic-Types.html#gint"
 
163
>gint</a> rowstride1,
 
164
                                                         const <a
 
165
href="../glib/glib-Basic-Types.html#guchar"
 
166
>guchar</a> *buf2,
 
167
                                                         <a
 
168
href="../glib/glib-Basic-Types.html#gint"
 
169
>gint</a> rowstride2,
 
170
                                                         const <a
 
171
href="../glib/glib-Basic-Types.html#guchar"
 
172
>guchar</a> *mask,
 
173
                                                         <a
 
174
href="../glib/glib-Basic-Types.html#gint"
 
175
>gint</a> rowstride_mask);
110
176
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</a>       (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
111
 
                                                         gint x,
112
 
                                                         gint y);
 
177
                                                         <a
 
178
href="../glib/glib-Basic-Types.html#gint"
 
179
>gint</a> x,
 
180
                                                         <a
 
181
href="../glib/glib-Basic-Types.html#gint"
 
182
>gint</a> y);
113
183
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</a>      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
114
 
                                                         const guchar *colormap,
115
 
                                                         gint num_colors);
 
184
                                                         const <a
 
185
href="../glib/glib-Basic-Types.html#guchar"
 
186
>guchar</a> *colormap,
 
187
                                                         <a
 
188
href="../glib/glib-Basic-Types.html#gint"
 
189
>gint</a> num_colors);
116
190
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</a>      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
117
 
                                                         gint width,
118
 
                                                         gint height);
 
191
                                                         <a
 
192
href="../glib/glib-Basic-Types.html#gint"
 
193
>gint</a> width,
 
194
                                                         <a
 
195
href="../glib/glib-Basic-Types.html#gint"
 
196
>gint</a> height);
119
197
void                <a class="link" href="GimpPreviewArea.html#gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</a>        (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
120
 
                                                         GdkEventButton *event);
 
198
                                                         <a
 
199
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
 
200
>GdkEventButton</a> *event);
121
201
 
122
202
</pre>
123
203
</div>
124
204
<div class="refsect1" lang="en">
125
 
<a name="id2635262"></a><h2>Object Hierarchy</h2>
 
205
<a name="id2635701"></a><h2>Object Hierarchy</h2>
126
206
<pre class="synopsis">
127
207
 
128
 
  GObject
129
 
   +----GInitiallyUnowned
130
 
         +----GtkObject
131
 
               +----GtkWidget
132
 
                     +----GtkDrawingArea
 
208
  <a
 
209
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
210
>GObject</a>
 
211
   +----<a
 
212
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
 
213
>GInitiallyUnowned</a>
 
214
         +----<a
 
215
href="../gtk/GtkObject.html"
 
216
>GtkObject</a>
 
217
               +----<a
 
218
href="../gtk/GtkWidget.html"
 
219
>GtkWidget</a>
 
220
                     +----<a
 
221
href="../gtk/GtkDrawingArea.html"
 
222
>GtkDrawingArea</a>
133
223
                           +----GimpPreviewArea
134
224
</pre>
135
225
</div>
136
226
<div class="refsect1" lang="en">
137
 
<a name="id2635310"></a><h2>Implemented Interfaces</h2>
 
227
<a name="id2635750"></a><h2>Implemented Interfaces</h2>
138
228
<p>
139
229
GimpPreviewArea implements
140
230
 AtkImplementorIface and  GtkBuildable.</p>
141
231
</div>
142
232
<div class="refsect1" lang="en">
143
 
<a name="id2635338"></a><h2>Properties</h2>
 
233
<a name="id2635778"></a><h2>Properties</h2>
144
234
<pre class="synopsis">
145
235
 
146
236
  "<a class="link" href="GimpPreviewArea.html#GimpPreviewArea--check-size">check-size</a>"               <a
152
242
</pre>
153
243
</div>
154
244
<div class="refsect1" lang="en">
155
 
<a name="id2635380"></a><h2>Description</h2>
 
245
<a name="id2640987"></a><h2>Description</h2>
156
246
<p>
157
247
A general purpose preview widget which caches its pixel data.
158
248
</p>
159
249
</div>
160
250
<div class="refsect1" lang="en">
161
 
<a name="id2635397"></a><h2>Details</h2>
 
251
<a name="id2641004"></a><h2>Details</h2>
162
252
<div class="refsect2" lang="en">
163
 
<a name="id2635408"></a><h3>
 
253
<a name="id2641015"></a><h3>
164
254
<a name="GimpPreviewArea-struct"></a>GimpPreviewArea</h3>
165
 
<a class="indexterm" name="id2635419"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
 
255
<a class="indexterm" name="id2641026"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
166
256
<p>
167
257
 
168
258
</p>
169
259
</div>
170
260
<hr>
171
261
<div class="refsect2" lang="en">
172
 
<a name="id2635436"></a><h3>
 
262
<a name="id2641043"></a><h3>
173
263
<a name="gimp-preview-area-new"></a>gimp_preview_area_new ()</h3>
174
 
<a class="indexterm" name="id2635447"></a><pre class="programlisting">GtkWidget*          gimp_preview_area_new               (void);</pre>
 
264
<a class="indexterm" name="id2641054"></a><pre class="programlisting"><a
 
265
href="../gtk/GtkWidget.html"
 
266
>GtkWidget</a>*          gimp_preview_area_new               (void);</pre>
175
267
<p>
176
268
Creates a new <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.</p>
177
269
<p>
190
282
</div>
191
283
<hr>
192
284
<div class="refsect2" lang="en">
193
 
<a name="id2635501"></a><h3>
 
285
<a name="id2641108"></a><h3>
194
286
<a name="gimp-preview-area-draw"></a>gimp_preview_area_draw ()</h3>
195
 
<a class="indexterm" name="id2635512"></a><pre class="programlisting">void                gimp_preview_area_draw              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
196
 
                                                         gint x,
197
 
                                                         gint y,
198
 
                                                         gint width,
199
 
                                                         gint height,
 
287
<a class="indexterm" name="id2641119"></a><pre class="programlisting">void                gimp_preview_area_draw              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
288
                                                         <a
 
289
href="../glib/glib-Basic-Types.html#gint"
 
290
>gint</a> x,
 
291
                                                         <a
 
292
href="../glib/glib-Basic-Types.html#gint"
 
293
>gint</a> y,
 
294
                                                         <a
 
295
href="../glib/glib-Basic-Types.html#gint"
 
296
>gint</a> width,
 
297
                                                         <a
 
298
href="../glib/glib-Basic-Types.html#gint"
 
299
>gint</a> height,
200
300
                                                         <a
201
301
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
202
302
>GimpImageType</a> type,
203
 
                                                         const guchar *buf,
204
 
                                                         gint rowstride);</pre>
 
303
                                                         const <a
 
304
href="../glib/glib-Basic-Types.html#guchar"
 
305
>guchar</a> *buf,
 
306
                                                         <a
 
307
href="../glib/glib-Basic-Types.html#gint"
 
308
>gint</a> rowstride);</pre>
205
309
<p>
206
310
Draws <em class="parameter"><code>buf</code></em> on <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
207
311
</p>
247
351
</tr>
248
352
<tr>
249
353
<td><p><span class="term"><em class="parameter"><code>buf</code></em>&#160;:</span></p></td>
250
 
<td>       a <span class="type">guchar</span> buffer that contains the preview pixel data.
 
354
<td>       a <a
 
355
href="../glib/glib-Basic-Types.html#guchar"
 
356
><span class="type">guchar</span></a> buffer that contains the preview pixel data.
251
357
</td>
252
358
</tr>
253
359
<tr>
260
366
</div>
261
367
<hr>
262
368
<div class="refsect2" lang="en">
263
 
<a name="id2647048"></a><h3>
 
369
<a name="id2647079"></a><h3>
264
370
<a name="gimp-preview-area-fill"></a>gimp_preview_area_fill ()</h3>
265
 
<a class="indexterm" name="id2647058"></a><pre class="programlisting">void                gimp_preview_area_fill              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
266
 
                                                         gint x,
267
 
                                                         gint y,
268
 
                                                         gint width,
269
 
                                                         gint height,
270
 
                                                         guchar red,
271
 
                                                         guchar green,
272
 
                                                         guchar blue);</pre>
 
371
<a class="indexterm" name="id2647089"></a><pre class="programlisting">void                gimp_preview_area_fill              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
372
                                                         <a
 
373
href="../glib/glib-Basic-Types.html#gint"
 
374
>gint</a> x,
 
375
                                                         <a
 
376
href="../glib/glib-Basic-Types.html#gint"
 
377
>gint</a> y,
 
378
                                                         <a
 
379
href="../glib/glib-Basic-Types.html#gint"
 
380
>gint</a> width,
 
381
                                                         <a
 
382
href="../glib/glib-Basic-Types.html#gint"
 
383
>gint</a> height,
 
384
                                                         <a
 
385
href="../glib/glib-Basic-Types.html#guchar"
 
386
>guchar</a> red,
 
387
                                                         <a
 
388
href="../glib/glib-Basic-Types.html#guchar"
 
389
>guchar</a> green,
 
390
                                                         <a
 
391
href="../glib/glib-Basic-Types.html#guchar"
 
392
>guchar</a> blue);</pre>
273
393
<p>
274
394
Fills the given rectangle of <em class="parameter"><code>area</code></em> in the given color and queues a
275
395
redraw.
327
447
</div>
328
448
<hr>
329
449
<div class="refsect2" lang="en">
330
 
<a name="id2647272"></a><h3>
 
450
<a name="id2647299"></a><h3>
331
451
<a name="gimp-preview-area-blend"></a>gimp_preview_area_blend ()</h3>
332
 
<a class="indexterm" name="id2647283"></a><pre class="programlisting">void                gimp_preview_area_blend             (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
333
 
                                                         gint x,
334
 
                                                         gint y,
335
 
                                                         gint width,
336
 
                                                         gint height,
 
452
<a class="indexterm" name="id2647311"></a><pre class="programlisting">void                gimp_preview_area_blend             (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
453
                                                         <a
 
454
href="../glib/glib-Basic-Types.html#gint"
 
455
>gint</a> x,
 
456
                                                         <a
 
457
href="../glib/glib-Basic-Types.html#gint"
 
458
>gint</a> y,
 
459
                                                         <a
 
460
href="../glib/glib-Basic-Types.html#gint"
 
461
>gint</a> width,
 
462
                                                         <a
 
463
href="../glib/glib-Basic-Types.html#gint"
 
464
>gint</a> height,
337
465
                                                         <a
338
466
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
339
467
>GimpImageType</a> type,
340
 
                                                         const guchar *buf1,
341
 
                                                         gint rowstride1,
342
 
                                                         const guchar *buf2,
343
 
                                                         gint rowstride2,
344
 
                                                         guchar opacity);</pre>
 
468
                                                         const <a
 
469
href="../glib/glib-Basic-Types.html#guchar"
 
470
>guchar</a> *buf1,
 
471
                                                         <a
 
472
href="../glib/glib-Basic-Types.html#gint"
 
473
>gint</a> rowstride1,
 
474
                                                         const <a
 
475
href="../glib/glib-Basic-Types.html#guchar"
 
476
>guchar</a> *buf2,
 
477
                                                         <a
 
478
href="../glib/glib-Basic-Types.html#gint"
 
479
>gint</a> rowstride2,
 
480
                                                         <a
 
481
href="../glib/glib-Basic-Types.html#guchar"
 
482
>guchar</a> opacity);</pre>
345
483
<p>
346
484
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>opacity</code></em>, draws the result
347
485
to <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
388
526
</tr>
389
527
<tr>
390
528
<td><p><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></p></td>
391
 
<td>       a <span class="type">guchar</span> buffer that contains the pixel data for
 
529
<td>       a <a
 
530
href="../glib/glib-Basic-Types.html#guchar"
 
531
><span class="type">guchar</span></a> buffer that contains the pixel data for
392
532
             the lower layer
393
533
</td>
394
534
</tr>
399
539
</tr>
400
540
<tr>
401
541
<td><p><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></p></td>
402
 
<td>       a <span class="type">guchar</span> buffer that contains the pixel data for
 
542
<td>       a <a
 
543
href="../glib/glib-Basic-Types.html#guchar"
 
544
><span class="type">guchar</span></a> buffer that contains the pixel data for
403
545
             the upper layer
404
546
</td>
405
547
</tr>
418
560
</div>
419
561
<hr>
420
562
<div class="refsect2" lang="en">
421
 
<a name="id2647630"></a><h3>
 
563
<a name="id2647658"></a><h3>
422
564
<a name="gimp-preview-area-mask"></a>gimp_preview_area_mask ()</h3>
423
 
<a class="indexterm" name="id2647641"></a><pre class="programlisting">void                gimp_preview_area_mask              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
424
 
                                                         gint x,
425
 
                                                         gint y,
426
 
                                                         gint width,
427
 
                                                         gint height,
 
565
<a class="indexterm" name="id2647669"></a><pre class="programlisting">void                gimp_preview_area_mask              (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
566
                                                         <a
 
567
href="../glib/glib-Basic-Types.html#gint"
 
568
>gint</a> x,
 
569
                                                         <a
 
570
href="../glib/glib-Basic-Types.html#gint"
 
571
>gint</a> y,
 
572
                                                         <a
 
573
href="../glib/glib-Basic-Types.html#gint"
 
574
>gint</a> width,
 
575
                                                         <a
 
576
href="../glib/glib-Basic-Types.html#gint"
 
577
>gint</a> height,
428
578
                                                         <a
429
579
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
430
580
>GimpImageType</a> type,
431
 
                                                         const guchar *buf1,
432
 
                                                         gint rowstride1,
433
 
                                                         const guchar *buf2,
434
 
                                                         gint rowstride2,
435
 
                                                         const guchar *mask,
436
 
                                                         gint rowstride_mask);</pre>
 
581
                                                         const <a
 
582
href="../glib/glib-Basic-Types.html#guchar"
 
583
>guchar</a> *buf1,
 
584
                                                         <a
 
585
href="../glib/glib-Basic-Types.html#gint"
 
586
>gint</a> rowstride1,
 
587
                                                         const <a
 
588
href="../glib/glib-Basic-Types.html#guchar"
 
589
>guchar</a> *buf2,
 
590
                                                         <a
 
591
href="../glib/glib-Basic-Types.html#gint"
 
592
>gint</a> rowstride2,
 
593
                                                         const <a
 
594
href="../glib/glib-Basic-Types.html#guchar"
 
595
>guchar</a> *mask,
 
596
                                                         <a
 
597
href="../glib/glib-Basic-Types.html#gint"
 
598
>gint</a> rowstride_mask);</pre>
437
599
<p>
438
600
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>mask</code></em>, draws the result on
439
601
<em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
480
642
</tr>
481
643
<tr>
482
644
<td><p><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></p></td>
483
 
<td>           a <span class="type">guchar</span> buffer that contains the pixel data for
 
645
<td>           a <a
 
646
href="../glib/glib-Basic-Types.html#guchar"
 
647
><span class="type">guchar</span></a> buffer that contains the pixel data for
484
648
                 the lower layer
485
649
</td>
486
650
</tr>
491
655
</tr>
492
656
<tr>
493
657
<td><p><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></p></td>
494
 
<td>           a <span class="type">guchar</span> buffer that contains the pixel data for
 
658
<td>           a <a
 
659
href="../glib/glib-Basic-Types.html#guchar"
 
660
><span class="type">guchar</span></a> buffer that contains the pixel data for
495
661
                 the upper layer
496
662
</td>
497
663
</tr>
502
668
</tr>
503
669
<tr>
504
670
<td><p><span class="term"><em class="parameter"><code>mask</code></em>&#160;:</span></p></td>
505
 
<td>           a <span class="type">guchar</span> buffer representing the mask of the second
 
671
<td>           a <a
 
672
href="../glib/glib-Basic-Types.html#guchar"
 
673
><span class="type">guchar</span></a> buffer representing the mask of the second
506
674
                 layer.
507
675
</td>
508
676
</tr>
516
684
</div>
517
685
<hr>
518
686
<div class="refsect2" lang="en">
519
 
<a name="id2648018"></a><h3>
 
687
<a name="id2648046"></a><h3>
520
688
<a name="gimp-preview-area-set-offsets"></a>gimp_preview_area_set_offsets ()</h3>
521
 
<a class="indexterm" name="id2648033"></a><pre class="programlisting">void                gimp_preview_area_set_offsets       (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
522
 
                                                         gint x,
523
 
                                                         gint y);</pre>
 
689
<a class="indexterm" name="id2648061"></a><pre class="programlisting">void                gimp_preview_area_set_offsets       (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
690
                                                         <a
 
691
href="../glib/glib-Basic-Types.html#gint"
 
692
>gint</a> x,
 
693
                                                         <a
 
694
href="../glib/glib-Basic-Types.html#gint"
 
695
>gint</a> y);</pre>
524
696
<p>
525
697
Sets the offsets of the previewed area. This information is used
526
698
when drawing the checkerboard and to determine the dither offsets.</p>
552
724
</div>
553
725
<hr>
554
726
<div class="refsect2" lang="en">
555
 
<a name="id2648142"></a><h3>
 
727
<a name="id2648170"></a><h3>
556
728
<a name="gimp-preview-area-set-colormap"></a>gimp_preview_area_set_colormap ()</h3>
557
 
<a class="indexterm" name="id2648155"></a><pre class="programlisting">void                gimp_preview_area_set_colormap      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
558
 
                                                         const guchar *colormap,
559
 
                                                         gint num_colors);</pre>
 
729
<a class="indexterm" name="id2648183"></a><pre class="programlisting">void                gimp_preview_area_set_colormap      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
730
                                                         const <a
 
731
href="../glib/glib-Basic-Types.html#guchar"
 
732
>guchar</a> *colormap,
 
733
                                                         <a
 
734
href="../glib/glib-Basic-Types.html#gint"
 
735
>gint</a> num_colors);</pre>
560
736
<p>
561
737
Sets the colormap for the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget. You need to
562
738
call this function before you use <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw"><code class="function">gimp_preview_area_draw()</code></a> with
577
753
</tr>
578
754
<tr>
579
755
<td><p><span class="term"><em class="parameter"><code>colormap</code></em>&#160;:</span></p></td>
580
 
<td>   a <span class="type">guchar</span> buffer that contains the colormap
 
756
<td>   a <a
 
757
href="../glib/glib-Basic-Types.html#guchar"
 
758
><span class="type">guchar</span></a> buffer that contains the colormap
581
759
</td>
582
760
</tr>
583
761
<tr>
590
768
</div>
591
769
<hr>
592
770
<div class="refsect2" lang="en">
593
 
<a name="id2648302"></a><h3>
 
771
<a name="id2648330"></a><h3>
594
772
<a name="gimp-preview-area-set-max-size"></a>gimp_preview_area_set_max_size ()</h3>
595
 
<a class="indexterm" name="id2648317"></a><pre class="programlisting">void                gimp_preview_area_set_max_size      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
596
 
                                                         gint width,
597
 
                                                         gint height);</pre>
 
773
<a class="indexterm" name="id2573202"></a><pre class="programlisting">void                gimp_preview_area_set_max_size      (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
774
                                                         <a
 
775
href="../glib/glib-Basic-Types.html#gint"
 
776
>gint</a> width,
 
777
                                                         <a
 
778
href="../glib/glib-Basic-Types.html#gint"
 
779
>gint</a> height);</pre>
598
780
<p>
599
781
Usually a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> fills the size that it is
600
782
allocated. This funtion allows you to limit the preview area to a
628
810
</div>
629
811
<hr>
630
812
<div class="refsect2" lang="en">
631
 
<a name="id2648409"></a><h3>
 
813
<a name="id2648435"></a><h3>
632
814
<a name="gimp-preview-area-menu-popup"></a>gimp_preview_area_menu_popup ()</h3>
633
 
<a class="indexterm" name="id2648424"></a><pre class="programlisting">void                gimp_preview_area_menu_popup        (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
634
 
                                                         GdkEventButton *event);</pre>
 
815
<a class="indexterm" name="id2648450"></a><pre class="programlisting">void                gimp_preview_area_menu_popup        (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
 
816
                                                         <a
 
817
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
 
818
>GdkEventButton</a> *event);</pre>
635
819
<p>
636
820
Creates a popup menu that allows to configure the size and type of
637
821
the checkerboard pattern that the <em class="parameter"><code>area</code></em> uses to visualize transparency.</p>
648
832
</tr>
649
833
<tr>
650
834
<td><p><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></p></td>
651
 
<td> the button event that causes the menu to popup or <code class="literal">NULL</code>
 
835
<td> the button event that causes the menu to popup or <a
 
836
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
 
837
><code class="literal">NULL</code></a>
652
838
</td>
653
839
</tr>
654
840
</tbody>
658
844
</div>
659
845
</div>
660
846
<div class="refsect1" lang="en">
661
 
<a name="id2648518"></a><h2>Property Details</h2>
 
847
<a name="id2648544"></a><h2>Property Details</h2>
662
848
<div class="refsect2" lang="en">
663
 
<a name="id2648527"></a><h3>
 
849
<a name="id2648553"></a><h3>
664
850
<a name="GimpPreviewArea--check-size"></a>The "<code class="literal">check-size</code>" property</h3>
665
 
<a class="indexterm" name="id2648540"></a><pre class="programlisting">  "check-size"               <a
 
851
<a class="indexterm" name="id2648566"></a><pre class="programlisting">  "check-size"               <a
666
852
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
667
853
>GimpCheckSize</a>         : Read / Write</pre>
668
854
<p></p>
670
856
</div>
671
857
<hr>
672
858
<div class="refsect2" lang="en">
673
 
<a name="id2648562"></a><h3>
 
859
<a name="id2648588"></a><h3>
674
860
<a name="GimpPreviewArea--check-type"></a>The "<code class="literal">check-type</code>" property</h3>
675
 
<a class="indexterm" name="id2648575"></a><pre class="programlisting">  "check-type"               <a
 
861
<a class="indexterm" name="id2648601"></a><pre class="programlisting">  "check-type"               <a
676
862
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
677
863
>GimpCheckType</a>         : Read / Write</pre>
678
864
<p></p>