← 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): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpui.html
48
48
<div class="refsynopsisdiv">
49
49
<a name="libgimp-gimpui.synopsis"></a><h2>Synopsis</h2>
50
50
<pre class="synopsis">
51
 
void                <a class="link" href="libgimp-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a>                        (const <a
52
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
53
 
>gchar</a> *prog_name,
54
 
                                                         <a
55
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
56
 
>gboolean</a> preview);
57
 
<a
58
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
59
 
>GdkWindow</a>*          <a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window" title="gimp_ui_get_display_window ()">gimp_ui_get_display_window</a>          (<a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
61
 
>guint32</a> gdisp_ID);
62
 
<a
63
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
64
 
>GdkWindow</a>*          <a class="link" href="libgimp-gimpui.html#gimp-ui-get-progress-window" title="gimp_ui_get_progress_window ()">gimp_ui_get_progress_window</a>         (void);
65
 
void                <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a>           (<a
66
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
67
 
>GtkWindow</a> *window);
 
51
void                <a class="link" href="libgimp-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a>                        (const gchar *prog_name,
 
52
                                                         gboolean preview);
 
53
GdkWindow*          <a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window" title="gimp_ui_get_display_window ()">gimp_ui_get_display_window</a>          (guint32 gdisp_ID);
 
54
GdkWindow*          <a class="link" href="libgimp-gimpui.html#gimp-ui-get-progress-window" title="gimp_ui_get_progress_window ()">gimp_ui_get_progress_window</a>         (void);
 
55
void                <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a>           (GtkWindow *window);
68
56
void                <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()">gimp_window_set_transient_for_display</a>
69
 
                                                        (<a
70
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
71
 
>GtkWindow</a> *window,
72
 
                                                         <a
73
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
74
 
>guint32</a> gdisp_ID);
 
57
                                                        (GtkWindow *window,
 
58
                                                         guint32 gdisp_ID);
75
59
</pre>
76
60
</div>
77
61
<div class="refsect1" lang="en">
86
70
<a name="libgimp-gimpui.details"></a><h2>Details</h2>
87
71
<div class="refsect2" lang="en">
88
72
<a name="gimp-ui-init"></a><h3>gimp_ui_init ()</h3>
89
 
<pre class="programlisting">void                gimp_ui_init                        (const <a
90
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
91
 
>gchar</a> *prog_name,
92
 
                                                         <a
93
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
94
 
>gboolean</a> preview);</pre>
 
73
<pre class="programlisting">void                gimp_ui_init                        (const gchar *prog_name,
 
74
                                                         gboolean preview);</pre>
95
75
<p>
96
 
This function initializes GTK+ with <a
97
 
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
98
 
><code class="function">gtk_init()</code></a> and initializes GDK's
 
76
This function initializes GTK+ with <code class="function">gtk_init()</code> and initializes GDK's
99
77
image rendering subsystem (GdkRGB) to follow the GIMP main program's
100
78
colormap allocation/installation policy.
101
79
</p>
111
89
<tr>
112
90
<td><p><span class="term"><em class="parameter"><code>prog_name</code></em> :</span></p></td>
113
91
<td> The name of the plug-in which will be passed as argv[0] to
114
 
            <a
115
 
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
116
 
><code class="function">gtk_init()</code></a>. It's a convention to use the name of the
 
92
            <code class="function">gtk_init()</code>. It's a convention to use the name of the
117
93
            executable and _not_ the PDB procedure name or something.
118
94
</td>
119
95
</tr>
129
105
<hr>
130
106
<div class="refsect2" lang="en">
131
107
<a name="gimp-ui-get-display-window"></a><h3>gimp_ui_get_display_window ()</h3>
132
 
<pre class="programlisting"><a
133
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
134
 
>GdkWindow</a>*          gimp_ui_get_display_window          (<a
135
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
136
 
>guint32</a> gdisp_ID);</pre>
 
108
<pre class="programlisting">GdkWindow*          gimp_ui_get_display_window          (guint32 gdisp_ID);</pre>
137
109
<p>
138
 
Returns the <a
139
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
140
 
><span class="type">GdkWindow</span></a> of a display window. The purpose is to allow
 
110
Returns the <span class="type">GdkWindow</span> of a display window. The purpose is to allow
141
111
to make plug-in dialogs transient to the image display as explained
142
 
with <a
143
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
144
 
><code class="function">gdk_window_set_transient_for()</code></a>.
 
112
with <code class="function">gdk_window_set_transient_for()</code>.
145
113
</p>
146
114
<p>
147
115
You shouldn't have to call this function directly. Use
159
127
</tr>
160
128
<tr>
161
129
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162
 
<td> A reference to a <a
163
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
164
 
><span class="type">GdkWindow</span></a> or <a
165
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
166
 
><code class="literal">NULL</code></a>. You should
167
 
              unref the window using <a
168
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
169
 
><code class="function">g_object_unref()</code></a> as soon as
 
130
<td> A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
 
131
              unref the window using <code class="function">g_object_unref()</code> as soon as
170
132
              you don't need it any longer.
171
133
 
172
134
</td>
179
141
<hr>
180
142
<div class="refsect2" lang="en">
181
143
<a name="gimp-ui-get-progress-window"></a><h3>gimp_ui_get_progress_window ()</h3>
182
 
<pre class="programlisting"><a
183
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
184
 
>GdkWindow</a>*          gimp_ui_get_progress_window         (void);</pre>
 
