← 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/gimppreview.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/gimppreview.xml
4
4
 
5
5
<refentry id="GimpPreview">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpPreview</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpPreview</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="GimpPreview-struct">GimpPreview</link>;
26
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-preview-get-update">gimp_preview_get_update</link>         (<link linkend="GimpPreview">GimpPreview</link> *preview);
27
 
<link linkend="void">void</link>        <link linkend="gimp-preview-set-update">gimp_preview_set_update</link>         (<link linkend="GimpPreview">GimpPreview</link> *preview,
28
 
                                             <link linkend="gboolean">gboolean</link> update);
29
 
<link linkend="void">void</link>        <link linkend="gimp-preview-set-bounds">gimp_preview_set_bounds</link>         (<link linkend="GimpPreview">GimpPreview</link> *preview,
30
 
                                             <link linkend="gint">gint</link> xmin,
31
 
                                             <link linkend="gint">gint</link> ymin,
32
 
                                             <link linkend="gint">gint</link> xmax,
33
 
                                             <link linkend="gint">gint</link> ymax);
34
 
<link linkend="void">void</link>        <link linkend="gimp-preview-get-size">gimp_preview_get_size</link>           (<link linkend="GimpPreview">GimpPreview</link> *preview,
35
 
                                             <link linkend="gint">gint</link> *width,
36
 
                                             <link linkend="gint">gint</link> *height);
37
 
<link linkend="void">void</link>        <link linkend="gimp-preview-get-position">gimp_preview_get_position</link>       (<link linkend="GimpPreview">GimpPreview</link> *preview,
38
 
                                             <link linkend="gint">gint</link> *x,
39
 
                                             <link linkend="gint">gint</link> *y);
40
 
<link linkend="void">void</link>        <link linkend="gimp-preview-draw">gimp_preview_draw</link>               (<link linkend="GimpPreview">GimpPreview</link> *preview);
41
 
<link linkend="void">void</link>        <link linkend="gimp-preview-draw-buffer">gimp_preview_draw_buffer</link>        (<link linkend="GimpPreview">GimpPreview</link> *preview,
42
 
                                             const <link linkend="guchar">guchar</link> *buffer,
43
 
                                             <link linkend="gint">gint</link> rowstride);
44
 
<link linkend="void">void</link>        <link linkend="gimp-preview-invalidate">gimp_preview_invalidate</link>         (<link linkend="GimpPreview">GimpPreview</link> *preview);
45
 
<link linkend="void">void</link>        <link linkend="gimp-preview-set-default-cursor">gimp_preview_set_default_cursor</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
46
 
                                             <link linkend="GdkCursor">GdkCursor</link> *cursor);
 
25
                    <link linkend="GimpPreview-struct">GimpPreview</link>;
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-preview-get-update">gimp_preview_get_update</link>             (<link linkend="GimpPreview">GimpPreview</link> *preview);
 
27
<link linkend="void">void</link>                <link linkend="gimp-preview-set-update">gimp_preview_set_update</link>             (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
28
                                                         <link linkend="gboolean">gboolean</link> update);
 
29
<link linkend="void">void</link>                <link linkend="gimp-preview-set-bounds">gimp_preview_set_bounds</link>             (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
30
                                                         <link linkend="gint">gint</link> xmin,
 
31
                                                         <link linkend="gint">gint</link> ymin,
 
32
                                                         <link linkend="gint">gint</link> xmax,
 
33
                                                         <link linkend="gint">gint</link> ymax);
 
34
<link linkend="void">void</link>                <link linkend="gimp-preview-get-size">gimp_preview_get_size</link>               (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
35
                                                         <link linkend="gint">gint</link> *width,
 
36
                                                         <link linkend="gint">gint</link> *height);
 
37
<link linkend="void">void</link>                <link linkend="gimp-preview-get-position">gimp_preview_get_position</link>           (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
38
                                                         <link linkend="gint">gint</link> *x,
 
39
                                                         <link linkend="gint">gint</link> *y);
 
40
<link linkend="void">void</link>                <link linkend="gimp-preview-transform">gimp_preview_transform</link>              (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
41
                                                         <link linkend="gint">gint</link> src_x,
 
42
                                                         <link linkend="gint">gint</link> src_y,
 
43
                                                         <link linkend="gint">gint</link> *dest_x,
 
44
                                                         <link linkend="gint">gint</link> *dest_y);
 
