← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimppreviewarea.xml
4
4
 
5
5
<refentry id="GimpPreviewArea">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpPreviewArea</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpPreviewArea</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
15
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
16
</refnamediv>
17
17
 
18
 
<refsynopsisdiv id="synopsis">
19
 
<title id="synopsis.title">Synopsis</title>
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
20
20
 
21
21
<synopsis>
22
22
 
23
23
 
24
24
 
25
 
            <link linkend="GimpPreviewArea-struct">GimpPreviewArea</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-preview-area-new">gimp_preview_area_new</link>           (void);
27
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-draw">gimp_preview_area_draw</link>          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
28
 
                                             <link linkend="gint">gint</link> x,
29
 
                                             <link linkend="gint">gint</link> y,
30
 
                                             <link linkend="gint">gint</link> width,
31
 
                                             <link linkend="gint">gint</link> height,
32
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
33
 
                                             const <link linkend="guchar">guchar</link> *buf,
34
 
                                             <link linkend="gint">gint</link> rowstride);
35
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-fill">gimp_preview_area_fill</link>          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
36
 
                                             <link linkend="gint">gint</link> x,
37
 
                                             <link linkend="gint">gint</link> y,
38
 
                                             <link linkend="gint">gint</link> width,
39
 
                                             <link linkend="gint">gint</link> height,
40
 
                                             <link linkend="guchar">guchar</link> red,
41
 
                                             <link linkend="guchar">guchar</link> green,
42
 
                                             <link linkend="guchar">guchar</link> blue);
43
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-blend">gimp_preview_area_blend</link>         (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
44
 
                                             <link linkend="gint">gint</link> x,
45
 
                                             <link linkend="gint">gint</link> y,
46
 
                                             <link linkend="gint">gint</link> width,
47
 
                                             <link linkend="gint">gint</link> height,
48
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
49
 
                                             const <link linkend="guchar">guchar</link> *buf1,
50
 
                                             <link linkend="gint">gint</link> rowstride1,
51
 
                                             const <link linkend="guchar">guchar</link> *buf2,
52
 
                                             <link linkend="gint">gint</link> rowstride2,
53
 
                                             <link linkend="guchar">guchar</link> opacity);
54
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-mask">gimp_preview_area_mask</link>          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
55
 
                                             <link linkend="gint">gint</link> x,
56
 
                                             <link linkend="gint">gint</link> y,
57
 
                                             <link linkend="gint">gint</link> width,
58
 
                                             <link linkend="gint">gint</link> height,
59
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
60
 
                                             const <link linkend="guchar">guchar</link> *buf1,
61
 
                                             <link linkend="gint">gint</link> rowstride1,
62
 
                                             const <link linkend="guchar">guchar</link> *buf2,
63
 
                                             <link linkend="gint">gint</link> rowstride2,
64
 
                                             const <link linkend="guchar">guchar</link> *mask,
65
 
                                             <link linkend="gint">gint</link> rowstride_mask);
66
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</link>   (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
67
 
                                             <link linkend="gint">gint</link> x,
68
 
                                             <link linkend="gint">gint</link> y);
69
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</link>  (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
70
 
                                             const <link linkend="guchar">guchar</link> *colormap,
71
 
                                             <link linkend="gint">gint</link> num_colors);
72
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</link>  (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
73
 
                                             <link linkend="gint">gint</link> width,
74
 
                                             <link linkend="gint">gint</link> height);
75
 
<link linkend="void">void</link>        <link linkend="gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</link>    (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
76
 
                                             <link linkend="GdkEventButton">GdkEventButton</link> *event);
 
25
                    <link linkend="GimpPreviewArea-struct">GimpPreviewArea</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-preview-area-new">gimp_preview_area_new</link>               (void);
 
27
<link linkend="void">void</link>                <link linkend="gimp-preview-area-draw">gimp_preview_area_draw</link>              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
28
                                                         <link linkend="gint">gint</link> x,
 
29
                                                         <link linkend="gint">gint</link> y,
 
30
                                                         <link linkend="gint">gint</link> width,
 
31
                                                         <link linkend="gint">gint</link> height,
 
32
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
33
                                                         const <link linkend="guchar">guchar</link> *buf,
 
34
                                                         <link linkend="gint">gint</link> rowstride);
 
35
<link linkend="void">void</link>                <link linkend="gimp-preview-area-fill">gimp_preview_area_fill</link>              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
36
                                                         <link linkend="gint">gint</link> x,
 
37
                                                         <link linkend="gint">gint</link> y,
 
38
                                                         <link linkend="gint">gint</link> width,
 
