Imported Upstream version 2.4.0

This commit is contained in:
Ari Pollak
2010-08-11 01:23:21 -04:00
parent f35d8506c6
commit 258b1471f0
781 changed files with 98804 additions and 57910 deletions

View File

@ -8,7 +8,7 @@
<link rel="up" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="prev" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="next" href="libgimp-gimpexport.html" title="gimpexport">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
@ -31,16 +31,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpexport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2628251" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2577111" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2729351" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2728878" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpui"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2628251"></a><span class="refentrytitle">gimpui</span>
<a name="id2577111"></a><span class="refentrytitle">gimpui</span>
</h2>
<p>gimpui &#8212; Common user interface functions. This header includes all other GIMP User
Interface Library headers.</p>
@ -54,33 +54,33 @@ Interface Library headers.</p>
void <a class="link" href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *prog_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> preview);
<a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* <a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window">gimp_ui_get_display_window</a> (<a
href="../glib/glib-Basic-Types.html#guint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);
<a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* <a class="link" href="libgimp-gimpui.html#gimp-ui-get-progress-window">gimp_ui_get_progress_window</a> (void);
void <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient">gimp_window_set_transient</a> (<a
href="../gtk/GtkWindow.html"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a> *window);
void <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display">gimp_window_set_transient_for_display</a>
(<a
href="../gtk/GtkWindow.html"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a> *window,
<a
href="../glib/glib-Basic-Types.html#guint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2729351"></a><h2>Description</h2>
<a name="id2728878"></a><h2>Description</h2>
<p>
Common user interface functions. This header includes all other GIMP User
Interface Library headers.
@ -88,19 +88,19 @@ Interface Library headers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2729368"></a><h2>Details</h2>
<a name="id2728896"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2729378"></a><h3>
<a name="id2728906"></a><h3>
<a name="gimp-ui-init"></a>gimp_ui_init ()</h3>
<a class="indexterm" name="id2729390"></a><pre class="programlisting">void gimp_ui_init (const <a
href="../glib/glib-Basic-Types.html#gchar"
<a class="indexterm" name="id2728917"></a><pre class="programlisting">void gimp_ui_init (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *prog_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> preview);</pre>
<p>
This function initializes GTK+ with <a
href="../gtk/gtk-General.html#gtk-init"
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
><code class="function">gtk_init()</code></a> and initializes GDK's
image rendering subsystem (GdkRGB) to follow the GIMP main program's
colormap allocation/installation policy.
@ -118,7 +118,7 @@ gimprc variables <em class="parameter"><code>min_colors</code></em> and <em clas
<td><p><span class="term"><em class="parameter"><code>prog_name</code></em>&#160;:</span></p></td>
<td> The name of the plug-in which will be passed as argv[0] to
<a
href="../gtk/gtk-General.html#gtk-init"
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
><code class="function">gtk_init()</code></a>. It's a convention to use the name of the
executable and _not_ the PDB procedure name or something.
</td>
@ -134,20 +134,20 @@ href="../gtk/gtk-General.html#gtk-init"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2726698"></a><h3>
<a name="id2727366"></a><h3>
<a name="gimp-ui-get-display-window"></a>gimp_ui_get_display_window ()</h3>
<a class="indexterm" name="id2726712"></a><pre class="programlisting"><a
href="../gdk/gdk-Windows.html#GdkWindow"
<a class="indexterm" name="id2727379"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* gimp_ui_get_display_window (<a
href="../glib/glib-Basic-Types.html#guint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);</pre>
<p>
Returns the <a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> of a display window. The purpose is to allow
to make plug-in dialogs transient to the image display as explained
with <a
href="../gdk/gdk-Windows.html#gdk-window-set-transient-for"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
><code class="function">gdk_window_set_transient_for()</code></a>.
</p>
<p>
@ -167,12 +167,12 @@ You shouldn't have to call this function directly. Use
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A reference to a <a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>. You should
unref the window using <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> as soon as
you don't need it any longer.
@ -185,18 +185,18 @@ href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2730402"></a><h3>
<a name="id2729839"></a><h3>
<a name="gimp-ui-get-progress-window"></a>gimp_ui_get_progress_window ()</h3>
<a class="indexterm" name="id2730415"></a><pre class="programlisting"><a
href="../gdk/gdk-Windows.html#GdkWindow"
<a class="indexterm" name="id2729852"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* gimp_ui_get_progress_window (void);</pre>
<p>
Returns the <a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> of the window this plug-in's progress bar is
shown in. Use it to make plug-in dialogs transient to this window
as explained with <a
href="../gdk/gdk-Windows.html#gdk-window-set-transient-for"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
><code class="function">gdk_window_set_transient_for()</code></a>.
</p>
<p>
@ -210,12 +210,12 @@ You shouldn't have to call this function directly. Use
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> A reference to a <a
href="../gdk/gdk-Windows.html#GdkWindow"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>. You should
unref the window using <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> as soon as
you don't need it any longer.
@ -227,10 +227,10 @@ href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2730519"></a><h3>
<a name="id2729956"></a><h3>
<a name="gimp-window-set-transient"></a>gimp_window_set_transient ()</h3>
<a class="indexterm" name="id2730532"></a><pre class="programlisting">void gimp_window_set_transient (<a
href="../gtk/GtkWindow.html"
<a class="indexterm" name="id2729969"></a><pre class="programlisting">void gimp_window_set_transient (<a
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a> *window);</pre>
<p>
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
@ -244,7 +244,7 @@ started from. See also <a class="link" href="libgimp-gimpui.html#gimp-window-set
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></p></td>
<td> the <a
href="../gtk/GtkWindow.html"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> that should become transient
</td>
</tr></tbody>
@ -254,20 +254,20 @@ href="../gtk/GtkWindow.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2730610"></a><h3>
<a name="id2731072"></a><h3>
<a name="gimp-window-set-transient-for-display"></a>gimp_window_set_transient_for_display ()</h3>
<a class="indexterm" name="id2727394"></a><pre class="programlisting">void gimp_window_set_transient_for_display
<a class="indexterm" name="id2731085"></a><pre class="programlisting">void gimp_window_set_transient_for_display
(<a
href="../gtk/GtkWindow.html"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
>GtkWindow</a> *window,
<a
href="../glib/glib-Basic-Types.html#guint32"
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);</pre>
<p>
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
associated with the GIMP image window that is identified by it's
display ID. See <a
href="../gdk/gdk-Windows.html#gdk-window-set-transient-for"
href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#gdk-window-set-transient-for"
><code class="function">gdk_window_set_transient_for()</code></a> for more information.
</p>
<p>
@ -282,7 +282,7 @@ Most of the time you will want to use the convenience function
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></p></td>
<td> the <a
href="../gtk/GtkWindow.html"
href="/usr/share/gtk-doc/html/gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> that should become transient
</td>
</tr>
@ -298,32 +298,37 @@ href="../gtk/GtkWindow.html"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2727510"></a><h2>See Also</h2>
<a name="id2731202"></a><h2>See Also</h2>
<p>
<a
href="../gtk/gtk-General.html#gtk-init"
href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"
><code class="function">gtk_init()</code></a>, <a
href="../gdk/gdk-General.html#gdk-set-use-xshm"
href="/usr/share/gtk-doc/html/gdk/gdk-General.html#gdk-set-use-xshm"
><code class="function">gdk_set_use_xshm()</code></a>, <a
href="../gdk/gdk-GdkRGB.html#gdk-rgb-set-min-colors"
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-set-min-colors"
><code class="function">gdk_rgb_set_min_colors()</code></a>,
<a
href="../gdk/gdk-GdkRGB.html#gdk-rgb-set-install"
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-set-install"
><code class="function">gdk_rgb_set_install()</code></a>, <a
href="../gdk/gdk-GdkRGB.html#gdk-rgb-get-visual"
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-get-visual"
><code class="function">gdk_rgb_get_visual()</code></a>, <a
href="../gdk/gdk-GdkRGB.html#gdk-rgb-get-cmap"
href="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-get-cmap"
><code class="function">gdk_rgb_get_cmap()</code></a>,
<a
href="../gtk/GtkWidget.html#gtk-widget-set-default-visual"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-default-visual"
><code class="function">gtk_widget_set_default_visual()</code></a>, <a
href="../gtk/GtkWidget.html#gtk-widget-set-default-colormap"
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-set-default-colormap"
><code class="function">gtk_widget_set_default_colormap()</code></a>,
<a
href="../gtk/GtkPreview.html#gtk-preview-set-gamma"
href="/usr/share/gtk-doc/html/gtk/GtkPreview.html#gtk-preview-set-gamma"
><code class="function">gtk_preview_set_gamma()</code></a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2731293"></a><div class="refsect2" lang="en"><a name="id2731294"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2731295"></a></div>
</div>
</div>
</body>
</html>