45
<link linkend="void">void</link>                <link linkend="gimp-preview-untransform">gimp_preview_untransform</link>            (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
46
                                                         <link linkend="gint">gint</link> src_x,
 
47
                                                         <link linkend="gint">gint</link> src_y,
 
48
                                                         <link linkend="gint">gint</link> *dest_x,
 
49
                                                         <link linkend="gint">gint</link> *dest_y);
 
50
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-preview-get-area">gimp_preview_get_area</link>               (<link linkend="GimpPreview">GimpPreview</link> *preview);
 
51
<link linkend="void">void</link>                <link linkend="gimp-preview-draw">gimp_preview_draw</link>                   (<link linkend="GimpPreview">GimpPreview</link> *preview);
 
52
<link linkend="void">void</link>                <link linkend="gimp-preview-draw-buffer">gimp_preview_draw_buffer</link>            (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
53
                                                         const <link linkend="guchar">guchar</link> *buffer,
 
54
                                                         <link linkend="gint">gint</link> rowstride);
 
55
<link linkend="void">void</link>                <link linkend="gimp-preview-invalidate">gimp_preview_invalidate</link>             (<link linkend="GimpPreview">GimpPreview</link> *preview);
 
56
<link linkend="void">void</link>                <link linkend="gimp-preview-set-default-cursor">gimp_preview_set_default_cursor</link>     (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
57
                                                         <link linkend="GdkCursor">GdkCursor</link> *cursor);
 
58
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-preview-get-controls">gimp_preview_get_controls</link>           (<link linkend="GimpPreview">GimpPreview</link> *preview);
47
59
 
48
60
</synopsis>
49
61
</refsynopsisdiv>
50
62
 
51
 
<refsect1 id="object_hierarchy">
52
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
63
<refsect1 role="object_hierarchy">
 
64
<title role="object_hierarchy.title">Object Hierarchy</title>
53
65
<synopsis>
54
66
 
55
67
  <link linkend="GObject">GObject</link>
60
72
                           +----<link linkend="GtkBox">GtkBox</link>
61
73
                                 +----<link linkend="GtkVBox">GtkVBox</link>
62
74
                                       +----GimpPreview
 
75
                                             +----<link linkend="GimpScrolledPreview">GimpScrolledPreview</link>
63
76
</synopsis>
64
77
 
65
78
</refsect1>
66
79
 
67
80
 
68
81
 
69
 
<refsect1 id="impl_interfaces">
70
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
82
<refsect1 role="impl_interfaces">
 
83
<title role="impl_interfaces.title">Implemented Interfaces</title>
71
84
<para>
72
85
GimpPreview implements
73
86
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
75
88
</refsect1>
76
89
 
77
90
 
78
 
<refsect1 id="properties">
79
 
<title id="properties.title">Properties</title>
80
 
<synopsis>
81
 
 
82
 
  &quot;<link linkend="GimpPreview--update">update</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
83
 
</synopsis>
84
 
</refsect1>
85
 
<refsect1 id="style_properties">
86
 
<title id="style_properties.title">Style Properties</title>
87
 
<synopsis>
88
 
 
89
 
  &quot;<link linkend="GimpPreview--size">size</link>&quot;                 <link linkend="gint">gint</link>                  : Read
90
 
</synopsis>
91
 
</refsect1>
92
 
 
93
 
<refsect1 id="signal_proto">
94
 
<title id="signal_proto.title">Signals</title>
95
 
<synopsis>
96
 
 
97
 
&quot;<link linkend="GimpPreview-invalidated">invalidated</link>&quot;
98
 
            <link linkend="void">void</link>        user_function      (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
99
 
                                            <link linkend="gpointer">gpointer</link>     user_data)        : Run first
100
 
</synopsis>
101
 
</refsect1>
102
 
 
103
 
 
104
 
<refsect1 id="desc">
105
 
<title id="desc.title">Description</title>
 
91
<refsect1 role="properties">
 
92
<title role="properties.title">Properties</title>
 
93
<synopsis>
 
94
 
 
95
  &quot;<link linkend="GimpPreview--update">update</link>&quot;                   <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
 
96
</synopsis>
 
97
</refsect1>
 
98
<refsect1 role="style_properties">
 
99
<title role="style_properties.title">Style Properties</title>
 
100
<synopsis>
 
101
 
 
102
  &quot;<link linkend="GimpPreview--size">size</link>&quot;                     <link linkend="gint">gint</link>                  : Read
 
