blob: c91e2c05a4942e616c0eff437f32eeeb70ee847c (
plain)
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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpDrawablePreview: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-gimpexport.html" title="gimpexport">
<link rel="next" href="GimpAspectPreview.html" title="GimpAspectPreview">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GimpDrawablePreview.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GimpDrawablePreview.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GimpDrawablePreview.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GimpDrawablePreview.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimpexport.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpAspectPreview.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpDrawablePreview"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpDrawablePreview.top_of_page"></a>GimpDrawablePreview</span></h2>
<p>GimpDrawablePreview — A widget providing a preview of a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpDrawablePreview.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new" title="gimp_drawable_preview_new ()">gimp_drawable_preview_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new-from-drawable-id" title="gimp_drawable_preview_new_from_drawable_id ()">gimp_drawable_preview_new_from_drawable_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="returnvalue">GimpDrawable</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-get-drawable" title="gimp_drawable_preview_get_drawable ()">gimp_drawable_preview_get_drawable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint32</span>
</td>
<td class="function_name">
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-get-drawable-id" title="gimp_drawable_preview_get_drawable_id ()">gimp_drawable_preview_get_drawable_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-draw-region" title="gimp_drawable_preview_draw_region ()">gimp_drawable_preview_draw_region</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview--drawable" title="The “drawable” property">drawable</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">int</span></td>
<td class="property_name"><a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview--drawable-id" title="The “drawable-id” property">drawable-id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview-struct" title="GimpDrawablePreview">GimpDrawablePreview</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> GtkObject
<span class="lineart">╰──</span> GtkWidget
<span class="lineart">╰──</span> GtkContainer
<span class="lineart">╰──</span> GtkBox
<span class="lineart">╰──</span> <a href="../html/GimpPreview.html#GimpPreview-struct">GimpPreview</a>
<span class="lineart">╰──</span> <a href="../html/GimpScrolledPreview.html#GimpScrolledPreview-struct">GimpScrolledPreview</a>
<span class="lineart">╰──</span> GimpDrawablePreview
</pre>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpDrawablePreview implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.description"></a><h2>Description</h2>
<p>A widget providing a preview of a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a>.</p>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-drawable-preview-new"></a><h3>gimp_drawable_preview_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_drawable_preview_new (<em class="parameter"><code><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> *drawable</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *toggle</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_drawable_preview_new</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new-from-drawable-id" title="gimp_drawable_preview_new_from_drawable_id ()"><code class="function">gimp_drawable_preview_new_from_drawable_id()</code></a> instead.</p>
</div>
<p>Creates a new <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget for <em class="parameter"><code>drawable</code></em>
.</p>
<p>In GIMP 2.2 the <em class="parameter"><code>toggle</code></em>
parameter was provided to conviently access
the state of the "Preview" check-button. This is not any longer
necessary as the preview itself now stores this state, as well as
the scroll offset.</p>
<div class="refsect3">
<a name="gimp-drawable-preview-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>toggle</p></td>
<td class="parameter_description"><p>unused</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-drawable-preview-new.returns"></a><h4>Returns</h4>
<p> A pointer to the new <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-drawable-preview-new-from-drawable-id"></a><h3>gimp_drawable_preview_new_from_drawable_id ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_drawable_preview_new_from_drawable_id
(<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>);</pre>
<p>Creates a new <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget for <em class="parameter"><code>drawable_ID</code></em>
.</p>
<div class="refsect3">
<a name="gimp-drawable-preview-new-from-drawable-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>a drawable ID</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-drawable-preview-new-from-drawable-id.returns"></a><h4>Returns</h4>
<p> A pointer to the new <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-drawable-preview-get-drawable"></a><h3>gimp_drawable_preview_get_drawable ()</h3>
<pre class="programlisting"><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="returnvalue">GimpDrawable</span></a> *
gimp_drawable_preview_get_drawable (<em class="parameter"><code><a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> *preview</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_drawable_preview_get_drawable</code> is deprecated and should not be used in newly-written code.</p>
<p>use <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-get-drawable-id" title="gimp_drawable_preview_get_drawable_id ()"><code class="function">gimp_drawable_preview_get_drawable_id()</code></a> instead.</p>
</div>
<div class="refsect3">
<a name="gimp-drawable-preview-get-drawable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>preview</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-drawable-preview-get-drawable.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a> that has been passed to
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new" title="gimp_drawable_preview_new ()"><code class="function">gimp_drawable_preview_new()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-drawable-preview-get-drawable-id"></a><h3>gimp_drawable_preview_get_drawable_id ()</h3>
<pre class="programlisting"><span class="returnvalue">gint32</span>
gimp_drawable_preview_get_drawable_id (<em class="parameter"><code><a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> *preview</code></em>);</pre>
<div class="refsect3">
<a name="gimp-drawable-preview-get-drawable-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>preview</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-drawable-preview-get-drawable-id.returns"></a><h4>Returns</h4>
<p> the drawable_ID that has been passed to
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new-from-drawable-id" title="gimp_drawable_preview_new_from_drawable_id ()"><code class="function">gimp_drawable_preview_new_from_drawable_id()</code></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-drawable-preview-draw-region"></a><h3>gimp_drawable_preview_draw_region ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_drawable_preview_draw_region (<em class="parameter"><code><a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> *preview</code></em>,
<em class="parameter"><code>const <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn" title="GimpPixelRgn"><span class="type">GimpPixelRgn</span></a> *region</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_drawable_preview_draw_region</code> is deprecated and should not be used in newly-written code.</p></div>
<div class="refsect3">
<a name="gimp-drawable-preview-draw-region.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>preview</p></td>
<td class="parameter_description"><p>a <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>region</p></td>
<td class="parameter_description"><p>a <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn" title="GimpPixelRgn"><span class="type">GimpPixelRgn</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GimpDrawablePreview-struct"></a><h3>GimpDrawablePreview</h3>
<pre class="programlisting">typedef struct _GimpDrawablePreview GimpDrawablePreview;</pre>
</div>
</div>
<div class="refsect1">
<a name="GimpDrawablePreview.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpDrawablePreview--drawable"></a><h3>The <code class="literal">“drawable”</code> property</h3>
<pre class="programlisting"> “drawable” <span class="type">gpointer</span></pre>
<p>Deprecated: use the drawable-id property instead.</p>
<div class="warning">
<p><code class="literal">GimpDrawablePreview:drawable</code> is deprecated and should not be used in newly-written code.</p>
<p>use the drawable-id property instead.</p>
</div>
<p>Owner: GimpDrawablePreview</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GimpDrawablePreview--drawable-id"></a><h3>The <code class="literal">“drawable-id”</code> property</h3>
<pre class="programlisting"> “drawable-id” <span class="type">int</span></pre>
<p>The drawable the <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> is attached to.</p>
<p>Owner: GimpDrawablePreview</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