39
                                                         <link linkend="gint">gint</link> height,
 
40
                                                         <link linkend="guchar">guchar</link> red,
 
41
                                                         <link linkend="guchar">guchar</link> green,
 
42
                                                         <link linkend="guchar">guchar</link> blue);
 
43
<link linkend="void">void</link>                <link linkend="gimp-preview-area-blend">gimp_preview_area_blend</link>             (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
44
                                                         <link linkend="gint">gint</link> x,
 
45
                                                         <link linkend="gint">gint</link> y,
 
46
                                                         <link linkend="gint">gint</link> width,
 
47
                                                         <link linkend="gint">gint</link> height,
 
48
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
49
                                                         const <link linkend="guchar">guchar</link> *buf1,
 
50
                                                         <link linkend="gint">gint</link> rowstride1,
 
51
                                                         const <link linkend="guchar">guchar</link> *buf2,
 
52
                                                         <link linkend="gint">gint</link> rowstride2,
 
53
                                                         <link linkend="guchar">guchar</link> opacity);
 
54
<link linkend="void">void</link>                <link linkend="gimp-preview-area-mask">gimp_preview_area_mask</link>              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
55
                                                         <link linkend="gint">gint</link> x,
 
56
                                                         <link linkend="gint">gint</link> y,
 
57
                                                         <link linkend="gint">gint</link> width,
 
58
                                                         <link linkend="gint">gint</link> height,
 
59
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
60
                                                         const <link linkend="guchar">guchar</link> *buf1,
 
61
                                                         <link linkend="gint">gint</link> rowstride1,
 
62
                                                         const <link linkend="guchar">guchar</link> *buf2,
 
63
                                                         <link linkend="gint">gint</link> rowstride2,
 
64
                                                         const <link linkend="guchar">guchar</link> *mask,
 
65
                                                         <link linkend="gint">gint</link> rowstride_mask);
 
66
<link linkend="void">void</link>                <link linkend="gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</link>       (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
67
                                                         <link linkend="gint">gint</link> x,
 
68
                                                         <link linkend="gint">gint</link> y);
 
69
<link linkend="void">void</link>                <link linkend="gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</link>      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
70
                                                         const <link linkend="guchar">guchar</link> *colormap,
 
71
                                                         <link linkend="gint">gint</link> num_colors);
 
72
<link linkend="void">void</link>                <link linkend="gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</link>      (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
73
                                                         <link linkend="gint">gint</link> width,
 
74
                                                         <link linkend="gint">gint</link> height);
 
75
<link linkend="void">void</link>                <link linkend="gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</link>        (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
76
                                                         <link linkend="GdkEventButton">GdkEventButton</link> *event);
77
77
 
78
78
</synopsis>
79
79
</refsynopsisdiv>
80
80
 
81
 
<refsect1 id="object_hierarchy">
82
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
81
<refsect1 role="object_hierarchy">
 
82
<title role="object_hierarchy.title">Object Hierarchy</title>
83
83
<synopsis>
84
84
 
85
85
  <link linkend="GObject">GObject</link>
94
94
 
95
95
 
96
96
 
97
 
<refsect1 id="impl_interfaces">
98
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
97
<refsect1 role="impl_interfaces">
 
98
<title role="impl_interfaces.title">Implemented Interfaces</title>
99
99
<para>
100
100
GimpPreviewArea implements
101
101
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
103
103
</refsect1>
104
104
 
105
105
 
106
 
<refsect1 id="properties">
107
 
<title id="properties.title">Properties</title>
 
106
<refsect1 role="properties">
 
107
<title role="properties.title">Properties</title>
108
108
<synopsis>
109
109
 
110
 
  &quot;<link linkend="GimpPreviewArea--check-size">check-size</link>&quot;           <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write
111
 
  &quot;<link linkend="GimpPreviewArea--check-type">check-type</link>&quot;           <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write
 
110
  &quot;<link linkend="GimpPreviewArea--check-size">check-size</link>&quot;               <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write
 
111
  &quot;<link linkend="GimpPreviewArea--check-type">check-type</link>&quot;               <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write
112
112
</synopsis>
113
113
</refsect1>
114
114
 
115
115
 
116
116
 
117
 
<refsect1 id="desc">
118
 
<title id="desc.title">Description</title>
 
117
<refsect1 role="desc">
 
118
<title role="desc.title">Description</title>
119
119
<para>
120
120
A general purpose preview widget which caches its pixel data.
121
121
</para>
122
122
</refsect1>
123
123
 
124
 
<refsect1 id="details">
125
 
<title id="details.title">Details</title>
 
124
<refsect1 role="details">
 
