Files
gimp/devel-docs/libgimpwidgets/html/GimpScrolledPreview.html
2010-08-11 01:23:08 -04:00

266 lines
12 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>GimpScrolledPreview</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="prev" href="GimpPreview.html" title="GimpPreview">
<link rel="next" href="GimpSizeEntry.html" title="GimpSizeEntry">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-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="GimpPreview.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="GimpSizeEntry.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="#id2575974" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2644516" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2643939" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2644488" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpScrolledPreview"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2575974"></a><span class="refentrytitle">GimpScrolledPreview</span>
</h2>
<p>GimpScrolledPreview &#8212; A widget providing a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> enhanced by scrolling capabilities.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="GimpScrolledPreview.html#GimpScrolledPreview-struct">GimpScrolledPreview</a>;
void <a class="link" href="GimpScrolledPreview.html#gimp-scrolled-preview-set-position">gimp_scrolled_preview_set_position</a> (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</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 class="link" href="GimpScrolledPreview.html#gimp-scrolled-preview-set-policy">gimp_scrolled_preview_set_policy</a> (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview,
<a
href="../gtk/gtk-Standard-Enumerations.html#GtkPolicyType"
>GtkPolicyType</a> hscrollbar_policy,
<a
href="../gtk/gtk-Standard-Enumerations.html#GtkPolicyType"
>GtkPolicyType</a> vscrollbar_policy);
void <a class="link" href="GimpScrolledPreview.html#gimp-scrolled-preview-freeze">gimp_scrolled_preview_freeze</a> (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview);
void <a class="link" href="GimpScrolledPreview.html#gimp-scrolled-preview-thaw">gimp_scrolled_preview_thaw</a> (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2643939"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</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>
+----<a class="link" href="GimpPreview.html" title="GimpPreview">GimpPreview</a>
+----GimpScrolledPreview
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2644488"></a><h2>Implemented Interfaces</h2>
<p>
GimpScrolledPreview implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2644516"></a><h2>Description</h2>
<p>
A widget providing a <a class="link" href="GimpPreview.html" title="GimpPreview"><span class="type">GimpPreview</span></a> enhanced by scrolling capabilities.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2644538"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2644549"></a><h3>
<a name="GimpScrolledPreview-struct"></a>GimpScrolledPreview</h3>
<a class="indexterm" name="id2644560"></a><pre class="programlisting">typedef struct _GimpScrolledPreview GimpScrolledPreview;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644577"></a><h3>
<a name="gimp-scrolled-preview-set-position"></a>gimp_scrolled_preview_set_position ()</h3>
<a class="indexterm" name="id2644590"></a><pre class="programlisting">void gimp_scrolled_preview_set_position (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</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><p><span class="term"><em class="parameter"><code>preview</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> horizontal scroll offset
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> vertical scroll offset
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2649511"></a><h3>
<a name="gimp-scrolled-preview-set-policy"></a>gimp_scrolled_preview_set_policy ()</h3>
<a class="indexterm" name="id2649525"></a><pre class="programlisting">void gimp_scrolled_preview_set_policy (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview,
<a
href="../gtk/gtk-Standard-Enumerations.html#GtkPolicyType"
>GtkPolicyType</a> hscrollbar_policy,
<a
href="../gtk/gtk-Standard-Enumerations.html#GtkPolicyType"
>GtkPolicyType</a> vscrollbar_policy);</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="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hscrollbar_policy</code></em>&#160;:</span></p></td>
<td> policy for horizontal scrollbar
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vscrollbar_policy</code></em>&#160;:</span></p></td>
<td> policy for vertical scrollbar
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644138"></a><h3>
<a name="gimp-scrolled-preview-freeze"></a>gimp_scrolled_preview_freeze ()</h3>
<a class="indexterm" name="id2644152"></a><pre class="programlisting">void gimp_scrolled_preview_freeze (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview);</pre>
<p>
While the <em class="parameter"><code>preview</code></em> is frozen, it is not going to redraw itself in
response to scroll events.
</p>
<p>
This function should only be used to implement widgets derived from
<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>. There is no point in calling this from a plug-in.</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="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2644237"></a><h3>
<a name="gimp-scrolled-preview-thaw"></a>gimp_scrolled_preview_thaw ()</h3>
<a class="indexterm" name="id2644251"></a><pre class="programlisting">void gimp_scrolled_preview_thaw (<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview">GimpScrolledPreview</a> *preview);</pre>
<p>
While the <em class="parameter"><code>preview</code></em> is frozen, it is not going to redraw itself in
response to scroll events.
</p>
<p>
This function should only be used to implement widgets derived from
<a class="link" href="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>. There is no point in calling this from a plug-in.</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="GimpScrolledPreview.html" title="GimpScrolledPreview"><span class="type">GimpScrolledPreview</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>