← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpui.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpui.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpui</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="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
8
<link rel="up" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
9
9
<link rel="prev" href="libgimpui-hierarchy.html" title="Object Hierarchy">
10
10
<link rel="next" href="libgimp-gimpexport.html" title="gimpexport">
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&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;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&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;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">
21
24
</head>
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-gimpexport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2555096" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2594443" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2587044" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2711053" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpui"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2555096"></a><span class="refentrytitle">gimpui</span>
 
43
<a name="id2594443"></a><span class="refentrytitle">gimpui</span>
41
44
</h2>
42
45
<p>gimpui &#8212; Common user interface functions. This header includes all other GIMP User
43
46
Interface Library headers.</p>
50
53
 
51
54
 
52
55
 
53
 
void        <a href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a>                    (const gchar *prog_name,
54
 
                                             gboolean preview);
 
56
void                <a href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a>                        (const gchar *prog_name,
 
57
                                                         gboolean preview);
 
58
GdkWindow*          <a href="libgimp-gimpui.html#gimp-ui-get-display-window">gimp_ui_get_display_window</a>          (guint32 gdisp_ID);
 
59
GdkWindow*          <a href="libgimp-gimpui.html#gimp-ui-get-progress-window">gimp_ui_get_progress_window</a>         (void);
 
60
void                <a href="libgimp-gimpui.html#gimp-window-set-transient">gimp_window_set_transient</a>           (GtkWindow *window);
 
61
void                <a href="libgimp-gimpui.html#gimp-window-set-transient-for-display">gimp_window_set_transient_for_display</a>
 
62
                                                        (GtkWindow *window,
 
63
                                                         guint32 gdisp_ID);
55
64
</pre>
56
65
</div>
57
66
<div class="refsect1" lang="en">
58
 
<a name="id2587044"></a><h2>Description</h2>
 
67
<a name="id2711053"></a><h2>Description</h2>
59
68
<p>
60
69
Common user interface functions. This header includes all other GIMP User
61
70
Interface Library headers.
63
72
</p>
64
73
</div>
65
74
<div class="refsect1" lang="en">
66
 
<a name="id2651878"></a><h2>Details</h2>
 
75
<a name="id2711070"></a><h2>Details</h2>
67
76
<div class="refsect2" lang="en">
68
 
<a name="id2650752"></a><h3>
 
77
<a name="id2711080"></a><h3>
69
78
<a name="gimp-ui-init"></a>gimp_ui_init ()</h3>
70
 
<a class="indexterm" name="id2650763"></a><pre class="programlisting">void        gimp_ui_init                    (const gchar *prog_name,
71
 
                                             gboolean preview);</pre>
 
79
<a class="indexterm" name="id2711092"></a><pre class="programlisting">void                gimp_ui_init                        (const gchar *prog_name,
 
80
                                                         gboolean preview);</pre>
72
81
<p>
73
82
This function initializes GTK+ with <code class="function">gtk_init()</code> and initializes GDK's
74
83
image rendering subsystem (GdkRGB) to follow the GIMP main program's
84
93
<col align="left" valign="top">
85
94
<tbody>
86
95
<tr>
87
 
<td>
88
 
<span class="term"><em class="parameter"><code>prog_name</code></em>&#160;:</span></td>
 
96
<td><span class="term"><em class="parameter"><code>prog_name</code></em>&#160;:</span></td>
89
97
<td> The name of the plug-in which will be passed as argv[0] to
90
98
            <code class="function">gtk_init()</code>. It's a convention to use the name of the
91
99
            executable and _not_ the PDB procedure name or something.
92
100
</td>
93
101
</tr>
94
102
<tr>
95
 
<td>
96
 
<span class="term"><em class="parameter"><code>preview</code></em>&#160;:</span></td>
 
103
<td><span class="term"><em class="parameter"><code>preview</code></em>&#160;:</span></td>
97
104
<td>   This parameter is unused and exists for historical
98
105
            reasons only.
99
106
</td>
101
108
</tbody>
102
109
</table></div>
103
110
</div>
 
111
<hr>
 
112
<div class="refsect2" lang="en">
 
113
<a name="id2707517"></a><h3>
 
114
<a name="gimp-ui-get-display-window"></a>gimp_ui_get_display_window ()</h3>
 
115
<a class="indexterm" name="id2707530"></a><pre class="programlisting">GdkWindow*          gimp_ui_get_display_window          (guint32 gdisp_ID);</pre>
 
116
<p>
 
117
Returns the <span class="type">GdkWindow</span> of a display window. The purpose is to allow
 
118
to make plug-in dialogs transient to the image display as explained
 
119
with <code class="function">gdk_window_set_transient_for()</code>.
 
120
</p>
 
121
<p>
 
122
You shouldn't have to call this function directly. Use
 
123
<a href="libgimp-gimpui.html#gimp-window-set-transient-for-display"><code class="function">gimp_window_set_transient_for_display()</code></a> instead.</p>
 
124
<p>
 
125
 
 
126
</p>
 