125
<title role="details.title">Details</title>
126
126
<refsect2>
127
127
<title><anchor id="GimpPreviewArea-struct" role="struct"/>GimpPreviewArea</title>
128
128
<indexterm><primary>GimpPreviewArea</primary></indexterm><programlisting>typedef struct _GimpPreviewArea GimpPreviewArea;</programlisting>
131
131
</para></refsect2>
132
132
<refsect2>
133
133
<title><anchor id="gimp-preview-area-new" role="function"/>gimp_preview_area_new ()</title>
134
 
<indexterm><primary>gimp_preview_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_preview_area_new           (void);</programlisting>
 
134
<indexterm><primary>gimp_preview_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_preview_area_new               (void);</programlisting>
135
135
<para>
136
 
</para>
 
136
Creates a new <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.</para>
137
137
<para>
138
138
 
139
139
</para><variablelist role="params">
144
144
</variablelist></refsect2>
145
145
<refsect2>
146
146
<title><anchor id="gimp-preview-area-draw" role="function"/>gimp_preview_area_draw ()</title>
147
 
<indexterm><primary>gimp_preview_area_draw</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_area_draw          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
148
 
                                             <link linkend="gint">gint</link> x,
149
 
                                             <link linkend="gint">gint</link> y,
150
 
                                             <link linkend="gint">gint</link> width,
151
 
                                             <link linkend="gint">gint</link> height,
152
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
153
 
                                             const <link linkend="guchar">guchar</link> *buf,
154
 
                                             <link linkend="gint">gint</link> rowstride);</programlisting>
 
147
<indexterm><primary>gimp_preview_area_draw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_draw              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
148
                                                         <link linkend="gint">gint</link> x,
 
149
                                                         <link linkend="gint">gint</link> y,
 
150
                                                         <link linkend="gint">gint</link> width,
 
151
                                                         <link linkend="gint">gint</link> height,
 
152
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
153
                                                         const <link linkend="guchar">guchar</link> *buf,
 
154
                                                         <link linkend="gint">gint</link> rowstride);</programlisting>
155
155
<para>
156
156
Draws <parameter>buf</parameter> on <parameter>area</parameter> and queues a redraw on the given rectangle.
157
157
</para>
187
187
</variablelist></refsect2>
188
188
<refsect2>
189
189
<title><anchor id="gimp-preview-area-fill" role="function"/>gimp_preview_area_fill ()</title>
190
 
<indexterm><primary>gimp_preview_area_fill</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_area_fill          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
191
 
                                             <link linkend="gint">gint</link> x,
192
 
                                             <link linkend="gint">gint</link> y,
193
 
                                             <link linkend="gint">gint</link> width,
194
 
                                             <link linkend="gint">gint</link> height,
195
 
                                             <link linkend="guchar">guchar</link> red,
196
 
                                             <link linkend="guchar">guchar</link> green,
197
 
                                             <link linkend="guchar">guchar</link> blue);</programlisting>
 
190
<indexterm><primary>gimp_preview_area_fill</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_fill              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
191
                                                         <link linkend="gint">gint</link> x,
 
192
                                                         <link linkend="gint">gint</link> y,
 
193
                                                         <link linkend="gint">gint</link> width,
 
194
                                                         <link linkend="gint">gint</link> height,
 
195
                                                         <link linkend="guchar">guchar</link> red,
 
196
                                                         <link linkend="guchar">guchar</link> green,
 
197
                                                         <link linkend="guchar">guchar</link> blue);</programlisting>
198
198
<para>
199
 
Fills <parameter>area</parameter> in the given color and queues a redraw on the given
200
 
rectangle.
 
199
Fills the given rectangle of <parameter>area</parameter> in the given color and queues a
 
200
redraw.
201
201
</para>
202
202
<para>
203
203
Since GIMP 2.2</para>
214
214
<listitem><simpara>      y offset in preview
215
215
</simpara></listitem></varlistentry>
216
216
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
217
 
<listitem><simpara>  buffer width
 
217
<listitem><simpara>  width of the rectangle to fill
218
218
</simpara></listitem></varlistentry>
219
219
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
220
 
<listitem><simpara> buffer height
 
220
<listitem><simpara> height of the rectangle to fill
221
221
</simpara></listitem></varlistentry>
222
222
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
223
223
<listitem><simpara>    red component of the fill color (0-255)
231
231
</variablelist></refsect2>
232
232
<refsect2>
233
233
<title><anchor id="gimp-preview-area-blend" role="function"/>gimp_preview_area_blend ()</title>
234
 
