Files
gimp/devel-docs/libgimp/html/libgimp-gimpdisplay.html
2010-08-11 01:18:40 -04:00

245 lines
9.0 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpdisplay</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimpconvert.html" title="gimpconvert">
<link rel="next" href="libgimp-gimpdrawable.html" title="gimpdrawable">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#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 all 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;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<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" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpconvert.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.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="libgimp-gimpdrawable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimp-gimpdisplay"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">gimpdisplay</span></h2>
<p>gimpdisplay &#8212; Functions to create, delete and flush new displays (views) on an image.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gint32 <a href="libgimp-gimpdisplay.html#gimp-display-new">gimp_display_new</a> (gint32 image_ID);
gboolean <a href="libgimp-gimpdisplay.html#gimp-display-delete">gimp_display_delete</a> (gint32 display_ID);
gint <a href="libgimp-gimpdisplay.html#gimp-display-get-window-handle">gimp_display_get_window_handle</a> (gint32 display_ID);
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-flush">gimp_displays_flush</a> (void);
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-reconnect">gimp_displays_reconnect</a> (gint32 old_image_ID,
gint32 new_image_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2574756"></a><h2>Description</h2>
<p>
Functions to create, delete and flush new displays (views) on an image.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2574768"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2574774"></a><h3>
<a name="gimp-display-new"></a>gimp_display_new ()</h3>
<a class="indexterm" name="id2574785"></a><pre class="programlisting">gint32 gimp_display_new (gint32 image_ID);</pre>
<p>
Create a new display for the specified image.
</p>
<p>
Creates a new display for the specified image. If the image already
has a display, another is added. Multiple displays are handled
transparently by the GIMP. The newly created display is returned and
can be subsequently destroyed with a call to 'gimp-display-delete'.
This procedure only makes sense for use with the GIMP UI.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The new display.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572398"></a><h3>
<a name="gimp-display-delete"></a>gimp_display_delete ()</h3>
<a class="indexterm" name="id2572408"></a><pre class="programlisting">gboolean gimp_display_delete (gint32 display_ID);</pre>
<p>
Delete the specified display.
</p>
<p>
This procedure removes the specified display. If this is the last
remaining display for the underlying image, then the image is
deleted also.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></td>
<td> The display to delete.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572473"></a><h3>
<a name="gimp-display-get-window-handle"></a>gimp_display_get_window_handle ()</h3>
<a class="indexterm" name="id2572482"></a><pre class="programlisting">gint gimp_display_get_window_handle (gint32 display_ID);</pre>
<p>
Get a handle to the native window for an image display.
</p>
<p>
This procedure returns a handle to the native window for a given
image display. For example in the X backend of GDK, a native window
handle is an Xlib XID. A value of 0 is returned for an invalid
display or if this function is unimplemented for the windowing
system that is being used.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></td>
<td> The display to get the window handle from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The native window handle or 0.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572555"></a><h3>
<a name="gimp-displays-flush"></a>gimp_displays_flush ()</h3>
<a class="indexterm" name="id2572565"></a><pre class="programlisting">gboolean gimp_displays_flush (void);</pre>
<p>
Flush all internal changes to the user interface
</p>
<p>
This procedure takes no arguments and returns nothing except a
success status. Its purpose is to flush all pending updates of image
manipulations to the user interface. It should be called whenever
appropriate.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572612"></a><h3>
<a name="gimp-displays-reconnect"></a>gimp_displays_reconnect ()</h3>
<a class="indexterm" name="id2572621"></a><pre class="programlisting">gboolean gimp_displays_reconnect (gint32 old_image_ID,
gint32 new_image_ID);</pre>
<p>
Reconnect displays from one image to another image.
</p>
<p>
This procedure connects all displays of the old_image to the
new_image. If the old_image has no display or new_image already has
a display the reconnect is not performed and the procedure returns
without success. You should rarely need to use this function.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>old_image_ID</code></em>&#160;:</span></td>
<td> The old image (must have at least one display).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_image_ID</code></em>&#160;:</span></td>
<td> The new image (must not have a display).
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimp-gimpconvert.html"><b>&lt;&lt;&#160;gimpconvert</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-gimpdrawable.html"><b>gimpdrawable&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>