Files
gimp/devel-docs/libgimpwidgets/html/GimpOffsetArea.html
2010-08-11 01:19:49 -04:00

309 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>GimpOffsetArea</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<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="GimpMemsizeEntry.html" title="GimpMemsizeEntry">
<link rel="next" href="GimpPageSelector.html" title="GimpPageSelector">
<meta name="generator" content="GTK-Doc V1.6 (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="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.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="GimpMemsizeEntry.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="GimpPageSelector.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="#top_of_page" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a>
&#160;|&#160;
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpOffsetArea"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>GimpOffsetArea</span></h2>
<p>GimpOffsetArea &#8212; Widget to control image offsets.</p>
</td>
<td valign="top" align="right"><img src="gimp-offset-area.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpOffsetArea.html#GimpOffsetArea-struct">GimpOffsetArea</a>;
GtkWidget* <a href="GimpOffsetArea.html#gimp-offset-area-new">gimp_offset_area_new</a> (gint orig_width,
gint orig_height);
void <a href="GimpOffsetArea.html#gimp-offset-area-set-size">gimp_offset_area_set_size</a> (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
gint width,
gint height);
void <a href="GimpOffsetArea.html#gimp-offset-area-set-offsets">gimp_offset_area_set_offsets</a> (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
gint offset_x,
gint offset_y);
void <a href="GimpOffsetArea.html#gimp-offset-area-set-pixbuf">gimp_offset_area_set_pixbuf</a> (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
GdkPixbuf *pixbuf);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkDrawingArea
+----GimpOffsetArea
</pre>
</div>
<div class="refsect1" lang="en">
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpOffsetArea implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="signal_proto"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpOffsetArea.html#GimpOffsetArea-offsets-changed">offsets-changed</a>"
void user_function (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *gimpoffsetarea,
gint arg1,
gint arg2,
gpointer user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2576118"></a><h3>
<a name="GimpOffsetArea-struct"></a>GimpOffsetArea</h3>
<a class="indexterm" name="id2576129"></a><pre class="programlisting">typedef struct _GimpOffsetArea GimpOffsetArea;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576145"></a><h3>
<a name="gimp-offset-area-new"></a>gimp_offset_area_new ()</h3>
<a class="indexterm" name="id2576156"></a><pre class="programlisting">GtkWidget* gimp_offset_area_new (gint orig_width,
gint orig_height);</pre>
<p>
Creates a new <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a> widget. A <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a> can be used
when resizing an image or a drawable to allow the user to interactively
specify the new offsets.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>orig_width</code></em>&#160;:</span></td>
<td> the original width
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>orig_height</code></em>&#160;:</span></td>
<td> the original height
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the new <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576561"></a><h3>
<a name="gimp-offset-area-set-size"></a>gimp_offset_area_set_size ()</h3>
<a class="indexterm" name="id2576573"></a><pre class="programlisting">void gimp_offset_area_set_size (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
gint width,
gint height);</pre>
<p>
Sets the size of the image/drawable displayed by the <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a>.
If the offsets change as a result of this change, the "offsets-changed"
signal is emitted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset_area</code></em>&#160;:</span></td>
<td> a <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> the new width
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> the new height
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2576681"></a><h3>
<a name="gimp-offset-area-set-offsets"></a>gimp_offset_area_set_offsets ()</h3>
<a class="indexterm" name="id2576692"></a><pre class="programlisting">void gimp_offset_area_set_offsets (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
gint offset_x,
gint offset_y);</pre>
<p>
Sets the offsets of the image/drawable displayed by the <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a>.
It does not emit the "offsets-changed" signal.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset_area</code></em>&#160;:</span></td>
<td> a <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset_x</code></em>&#160;:</span></td>
<td> the X offset
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset_y</code></em>&#160;:</span></td>
<td> the Y offset
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2578259"></a><h3>
<a name="gimp-offset-area-set-pixbuf"></a>gimp_offset_area_set_pixbuf ()</h3>
<a class="indexterm" name="id2578272"></a><pre class="programlisting">void gimp_offset_area_set_pixbuf (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *offset_area,
GdkPixbuf *pixbuf);</pre>
<p>
Sets the pixbuf which represents the original image/drawable which
is being offset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset_area</code></em>&#160;:</span></td>
<td> a <a href="GimpOffsetArea.html" title="GimpOffsetArea"><span class="type">GimpOffsetArea</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em>&#160;:</span></td>
<td> a <span class="type">GdkPixbuf</span>.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="signals"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2578376"></a><h3>
<a name="GimpOffsetArea-offsets-changed"></a>The "offsets-changed" signal</h3>
<a class="indexterm" name="id2578384"></a><pre class="programlisting">void user_function (<a href="GimpOffsetArea.html" title="GimpOffsetArea">GimpOffsetArea</a> *gimpoffsetarea,
gint arg1,
gint arg2,
gpointer user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>gimpoffsetarea</code></em>&#160;:</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>arg2</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>