← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimppreviewarea.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppreviewarea.xml
12
12
<refnamediv>
13
13
<refname>GimpPreviewArea</refname>
14
14
<refpurpose>A general purpose preview widget which caches its pixel data.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpPreviewArea.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpPreviewArea-struct">GimpPreviewArea</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-preview-area-new">gimp_preview_area_new</link>               (void);
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-preview-area-new">gimp_preview_area_new</link>               (void);
24
23
<link linkend="void">void</link>                <link linkend="gimp-preview-area-draw">gimp_preview_area_draw</link>              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
25
24
                                                         <link linkend="gint">gint</link> x,
26
25
                                                         <link linkend="gint">gint</link> y,
84
83
                     +----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
85
84
                           +----GimpPreviewArea
86
85
</synopsis>
87
 
 
88
86
</refsect1>
89
87
 
90
88
 
93
91
<title role="impl_interfaces.title">Implemented Interfaces</title>
94
92
<para>
95
93
GimpPreviewArea implements
96
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
97
 
 
 
94
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
98
95
</refsect1>
99
96
 
100
97
 
119
116
<title role="details.title">Details</title>
120
117
<refsect2 id="GimpPreviewArea-struct" role="struct">
121
118
<title>GimpPreviewArea</title>
122
 
<indexterm zone="GimpPreviewArea-struct"><primary>GimpPreviewArea</primary></indexterm><programlisting>typedef struct _GimpPreviewArea GimpPreviewArea;</programlisting>
 
119
<indexterm zone="GimpPreviewArea-struct"><primary sortas="GimpPreviewArea">GimpPreviewArea</primary></indexterm><programlisting>typedef struct _GimpPreviewArea GimpPreviewArea;</programlisting>
123
120
<para>
124
 
 
125
121
</para></refsect2>
126
122
<refsect2 id="gimp-preview-area-new" role="function">
127
123
<title>gimp_preview_area_new ()</title>
128
 
<indexterm zone="gimp-preview-area-new"><primary>gimp_preview_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_preview_area_new               (void);</programlisting>
 
124
<indexterm zone="gimp-preview-area-new"><primary sortas="gimp_preview_area_new">gimp_preview_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_preview_area_new               (void);</programlisting>
129
125
<para>
130
126
Creates a new <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.</para>
131
127
<para>
132
 
 
133
128
</para><variablelist role="params">
134
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
 
129
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
135
130
 
136
131
Since GIMP 2.2
137
132
</simpara></listitem></varlistentry>
138
133
</variablelist></refsect2>
139
134
<refsect2 id="gimp-preview-area-draw" role="function">
140
135
<title>gimp_preview_area_draw ()</title>
141
 
<indexterm zone="gimp-preview-area-draw"><primary>gimp_preview_area_draw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_draw              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
136
<indexterm zone="gimp-preview-area-draw"><primary sortas="gimp_preview_area_draw">gimp_preview_area_draw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_draw              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
142
137
                                                         <link linkend="gint">gint</link> x,
143
138
                                                         <link linkend="gint">gint</link> y,
144
139
                                                         <link linkend="gint">gint</link> width,
152
147
<para>
153
148
Since GIMP 2.2</para>
154
149
<para>
155
 
 
156
150
</para><variablelist role="params">
157
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
151
<varlistentry><term><parameter>area</parameter>&#160;:</term>
158
152
<listitem><simpara>      a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
159
153
</simpara></listitem></varlistentry>
160
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
154
<varlistentry><term><parameter>x</parameter>&#160;:</term>
161
155
<listitem><simpara>         x offset in preview
162
156
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
157
<varlistentry><term><parameter>y</parameter>&#160;:</term>
164
158
<listitem><simpara>         y offset in preview
165
159
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
160
<varlistentry><term><parameter>width</parameter>&#160;:</term>
167
161
<listitem><simpara>     buffer width
168
162
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
163
<varlistentry><term><parameter>height</parameter>&#160;:</term>
170
164
<listitem><simpara>    buffer height
171
165
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
166
<varlistentry><term><parameter>type</parameter>&#160;:</term>
173
167
<listitem><simpara>      the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf</parameter>
174
168
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><parameter>buf</parameter>&nbsp;:</term>
 