144
<pre class="programlisting">GdkWindow*          gimp_ui_get_progress_window         (void);</pre>
185
145
<p>
186
 
Returns the <a
187
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
188
 
><span class="type">GdkWindow</span></a> of the window this plug-in's progress bar is
 
146
Returns the <span class="type">GdkWindow</span> of the window this plug-in's progress bar is
189
147
shown in. Use it to make plug-in dialogs transient to this window
190
 
as explained with <a
191
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
192
 
><code class="function">gdk_window_set_transient_for()</code></a>.
 
148
as explained with <code class="function">gdk_window_set_transient_for()</code>.
193
149
</p>
194
150
<p>
195
151
You shouldn't have to call this function directly. Use
201
157
<col align="left" valign="top">
202
158
<tbody><tr>
203
159
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
204
 
<td> A reference to a <a
205
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
206
 
><span class="type">GdkWindow</span></a> or <a
207
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
208
 
><code class="literal">NULL</code></a>. You should
209
 
              unref the window using <a
210
 
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
211
 
><code class="function">g_object_unref()</code></a> as soon as
 
160
<td> A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
 
161
              unref the window using <code class="function">g_object_unref()</code> as soon as
212
162
              you don't need it any longer.
213
163
 
214
164
</td>
220
170
<hr>
221
171
<div class="refsect2" lang="en">
222
172
<a name="gimp-window-set-transient"></a><h3>gimp_window_set_transient ()</h3>
223
 
<pre class="programlisting">void                gimp_window_set_transient           (<a
224
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
225
 
>GtkWindow</a> *window);</pre>
 
173
<pre class="programlisting">void                gimp_window_set_transient           (GtkWindow *window);</pre>
226
174
<p>
227
175
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
228
176
associated with the GIMP window that the plug-in has been
234
182
<col align="left" valign="top">
235
183
<tbody><tr>
236
184
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
237
 
<td> the <a
238
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
239
 
><span class="type">GtkWindow</span></a> that should become transient
 
185
<td> the <span class="type">GtkWindow</span> that should become transient
240
186
</td>
241
187
</tr></tbody>
242
188
</table></div>
247
193
<div class="refsect2" lang="en">
248
194
<a name="gimp-window-set-transient-for-display"></a><h3>gimp_window_set_transient_for_display ()</h3>
249
195
<pre class="programlisting">void                gimp_window_set_transient_for_display
250
 
                                                        (<a
251
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
252
 
>GtkWindow</a> *window,
253
 
                                                         <a
254
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
255
 
>guint32</a> gdisp_ID);</pre>
 
196
                                                        (GtkWindow *window,
 
197
                                                         guint32 gdisp_ID);</pre>
256
198
<p>
257
199
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
258
200
associated with the GIMP image window that is identified by it's
259
 
display ID.  See <a
260
 
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
261
 
><code class="function">gdk_window_set_transient_for()</code></a> for more information.
 
201
display ID.  See <code class="function">gdk_window_set_transient_for()</code> for more information.
262
202
</p>
263
203
<p>
264
204
Most of the time you will want to use the convenience function
271
211
<tbody>
272
212
<tr>
273
213
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
274
 
<td>   the <a
275
 
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
276
 
><span class="type">GtkWindow</span></a> that should become transient
 
214
<td>   the <span class="type">GtkWindow</span> that should become transient
277
215
</td>
278
216
</tr>
279
217
<tr>
290
228
<div class="refsect1" lang="en">
291
229
<a name="libgimp-gimpui.see-also"></a><h2>See Also</h2>
292
230
<p>
293
 
<a
294
 
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
295
 
><code class="function">gtk_init()</code></a>, <a
296
 
href="/usr/share/gtk-doc/html/gdk/gdk-General.html#gdk-set-use-xshm"
297
 
><code class="function">gdk_set_use_xshm()</code></a>, <a
298
 
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-set-min-colors"
299
 
><code class="function">gdk_rgb_set_min_colors()</code></a>,
300
 
<a
301
 
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-set-install"
302
 
><code class="function">gdk_rgb_set_install()</code></a>, <a
303
 
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-get-visual"
304
 
><code class="function">gdk_rgb_get_visual()</code></a>, <a
305
 
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-get-cmap"
306
 
><code class="function">gdk_rgb_get_cmap()</code></a>,
307
 
<a
308
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-default-visual"
309
 
><code class="function">gtk_widget_set_default_visual()</code></a>, <a
310
 
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-default-colormap"
311
 
><code class="function">gtk_widget_set_default_colormap()</code></a>,
312
 
<a
313
 
href="/usr/share/gtk-doc/html/gtk/GtkPreview.html#gtk-preview-set-gamma"
314
 
><code class="function">gtk_preview_set_gamma()</code></a>.
 
231
<code class="function">gtk_init()</code>, <code class="function">gdk_set_use_xshm()</code>, <code class="function">gdk_rgb_set_min_colors()</code>,
 
232
<code class="function">gdk_rgb_set_install()</code>, <code class="function">gdk_rgb_get_visual()</code>, <code class="function">gdk_rgb_get_cmap()</code>,
 
233
<code class="function">gtk_widget_set_default_visual()</code>, <code class="function">gtk_widget_set_default_colormap()</code>,
 
234
<code class="function">gtk_preview_set_gamma()</code>.
315
235
</p>
316
236
</div>
317
237
</div>