1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpPreview">
<refmeta>
<refentrytitle id="top_of_page">GimpPreview</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpPreview</refname>
<refpurpose>A widget providing a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> plus framework to update the preview.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpPreview-struct">GimpPreview</link>;
<link linkend="gboolean">gboolean</link> <link linkend="gimp-preview-get-update">gimp_preview_get_update</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
<link linkend="void">void</link> <link linkend="gimp-preview-set-update">gimp_preview_set_update</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
<link linkend="gboolean">gboolean</link> update);
<link linkend="void">void</link> <link linkend="gimp-preview-set-bounds">gimp_preview_set_bounds</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
<link linkend="gint">gint</link> xmin,
<link linkend="gint">gint</link> ymin,
<link linkend="gint">gint</link> xmax,
<link linkend="gint">gint</link> ymax);
<link linkend="void">void</link> <link linkend="gimp-preview-get-size">gimp_preview_get_size</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);
<link linkend="void">void</link> <link linkend="gimp-preview-get-position">gimp_preview_get_position</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
<link linkend="gint">gint</link> *x,
<link linkend="gint">gint</link> *y);
<link linkend="void">void</link> <link linkend="gimp-preview-draw">gimp_preview_draw</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
<link linkend="void">void</link> <link linkend="gimp-preview-draw-buffer">gimp_preview_draw_buffer</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
const <link linkend="guchar">guchar</link> *buffer,
<link linkend="gint">gint</link> rowstride);
<link linkend="void">void</link> <link linkend="gimp-preview-invalidate">gimp_preview_invalidate</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
<link linkend="void">void</link> <link linkend="gimp-preview-set-default-cursor">gimp_preview_set_default_cursor</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
<link linkend="GdkCursor">GdkCursor</link> *cursor);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkVBox">GtkVBox</link>
+----GimpPreview
</synopsis>
</refsect1>
<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpPreview implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpPreview--update">update</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="style_properties">
<title id="style_properties.title">Style Properties</title>
<synopsis>
"<link linkend="GimpPreview--size">size</link>" <link linkend="gint">gint</link> : Read
</synopsis>
</refsect1>
<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpPreview-invalidated">invalidated</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
<link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
A widget providing a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> plus framework to update the preview.
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpPreview-struct" role="struct"/>GimpPreview</title>
<indexterm><primary>GimpPreview</primary></indexterm><programlisting>typedef struct _GimpPreview GimpPreview;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-get-update" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_update ()</title>
<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>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the state of the "Preview" check button.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-set-update" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_update ()</title>
<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,
<link linkend="gboolean">gboolean</link> update);</programlisting>
<para>
Sets the state of the "Preview" check button.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>update</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the preview should invalidate itself when being
scrolled or when <link linkend="gimp-preview-invalidate"><function>gimp_preview_invalidate()</function></link> is being called
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-set-bounds" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_bounds ()</title>
<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,
<link linkend="gint">gint</link> xmin,
<link linkend="gint">gint</link> ymin,
<link linkend="gint">gint</link> xmax,
<link linkend="gint">gint</link> ymax);</programlisting>
<para>
Sets the lower and upper limits for the previewed area. The
difference between the upper and lower value is used to set the
maximum size of the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> used in the <parameter>preview</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xmin</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ymin</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xmax</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ymax</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-get-size" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_size ()</title>
<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,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> return location for the preview area width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> return location for the preview area height
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-get-position" role="function" condition="since:GIMP 2.2"/>gimp_preview_get_position ()</title>
<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,
<link linkend="gint">gint</link> *x,
<link linkend="gint">gint</link> *y);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> return location for the horizontal offset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> return location for the vertical offset
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-draw" role="function" condition="since:GIMP 2.2"/>gimp_preview_draw ()</title>
<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>
<para>
Calls the GimpPreview::draw method. GimpPreview itself doesn't
implement a default draw method so the behaviour is determined by
the derived class implementing this method.
</para>
<para>
<link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> implements <link linkend="gimp-preview-draw"><function>gimp_preview_draw()</function></link> by drawing the
original, unmodified drawable to the <parameter>preview</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-draw-buffer" role="function" condition="since:GIMP 2.2"/>gimp_preview_draw_buffer ()</title>
<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,
const <link linkend="guchar">guchar</link> *buffer,
<link linkend="gint">gint</link> rowstride);</programlisting>
<para>
Calls the GimpPreview::draw_buffer method. GimpPreview itself
doesn't implement this method so the behaviour is determined by the
derived class implementing this method.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> a pixel buffer the size of the preview
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rowstride</parameter> :</term>
<listitem><simpara> the <parameter>buffer</parameter>'s rowstride
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-invalidate" role="function" condition="since:GIMP 2.2"/>gimp_preview_invalidate ()</title>
<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>
<para>
This function starts or renews a short low-priority timeout. When
the timeout expires, the GimpPreview::invalidated signal is emitted
which will usually cause the <parameter>preview</parameter> to be updated.
</para>
<para>
This function does nothing unless the "Preview" button is checked.
</para>
<para>
During the emission of the signal a busy cursor is set on the
toplevel window containing the <parameter>preview</parameter> and on the preview area
itself.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-preview-set-default-cursor" role="function" condition="since:GIMP 2.2"/>gimp_preview_set_default_cursor ()</title>
<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,
<link linkend="GdkCursor">GdkCursor</link> *cursor);</programlisting>
<para>
Sets the default mouse cursor for the preview. Note that this will
be overriden by a <link linkend="GDK-FLEUR:CAPS"><literal>GDK_FLEUR</literal></link> if the preview has scrollbars, or by a
<link linkend="GDK-WATCH:CAPS"><literal>GDK_WATCH</literal></link> when the preview is invalidated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>preview</parameter> :</term>
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cursor</parameter> :</term>
<listitem><simpara> a <link linkend="GdkCursor"><type>GdkCursor</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpPreview--update"/>The "<literal>update</literal>" property</title>
<indexterm><primary>GimpPreview:update</primary></indexterm><programlisting> "update" <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para></para><para>Default value: TRUE</para>
</refsect2>
</refsect1>
<refsect1 id="style_properties_details">
<title id="style_properties_details.title">Style Property Details</title>
<refsect2><title><anchor id="GimpPreview--size"/>The "<literal>size</literal>" style property</title>
<indexterm><primary>GimpPreview:size</primary></indexterm><programlisting> "size" <link linkend="gint">gint</link> : Read</programlisting>
<para></para><para>Allowed values: [1,1024]</para>
<para>Default value: 150</para>
</refsect2>
</refsect1>
<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpPreview-invalidated"/>The "invalidated" signal</title>
<indexterm><primary>GimpPreview::invalidated</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimppreview</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
