Imported Upstream version 2.8.0

This commit is contained in:
Jordi Mallach
2012-05-05 12:33:49 +02:00
parent 3fcab19200
commit f03e90f6fe
4714 changed files with 1354362 additions and 818907 deletions

View File

@ -31,38 +31,38 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpui.top_of_page"></a>gimpui</span></h2>
<p>gimpui — Common user interface functions. This header includes all other GIMP User
Interface Library headers.</p>
<p>gimpui — Common user interface functions. This header includes
all other GIMP User Interface Library headers.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimp-gimpui.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="libgimp-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);
<a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></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> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);
<a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></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> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="libgimp-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a> (<em class="parameter"><code>const <span class="type">gchar</span> *prog_name</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> preview</code></em>);
<span class="returnvalue">GdkWindow</span> * <a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window" title="gimp_ui_get_display_window ()">gimp_ui_get_display_window</a> (<em class="parameter"><code><span class="type">guint32</span> gdisp_ID</code></em>);
<span class="returnvalue">GdkWindow</span> * <a class="link" href="libgimp-gimpui.html#gimp-ui-get-progress-window" title="gimp_ui_get_progress_window ()">gimp_ui_get_progress_window</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a> (<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);
<span class="returnvalue">void</span> <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>
(<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);
(<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>,
<em class="parameter"><code><span class="type">guint32</span> gdisp_ID</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgimp-gimpui.description"></a><h2>Description</h2>
<p>
Common user interface functions. This header includes all other GIMP User
Interface Library headers.
Common user interface functions. This header includes all other
GIMP User Interface Library headers.
</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpui.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gimp-ui-init"></a><h3>gimp_ui_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_ui_init (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_ui_init (<em class="parameter"><code>const <span class="type">gchar</span> *prog_name</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> preview</code></em>);</pre>
<p>
This function initializes GTK+ with <a href="http://library.gnome.org/devel/gtk3/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a> and initializes GDK's
This function initializes GTK+ with <code class="function">gtk_init()</code> and initializes GDK's
image rendering subsystem (GdkRGB) to follow the GIMP main program's
colormap allocation/installation policy.
</p>
@ -79,7 +79,7 @@ this function.
<tr>
<td><p><span class="term"><em class="parameter"><code>prog_name</code></em> :</span></p></td>
<td>The name of the plug-in which will be passed as argv[0] to
<a href="http://library.gnome.org/devel/gtk3/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a>. It's a convention to use the name of the
<code class="function">gtk_init()</code>. It's a convention to use the name of the
executable and _not_ the PDB procedure name.</td>
</tr>
<tr>
@ -93,11 +93,11 @@ reasons only.</td>
<hr>
<div class="refsect2">
<a name="gimp-ui-get-display-window"></a><h3>gimp_ui_get_display_window ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gimp_ui_get_display_window (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> * gimp_ui_get_display_window (<em class="parameter"><code><span class="type">guint32</span> gdisp_ID</code></em>);</pre>
<p>
Returns the <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> of a display window. The purpose is to allow
Returns the <span class="type">GdkWindow</span> of a display window. The purpose is to allow
to make plug-in dialogs transient to the image display as explained
with <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a>.
with <code class="function">gdk_window_set_transient_for()</code>.
</p>
<p>
You shouldn't have to call this function directly. Use
@ -105,23 +105,29 @@ You shouldn't have to call this function directly. Use
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em> :</span></p></td>
<td>a <a href="/local/head/share/gtk-doc/html/app/GimpDisplay.html"><span class="type">GimpDisplay</span></a> ID.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A reference to a <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. You should
unref the window using <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> as soon as
<td>A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
unref the window using <code class="function">g_object_unref()</code> as soon as
you don't need it any longer.</td>
</tr></tbody>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-ui-get-progress-window"></a><h3>gimp_ui_get_progress_window ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gimp_ui_get_progress_window (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> * gimp_ui_get_progress_window (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> of the window this plug-in's progress bar is
Returns the <span class="type">GdkWindow</span> 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="http://library.gnome.org/devel/gdk3/gdk-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a>.
as explained with <code class="function">gdk_window_set_transient_for()</code>.
</p>
<p>
You shouldn't have to call this function directly. Use
@ -131,8 +137,8 @@ You shouldn't have to call this function directly. Use
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A reference to a <a href="http://library.gnome.org/devel/gdk3/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. You should
unref the window using <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> as soon as
<td>A reference to a <span class="type">GdkWindow</span> or <code class="literal">NULL</code>. You should
unref the window using <code class="function">g_object_unref()</code> as soon as
you don't need it any longer.</td>
</tr></tbody>
</table></div>
@ -141,7 +147,7 @@ you don't need it any longer.</td>
<hr>
<div class="refsect2">
<a name="gimp-window-set-transient"></a><h3>gimp_window_set_transient ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_window_set_transient (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_window_set_transient (<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>);</pre>
<p>
Indicates to the window manager that <em class="parameter"><code>window</code></em> is a transient dialog
associated with the GIMP window that the plug-in has been
@ -151,7 +157,7 @@ started from. See also <a class="link" href="libgimp-gimpui.html#gimp-window-set
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient</td>
<td>the <span class="type">GtkWindow</span> that should become transient</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
@ -160,12 +166,12 @@ started from. See also <a class="link" href="libgimp-gimpui.html#gimp-window-set
<div class="refsect2">
<a name="gimp-window-set-transient-for-display"></a><h3>gimp_window_set_transient_for_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_window_set_transient_for_display
(<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
(<em class="parameter"><code><span class="type">GtkWindow</span> *window</code></em>,
<em class="parameter"><code><span class="type">guint32</span> gdisp_ID</code></em>);</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="http://library.gnome.org/devel/gdk3/gdk-Windows.html#gdk-window-set-transient-for"><code class="function">gdk_window_set_transient_for()</code></a> for more information.
display ID. See <code class="function">gdk_window_set_transient_for()</code> for more information.
</p>
<p>
Most of the time you will want to use the convenience function
@ -176,7 +182,7 @@ Most of the time you will want to use the convenience function
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient</td>
<td>the <span class="type">GtkWindow</span> that should become transient</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em> :</span></p></td>
@ -189,12 +195,9 @@ Most of the time you will want to use the convenience function
</div>
<div class="refsect1">
<a name="libgimp-gimpui.see-also"></a><h2>See Also</h2>
<p>
<a href="http://library.gnome.org/devel/gtk3/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a>, <a href="http://library.gnome.org/devel/gdk3/gdk-General.html#gdk-set-use-xshm"><code class="function">gdk_set_use_xshm()</code></a>, <a href="http://library.gnome.org/devel/gdk3/gdk-GdkRGB.html#gdk-rgb-set-min-colors"><code class="function">gdk_rgb_set_min_colors()</code></a>,
<a href="http://library.gnome.org/devel/gdk3/gdk-GdkRGB.html#gdk-rgb-set-install"><code class="function">gdk_rgb_set_install()</code></a>, <a href="http://library.gnome.org/devel/gdk3/gdk-GdkRGB.html#gdk-rgb-get-visual"><code class="function">gdk_rgb_get_visual()</code></a>, <a href="http://library.gnome.org/devel/gdk3/gdk-GdkRGB.html#gdk-rgb-get-cmap"><code class="function">gdk_rgb_get_cmap()</code></a>,
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html#gtk-widget-set-default-visual"><code class="function">gtk_widget_set_default_visual()</code></a>, <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html#gtk-widget-set-default-colormap"><code class="function">gtk_widget_set_default_colormap()</code></a>,
<a href="http://library.gnome.org/devel/gtk3/GtkPreview.html#gtk-preview-set-gamma"><code class="function">gtk_preview_set_gamma()</code></a>.
</p>
gtk_init(), <code class="function">gdk_set_use_xshm()</code>, <code class="function">gdk_rgb_get_visual()</code>,
<code class="function">gdk_rgb_get_cmap()</code>, <code class="function">gtk_widget_set_default_visual()</code>,
<code class="function">gtk_widget_set_default_colormap()</code>, <code class="function">gtk_preview_set_gamma()</code>.
</div>
</div>
<div class="footer">