127
<div class="variablelist"><table border="0">
 
128
<col align="left" valign="top">
 
129
<tbody>
 
130
<tr>
 
131
<td><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></td>
 
132
<td>
 
133
</td>
 
134
</tr>
 
135
<tr>
 
136
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
137
<td> A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
 
138
              unref the window using <code class="function">g_object_unref()</code> as soon as
 
139
              you don't need it any longer.
 
140
 
 
141
</td>
 
142
</tr>
 
143
</tbody>
 
144
</table></div>
 
145
<p class="since">Since  GIMP 2.4
 
146
</p>
 
147
</div>
 
148
<hr>
 
149
<div class="refsect2" lang="en">
 
150
<a name="id2709149"></a><h3>
 
151
<a name="gimp-ui-get-progress-window"></a>gimp_ui_get_progress_window ()</h3>
 
152
<a class="indexterm" name="id2709163"></a><pre class="programlisting">GdkWindow*          gimp_ui_get_progress_window         (void);</pre>
 
153
<p>
 
154
Returns the <span class="type">GdkWindow</span> of the window this plug-in's progress bar is
 
155
shown in. Use it to make plug-in dialogs transient to this window
 
156
as explained with <code class="function">gdk_window_set_transient_for()</code>.
 
157
</p>
 
158
<p>
 
159
You shouldn't have to call this function directly. Use
 
160
<a href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a> instead.</p>
 
161
<p>
 
162
 
 
163
</p>
 
164
<div class="variablelist"><table border="0">
 
165
<col align="left" valign="top">
 
166
<tbody><tr>
 
167
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
168
<td> A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
 
169
              unref the window using <code class="function">g_object_unref()</code> as soon as
 
170
              you don't need it any longer.
 
171
 
 
172
</td>
 
173
</tr></tbody>
 
174
</table></div>
 
175
<p class="since">Since  GIMP 2.4
 
176
</p>
 
177
</div>
 
178
<hr>
 
179
<div class="refsect2" lang="en">
 
180
<a name="id2712646"></a><h3>
 
181
<a name="gimp-window-set-transient"></a>gimp_window_set_transient ()</h3>
 
182
<a class="indexterm" name="id2712660"></a><pre class="programlisting">void                gimp_window_set_transient           (GtkWindow *window);</pre>
 
183
<p>
 
184
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
 
185
associated with the GIMP window that the plug-in has been
 
186
started from. See also <a href="libgimp-gimpui.html#gimp-window-set-transient-for-display"><code class="function">gimp_window_set_transient_for_display()</code></a>.</p>
 
187
<p>
 
188
 
 
189
</p>
 
190
<div class="variablelist"><table border="0">
 
191
<col align="left" valign="top">
 
192
<tbody><tr>
 
193
<td><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></td>
 
194
<td> the <span class="type">GtkWindow</span> that should become transient
 
195
</td>
 
196
</tr></tbody>
 
197
</table></div>
 
198
<p class="since">Since  GIMP 2.4
 
199
</p>
 
200
</div>
 
201
<hr>
 
202
<div class="refsect2" lang="en">
 
203
<a name="id2712738"></a><h3>
 
204
<a name="gimp-window-set-transient-for-display"></a>gimp_window_set_transient_for_display ()</h3>
 
205
<a class="indexterm" name="id2712752"></a><pre class="programlisting">void                gimp_window_set_transient_for_display
 
206
                                                        (GtkWindow *window,
 
207
                                                         guint32 gdisp_ID);</pre>
 
208
<p>
 
209
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
 
210
associated with the GIMP image window that is identified by it's
 
211
display ID.  See <code class="function">gdk_window_set_transient_for()</code> for more information.
 
212
</p>
 
213
<p>
 
214
Most of the time you will want to use the convenience function
 
215
<a href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a>.</p>
 
216
<p>
 
217
 
 
218
</p>
 
219
<div class="variablelist"><table border="0">
 
220
<col align="left" valign="top">
 
221
<tbody>
 
222
<tr>
 
223
<td><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></td>
 
224
<td>   the <span class="type">GtkWindow</span> that should become transient
 
225
</td>
 
226
</tr>
 
227
<tr>
 
228
<td><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></td>
 
229
<td> display ID of the image window that should become the parent
 
230
</td>
 
231
</tr>
 
232
</tbody>
 
233
</table></div>
 
234
<p class="since">Since  GIMP 2.4
 
235
</p>
 
236
</div>
104
237
</div>
105
238
<div class="refsect1" lang="en">
106
 
<a name="id2650875"></a><h2>See Also</h2>
 
239
<a name="id2710057"></a><h2>See Also</h2>
107
240
<p>
108
241
<code class="function">gtk_init()</code>, <code class="function">gdk_set_use_xshm()</code>, <code class="function">gdk_rgb_set_min_colors()</code>,
109
242
<code class="function">gdk_rgb_set_install()</code>, <code class="function">gdk_rgb_get_visual()</code>, <code class="function">gdk_rgb_get_cmap()</code>,