1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpdisplay">
<refmeta>
<refentrytitle role="top_of_page">gimpdisplay</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpdisplay</refname>
<refpurpose>Functions to create, delete and flush new displays (views) on an image.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gint32">gint32</link> <link linkend="gimp-display-new">gimp_display_new</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-display-delete">gimp_display_delete</link> (<link linkend="gint32">gint32</link> display_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-displays-flush">gimp_displays_flush</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-displays-reconnect">gimp_displays_reconnect</link> (<link linkend="gint32">gint32</link> old_image_ID,
<link linkend="gint32">gint32</link> new_image_ID);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions to create, delete and flush new displays (views) on an image.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-display-new" role="function"/>gimp_display_new ()</title>
<indexterm><primary>gimp_display_new</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_display_new (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Create a new display for the specified image.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new display.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-display-delete" role="function"/>gimp_display_delete ()</title>
<indexterm><primary>gimp_display_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_display_delete (<link linkend="gint32">gint32</link> display_ID);</programlisting>
<para>
Delete the specified display.
</para>
<para>
This procedure removes the specified display. If this is the last
remaining display for the underlying image, then the image is
deleted also.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>display_ID</parameter> :</term>
<listitem><simpara> The display to delete.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-displays-flush" role="function"/>gimp_displays_flush ()</title>
<indexterm><primary>gimp_displays_flush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_displays_flush (void);</programlisting>
<para>
Flush all internal changes to the user interface
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-displays-reconnect" role="function"/>gimp_displays_reconnect ()</title>
<indexterm><primary>gimp_displays_reconnect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_displays_reconnect (<link linkend="gint32">gint32</link> old_image_ID,
<link linkend="gint32">gint32</link> new_image_ID);</programlisting>
<para>
Reconnect displays from one image to another image.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>old_image_ID</parameter> :</term>
<listitem><simpara> The old image (must have at least one display).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_image_ID</parameter> :</term>
<listitem><simpara> The new image (must not have a display).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
