4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpdisplay</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
9
9
<link rel="prev" href="libgimp-gimpconvert.html" title="gimpconvert">
10
10
<link rel="next" href="libgimp-gimpdrawable.html" title="gimpdrawable">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
14
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
<link rel="index" href="libgimp-index.html" title="Index">
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimpdrawable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2556417" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2581879" class="shortcut">Top</a>
33
<a href="#id2577408" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2611518" class="shortcut">Description</a></nobr></td></tr>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpdisplay"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2556417"></a><span class="refentrytitle">gimpdisplay</span>
43
<a name="id2581879"></a><span class="refentrytitle">gimpdisplay</span>
42
45
<p>gimpdisplay — Functions to create, delete and flush new displays (views) on an image.</p>
52
gint32 <a href="libgimp-gimpdisplay.html#gimp-display-new">gimp_display_new</a> (gint32 image_ID);
53
gboolean <a href="libgimp-gimpdisplay.html#gimp-display-delete">gimp_display_delete</a> (gint32 display_ID);
54
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-flush">gimp_displays_flush</a> (void);
55
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-reconnect">gimp_displays_reconnect</a> (gint32 old_image_ID,
55
gint32 <a href="libgimp-gimpdisplay.html#gimp-display-new">gimp_display_new</a> (gint32 image_ID);
56
gboolean <a href="libgimp-gimpdisplay.html#gimp-display-delete">gimp_display_delete</a> (gint32 display_ID);
57
gboolean <a href="libgimp-gimpdisplay.html#gimp-display-is-valid">gimp_display_is_valid</a> (gint32 display_ID);
58
gint <a href="libgimp-gimpdisplay.html#gimp-display-get-window-handle">gimp_display_get_window_handle</a> (gint32 display_ID);
59
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-flush">gimp_displays_flush</a> (void);
60
gboolean <a href="libgimp-gimpdisplay.html#gimp-displays-reconnect">gimp_displays_reconnect</a> (gint32 old_image_ID,
59
64
<div class="refsect1" lang="en">
60
<a name="id2577408"></a><h2>Description</h2>
65
<a name="id2611518"></a><h2>Description</h2>
62
67
Functions to create, delete and flush new displays (views) on an image.
66
71
<div class="refsect1" lang="en">
67
<a name="id2577425"></a><h2>Details</h2>
72
<a name="id2611535"></a><h2>Details</h2>
68
73
<div class="refsect2" lang="en">
69
<a name="id2577436"></a><h3>
74
<a name="id2611546"></a><h3>
70
75
<a name="gimp-display-new"></a>gimp_display_new ()</h3>
71
<a class="indexterm" name="id2577448"></a><pre class="programlisting">gint32 gimp_display_new (gint32 image_ID);</pre>
76
<a class="indexterm" name="id2611558"></a><pre class="programlisting">gint32 gimp_display_new (gint32 image_ID);</pre>
73
78
Create a new display for the specified image.
76
81
Creates a new display for the specified image. If the image already
77
82
has a display, another is added. Multiple displays are handled
78
83
transparently by the GIMP. The newly created display is returned and
79
can be subsequently destroyed with a call to 'gimp-display-delete'.
84
can be subsequently destroyed with a call to <a href="libgimp-gimpdisplay.html#gimp-display-delete"><code class="function">gimp_display_delete()</code></a>.
80
85
This procedure only makes sense for use with the GIMP UI.</p>
85
90
<col align="left" valign="top">
89
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
93
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
95
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
98
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
96
99
<td> The new display.
103
106
<div class="refsect2" lang="en">
104
<a name="id2578337"></a><h3>
107
<a name="id2617011"></a><h3>
105
108
<a name="gimp-display-delete"></a>gimp_display_delete ()</h3>
106
<a class="indexterm" name="id2578350"></a><pre class="programlisting">gboolean gimp_display_delete (gint32 display_ID);</pre>
109
<a class="indexterm" name="id2617023"></a><pre class="programlisting">gboolean gimp_display_delete (gint32 display_ID);</pre>
108
111
Delete the specified display.
111
114
This procedure removes the specified display. If this is the last
112
115
remaining display for the underlying image, then the image is
116
deleted also. Note that the display is closed no matter if the image
117
is dirty or not. Better save the image before calling this
118
123
<col align="left" valign="top">
122
<span class="term"><em class="parameter"><code>display_ID</code></em> :</span></td>
126
<td><span class="term"><em class="parameter"><code>display_ID</code></em> :</span></td>
123
127
<td> The display to delete.
128
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
131
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
129
132
<td> TRUE on success.
136
139
<div class="refsect2" lang="en">
137
<a name="id2578414"></a><h3>
140
<a name="id2617091"></a><h3>
141
<a name="gimp-display-is-valid"></a>gimp_display_is_valid ()</h3>
142
<a class="indexterm" name="id2617105"></a><pre class="programlisting">gboolean gimp_display_is_valid (gint32 display_ID);</pre>
144
Returns TRUE if the display is valid.
147
This procedure checks if the given display ID is valid and refers to
148
an existing display.</p>
152
<div class="variablelist"><table border="0">
153
<col align="left" valign="top">
156
<td><span class="term"><em class="parameter"><code>display_ID</code></em> :</span></td>
157
<td> The display to check.
161
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
162
<td> Whether the display ID is valid.
168
<p class="since">Since GIMP 2.4
172
<div class="refsect2" lang="en">
173
<a name="id2617176"></a><h3>
174
<a name="gimp-display-get-window-handle"></a>gimp_display_get_window_handle ()</h3>
175
<a class="indexterm" name="id2617190"></a><pre class="programlisting">gint gimp_display_get_window_handle (gint32 display_ID);</pre>
177
Get a handle to the native window for an image display.
180
This procedure returns a handle to the native window for a given
181
image display. For example in the X backend of GDK, a native window
182
handle is an Xlib XID. A value of 0 is returned for an invalid
183
display or if this function is unimplemented for the windowing
184
system that is being used.</p>
188
<div class="variablelist"><table border="0">
189
<col align="left" valign="top">
192
<td><span class="term"><em class="parameter"><code>display_ID</code></em> :</span></td>
193
<td> The display to get the window handle from.
197
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
198
<td> The native window handle or 0.
204
<p class="since">Since GIMP 2.4
208
<div class="refsect2" lang="en">
209
<a name="id2613924"></a><h3>
138
210
<a name="gimp-displays-flush"></a>gimp_displays_flush ()</h3>
139
<a class="indexterm" name="id2578427"></a><pre class="programlisting">gboolean gimp_displays_flush (void);</pre>
211
<a class="indexterm" name="id2613937"></a><pre class="programlisting">gboolean gimp_displays_flush (void);</pre>
141
213
Flush all internal changes to the user interface
162
233
<div class="refsect2" lang="en">
163
<a name="id2578473"></a><h3>
234
<a name="id2613984"></a><h3>
164
235
<a name="gimp-displays-reconnect"></a>gimp_displays_reconnect ()</h3>
165
<a class="indexterm" name="id2578485"></a><pre class="programlisting">gboolean gimp_displays_reconnect (gint32 old_image_ID,
166
gint32 new_image_ID);</pre>
236
<a class="indexterm" name="id2613996"></a><pre class="programlisting">gboolean gimp_displays_reconnect (gint32 old_image_ID,
237
gint32 new_image_ID);</pre>
168
239
Reconnect displays from one image to another image.
179
250
<col align="left" valign="top">
183
<span class="term"><em class="parameter"><code>old_image_ID</code></em> :</span></td>
253
<td><span class="term"><em class="parameter"><code>old_image_ID</code></em> :</span></td>
184
254
<td> The old image (must have at least one display).
189
<span class="term"><em class="parameter"><code>new_image_ID</code></em> :</span></td>
258
<td><span class="term"><em class="parameter"><code>new_image_ID</code></em> :</span></td>
190
259
<td> The new image (must not have a display).
195
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
263
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
196
264
<td> TRUE on success.
added
removed
devel-docs/libgimp/html/libgimp-gimpdisplay.html
