Adding upstream version 2.10.36.upstream/2.10.36

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
author: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-04-19 03:13:10 +0000
committer: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-04-19 03:13:10 +0000
commit: 3c57dd931145d43f2b0aef96c4d178135956bf91 (patch)
tree: 3de698981e9f0cc2c4f9569b19a5f3595e741f6b /devel-docs/libgimp/html/libgimp-gimpdisplay.html
parent: Initial commit. (diff)
download: gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.tar.xz
gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.zip
1 files changed, 280 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpdisplay.html b/devel-docs/libgimp/html/libgimp-gimpdisplay.html
new file mode 100644
index 0000000..86e3e5f
--- /dev/null
+++ b/devel-docs/libgimp/html/libgimp-gimpdisplay.html
@@ -0,0 +1,280 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>gimpdisplay: GIMP Library Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
+<link rel="home" href="index.html" title="GIMP Library Reference Manual">
+<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
+<link rel="prev" href="libgimp-gimpcolor.html" title="gimpcolor">
+<link rel="next" href="libgimp-gimpdrawable.html" title="gimpdrawable">
+<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
+                  <a href="#libgimp-gimpdisplay.description" class="shortcut">Description</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="libgimp-gimpcolor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="libgimp-gimpdrawable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="libgimp-gimpdisplay"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="libgimp-gimpdisplay.top_of_page"></a>gimpdisplay</span></h2>
+<p>gimpdisplay — Functions to create, delete and flush displays (views) on an image.</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="libgimp-gimpdisplay.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_proto_type">
+<col class="functions_proto_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gint32</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-display-new" title="gimp_display_new ()">gimp_display_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-display-delete" title="gimp_display_delete ()">gimp_display_delete</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-display-is-valid" title="gimp_display_is_valid ()">gimp_display_is_valid</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gint</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-display-get-window-handle" title="gimp_display_get_window_handle ()">gimp_display_get_window_handle</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-displays-flush" title="gimp_displays_flush ()">gimp_displays_flush</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpdisplay.html#gimp-displays-reconnect" title="gimp_displays_reconnect ()">gimp_displays_reconnect</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpdisplay.description"></a><h2>Description</h2>
+<p>Functions to create, delete and flush displays (views) on an image.</p>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpdisplay.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gimp-display-new"></a><h3>gimp_display_new ()</h3>
+<pre class="programlisting"><span class="returnvalue">gint32</span>
+gimp_display_new (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</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 GIMP. The newly created display is returned and can
+be subsequently destroyed with a call to <a class="link" href="libgimp-gimpdisplay.html#gimp-display-delete" title="gimp_display_delete ()"><code class="function">gimp_display_delete()</code></a>. This
+procedure only makes sense for use with the GIMP UI, and will result
+in an execution error if called when GIMP has no UI.</p>
+<div class="refsect3">
+<a name="gimp-display-new.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>image_ID</p></td>
+<td class="parameter_description"><p>The image.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-display-new.returns"></a><h4>Returns</h4>
+<p> The new display.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-display-delete"></a><h3>gimp_display_delete ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_display_delete (<em class="parameter"><code><span class="type">gint32</span> display_ID</code></em>);</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. Note that the display is closed no matter if the image
+is dirty or not. Better save the image before calling this
+procedure.</p>
+<div class="refsect3">
+<a name="gimp-display-delete.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>display_ID</p></td>
+<td class="parameter_description"><p>The display to delete.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-display-delete.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-display-is-valid"></a><h3>gimp_display_is_valid ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_display_is_valid (<em class="parameter"><code><span class="type">gint32</span> display_ID</code></em>);</pre>
+<p>Returns TRUE if the display is valid.</p>
+<p>This procedure checks if the given display ID is valid and refers to
+an existing display.</p>
+<div class="refsect3">
+<a name="gimp-display-is-valid.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>display_ID</p></td>
+<td class="parameter_description"><p>The display to check.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-display-is-valid.returns"></a><h4>Returns</h4>
+<p> Whether the display ID is valid.</p>
+</div>
+<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-display-get-window-handle"></a><h3>gimp_display_get_window_handle ()</h3>
+<pre class="programlisting"><span class="returnvalue">gint</span>
+gimp_display_get_window_handle (<em class="parameter"><code><span class="type">gint32</span> display_ID</code></em>);</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>
+<div class="refsect3">
+<a name="gimp-display-get-window-handle.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>display_ID</p></td>
+<td class="parameter_description"><p>The display to get the window handle from.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-display-get-window-handle.returns"></a><h4>Returns</h4>
+<p> The native window handle or 0.</p>
+</div>
+<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-displays-flush"></a><h3>gimp_displays_flush ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_displays_flush (<em class="parameter"><code><span class="type">void</span></code></em>);</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>
+<div class="refsect3">
+<a name="gimp-displays-flush.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-displays-reconnect"></a><h3>gimp_displays_reconnect ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_displays_reconnect (<em class="parameter"><code><span class="type">gint32</span> old_image_ID</code></em>,
+                         <em class="parameter"><code><span class="type">gint32</span> new_image_ID</code></em>);</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>
+<div class="refsect3">
+<a name="gimp-displays-reconnect.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>old_image_ID</p></td>
+<td class="parameter_description"><p>The old image (must have at least one display).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>new_image_ID</p></td>
+<td class="parameter_description"><p>The new image (must not have a display).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-displays-reconnect.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.33.1</div>
+</body>
+</html>
+\ No newline at end of file
author	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-04-19 03:13:10 +0000
committer	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-04-19 03:13:10 +0000
commit	3c57dd931145d43f2b0aef96c4d178135956bf91 (patch)
tree	3de698981e9f0cc2c4f9569b19a5f3595e741f6b /devel-docs/libgimp/html/libgimp-gimpdisplay.html
parent	Initial commit. (diff)
download	gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.tar.xz gimp-3c57dd931145d43f2b0aef96c4d178135956bf91.zip