<indexterm><primary>gimp_preview_area_blend</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_area_blend         (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
235
 
                                             <link linkend="gint">gint</link> x,
236
 
                                             <link linkend="gint">gint</link> y,
237
 
                                             <link linkend="gint">gint</link> width,
238
 
                                             <link linkend="gint">gint</link> height,
239
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
240
 
                                             const <link linkend="guchar">guchar</link> *buf1,
241
 
                                             <link linkend="gint">gint</link> rowstride1,
242
 
                                             const <link linkend="guchar">guchar</link> *buf2,
243
 
                                             <link linkend="gint">gint</link> rowstride2,
244
 
                                             <link linkend="guchar">guchar</link> opacity);</programlisting>
 
234
<indexterm><primary>gimp_preview_area_blend</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_blend             (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
235
                                                         <link linkend="gint">gint</link> x,
 
236
                                                         <link linkend="gint">gint</link> y,
 
237
                                                         <link linkend="gint">gint</link> width,
 
238
                                                         <link linkend="gint">gint</link> height,
 
239
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
240
                                                         const <link linkend="guchar">guchar</link> *buf1,
 
241
                                                         <link linkend="gint">gint</link> rowstride1,
 
242
                                                         const <link linkend="guchar">guchar</link> *buf2,
 
243
                                                         <link linkend="gint">gint</link> rowstride2,
 
244
                                                         <link linkend="guchar">guchar</link> opacity);</programlisting>
245
245
<para>
246
246
Composites <parameter>buf1</parameter> on <parameter>buf2</parameter> with the given <parameter>opacity</parameter>, draws the result
247
247
to <parameter>area</parameter> and queues a redraw on the given rectangle.
289
289
</variablelist></refsect2>
290
290
<refsect2>
291
291
<title><anchor id="gimp-preview-area-mask" role="function"/>gimp_preview_area_mask ()</title>
292
 
<indexterm><primary>gimp_preview_area_mask</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_area_mask          (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
293
 
                                             <link linkend="gint">gint</link> x,
294
 
                                             <link linkend="gint">gint</link> y,
295
 
                                             <link linkend="gint">gint</link> width,
296
 
                                             <link linkend="gint">gint</link> height,
297
 
                                             <link linkend="GimpImageType">GimpImageType</link> type,
298
 
                                             const <link linkend="guchar">guchar</link> *buf1,
299
 
                                             <link linkend="gint">gint</link> rowstride1,
300
 
                                             const <link linkend="guchar">guchar</link> *buf2,
301
 
                                             <link linkend="gint">gint</link> rowstride2,
302
 
                                             const <link linkend="guchar">guchar</link> *mask,
303
 
                                             <link linkend="gint">gint</link> rowstride_mask);</programlisting>
 
292
<indexterm><primary>gimp_preview_area_mask</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_area_mask              (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
 
293
                                                         <link linkend="gint">gint</link> x,
 
294
                                                         <link linkend="gint">gint</link> y,
 
295
                                                         <link linkend="gint">gint</link> width,
 
296
                                                         <link linkend="gint">gint</link> height,
 
297
                                                         <link linkend="GimpImageType">GimpImageType</link> type,
 
298
                                                         const <link linkend="guchar">guchar</link> *buf1,
 
299
                                                         <link linkend="gint">gint</link> rowstride1,
 
300
                                                         const <link linkend="guchar">guchar</link> *buf2,
 
301
                                                         <link linkend="gint">gint</link> rowstride2,
 
302
                                                         const <link linkend="guchar">guchar</link> *mask,
 
303
                                                         <link linkend="gint">gint</link> rowstride_mask);</programlisting>
304
304
<para>
305
305
Composites <parameter>buf1</parameter> on <parameter>buf2</parameter> with the given <parameter>mask</parameter>, draws the result on
306
306
<parameter>area</parameter> and queues a redraw on the given rectangle.
352
352
</variablelist></refsect2>
353
353
<refsect2>
354
354
<title><anchor id="gimp-preview-area-set-offsets" role="function" condition="since:GIMP 2.2"/>gimp_preview_area_set_offsets ()</title>
355
 
<indexterm 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,
356
 
                                             <link linkend="gint">gint</link> x,
357
 
                                             <link linkend="gint">gint</link> y);</programlisting>
 
355
<indexterm 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,
 
356
                                                         <link linkend="gint">gint</link> x,
 
357
                                                         <link linkend="gint">gint</link> y);</programlisting>
358
358
<para>
359
359
Sets the offsets of the previewed area. This information is used
360
360
when drawing the checkerboard and to determine the dither offsets.</para>
370
370
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
371
371
<listitem><simpara>    vertical offset
372
372
</simpara></listitem></varlistentry>
373
 
