← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gimp/karmic-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
https://launchpad.net/bugs/419593
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

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