169
<varlistentry><term><parameter>buf</parameter>&#160;:</term>
176
170
<listitem><simpara>       a <link linkend="guchar"><type>guchar</type></link> buffer that contains the preview pixel data.
177
171
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><parameter>rowstride</parameter>&nbsp;:</term>
 
172
<varlistentry><term><parameter>rowstride</parameter>&#160;:</term>
179
173
<listitem><simpara> rowstride of <parameter>buf</parameter>
180
174
</simpara></listitem></varlistentry>
181
175
</variablelist></refsect2>
182
176
<refsect2 id="gimp-preview-area-fill" role="function">
183
177
<title>gimp_preview_area_fill ()</title>
184
 
<indexterm zone="gimp-preview-area-fill"><primary>gimp_preview_area_fill</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_fill              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
178
<indexterm zone="gimp-preview-area-fill"><primary sortas="gimp_preview_area_fill">gimp_preview_area_fill</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_fill              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
185
179
                                                         <link linkend="gint">gint</link> x,
186
180
                                                         <link linkend="gint">gint</link> y,
187
181
                                                         <link linkend="gint">gint</link> width,
196
190
<para>
197
191
Since GIMP 2.2</para>
198
192
<para>
199
 
 
200
193
</para><variablelist role="params">
201
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
194
<varlistentry><term><parameter>area</parameter>&#160;:</term>
202
195
<listitem><simpara>   a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
203
196
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
197
<varlistentry><term><parameter>x</parameter>&#160;:</term>
205
198
<listitem><simpara>      x offset in preview
206
199
</simpara></listitem></varlistentry>
207
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
200
<varlistentry><term><parameter>y</parameter>&#160;:</term>
208
201
<listitem><simpara>      y offset in preview
209
202
</simpara></listitem></varlistentry>
210
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
203
<varlistentry><term><parameter>width</parameter>&#160;:</term>
211
204
<listitem><simpara>  width of the rectangle to fill
212
205
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
206
<varlistentry><term><parameter>height</parameter>&#160;:</term>
214
207
<listitem><simpara> height of the rectangle to fill
215
208
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
 
209
<varlistentry><term><parameter>red</parameter>&#160;:</term>
217
210
<listitem><simpara>    red component of the fill color (0-255)
218
211
</simpara></listitem></varlistentry>
219
 
<varlistentry><term><parameter>green</parameter>&nbsp;:</term>
 
212
<varlistentry><term><parameter>green</parameter>&#160;:</term>
220
213
<listitem><simpara>  green component of the fill color (0-255)
221
214
</simpara></listitem></varlistentry>
222
 
<varlistentry><term><parameter>blue</parameter>&nbsp;:</term>
 
215
<varlistentry><term><parameter>blue</parameter>&#160;:</term>
223
216
<listitem><simpara>   red component of the fill color (0-255)
224
217
</simpara></listitem></varlistentry>
225
218
</variablelist></refsect2>
226
219
<refsect2 id="gimp-preview-area-blend" role="function">
227
220
<title>gimp_preview_area_blend ()</title>
228
 