</variablelist><para>Since  GIMP 2.2
 
373
</variablelist><para role="since">Since  GIMP 2.2
374
374
</para></refsect2>
375
375
<refsect2>
376
376
<title><anchor id="gimp-preview-area-set-colormap" role="function"/>gimp_preview_area_set_colormap ()</title>
377
 
<indexterm><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,
378
 
                                             const <link linkend="guchar">guchar</link> *colormap,
379
 
                                             <link linkend="gint">gint</link> num_colors);</programlisting>
 
377
<indexterm><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,
 
378
                                                         const <link linkend="guchar">guchar</link> *colormap,
 
379
                                                         <link linkend="gint">gint</link> num_colors);</programlisting>
380
380
<para>
381
381
Sets the colormap for the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget. You need to
382
382
call this function before you use <link linkend="gimp-preview-area-draw"><function>gimp_preview_area_draw()</function></link> with
399
399
</variablelist></refsect2>
400
400
<refsect2>
401
401
<title><anchor id="gimp-preview-area-set-max-size" role="function" condition="since:GIMP 2.2"/>gimp_preview_area_set_max_size ()</title>
402
 
<indexterm 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,
403
 
                                             <link linkend="gint">gint</link> width,
404
 
                                             <link linkend="gint">gint</link> height);</programlisting>
 
402
<indexterm 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,
 
403
                                                         <link linkend="gint">gint</link> width,
 
404
                                                         <link linkend="gint">gint</link> height);</programlisting>
405
405
<para>
406
406
Usually a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> fills the size that it is
407
407
allocated. This funtion allows you to limit the preview area to a
419
419
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
420
420
<listitem><simpara> the maximum height in pixels or -1 to unset the limit
421
421
</simpara></listitem></varlistentry>
422
 
</variablelist><para>Since  GIMP 2.2
 
422
</variablelist><para role="since">Since  GIMP 2.2
423
423
</para></refsect2>
424
424
<refsect2>
425
425
<title><anchor id="gimp-preview-area-menu-popup" role="function" condition="since:GIMP 2.2"/>gimp_preview_area_menu_popup ()</title>
426
 
<indexterm 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,
427
 
                                             <link linkend="GdkEventButton">GdkEventButton</link> *event);</programlisting>
 
426
<indexterm 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,
 
427
                                                         <link linkend="GdkEventButton">GdkEventButton</link> *event);</programlisting>
428
428
<para>
429
429
Creates a popup menu that allows to configure the size and type of
430
430
the checkerboard pattern that the <parameter>area</parameter> uses to visualize transparency.</para>
437
437
<varlistentry><term><parameter>event</parameter>&nbsp;:</term>
438
438
<listitem><simpara> the button event that causes the menu to popup or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
439
439
</simpara></listitem></varlistentry>
440
 
</variablelist><para>Since  GIMP 2.2
 
440
</variablelist><para role="since">Since  GIMP 2.2
441
441
</para></refsect2>
442
442
 
443
443
</refsect1>
444
 
<refsect1 id="property_details">
445
 
<title id="property_details.title">Property Details</title>
 
444
<refsect1 role="property_details">
 
445
<title role="property_details.title">Property Details</title>
446
446
<refsect2><title><anchor id="GimpPreviewArea--check-size"/>The &quot;<literal>check-size</literal>&quot; property</title>
447
 
<indexterm><primary>GimpPreviewArea:check-size</primary></indexterm><programlisting>  &quot;check-size&quot;           <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write</programlisting>
 
447
<indexterm><primary>GimpPreviewArea:check-size</primary></indexterm><programlisting>  &quot;check-size&quot;               <link linkend="GimpCheckSize">GimpCheckSize</link>         : Read / Write</programlisting>
448
448
<para></para><para>Default value: GIMP_CHECK_SIZE_MEDIUM_CHECKS</para>
449
449
</refsect2>
450
450
<refsect2><title><anchor id="GimpPreviewArea--check-type"/>The &quot;<literal>check-type</literal>&quot; property</title>
451
 
<indexterm><primary>GimpPreviewArea:check-type</primary></indexterm><programlisting>  &quot;check-type&quot;           <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write</programlisting>
 
451
<indexterm><primary>GimpPreviewArea:check-type</primary></indexterm><programlisting>  &quot;check-type&quot;               <link linkend="GimpCheckType">GimpCheckType</link>         : Read / Write</programlisting>
452
452
<para></para><para>Default value: GIMP_CHECK_TYPE_GRAY_CHECKS</para>
453
453
</refsect2>
454
454