Imported Upstream version 2.4.0~rc2

This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpdisplay</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimpconvert.html" title="gimpconvert">
@ -31,16 +31,16 @@
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2565929" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2584218" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2615558" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2631488" class="shortcut">Description</a></nobr></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>
<a name="id2565929"></a><span class="refentrytitle">gimpdisplay</span>
<a name="id2584218"></a><span class="refentrytitle">gimpdisplay</span>
</h2>
<p>gimpdisplay &#8212; Functions to create, delete and flush new displays (views) on an image.</p>
</td>
@ -52,56 +52,28 @@
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> <a href="libgimp-gimpdisplay.html#gimp-display-new">gimp_display_new</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpdisplay.html#gimp-display-delete">gimp_display_delete</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpdisplay.html#gimp-display-is-valid">gimp_display_is_valid</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libgimp-gimpdisplay.html#gimp-display-get-window-handle">gimp_display_get_window_handle</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpdisplay.html#gimp-displays-flush">gimp_displays_flush</a> (void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpdisplay.html#gimp-displays-reconnect">gimp_displays_reconnect</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> old_image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> new_image_ID);
gint32 <a class="link" href="libgimp-gimpdisplay.html#gimp-display-new">gimp_display_new</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpdisplay.html#gimp-display-delete">gimp_display_delete</a> (gint32 display_ID);
gboolean <a class="link" href="libgimp-gimpdisplay.html#gimp-display-is-valid">gimp_display_is_valid</a> (gint32 display_ID);
gint <a class="link" href="libgimp-gimpdisplay.html#gimp-display-get-window-handle">gimp_display_get_window_handle</a> (gint32 display_ID);
gboolean <a class="link" href="libgimp-gimpdisplay.html#gimp-displays-flush">gimp_displays_flush</a> (void);
gboolean <a class="link" 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="id2615558"></a><h2>Description</h2>
<a name="id2631488"></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="id2615575"></a><h2>Details</h2>
<a name="id2631505"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2615586"></a><h3>
<a name="id2631516"></a><h3>
<a name="gimp-display-new"></a>gimp_display_new ()</h3>
<a class="indexterm" name="id2615598"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> gimp_display_new (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2631528"></a><pre class="programlisting">gint32 gimp_display_new (gint32 image_ID);</pre>
<p>
Create a new display for the specified image.
</p>
@ -109,7 +81,7 @@ Create a new display for the specified image.
Creates a new display for the specified image. If the image already
has a display, another is added. Multiple displays are handled
transparently by GIMP. The newly created display is returned and can
be subsequently destroyed with a call to <a href="libgimp-gimpdisplay.html#gimp-display-delete"><code class="function">gimp_display_delete()</code></a>. This
be subsequently destroyed with a call to <a class="link" href="libgimp-gimpdisplay.html#gimp-display-delete"><code class="function">gimp_display_delete()</code></a>. This
procedure only makes sense for use with the GIMP UI.</p>
<p>
@ -118,12 +90,12 @@ procedure only makes sense for use with the GIMP UI.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The new display.
</td>
</tr>
@ -132,13 +104,9 @@ procedure only makes sense for use with the GIMP UI.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615677"></a><h3>
<a name="id2631607"></a><h3>
<a name="gimp-display-delete"></a>gimp_display_delete ()</h3>
<a class="indexterm" name="id2615689"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_display_delete (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);</pre>
<a class="indexterm" name="id2631620"></a><pre class="programlisting">gboolean gimp_display_delete (gint32 display_ID);</pre>
<p>
Delete the specified display.
</p>
@ -155,12 +123,12 @@ procedure.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></p></td>
<td> The display to delete.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -169,13 +137,9 @@ procedure.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615757"></a><h3>
<a name="id2631688"></a><h3>
<a name="gimp-display-is-valid"></a>gimp_display_is_valid ()</h3>
<a class="indexterm" name="id2615771"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_display_is_valid (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);</pre>
<a class="indexterm" name="id2631701"></a><pre class="programlisting">gboolean gimp_display_is_valid (gint32 display_ID);</pre>
<p>
Returns TRUE if the display is valid.
</p>
@ -189,12 +153,12 @@ an existing display.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></p></td>
<td> The display to check.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> Whether the display ID is valid.
</td>
@ -206,13 +170,9 @@ an existing display.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615842"></a><h3>
<a name="id2631773"></a><h3>
<a name="gimp-display-get-window-handle"></a>gimp_display_get_window_handle ()</h3>
<a class="indexterm" name="id2615856"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_display_get_window_handle (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> display_ID);</pre>
<a class="indexterm" name="id2631786"></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>
@ -229,12 +189,12 @@ system that is being used.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>display_ID</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The native window handle or 0.
</td>
@ -246,11 +206,9 @@ system that is being used.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615933"></a><h3>
<a name="id2631863"></a><h3>
<a name="gimp-displays-flush"></a>gimp_displays_flush ()</h3>
<a class="indexterm" name="id2615945"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_displays_flush (void);</pre>
<a class="indexterm" name="id2631876"></a><pre class="programlisting">gboolean gimp_displays_flush (void);</pre>
<p>
Flush all internal changes to the user interface
</p>
@ -265,7 +223,7 @@ appropriate.</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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -273,16 +231,10 @@ appropriate.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615993"></a><h3>
<a name="id2633050"></a><h3>
<a name="gimp-displays-reconnect"></a>gimp_displays_reconnect ()</h3>
<a class="indexterm" name="id2616004"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_displays_reconnect (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> old_image_ID,
<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> new_image_ID);</pre>
<a class="indexterm" name="id2633061"></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>
@ -298,17 +250,17 @@ without success. You should rarely need to use this function.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>old_image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>old_image_ID</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>new_image_ID</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>