4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpPreview</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
9
9
<link rel="prev" href="GimpPreviewArea.html" title="GimpPreviewArea">
10
10
<link rel="next" href="GimpRuler.html" title="GimpRuler">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="GimpRuler.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
37
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpPreview.synopsis" class="shortcut">Top</a>
39
<a href="#GimpPreview.description" class="shortcut">Description</a>
41
<a href="#GimpPreview.object-hierarchy" class="shortcut">Object Hierarchy</a>
43
<a href="#GimpPreview.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
45
<a href="#GimpPreview.properties" class="shortcut">Properties</a>
47
<a href="#GimpPreview.style-properties" class="shortcut">Style Properties</a>
49
<a href="#GimpPreview.signals" class="shortcut">Signals</a></nobr></td></tr>
37
<tr><td colspan="5" class="shortcuts">
38
<a href="#GimpPreview.synopsis" class="shortcut">Top</a>
40
<a href="#GimpPreview.description" class="shortcut">Description</a>
42
<a href="#GimpPreview.object-hierarchy" class="shortcut">Object Hierarchy</a>
44
<a href="#GimpPreview.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
46
<a href="#GimpPreview.properties" class="shortcut">Properties</a>
48
<a href="#GimpPreview.style-properties" class="shortcut">Style Properties</a>
50
<a href="#GimpPreview.signals" class="shortcut">Signals</a>
51
<div class="refentry" lang="en">
53
<div class="refentry" title="GimpPreview">
52
54
<a name="GimpPreview"></a><div class="titlepage"></div>
53
55
<div class="refnamediv"><table width="100%"><tr>
58
60
<td valign="top" align="right"></td>
59
61
</tr></table></div>
60
<div class="refsynopsisdiv">
62
<div class="refsynopsisdiv" title="Synopsis">
61
63
<a name="GimpPreview.synopsis"></a><h2>Synopsis</h2>
62
64
<pre class="synopsis">
63
65
<a class="link" href="GimpPreview.html#GimpPreview-struct" title="GimpPreview">GimpPreview</a>;
122
124
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
123
125
>gint</a> *dest_y);
125
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
126
>GtkWidget</a>* <a class="link" href="GimpPreview.html#gimp-preview-get-area" title="gimp_preview_get_area ()">gimp_preview_get_area</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
127
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
128
>GtkWidget</a> * <a class="link" href="GimpPreview.html#gimp-preview-get-area" title="gimp_preview_get_area ()">gimp_preview_get_area</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
127
129
void <a class="link" href="GimpPreview.html#gimp-preview-draw" title="gimp_preview_draw ()">gimp_preview_draw</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
128
130
void <a class="link" href="GimpPreview.html#gimp-preview-draw-buffer" title="gimp_preview_draw_buffer ()">gimp_preview_draw_buffer</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
135
137
void <a class="link" href="GimpPreview.html#gimp-preview-invalidate" title="gimp_preview_invalidate ()">gimp_preview_invalidate</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
136
138
void <a class="link" href="GimpPreview.html#gimp-preview-set-default-cursor" title="gimp_preview_set_default_cursor ()">gimp_preview_set_default_cursor</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
138
href="/usr/share/gtk-doc/html/gdk/gdk-Cursors.html#GdkCursor"
140
href="http://library.gnome.org/devel/gdk/unstable/gdk-Cursors.html#GdkCursor"
139
141
>GdkCursor</a> *cursor);
141
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
142
>GtkWidget</a>* <a class="link" href="GimpPreview.html#gimp-preview-get-controls" title="gimp_preview_get_controls ()">gimp_preview_get_controls</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
143
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
144
>GtkWidget</a> * <a class="link" href="GimpPreview.html#gimp-preview-get-controls" title="gimp_preview_get_controls ()">gimp_preview_get_controls</a> (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
145
<div class="refsect1" lang="en">
147
<div class="refsect1" title="Object Hierarchy">
146
148
<a name="GimpPreview.object-hierarchy"></a><h2>Object Hierarchy</h2>
147
149
<pre class="synopsis">
152
154
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
153
155
>GInitiallyUnowned</a>
155
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
157
href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html"
158
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
160
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
161
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
163
href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html"
162
164
>GtkContainer</a>
164
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
166
href="http://library.gnome.org/devel/gtk/unstable/GtkBox.html"
167
href="/usr/share/gtk-doc/html/gtk/GtkVBox.html"
169
href="http://library.gnome.org/devel/gtk/unstable/GtkVBox.html"
170
172
+----<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a>
173
<div class="refsect1" lang="en">
175
<div class="refsect1" title="Implemented Interfaces">
174
176
<a name="GimpPreview.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
176
178
GimpPreview implements
177
AtkImplementorIface and <a
178
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
179
>GtkBuildable</a>.</p>
180
href="http://library.gnome.org/devel/gtk/unstable/gtk-gtkbuildable.html#GtkBuildable"
181
>GtkBuildable</a>, AtkImplementorIface and <a
182
href="http://library.gnome.org/devel/gtk/unstable/gtk-Orientable.html#GtkOrientable"
183
>GtkOrientable</a>.</p>
181
<div class="refsect1" lang="en">
185
<div class="refsect1" title="Properties">
182
186
<a name="GimpPreview.properties"></a><h2>Properties</h2>
183
187
<pre class="synopsis">
184
188
"<a class="link" href="GimpPreview.html#GimpPreview--update" title='The "update" property'>update</a>" <a
186
190
>gboolean</a> : Read / Write / Construct
189
<div class="refsect1" lang="en">
193
<div class="refsect1" title="Style Properties">
190
194
<a name="GimpPreview.style-properties"></a><h2>Style Properties</h2>
191
195
<pre class="synopsis">
192
"<a class="link" href="GimpPreview.html#GimpPreview--size" title='The "size" style property'>size</a>" <a
196
"<a class="link" href="GimpPreview.html#GimpPreview--s-size" title='The "size" style property'>size</a>" <a
193
197
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
197
<div class="refsect1" lang="en">
201
<div class="refsect1" title="Signals">
198
202
<a name="GimpPreview.signals"></a><h2>Signals</h2>
199
203
<pre class="synopsis">
200
204
"<a class="link" href="GimpPreview.html#GimpPreview-invalidated" title='The "invalidated" signal'>invalidated</a>" : Run First
203
<div class="refsect1" lang="en">
207
<div class="refsect1" title="Description">
204
208
<a name="GimpPreview.description"></a><h2>Description</h2>
206
210
A widget providing a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> plus framework to update the preview.
209
<div class="refsect1" lang="en">
213
<div class="refsect1" title="Details">
210
214
<a name="GimpPreview.details"></a><h2>Details</h2>
211
<div class="refsect2" lang="en">
215
<div class="refsect2" title="GimpPreview">
212
216
<a name="GimpPreview-struct"></a><h3>GimpPreview</h3>
213
217
<pre class="programlisting">typedef struct _GimpPreview GimpPreview;</pre>
219
<div class="refsect2" lang="en">
222
<div class="refsect2" title="gimp_preview_get_update ()">
220
223
<a name="gimp-preview-get-update"></a><h3>gimp_preview_get_update ()</h3>
221
224
<pre class="programlisting"><a
222
225
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
245
<p class="since">Since GIMP 2.2
247
<p class="since">Since GIMP 2.2</p>
249
<div class="refsect2" lang="en">
250
<div class="refsect2" title="gimp_preview_set_update ()">
250
251
<a name="gimp-preview-set-update"></a><h3>gimp_preview_set_update ()</h3>
251
252
<pre class="programlisting">void gimp_preview_set_update (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
269
269
<td><p><span class="term"><em class="parameter"><code>update</code></em> :</span></p></td>
271
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"
271
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
272
272
><code class="literal">TRUE</code></a> if the preview should invalidate itself when being
273
273
scrolled or when <a class="link" href="GimpPreview.html#gimp-preview-invalidate" title="gimp_preview_invalidate ()"><code class="function">gimp_preview_invalidate()</code></a> is being called
278
<p class="since">Since GIMP 2.2
278
<p class="since">Since GIMP 2.2</p>
282
<div class="refsect2" lang="en">
281
<div class="refsect2" title="gimp_preview_set_bounds ()">
283
282
<a name="gimp-preview-set-bounds"></a><h3>gimp_preview_set_bounds ()</h3>
284
283
<pre class="programlisting">void gimp_preview_set_bounds (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
299
298
difference between the upper and lower value is used to set the
300
299
maximum size of the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> used in the <em class="parameter"><code>preview</code></em>.</p>
304
302
<div class="variablelist"><table border="0">
305
303
<col align="left" valign="top">
334
<p class="since">Since GIMP 2.2
332
<p class="since">Since GIMP 2.2</p>
338
<div class="refsect2" lang="en">
335
<div class="refsect2" title="gimp_preview_get_size ()">
339
336
<a name="gimp-preview-get-size"></a><h3>gimp_preview_get_size ()</h3>
340
337
<pre class="programlisting">void gimp_preview_get_size (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
372
<p class="since">Since GIMP 2.2
368
<p class="since">Since GIMP 2.2</p>
376
<div class="refsect2" lang="en">
371
<div class="refsect2" title="gimp_preview_get_position ()">
377
372
<a name="gimp-preview-get-position"></a><h3>gimp_preview_get_position ()</h3>
378
373
<pre class="programlisting">void gimp_preview_get_position (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
410
<p class="since">Since GIMP 2.2
404
<p class="since">Since GIMP 2.2</p>
414
<div class="refsect2" lang="en">
407
<div class="refsect2" title="gimp_preview_transform ()">
415
408
<a name="gimp-preview-transform"></a><h3>gimp_preview_transform ()</h3>
416
409
<pre class="programlisting">void gimp_preview_transform (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
464
<p class="since">Since GIMP 2.4
456
<p class="since">Since GIMP 2.4</p>
468
<div class="refsect2" lang="en">
459
<div class="refsect2" title="gimp_preview_untransform ()">
469
460
<a name="gimp-preview-untransform"></a><h3>gimp_preview_untransform ()</h3>
470
461
<pre class="programlisting">void gimp_preview_untransform (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
518
<p class="since">Since GIMP 2.4
508
<p class="since">Since GIMP 2.4</p>
522
<div class="refsect2" lang="en">
511
<div class="refsect2" title="gimp_preview_get_area ()">
523
512
<a name="gimp-preview-get-area"></a><h3>gimp_preview_get_area ()</h3>
524
513
<pre class="programlisting"><a
525
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
526
>GtkWidget</a>* gimp_preview_get_area (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
514
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
515
>GtkWidget</a> * gimp_preview_get_area (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
528
517
In most cases, you shouldn't need to access the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
529
518
that is being used in the <em class="parameter"><code>preview</code></em>. Sometimes however, you need to.
530
519
For example if you want to receive mouse events from the area. In
531
520
such cases, use <a class="link" href="GimpPreview.html#gimp-preview-get-area" title="gimp_preview_get_area ()"><code class="function">gimp_preview_get_area()</code></a>.</p>
535
523
<div class="variablelist"><table border="0">
536
524
<col align="left" valign="top">
551
<p class="since">Since GIMP 2.4
539
<p class="since">Since GIMP 2.4</p>
555
<div class="refsect2" lang="en">
542
<div class="refsect2" title="gimp_preview_draw ()">
556
543
<a name="gimp-preview-draw"></a><h3>gimp_preview_draw ()</h3>
557
544
<pre class="programlisting">void gimp_preview_draw (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
566
553
><span class="type">GimpDrawablePreview</span></a> implements <a class="link" href="GimpPreview.html#gimp-preview-draw" title="gimp_preview_draw ()"><code class="function">gimp_preview_draw()</code></a> by drawing the
567
554
original, unmodified drawable to the <em class="parameter"><code>preview</code></em>.</p>
571
557
<div class="variablelist"><table border="0">
572
558
<col align="left" valign="top">
579
<p class="since">Since GIMP 2.2
565
<p class="since">Since GIMP 2.2</p>
583
<div class="refsect2" lang="en">
568
<div class="refsect2" title="gimp_preview_draw_buffer ()">
584
569
<a name="gimp-preview-draw-buffer"></a><h3>gimp_preview_draw_buffer ()</h3>
585
570
<pre class="programlisting">void gimp_preview_draw_buffer (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
619
<p class="since">Since GIMP 2.2
603
<p class="since">Since GIMP 2.2</p>
623
<div class="refsect2" lang="en">
606
<div class="refsect2" title="gimp_preview_invalidate ()">
624
607
<a name="gimp-preview-invalidate"></a><h3>gimp_preview_invalidate ()</h3>
625
608
<pre class="programlisting">void gimp_preview_invalidate (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
649
<p class="since">Since GIMP 2.2
631
<p class="since">Since GIMP 2.2</p>
653
<div class="refsect2" lang="en">
634
<div class="refsect2" title="gimp_preview_set_default_cursor ()">
654
635
<a name="gimp-preview-set-default-cursor"></a><h3>gimp_preview_set_default_cursor ()</h3>
655
636
<pre class="programlisting">void gimp_preview_set_default_cursor (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
657
href="/usr/share/gtk-doc/html/gdk/gdk-Cursors.html#GdkCursor"
638
href="http://library.gnome.org/devel/gdk/unstable/gdk-Cursors.html#GdkCursor"
658
639
>GdkCursor</a> *cursor);</pre>
660
641
Sets the default mouse cursor for the preview. Note that this will
661
642
be overriden by a <code class="literal">GDK_FLEUR</code> if the preview has scrollbars, or by a
662
643
<code class="literal">GDK_WATCH</code> when the preview is invalidated.</p>
666
646
<div class="variablelist"><table border="0">
667
647
<col align="left" valign="top">
675
655
<td><p><span class="term"><em class="parameter"><code>cursor</code></em> :</span></p></td>
677
href="/usr/share/gtk-doc/html/gdk/gdk-Cursors.html#GdkCursor"
657
href="http://library.gnome.org/devel/gdk/unstable/gdk-Cursors.html#GdkCursor"
678
658
><span class="type">GdkCursor</span></a> or <a
679
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"
659
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
680
660
><code class="literal">NULL</code></a>
685
<p class="since">Since GIMP 2.2
665
<p class="since">Since GIMP 2.2</p>
689
<div class="refsect2" lang="en">
668
<div class="refsect2" title="gimp_preview_get_controls ()">
690
669
<a name="gimp-preview-get-controls"></a><h3>gimp_preview_get_controls ()</h3>
691
670
<pre class="programlisting"><a
692
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
693
>GtkWidget</a>* gimp_preview_get_controls (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
671
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
672
>GtkWidget</a> * gimp_preview_get_controls (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre>
695
674
Gives access to the <a
696
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
675
href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html"
697
676
><span class="type">GtkHBox</span></a> at the bottom of the preview that
698
677
contains the update toggle. Derived widgets can use this function
699
678
if they need to add controls to this area.</p>
703
681
<div class="variablelist"><table border="0">
704
682
<col align="left" valign="top">
712
690
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
714
href="/usr/share/gtk-doc/html/gtk/GtkHBox.html"
692
href="http://library.gnome.org/devel/gtk/unstable/GtkHBox.html"
715
693
><span class="type">GtkHBox</span></a> at the bottom of the preview.
721
<p class="since">Since GIMP 2.4
725
<div class="refsect1" lang="en">
699
<p class="since">Since GIMP 2.4</p>
702
<div class="refsect1" title="Property Details">
726
703
<a name="GimpPreview.property-details"></a><h2>Property Details</h2>
727
<div class="refsect2" lang="en">
704
<div class="refsect2" title='The "update" property'>
728
705
<a name="GimpPreview--update"></a><h3>The <code class="literal">"update"</code> property</h3>
729
706
<pre class="programlisting"> "update" <a
730
707
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
733
710
<p>Default value: TRUE</p>
736
<div class="refsect1" lang="en">
713
<div class="refsect1" title="Style Property Details">
737
714
<a name="GimpPreview.style-property-details"></a><h2>Style Property Details</h2>
738
<div class="refsect2" lang="en">
739
<a name="GimpPreview--size"></a><h3>The <code class="literal">"size"</code> style property</h3>
715
<div class="refsect2" title='The "size" style property'>
716
<a name="GimpPreview--s-size"></a><h3>The <code class="literal">"size"</code> style property</h3>
740
717
<pre class="programlisting"> "size" <a
741
718
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
742
719
>gint</a> : Read</pre>
745
722
<p>Default value: 200</p>
748
<div class="refsect1" lang="en">
725
<div class="refsect1" title="Signal Details">
749
726
<a name="GimpPreview.signal-details"></a><h2>Signal Details</h2>
750
<div class="refsect2" lang="en">
727
<div class="refsect2" title='The "invalidated" signal'>
751
728
<a name="GimpPreview-invalidated"></a><h3>The <code class="literal">"invalidated"</code> signal</h3>
752
729
<pre class="programlisting">void user_function (<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *gimppreview,
754
731
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
755
732
>gpointer</a> user_data) : Run First</pre>
759
735
<div class="variablelist"><table border="0">
760
736
<col align="left" valign="top">