Files
gimp/devel-docs/libgimp/html/GimpDrawablePreview.html
2010-08-11 01:22:44 -04:00

237 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpDrawablePreview</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part&#160;II.&#160;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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</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="libgimp-gimpexport.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.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 Library Reference Manual</th>
<td><a accesskey="n" href="GimpAspectPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2607772" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2729809" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2729684" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2729754" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2729780" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpDrawablePreview"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2607772"></a><span class="refentrytitle">GimpDrawablePreview</span>
</h2>
<p>GimpDrawablePreview &#8212; A widget providing a preview of a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a>.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview-struct">GimpDrawablePreview</a>;
GtkWidget* <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new">gimp_drawable_preview_new</a> (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gboolean *toggle);
<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a>* <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-get-drawable">gimp_drawable_preview_get_drawable</a> (<a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview">GimpDrawablePreview</a> *preview);
void <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-draw-region">gimp_drawable_preview_draw_region</a> (<a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview">GimpDrawablePreview</a> *preview,
const <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *region);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2729684"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkVBox
+----<a
href="../libgimpwidgets/GimpPreview.html"
>GimpPreview</a>
+----<a
href="../libgimpwidgets/GimpScrolledPreview.html"
>GimpScrolledPreview</a>
+----GimpDrawablePreview
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2729754"></a><h2>Implemented Interfaces</h2>
<p>
GimpDrawablePreview implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2729780"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview--drawable">drawable</a>" gpointer : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2729809"></a><h2>Description</h2>
<p>
A widget providing a preview of a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2729831"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2729842"></a><h3>
<a name="GimpDrawablePreview-struct"></a>GimpDrawablePreview</h3>
<a class="indexterm" name="id2729853"></a><pre class="programlisting">typedef struct _GimpDrawablePreview GimpDrawablePreview;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2729868"></a><h3>
<a name="gimp-drawable-preview-new"></a>gimp_drawable_preview_new ()</h3>
<a class="indexterm" name="id2729882"></a><pre class="programlisting">GtkWidget* gimp_drawable_preview_new (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a> *drawable,
gboolean *toggle);</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</code></em>. If
updating the preview takes considerable time, you will want to
store the state of the "Preview" check-button in the plug-in
data. For convenience you can pass a pointer to the <span class="type">gboolean</span> as
<em class="parameter"><code>toggle</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>drawable</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>toggle</code></em>&#160;:</span></p></td>
<td> pointer to a <span class="type">gboolean</span> variable to sync with the "Preview"
check-button or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A pointer to the new <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2731512"></a><h3>
<a name="gimp-drawable-preview-get-drawable"></a>gimp_drawable_preview_get_drawable ()</h3>
<a class="indexterm" name="id2731525"></a><pre class="programlisting"><a class="link" href="libgimp-gimpdrawable.html#GimpDrawable">GimpDrawable</a>* gimp_drawable_preview_get_drawable (<a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview">GimpDrawablePreview</a> *preview);</pre>
<p>
</p>
<p>
</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>&#160;:</span></p></td>
<td> a <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> the <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable"><span class="type">GimpDrawable</span></a> that has been passed to
<a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new"><code class="function">gimp_drawable_preview_new()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2731612"></a><h3>
<a name="gimp-drawable-preview-draw-region"></a>gimp_drawable_preview_draw_region ()</h3>
<a class="indexterm" name="id2731625"></a><pre class="programlisting">void gimp_drawable_preview_draw_region (<a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview">GimpDrawablePreview</a> *preview,
const <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn">GimpPixelRgn</a> *region);</pre>
<p>
</p>
<p>
</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>&#160;:</span></p></td>
<td> a <a class="link" href="GimpDrawablePreview.html" title="GimpDrawablePreview"><span class="type">GimpDrawablePreview</span></a> widget
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>region</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn"><span class="type">GimpPixelRgn</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2726602"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2726612"></a><h3>
<a name="GimpDrawablePreview--drawable"></a>The "<code class="literal">drawable</code>" property</h3>
<a class="indexterm" name="id2726626"></a><pre class="programlisting"> "drawable" gpointer : Read / Write / Construct Only</pre>
<p>
</p>
<p>
</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>