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

257 lines
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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</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 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.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part I. 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 II. 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-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<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="#GimpDrawablePreview.synopsis" class="shortcut">Top</a>
 | 
<a href="#GimpDrawablePreview.description" class="shortcut">Description</a>
 | 
<a href="#GimpDrawablePreview.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#GimpDrawablePreview.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#GimpDrawablePreview.properties" 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><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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GimpDrawablePreview.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview-struct" title="GimpDrawablePreview">GimpDrawablePreview</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-new" title="gimp_drawable_preview_new ()">gimp_drawable_preview_new</a> (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable">GimpDrawable</a> *drawable,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> *toggle);
<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable">GimpDrawable</a>* <a class="link" href="GimpDrawablePreview.html#gimp-drawable-preview-get-drawable" title="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" title="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" title="GimpPixelRgn">GimpPixelRgn</a> *region);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpDrawablePreview.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBox.html"
>GtkBox</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkVBox.html"
>GtkVBox</a>
+----<a
href="../libgimpwidgets/GimpPreview.html"
>GimpPreview</a>
+----<a
href="../libgimpwidgets/GimpScrolledPreview.html"
>GimpScrolledPreview</a>
+----GimpDrawablePreview
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GimpDrawablePreview.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpDrawablePreview implements
AtkImplementorIface and <a
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GimpDrawablePreview.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GimpDrawablePreview.html#GimpDrawablePreview--drawable" title='The "drawable" property'>drawable</a>" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<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" lang="en">
<a name="GimpDrawablePreview.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GimpDrawablePreview-struct"></a><h3>GimpDrawablePreview</h3>
<pre class="programlisting">typedef struct _GimpDrawablePreview GimpDrawablePreview;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-drawable-preview-new"></a><h3>gimp_drawable_preview_new ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gimp_drawable_preview_new (<a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable">GimpDrawable</a> *drawable,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> *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>.
</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>
<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> :</span></p></td>
<td> a <a class="link" href="libgimp-gimpdrawable.html#GimpDrawable" title="GimpDrawable"><span class="type">GimpDrawable</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>toggle</code></em> :</span></p></td>
<td> unused
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</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="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">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> :</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> :</span></p></td>
<td> 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>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-drawable-preview-draw-region"></a><h3>gimp_drawable_preview_draw_region ()</h3>
<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" title="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> :</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> :</span></p></td>
<td> a <a class="link" href="libgimp-gimppixelrgn.html#GimpPixelRgn" title="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="GimpDrawablePreview.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GimpDrawablePreview--drawable"></a><h3>The <code class="literal">"drawable"</code> property</h3>
<pre class="programlisting"> "drawable" <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write / Construct Only</pre>
<p>
</p>
<p>
</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>