<indexterm zone="gimp-preview-area-blend"><primary>gimp_preview_area_blend</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_blend             (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
221
<indexterm zone="gimp-preview-area-blend"><primary sortas="gimp_preview_area_blend">gimp_preview_area_blend</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_blend             (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
229
222
                                                         <link linkend="gint">gint</link> x,
230
223
                                                         <link linkend="gint">gint</link> y,
231
224
                                                         <link linkend="gint">gint</link> width,
243
236
<para>
244
237
Since GIMP 2.2</para>
245
238
<para>
246
 
 
247
239
</para><variablelist role="params">
248
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
240
<varlistentry><term><parameter>area</parameter>&#160;:</term>
249
241
<listitem><simpara>       a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
250
242
</simpara></listitem></varlistentry>
251
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
243
<varlistentry><term><parameter>x</parameter>&#160;:</term>
252
244
<listitem><simpara>          x offset in preview
253
245
</simpara></listitem></varlistentry>
254
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
246
<varlistentry><term><parameter>y</parameter>&#160;:</term>
255
247
<listitem><simpara>          y offset in preview
256
248
</simpara></listitem></varlistentry>
257
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
249
<varlistentry><term><parameter>width</parameter>&#160;:</term>
258
250
<listitem><simpara>      buffer width
259
251
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
252
<varlistentry><term><parameter>height</parameter>&#160;:</term>
261
253
<listitem><simpara>     buffer height
262
254
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
255
<varlistentry><term><parameter>type</parameter>&#160;:</term>
264
256
<listitem><simpara>       the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf1</parameter> and <parameter>buf2</parameter>
265
257
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><parameter>buf1</parameter>&nbsp;:</term>
 
258
<varlistentry><term><parameter>buf1</parameter>&#160;:</term>
267
259
<listitem><simpara>       a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
268
260
             the lower layer
269
261
</simpara></listitem></varlistentry>
270
 
<varlistentry><term><parameter>rowstride1</parameter>&nbsp;:</term>
 
262
<varlistentry><term><parameter>rowstride1</parameter>&#160;:</term>
271
263
<listitem><simpara> rowstride of <parameter>buf1</parameter>
272
264
</simpara></listitem></varlistentry>
273
 
<varlistentry><term><parameter>buf2</parameter>&nbsp;:</term>
 
265
<varlistentry><term><parameter>buf2</parameter>&#160;:</term>
274
266
<listitem><simpara>       a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
275
267
             the upper layer
276
268
</simpara></listitem></varlistentry>
277
 
<varlistentry><term><parameter>rowstride2</parameter>&nbsp;:</term>
 
269
<varlistentry><term><parameter>rowstride2</parameter>&#160;:</term>
278
270
<listitem><simpara> rowstride of <parameter>buf2</parameter>
279
271
</simpara></listitem></varlistentry>
280
 
<varlistentry><term><parameter>opacity</parameter>&nbsp;:</term>
 
272
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
281
273
<listitem><simpara>    The opacity of the first layer.
282
274
</simpara></listitem></varlistentry>
283
275
</variablelist></refsect2>
284
276
<refsect2 id="gimp-preview-area-mask" role="function">
285
277
<title>gimp_preview_area_mask ()</title>
286
 
<indexterm zone="gimp-preview-area-mask"><primary>gimp_preview_area_mask</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_mask              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
278
<indexterm zone="gimp-preview-area-mask"><primary sortas="gimp_preview_area_mask">gimp_preview_area_mask</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_mask              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
287
279
                                                         <link linkend="gint">gint</link> x,
288
280
                                                         <link linkend="gint">gint</link> y,
289
281
                                                         <link linkend="gint">gint</link> width,
302
294
<para>
303
295
Since GIMP 2.2</para>
304
296
<para>
305
 
 
306
297
</para><variablelist role="params">
307
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
298
<varlistentry><term><parameter>area</parameter>&#160;:</term>
308
299
<listitem><simpara>           a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
309
300
</simpara></listitem></varlistentry>
310
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
301
<varlistentry><term><parameter>x</parameter>&#160;:</term>
311
302
<listitem><simpara>              x offset in preview
312
303
</simpara></listitem></varlistentry>
313
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
304
<varlistentry><term><parameter>y</parameter>&#160;:</term>
314
305
<listitem><simpara>              y offset in preview
315
306
</simpara></listitem></varlistentry>
316
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
307
<varlistentry><term><parameter>width</parameter>&#160;:</term>
317
308
<listitem><simpara>          buffer width
318
309
</simpara></listitem></varlistentry>
319
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
310
<varlistentry><term><parameter>height</parameter>&#160;:</term>
320
311
<listitem><simpara>         buffer height
321
312
</simpara></listitem></varlistentry>
322
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
313
<varlistentry><term><parameter>type</parameter>&#160;:</term>
323
314
<listitem><simpara>           the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf1</parameter> and <parameter>buf2</parameter>
324
315
</simpara></listitem></varlistentry>
325
 
<varlistentry><term><parameter>buf1</parameter>&nbsp;:</term>
 
316
<varlistentry><term><parameter>buf1</parameter>&#160;:</term>
326
317
<listitem><simpara>           a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
327
318
                 the lower layer
328
319
</simpara></listitem></varlistentry>
329
 
<varlistentry><term><parameter>rowstride1</parameter>&nbsp;:</term>
 
320
<varlistentry><term><parameter>rowstride1</parameter>&#160;:</term>
330
321
<listitem><simpara>     rowstride of <parameter>buf1</parameter>
331
322
</simpara></listitem></varlistentry>
332
 
<varlistentry><term><parameter>buf2</parameter>&nbsp;:</term>
 
323
<varlistentry><term><parameter>buf2</parameter>&#160;:</term>
333
324
<listitem><simpara>           a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
334
325
                 the upper layer
335
326
</simpara></listitem></varlistentry>
336
 
<varlistentry><term><parameter>rowstride2</parameter>&nbsp;:</term>
 
327
<varlistentry><term><parameter>rowstride2</parameter>&#160;:</term>
337
328
<listitem><simpara>     rowstride of <parameter>buf2</parameter>
338
329
</simpara></listitem></varlistentry>
339
 
<varlistentry><term><parameter>mask</parameter>&nbsp;:</term>
 
330
<varlistentry><term><parameter>mask</parameter>&#160;:</term>
340
331
<listitem><simpara>           a <link linkend="guchar"><type>guchar</type></link> buffer representing the mask of the second
341
332
                 layer.
342
333
</simpara></listitem></varlistentry>
343
 
<varlistentry><term><parameter>rowstride_mask</parameter>&nbsp;:</term>
 
334
<varlistentry><term><parameter>rowstride_mask</parameter>&#160;:</term>
344
335
<listitem><simpara> rowstride for the mask.
345
336
</simpara></listitem></varlistentry>
346
337
</variablelist></refsect2>
347
338
<refsect2 id="gimp-preview-area-set-offsets" role="function" condition="since:GIMP 2.2">
348
339
<title>gimp_preview_area_set_offsets ()</title>
349
 
<indexterm zone="gimp-preview-area-set-offsets" role="GIMP 2.2"><primary>gimp_preview_area_set_offsets</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_offsets       (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
340
<indexterm zone="gimp-preview-area-set-offsets" role="GIMP 2.2"><primary sortas="gimp_preview_area_set_offsets">gimp_preview_area_set_offsets</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_offsets       (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
350
341
                                                         <link linkend="gint">gint</link> x,
351
342
                                                         <link linkend="gint">gint</link> y);</programlisting>
352
343
<para>
353
344
Sets the offsets of the previewed area. This information is used
354
345
when drawing the checkerboard and to determine the dither offsets.</para>
355
346
<para>
356
 
 
357
347
</para><variablelist role="params">
358
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
348
<varlistentry><term><parameter>area</parameter>&#160;:</term>
359
349
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
360
350
</simpara></listitem></varlistentry>
361
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
351
<varlistentry><term><parameter>x</parameter>&#160;:</term>
362
352
<listitem><simpara>    horizontal offset
363
353
</simpara></listitem></varlistentry>
364
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
354
<varlistentry><term><parameter>y</parameter>&#160;:</term>
365
355
<listitem><simpara>    vertical offset
366
356
</simpara></listitem></varlistentry>
367
 
</variablelist><para role="since">Since  GIMP 2.2
368
 
</para></refsect2>
 
357
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
369
358
<refsect2 id="gimp-preview-area-set-colormap" role="function">
370
359
<title>gimp_preview_area_set_colormap ()</title>
371
 
<indexterm zone="gimp-preview-area-set-colormap"><primary>gimp_preview_area_set_colormap</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_colormap      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
360
<indexterm zone="gimp-preview-area-set-colormap"><primary sortas="gimp_preview_area_set_colormap">gimp_preview_area_set_colormap</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_colormap      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
372
361
                                                         const <link linkend="guchar">guchar</link> *colormap,
373
362
                                                         <link linkend="gint">gint</link> num_colors);</programlisting>
374
363
<para>
375
364
Sets the colormap for the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget. You need to
376
365
call this function before you use <link linkend="gimp-preview-area-draw"><function>gimp_preview_area_draw()</function></link> with
377
 
an image type of <link linkend="GIMP-INDEXED-IMAGE:CAPS"><literal>GIMP_INDEXED_IMAGE</literal></link> or <link linkend="GIMP-INDEXEDA-IMAGE:CAPS"><literal>GIMP_INDEXEDA_IMAGE</literal></link>.
 
366
an image type of <link linkend="GIMP-INDEXED-IMAGE--CAPS"><literal>GIMP_INDEXED_IMAGE</literal></link> or <link linkend="GIMP-INDEXEDA-IMAGE--CAPS"><literal>GIMP_INDEXEDA_IMAGE</literal></link>.
378
367
</para>
379
368
<para>
380
369
Since GIMP 2.2</para>
381
370
<para>
382
 
 
383
371
</para><variablelist role="params">
384
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
372
<varlistentry><term><parameter>area</parameter>&#160;:</term>
385
373
<listitem><simpara>       a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
386
374
</simpara></listitem></varlistentry>
387
 
<varlistentry><term><parameter>colormap</parameter>&nbsp;:</term>
 
375
<varlistentry><term><parameter>colormap</parameter>&#160;:</term>
388
376
<listitem><simpara>   a <link linkend="guchar"><type>guchar</type></link> buffer that contains the colormap
389
377
</simpara></listitem></varlistentry>
390
 
<varlistentry><term><parameter>num_colors</parameter>&nbsp;:</term>
 
378
<varlistentry><term><parameter>num_colors</parameter>&#160;:</term>
391
379
<listitem><simpara> the number of colors in the colormap
392
380
</simpara></listitem></varlistentry>
393
381
</variablelist></refsect2>
394
382
<refsect2 id="gimp-preview-area-set-max-size" role="function" condition="since:GIMP 2.2">
395
383
<title>gimp_preview_area_set_max_size ()</title>
396
 
<indexterm zone="gimp-preview-area-set-max-size" role="GIMP 2.2"><primary>gimp_preview_area_set_max_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_max_size      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
384
<indexterm zone="gimp-preview-area-set-max-size" role="GIMP 2.2"><primary sortas="gimp_preview_area_set_max_size">gimp_preview_area_set_max_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_set_max_size      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
397
385
                                                         <link linkend="gint">gint</link> width,
398
386
                                                         <link linkend="gint">gint</link> height);</programlisting>
399
387
<para>
402
390
maximum size. If a larger size is allocated for the widget, the
403
391
preview will draw itself centered into the allocated area.</para>
404
392
<para>
405
 
 
406
393
</para><variablelist role="params">
407
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
394
<varlistentry><term><parameter>area</parameter>&#160;:</term>
408
395
<listitem><simpara>   a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget
409
396
</simpara></listitem></varlistentry>
410
 
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
 
397
<varlistentry><term><parameter>width</parameter>&#160;:</term>
411
398
<listitem><simpara>  the maximum width in pixels or -1 to unset the limit
412
399
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
 
400
<varlistentry><term><parameter>height</parameter>&#160;:</term>
414
401
<listitem><simpara> the maximum height in pixels or -1 to unset the limit
415
402
</simpara></listitem></varlistentry>
416
 
</variablelist><para role="since">Since  GIMP 2.2
417
 
</para></refsect2>
 
403
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
418
404
<refsect2 id="gimp-preview-area-menu-popup" role="function" condition="since:GIMP 2.2">
419
405
<title>gimp_preview_area_menu_popup ()</title>
420
 
<indexterm zone="gimp-preview-area-menu-popup" role="GIMP 2.2"><primary>gimp_preview_area_menu_popup</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_menu_popup        (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
406
<indexterm zone="gimp-preview-area-menu-popup" role="GIMP 2.2"><primary sortas="gimp_preview_area_menu_popup">gimp_preview_area_menu_popup</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_menu_popup        (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
421
407
                                                         <link linkend="GdkEventButton">GdkEventButton</link> *event);</programlisting>
422
408
<para>
423
409
Creates a popup menu that allows to configure the size and type of
424
410
the checkerboard pattern that the <parameter>area</parameter> uses to visualize transparency.</para>
425
411
<para>
426
 
 
427
412
</para><variablelist role="params">
428
 
<varlistentry><term><parameter>area</parameter>&nbsp;:</term>
 
413
<varlistentry><term><parameter>area</parameter>&#160;:</term>
429
414
<listitem><simpara>  a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
430
415
</simpara></listitem></varlistentry>
431
 
<varlistentry><term><parameter>event</parameter>&nbsp;:</term>
432
 
<listitem><simpara> the button event that causes the menu to popup or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
416
<varlistentry><term><parameter>event</parameter>&#160;:</term>
 
417
<listitem><simpara> the button event that causes the menu to popup or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
433
418
</simpara></listitem></varlistentry>
434
 
</variablelist><para role="since">Since  GIMP 2.2
435
 
</para></refsect2>
 
419
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
436
420
 
437
421
</refsect1>
438
422
<refsect1 id="GimpPreviewArea.property-details" role="property_details">
439
423
<title role="property_details.title">Property Details</title>
440
 
<refsect2 id="GimpPreviewArea--check-size"><title>The <literal>&quot;check-size&quot;</literal> property</title>
441
 
<indexterm zone="GimpPreviewArea--check-size"><primary>GimpPreviewArea:check-size</primary></indexterm><programlisting>  &quot;check-size&quot;               <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write</programlisting>
 
424
<refsect2 id="GimpPreviewArea--check-size" role="property"><title>The <literal>&quot;check-size&quot;</literal> property</title>
 
425
<indexterm zone="GimpPreviewArea--check-size"><primary sortas="GimpPreviewArea:check-size">GimpPreviewArea:check-size</primary></indexterm><programlisting>  &quot;check-size&quot;               <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write</programlisting>
442
426
<para></para><para>Default value: GIMP_CHECK_SIZE_MEDIUM_CHECKS</para>
443
427
</refsect2>
444
 
<refsect2 id="GimpPreviewArea--check-type"><title>The <literal>&quot;check-type&quot;</literal> property</title>
445
 
<indexterm zone="GimpPreviewArea--check-type"><primary>GimpPreviewArea:check-type</primary></indexterm><programlisting>  &quot;check-type&quot;               <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write</programlisting>
 
428
<refsect2 id="GimpPreviewArea--check-type" role="property"><title>The <literal>&quot;check-type&quot;</literal> property</title>
 
429
<indexterm zone="GimpPreviewArea--check-type"><primary sortas="GimpPreviewArea:check-type">GimpPreviewArea:check-type</primary></indexterm><programlisting>  &quot;check-type&quot;               <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write</programlisting>
446
430
<para></para><para>Default value: GIMP_CHECK_TYPE_GRAY_CHECKS</para>
447
431
</refsect2>
448
 
 
449
432
</refsect1>
450
433
 
451
434