/usr/share/gtk-doc/html/libgimpwidgets/GimpPreview.html is in libgimp2.0-doc 2.6.12-1ubuntu1.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpPreview</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
<link rel="prev" href="GimpPreviewArea.html" title="GimpPreviewArea">
<link rel="next" href="GimpRuler.html" title="GimpRuler">
<meta name="generator" content="GTK-Doc V1.18 (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="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="GimpRuler.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GimpPreview.synopsis" class="shortcut">Top</a>
|
<a href="#GimpPreview.description" class="shortcut">Description</a>
|
<a href="#GimpPreview.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GimpPreview.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GimpPreview.properties" class="shortcut">Properties</a>
|
<a href="#GimpPreview.style-properties" class="shortcut">Style Properties</a>
|
<a href="#GimpPreview.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GimpPreview"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpPreview.top_of_page"></a>GimpPreview</span></h2>
<p>GimpPreview — A widget providing a <a class="link" 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">
<a name="GimpPreview.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GimpPreview.html#GimpPreview-struct" title="GimpPreview">GimpPreview</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="GimpPreview.html#gimp-preview-get-update" title="gimp_preview_get_update ()">gimp_preview_get_update</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-set-update" title="gimp_preview_set_update ()">gimp_preview_set_update</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> update</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-set-bounds" title="gimp_preview_set_bounds ()">gimp_preview_set_bounds</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> xmin</code></em>,
<em class="parameter"><code><span class="type">gint</span> ymin</code></em>,
<em class="parameter"><code><span class="type">gint</span> xmax</code></em>,
<em class="parameter"><code><span class="type">gint</span> ymax</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-get-size" title="gimp_preview_get_size ()">gimp_preview_get_size</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-get-position" title="gimp_preview_get_position ()">gimp_preview_get_position</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-transform" title="gimp_preview_transform ()">gimp_preview_transform</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-untransform" title="gimp_preview_untransform ()">gimp_preview_untransform</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GimpPreview.html#gimp-preview-get-area" title="gimp_preview_get_area ()">gimp_preview_get_area</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-draw" title="gimp_preview_draw ()">gimp_preview_draw</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-draw-buffer" title="gimp_preview_draw_buffer ()">gimp_preview_draw_buffer</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gint</span> rowstride</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-invalidate" title="gimp_preview_invalidate ()">gimp_preview_invalidate</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GimpPreview.html#gimp-preview-set-default-cursor" title="gimp_preview_set_default_cursor ()">gimp_preview_set_default_cursor</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">GdkCursor</span> *cursor</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="GimpPreview.html#gimp-preview-get-controls" title="gimp_preview_get_controls ()">gimp_preview_get_controls</a> (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GimpPreview.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkVBox
+----GimpPreview
+----<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a>
</pre>
</div>
<div class="refsect1">
<a name="GimpPreview.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpPreview implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="GimpPreview.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpPreview.html#GimpPreview--update" title='The "update" property'>update</a>" <span class="type">gboolean</span> : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="GimpPreview.style-properties"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpPreview.html#GimpPreview--s-size" title='The "size" style property'>size</a>" <span class="type">gint</span> : Read
</pre>
</div>
<div class="refsect1">
<a name="GimpPreview.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GimpPreview.html#GimpPreview-invalidated" title='The "invalidated" signal'>invalidated</a>" : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="GimpPreview.description"></a><h2>Description</h2>
<p>
A widget providing a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> plus framework to update the preview.
</p>
</div>
<div class="refsect1">
<a name="GimpPreview.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GimpPreview-struct"></a><h3>GimpPreview</h3>
<pre class="programlisting">typedef struct _GimpPreview GimpPreview;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-get-update"></a><h3>gimp_preview_get_update ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_preview_get_update (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the state of the "Preview" check button.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-set-update"></a><h3>gimp_preview_set_update ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_set_update (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> update</code></em>);</pre>
<p>
Sets the state of the "Preview" check button.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>update</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the preview should invalidate itself when being
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</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-set-bounds"></a><h3>gimp_preview_set_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_set_bounds (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> xmin</code></em>,
<em class="parameter"><code><span class="type">gint</span> ymin</code></em>,
<em class="parameter"><code><span class="type">gint</span> xmax</code></em>,
<em class="parameter"><code><span class="type">gint</span> ymax</code></em>);</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 class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> used in the <em class="parameter"><code>preview</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-get-size"></a><h3>gimp_preview_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_get_size (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>return location for the preview area width</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>return location for the preview area height</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-get-position"></a><h3>gimp_preview_get_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_get_position (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>return location for the horizontal offset</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>return location for the vertical offset</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-transform"></a><h3>gimp_preview_transform ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_transform (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>);</pre>
<p>
Transforms from image to widget coordinates.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_x</code></em> :</span></p></td>
<td>horizontal position on the previewed image</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_y</code></em> :</span></p></td>
<td>vertical position on the previewed image</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_x</code></em> :</span></p></td>
<td>returns the transformed horizontal position</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_y</code></em> :</span></p></td>
<td>returns the transformed vertical position</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-untransform"></a><h3>gimp_preview_untransform ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_untransform (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>);</pre>
<p>
Transforms from widget to image coordinates.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_x</code></em> :</span></p></td>
<td>horizontal position relative to the preview area's origin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_y</code></em> :</span></p></td>
<td>vertical position relative to preview area's origin</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_x</code></em> :</span></p></td>
<td>returns the untransformed horizontal position</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_y</code></em> :</span></p></td>
<td>returns the untransformed vertical position</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-get-area"></a><h3>gimp_preview_get_area ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gimp_preview_get_area (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);</pre>
<p>
In most cases, you shouldn't need to access the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
that is being used in the <em class="parameter"><code>preview</code></em>. Sometimes however, you need to.
For example if you want to receive mouse events from the area. In
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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to 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>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-draw"></a><h3>gimp_preview_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_draw (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);</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>
<span class="type">GimpDrawablePreview</span> 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
original, unmodified drawable to the <em class="parameter"><code>preview</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-draw-buffer"></a><h3>gimp_preview_draw_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_draw_buffer (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gint</span> rowstride</code></em>);</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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>a pixel buffer the size of the preview</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rowstride</code></em> :</span></p></td>
<td>the <em class="parameter"><code>buffer</code></em>'s rowstride</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-invalidate"></a><h3>gimp_preview_invalidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_invalidate (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);</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 <em class="parameter"><code>preview</code></em> 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 <em class="parameter"><code>preview</code></em> and on the preview area
itself.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-set-default-cursor"></a><h3>gimp_preview_set_default_cursor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_preview_set_default_cursor (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>,
<em class="parameter"><code><span class="type">GdkCursor</span> *cursor</code></em>);</pre>
<p>
Sets the default mouse cursor for the preview. Note that this will
be overriden by a <code class="literal">GDK_FLEUR</code> if the preview has scrollbars, or by a
<code class="literal">GDK_WATCH</code> when the preview is invalidated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cursor</code></em> :</span></p></td>
<td>a <span class="type">GdkCursor</span> or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-preview-get-controls"></a><h3>gimp_preview_get_controls ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gimp_preview_get_controls (<em class="parameter"><code><a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *preview</code></em>);</pre>
<p>
Gives access to the <span class="type">GtkHBox</span> at the bottom of the preview that
contains the update toggle. Derived widgets can use this function
if they need to add controls to this area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GtkHBox</span> at the bottom of the preview.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GimpPreview.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpPreview--update"></a><h3>The <code class="literal">"update"</code> property</h3>
<pre class="programlisting"> "update" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p></p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="GimpPreview.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GimpPreview--s-size"></a><h3>The <code class="literal">"size"</code> style property</h3>
<pre class="programlisting"> "size" <span class="type">gint</span> : Read</pre>
<p></p>
<p>Allowed values: [1,1024]</p>
<p>Default value: 200</p>
</div>
</div>
<div class="refsect1">
<a name="GimpPreview.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GimpPreview-invalidated"></a><h3>The <code class="literal">"invalidated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> *gimppreview,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gimppreview</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|