103
</synopsis>
 
104
</refsect1>
 
105
 
 
106
<refsect1 role="signal_proto">
 
107
<title role="signal_proto.title">Signals</title>
 
108
<synopsis>
 
109
 
 
110
  &quot;<link linkend="GimpPreview-invalidated">invalidated</link>&quot;                                    : Run First
 
111
</synopsis>
 
112
</refsect1>
 
113
 
 
114
 
 
115
<refsect1 role="desc">
 
116
<title role="desc.title">Description</title>
106
117
<para>
107
118
A widget providing a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> plus framework to update the preview.
108
119
</para>
109
120
</refsect1>
110
121
 
111
 
<refsect1 id="details">
112
 
<title id="details.title">Details</title>
 
122
<refsect1 role="details">
 
123
<title role="details.title">Details</title>
113
124
<refsect2>
114
125
<title><anchor id="GimpPreview-struct" role="struct"/>GimpPreview</title>
115
126
<indexterm><primary>GimpPreview</primary></indexterm><programlisting>typedef struct _GimpPreview GimpPreview;</programlisting>
118
129
</para></refsect2>
119
130
<refsect2>
120
131
<title><anchor id="gimp-preview-get-update" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_update ()</title>
121
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_preview_get_update         (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
 
132
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_preview_get_update             (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
122
133
<para>
123
134
</para>
124
135
<para>
130
141
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the state of the "Preview" check button.
131
142
 
132
143
</simpara></listitem></varlistentry>
133
 
</variablelist><para>Since  GIMP 2.2
 
144
</variablelist><para role="since">Since  GIMP 2.2
134
145
</para></refsect2>
135
146
<refsect2>
136
147
<title><anchor id="gimp-preview-set-update" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_update ()</title>
137
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_update</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_set_update         (<link linkend="GimpPreview">GimpPreview</link> *preview,
138
 
                                             <link linkend="gboolean">gboolean</link> update);</programlisting>
 
148
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_update</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_set_update             (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
149
                                                         <link linkend="gboolean">gboolean</link> update);</programlisting>
139
150
<para>
140
151
Sets the state of the "Preview" check button.</para>
141
152
<para>
148
159
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the preview should invalidate itself when being
149
160
         scrolled or when <link linkend="gimp-preview-invalidate"><function>gimp_preview_invalidate()</function></link> is being called
150
161
</simpara></listitem></varlistentry>
151
 
</variablelist><para>Since  GIMP 2.2
 
162
</variablelist><para role="since">Since  GIMP 2.2
152
163
</para></refsect2>
153
164
<refsect2>
154
165
<title><anchor id="gimp-preview-set-bounds" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_bounds ()</title>
155
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_bounds</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_set_bounds         (<link linkend="GimpPreview">GimpPreview</link> *preview,
156
 
                                             <link linkend="gint">gint</link> xmin,
157
 
                                             <link linkend="gint">gint</link> ymin,
158
 
                                             <link linkend="gint">gint</link> xmax,
159
 
                                             <link linkend="gint">gint</link> ymax);</programlisting>
 
166
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_bounds</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_set_bounds             (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
167
                                                         <link linkend="gint">gint</link> xmin,
 
168
                                                         <link linkend="gint">gint</link> ymin,
 
169
                                                         <link linkend="gint">gint</link> xmax,
 
170
                                                         <link linkend="gint">gint</link> ymax);</programlisting>
160
171
<para>
161
172
Sets the lower and upper limits for the previewed area. The
162
173
difference between the upper and lower value is used to set the
179
190
<varlistentry><term><parameter>ymax</parameter>&nbsp;:</term>
180
191
<listitem><simpara>
181
192
</simpara></listitem></varlistentry>
182
 
</variablelist><para>Since  GIMP 2.2
 
193
</variablelist><para role="since">Since  GIMP 2.2
183
194
</para></refsect2>
184
195
<refsect2>
185
196
<title><anchor id="gimp-preview-get-size" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_size ()</title>
186
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_size</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_get_size           (<link linkend="GimpPreview">GimpPreview</link> *preview,
187
 
                                             <link linkend="gint">gint</link> *width,
188
 
                                             <link linkend="gint">gint</link> *height);</programlisting>
 
197
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_size</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_get_size               (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
198
                                                         <link linkend="gint">gint</link> *width,
 
199
                                                         <link linkend="gint">gint</link> *height);</programlisting>
189
200
<para>
190
201
</para>
191
202
<para>
200
211
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
201
212
<listitem><simpara>  return location for the preview area height
202
213
</simpara></listitem></varlistentry>
203
 
</variablelist><para>Since  GIMP 2.2
 
214
</variablelist><para role="since">Since  GIMP 2.2
204
215
</para></refsect2>
205
216
<refsect2>
206
217
<title><anchor id="gimp-preview-get-position" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_position ()</title>
207
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_position</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_get_position       (<link linkend="GimpPreview">GimpPreview</link> *preview,
208
 
                                             <link linkend="gint">gint</link> *x,
209
 
                                             <link linkend="gint">gint</link> *y);</programlisting>
 
218
<indexterm role="GIMP 2.2"><primary>gimp_preview_get_position</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_get_position           (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
219
                                                         <link linkend="gint">gint</link> *x,
 
220
                                                         <link linkend="gint">gint</link> *y);</programlisting>
210
221
<para>
211
222
</para>
212
223
<para>
221
232
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
222
233
<listitem><simpara>       return location for the vertical offset
223
234
</simpara></listitem></varlistentry>
224
 
</variablelist><para>Since  GIMP 2.2
 
235
</variablelist><para role="since">Since  GIMP 2.2
 
236
</para></refsect2>
 
237
<refsect2>
 
238
<title><anchor id="gimp-preview-transform" role="function" condition="since:GIMP 2.4"/>gimp_preview_transform ()</title>
 
239
<indexterm role="GIMP 2.4"><primary>gimp_preview_transform</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_transform              (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
240
                                                         <link linkend="gint">gint</link> src_x,
 
241
                                                         <link linkend="gint">gint</link> src_y,
 
242
                                                         <link linkend="gint">gint</link> *dest_x,
 
243
                                                         <link linkend="gint">gint</link> *dest_y);</programlisting>
 
244
<para>
 
245
Transforms from image to widget coordinates.</para>
 
246
<para>
 
247
 
 
248
</para><variablelist role="params">
 
249
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
250
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
 
251
</simpara></listitem></varlistentry>
 
252
<varlistentry><term><parameter>src_x</parameter>&nbsp;:</term>
 
253
<listitem><simpara>   horizontal position on the previewed image
 
254
</simpara></listitem></varlistentry>
 
255
<varlistentry><term><parameter>src_y</parameter>&nbsp;:</term>
 
256
<listitem><simpara>   vertical position on the previewed image
 
257
</simpara></listitem></varlistentry>
 
258
<varlistentry><term><parameter>dest_x</parameter>&nbsp;:</term>
 
259
<listitem><simpara>  returns the transformed horizontal position
 
260
</simpara></listitem></varlistentry>
 
261
<varlistentry><term><parameter>dest_y</parameter>&nbsp;:</term>
 
262
<listitem><simpara>  returns the transformed vertical position
 
263
</simpara></listitem></varlistentry>
 
264
</variablelist><para role="since">Since  GIMP 2.4
 
265
</para></refsect2>
 
266
<refsect2>
 
267
<title><anchor id="gimp-preview-untransform" role="function" condition="since:GIMP 2.4"/>gimp_preview_untransform ()</title>
 
268
<indexterm role="GIMP 2.4"><primary>gimp_preview_untransform</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_untransform            (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
269
                                                         <link linkend="gint">gint</link> src_x,
 
270
                                                         <link linkend="gint">gint</link> src_y,
 
271
                                                         <link linkend="gint">gint</link> *dest_x,
 
272
                                                         <link linkend="gint">gint</link> *dest_y);</programlisting>
 
273
<para>
 
274
Transforms from widget to image coordinates.</para>
 
275
<para>
 
276
 
 
277
</para><variablelist role="params">
 
278
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
279
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
 
280
</simpara></listitem></varlistentry>
 
281
<varlistentry><term><parameter>src_x</parameter>&nbsp;:</term>
 
282
<listitem><simpara>   horizontal position relative to the preview area's origin
 
283
</simpara></listitem></varlistentry>
 
284
<varlistentry><term><parameter>src_y</parameter>&nbsp;:</term>
 
285
<listitem><simpara>   vertical position relative to  preview area's origin
 
286
</simpara></listitem></varlistentry>
 
287
<varlistentry><term><parameter>dest_x</parameter>&nbsp;:</term>
 
288
<listitem><simpara>  returns the untransformed horizontal position
 
289
</simpara></listitem></varlistentry>
 
290
<varlistentry><term><parameter>dest_y</parameter>&nbsp;:</term>
 
291
<listitem><simpara>  returns the untransformed vertical position
 
292
</simpara></listitem></varlistentry>
 
293
</variablelist><para role="since">Since  GIMP 2.4
 
294
</para></refsect2>
 
295
<refsect2>
 
296
<title><anchor id="gimp-preview-get-area" role="function" condition="since:GIMP 2.4"/>gimp_preview_get_area ()</title>
 
297
<indexterm role="GIMP 2.4"><primary>gimp_preview_get_area</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_preview_get_area               (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
 
298
<para>
 
299
In most cases, you shouldn't need to access the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
 
300
that is being used in the <parameter>preview</parameter>. Sometimes however, you need to.
 
301
For example if you want to receive mouse events from the area. In
 
302
such cases, use <link linkend="gimp-preview-get-area"><function>gimp_preview_get_area()</function></link>.</para>
 
303
<para>
 
304
 
 
305
</para><variablelist role="params">
 
306
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
307
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
 
308
</simpara></listitem></varlistentry>
 
309
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> used in the <parameter>preview</parameter>.
 
310
 
 
311
</simpara></listitem></varlistentry>
 
312
</variablelist><para role="since">Since  GIMP 2.4
225
313
</para></refsect2>
226
314
<refsect2>
227
315
<title><anchor id="gimp-preview-draw" role="function" condition="since:GIMP 2.2"/>gimp_preview_draw ()</title>
228
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_draw</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_draw               (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
 
316
<indexterm role="GIMP 2.2"><primary>gimp_preview_draw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_draw                   (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
229
317
<para>
230
318
Calls the GimpPreview::draw method. GimpPreview itself doesn't
231
319
implement a default draw method so the behaviour is determined by
240
328
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
241
329
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
242
330
</simpara></listitem></varlistentry>
243
 
</variablelist><para>Since  GIMP 2.2
 
331
</variablelist><para role="since">Since  GIMP 2.2
244
332
</para></refsect2>
245
333
<refsect2>
246
334
<title><anchor id="gimp-preview-draw-buffer" role="function" condition="since:GIMP 2.2"/>gimp_preview_draw_buffer ()</title>
247
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_draw_buffer</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_draw_buffer        (<link linkend="GimpPreview">GimpPreview</link> *preview,
248
 
                                             const <link linkend="guchar">guchar</link> *buffer,
249
 
                                             <link linkend="gint">gint</link> rowstride);</programlisting>
 
335
<indexterm role="GIMP 2.2"><primary>gimp_preview_draw_buffer</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_draw_buffer            (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
336
                                                         const <link linkend="guchar">guchar</link> *buffer,
 
337
                                                         <link linkend="gint">gint</link> rowstride);</programlisting>
250
338
<para>
251
339
Calls the GimpPreview::draw_buffer method. GimpPreview itself
252
340
doesn't implement this method so the behaviour is determined by the
263
351
<varlistentry><term><parameter>rowstride</parameter>&nbsp;:</term>
264
352
<listitem><simpara> the <parameter>buffer</parameter>'s rowstride
265
353
</simpara></listitem></varlistentry>
266
 
</variablelist><para>Since  GIMP 2.2
 
354
</variablelist><para role="since">Since  GIMP 2.2
267
355
</para></refsect2>
268
356
<refsect2>
269
357
<title><anchor id="gimp-preview-invalidate" role="function" condition="since:GIMP 2.2"/>gimp_preview_invalidate ()</title>
270
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_invalidate</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_invalidate         (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
 
358
<indexterm role="GIMP 2.2"><primary>gimp_preview_invalidate</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_invalidate             (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
271
359
<para>
272
360
This function starts or renews a short low-priority timeout. When
273
361
the timeout expires, the GimpPreview::invalidated signal is emitted
286
374
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
287
375
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
288
376
</simpara></listitem></varlistentry>
289
 
</variablelist><para>Since  GIMP 2.2
 
377
</variablelist><para role="since">Since  GIMP 2.2
290
378
</para></refsect2>
291
379
<refsect2>
292
380
<title><anchor id="gimp-preview-set-default-cursor" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_default_cursor ()</title>
293
 
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_default_cursor</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_preview_set_default_cursor (<link linkend="GimpPreview">GimpPreview</link> *preview,
294
 
                                             <link linkend="GdkCursor">GdkCursor</link> *cursor);</programlisting>
 
381
<indexterm role="GIMP 2.2"><primary>gimp_preview_set_default_cursor</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_preview_set_default_cursor     (<link linkend="GimpPreview">GimpPreview</link> *preview,
 
382
                                                         <link linkend="GdkCursor">GdkCursor</link> *cursor);</programlisting>
295
383
<para>
296
384
Sets the default mouse cursor for the preview.  Note that this will
297
385
be overriden by a <link linkend="GDK-FLEUR:CAPS"><literal>GDK_FLEUR</literal></link> if the preview has scrollbars, or by a
305
393
<varlistentry><term><parameter>cursor</parameter>&nbsp;:</term>
306
394
<listitem><simpara>  a <link linkend="GdkCursor"><type>GdkCursor</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
307
395
</simpara></listitem></varlistentry>
308
 
</variablelist><para>Since  GIMP 2.2
 
396
</variablelist><para role="since">Since  GIMP 2.2
 
397
</para></refsect2>
 
398
<refsect2>
 
399
<title><anchor id="gimp-preview-get-controls" role="function" condition="since:GIMP 2.4"/>gimp_preview_get_controls ()</title>
 
400
<indexterm role="GIMP 2.4"><primary>gimp_preview_get_controls</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_preview_get_controls           (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
 
401
<para>
 
402
Gives access to the <link linkend="GtkHBox"><type>GtkHBox</type></link> at the bottom of the preview that
 
403
contains the update toggle. Derived widgets can use this function
 
404
if they need to add controls to this area.</para>
 
405
<para>
 
406
 
 
407
</para><variablelist role="params">
 
408
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
409
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
 
410
</simpara></listitem></varlistentry>
 
411
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GtkHBox"><type>GtkHBox</type></link> at the bottom of the preview.
 
412
 
 
413
</simpara></listitem></varlistentry>
 
414
</variablelist><para role="since">Since  GIMP 2.4
309
415
</para></refsect2>
310
416
 
311
417
</refsect1>
312
 
<refsect1 id="property_details">
313
 
<title id="property_details.title">Property Details</title>
 
418
<refsect1 role="property_details">
 
419
<title role="property_details.title">Property Details</title>
314
420
<refsect2><title><anchor id="GimpPreview--update"/>The &quot;<literal>update</literal>&quot; property</title>
315
 
<indexterm><primary>GimpPreview:update</primary></indexterm><programlisting>  &quot;update&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
421
<indexterm><primary>GimpPreview:update</primary></indexterm><programlisting>  &quot;update&quot;                   <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
316
422
<para></para><para>Default value: TRUE</para>
317
423
</refsect2>
318
424
 
319
425
</refsect1>
320
 
<refsect1 id="style_properties_details">
321
 
<title id="style_properties_details.title">Style Property Details</title>
 
426
<refsect1 role="style_properties_details">
 
427
<title role="style_properties_details.title">Style Property Details</title>
322
428
<refsect2><title><anchor id="GimpPreview--size"/>The &quot;<literal>size</literal>&quot; style property</title>
323
 
<indexterm><primary>GimpPreview:size</primary></indexterm><programlisting>  &quot;size&quot;                 <link linkend="gint">gint</link>                  : Read</programlisting>
 
429
<indexterm><primary>GimpPreview:size</primary></indexterm><programlisting>  &quot;size&quot;                     <link linkend="gint">gint</link>                  : Read</programlisting>
324
430
<para></para><para>Allowed values: [1,1024]</para>
325
 
<para>Default value: 150</para>
 
431
<para>Default value: 200</para>
326
432
</refsect2>
327
433
 
328
434
</refsect1>
329
435
 
330
 
<refsect1 id="signals">
331
 
<title id="signals.title">Signal Details</title>
 
436
<refsect1 role="signals">
 
437
<title role="signals.title">Signal Details</title>
332
438
<refsect2><title><anchor id="GimpPreview-invalidated"/>The &quot;invalidated&quot; signal</title>
333
 
<indexterm><primary>GimpPreview::invalidated</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
334
 
                                            <link linkend="gpointer">gpointer</link>     user_data)        : Run first</programlisting>
 
439
<indexterm><primary>GimpPreview::invalidated</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
 
440
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run First</programlisting>
335
441
<para>
336
442
 
337
443
</para><variablelist role="params">