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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpPreview</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="prev" href="GimpPreviewArea.html" title="GimpPreviewArea"><link rel="next" href="libgimpwidgets-GimpScrolledPreview.html" title="GimpScrolledPreview"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="PartII.GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="PartIII.GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="PartVI.Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="GimpPreviewArea.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Widgets Library Reference Manual</th><td><a accesskey="n" href="libgimpwidgets-GimpScrolledPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="GimpPreview"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpPreview</span></h2><p>GimpPreview — A widget providing a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> plus framework to update the preview.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<a href="GimpPreview.html#GimpPreview-struct">GimpPreview</a>;
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GimpPreview.html#gimp-preview-get-update">gimp_preview_get_update</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
void <a href="GimpPreview.html#gimp-preview-set-update">gimp_preview_set_update</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> update);
void <a href="GimpPreview.html#gimp-preview-set-bounds">gimp_preview_set_bounds</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> xmin,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ymin,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> xmax,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ymax);
void <a href="GimpPreview.html#gimp-preview-get-size">gimp_preview_get_size</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);
void <a href="GimpPreview.html#gimp-preview-get-position">gimp_preview_get_position</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y);
void <a href="GimpPreview.html#gimp-preview-draw">gimp_preview_draw</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
void <a href="GimpPreview.html#gimp-preview-draw-buffer">gimp_preview_draw_buffer</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buffer,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride);
void <a href="GimpPreview.html#gimp-preview-invalidate">gimp_preview_invalidate</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);
void <a href="GimpPreview.html#gimp-preview-set-default-cursor">gimp_preview_set_default_cursor</a> (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../gdk/gdk-Cursors.html#GdkCursor"
>GdkCursor</a> *cursor);
</pre></div><div class="refsect1" lang="en"><a name="id2592409"></a><h2>Object Hierarchy</h2><pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="../gtk/GtkBox.html"
>GtkBox</a>
+----<a
href="../gtk/GtkVBox.html"
>GtkVBox</a>
+----GimpPreview
</pre></div><div class="refsect1" lang="en"><a name="id2592451"></a><h2>Implemented Interfaces</h2><p>
GimpPreview implements
AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2592465"></a><h2>Properties</h2><pre class="synopsis">
"<a href="GimpPreview.html#GimpPreview--update">update</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
</pre></div><div class="refsect1" lang="en"><a name="id2593196"></a><h2>Style Properties</h2><pre class="synopsis">
"<a href="GimpPreview.html#GimpPreview--size">size</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
</pre></div><div class="refsect1" lang="en"><a name="id2593216"></a><h2>Signal Prototypes</h2><pre class="synopsis">
"<a href="GimpPreview.html#GimpPreview-invalidated">invalidated</a>"
void user_function (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *gimppreview,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2593248"></a><h2>Description</h2><p>
A widget providing a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> plus framework to update the preview.
</p></div><div class="refsect1" lang="en"><a name="id2593263"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2593269"></a><h3><a name="GimpPreview-struct"></a>GimpPreview</h3><a class="indexterm" name="id2593277"></a><pre class="programlisting">typedef struct _GimpPreview GimpPreview;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2593287"></a><h3><a name="gimp-preview-get-update"></a>gimp_preview_get_update ()</h3><a class="indexterm" name="id2593295"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_preview_get_update (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre><p>
</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td> the state of the "Preview" check button.
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2593352"></a><h3><a name="gimp-preview-set-update"></a>gimp_preview_set_update ()</h3><a class="indexterm" name="id2593360"></a><pre class="programlisting">void gimp_preview_set_update (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> update);</pre><p>
Sets the state of the "Preview" check button.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>update</tt></i>:</span></td><td> <tt class="literal">TRUE</tt> if the preview should invalidate itself when being
scrolled or when <a href="GimpPreview.html#gimp-preview-invalidate"><tt class="function">gimp_preview_invalidate()</tt></a> is being called
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2593437"></a><h3><a name="gimp-preview-set-bounds"></a>gimp_preview_set_bounds ()</h3><a class="indexterm" name="id2591922"></a><pre class="programlisting">void gimp_preview_set_bounds (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> xmin,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ymin,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> xmax,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ymax);</pre><p>
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 <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> used in the <i class="parameter"><tt>preview</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>xmin</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>ymin</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>xmax</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>ymax</tt></i>:</span></td><td>
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2592049"></a><h3><a name="gimp-preview-get-size"></a>gimp_preview_get_size ()</h3><a class="indexterm" name="id2592057"></a><pre class="programlisting">void gimp_preview_get_size (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height);</pre><p>
</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i>:</span></td><td> return location for the preview area width
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i>:</span></td><td> return location for the preview area height
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2592141"></a><h3><a name="gimp-preview-get-position"></a>gimp_preview_get_position ()</h3><a class="indexterm" name="id2592150"></a><pre class="programlisting">void gimp_preview_get_position (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y);</pre><p>
</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x</tt></i>:</span></td><td> return location for the horizontal offset
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y</tt></i>:</span></td><td> return location for the vertical offset
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2597595"></a><h3><a name="gimp-preview-draw"></a>gimp_preview_draw ()</h3><a class="indexterm" name="id2597604"></a><pre class="programlisting">void gimp_preview_draw (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre><p>
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.
</p><p>
<a
href="../libgimp/GimpDrawablePreview.html"
><span class="type">GimpDrawablePreview</span></a> implements <a href="GimpPreview.html#gimp-preview-draw"><tt class="function">gimp_preview_draw()</tt></a> by drawing the
original, unmodified drawable to the <i class="parameter"><tt>preview</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2597675"></a><h3><a name="gimp-preview-draw-buffer"></a>gimp_preview_draw_buffer ()</h3><a class="indexterm" name="id2597683"></a><pre class="programlisting">void gimp_preview_draw_buffer (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buffer,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride);</pre><p>
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.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>buffer</tt></i>:</span></td><td> a pixel buffer the size of the preview
</td></tr><tr><td><span class="term"><i class="parameter"><tt>rowstride</tt></i>:</span></td><td> the <i class="parameter"><tt>buffer</tt></i>'s rowstride
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2597772"></a><h3><a name="gimp-preview-invalidate"></a>gimp_preview_invalidate ()</h3><a class="indexterm" name="id2597781"></a><pre class="programlisting">void gimp_preview_invalidate (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview);</pre><p>
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 <i class="parameter"><tt>preview</tt></i> to be updated.
</p><p>
This function does nothing unless the "Preview" button is checked.
</p><p>
During the emission of the signal a busy cursor is set on the
toplevel window containing the <i class="parameter"><tt>preview</tt></i> and on the preview area
itself.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2597848"></a><h3><a name="gimp-preview-set-default-cursor"></a>gimp_preview_set_default_cursor ()</h3><a class="indexterm" name="id2597856"></a><pre class="programlisting">void gimp_preview_set_default_cursor (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *preview,
<a
href="../gdk/gdk-Cursors.html#GdkCursor"
>GdkCursor</a> *cursor);</pre><p>
Sets the default mouse cursor for the preview. Note that this will
be overriden by a <tt class="literal">GDK_FLEUR</tt> if the preview has scrollbars, or by a
<tt class="literal">GDK_WATCH</tt> when the preview is invalidated.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>preview</tt></i>:</span></td><td> a <a href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget
</td></tr><tr><td><span class="term"><i class="parameter"><tt>cursor</tt></i>:</span></td><td> a <a
href="../gdk/gdk-Cursors.html#GdkCursor"
><span class="type">GdkCursor</span></a> or <tt class="literal">NULL</tt>
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div></div><div class="refsect1" lang="en"><a name="id2597940"></a><h2>Properties</h2><div class="refsect2" lang="en"><a name="id2597946"></a><h3><a name="GimpPreview--update"></a>The "<tt class="literal">update</tt>" property</h3><pre class="programlisting"> "update" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre><p></p><p>Default value: TRUE</p></div></div><div class="refsect1" lang="en"><a name="id2597972"></a><h2>Style Properties</h2><div class="refsect2" lang="en"><a name="id2597977"></a><h3><a name="GimpPreview--size"></a>The "<tt class="literal">size</tt>" style property</h3><pre class="programlisting"> "size" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre><p></p><p>Allowed values: [1,1024]</p><p>Default value: 150</p></div></div><div class="refsect1" lang="en"><a name="id2598006"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2598011"></a><h3><a name="GimpPreview-invalidated"></a>The "invalidated" signal</h3><pre class="programlisting">void user_function (<a href="GimpPreview.html" title="GimpPreview">GimpPreview</a> *gimppreview,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimppreview</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="GimpPreviewArea.html"><b><<GimpPreviewArea</b></a></td><td align="right"><a accesskey="n" href="libgimpwidgets-GimpScrolledPreview.html"><b>GimpScrolledPreview>></b></a></td></tr></table></body></html>
|
