callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.6.12

Browse Source
This commit is contained in:
Ari Pollak
2012-02-18 13:51:51 -05:00
parent 357cf155b6
commit 3fcab19200
550 changed files with 140833 additions and 99740 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
devel-docs/libgimp/html/libgimp-gimpui.html
View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpui</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. 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.15 (XML mode)">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -26,7 +26,7 @@
<a href="#libgimp-gimpui.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpui">
<div class="refentry">
<a name="libgimp-gimpui"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
@ -36,33 +36,33 @@ Interface Library headers.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);
<a href="/usr/share/gtk-doc/html/gdk/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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);
<a href="/usr/share/gtk-doc/html/gdk/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="/usr/share/gtk-doc/html/gtk/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 <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>);
<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="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);
(<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>
</div>
<div class="refsect1" title="Description">
<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.
</p>
</div>
<div class="refsect1" title="Details">
<div class="refsect1">
<a name="libgimp-gimpui.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_ui_init ()">
<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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/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 <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>
<p>
This function initializes GTK+ with <a href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a> and initializes GDK's
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
image rendering subsystem (GdkRGB) to follow the GIMP main program's
colormap allocation/installation policy.
</p>
@ -79,27 +79,25 @@ 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="/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.
</td>
<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
executable and _not_ the PDB procedure name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>preview</code></em> :</span></p></td>
<td>This parameter is unused and exists for historical
reasons only.
</td>
reasons only.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_ui_get_display_window ()">
<div class="refsect2">
<a name="gimp-ui-get-display-window"></a><h3>gimp_ui_get_display_window ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gimp_ui_get_display_window (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<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>
<p>
Returns the <a 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
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
to make plug-in dialogs transient to the image display as explained
with <a 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>.
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>.
</p>
<p>
You shouldn't have to call this function directly. Use
@ -107,32 +105,23 @@ You shouldn't have to call this function directly. Use
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A reference to a <a href="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> or <a 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="/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.
</td>
</tr>
</tbody>
<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
you don't need it any longer.</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_ui_get_progress_window ()">
<div class="refsect2">
<a name="gimp-ui-get-progress-window"></a><h3>gimp_ui_get_progress_window ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gdk/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"><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>
<p>
Returns the <a 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
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
shown in. Use it to make plug-in dialogs transient to this window
as explained with <a 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>.
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>.
</p>
<p>
You shouldn't have to call this function directly. Use
@ -142,19 +131,17 @@ 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="/usr/share/gtk-doc/html/gdk/gdk-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> or <a 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="/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.
</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
you don't need it any longer.</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_window_set_transient ()">
<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="/usr/share/gtk-doc/html/gtk/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><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *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
@ -164,22 +151,21 @@ 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="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient
</td>
<td>the <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient</td>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_window_set_transient_for_display ()">
<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="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
(<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>
<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="/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.
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.
</p>
<p>
Most of the time you will want to use the convenience function
@ -190,31 +176,29 @@ 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="/usr/share/gtk-doc/html/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient
</td>
<td>the <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> that should become transient</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em> :</span></p></td>
<td>display ID of the image window that should become the parent
</td>
<td>display ID of the image window that should become the parent</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
</div>
<div class="refsect1" title="See Also">
<div class="refsect1">
<a name="libgimp-gimpui.see-also"></a><h2>See Also</h2>
<p>
<a href="/usr/share/gtk-doc/html/gtk/gtk-General.html#gtk-init"><code class="function">gtk_init()</code></a>, <a 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="/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="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-set-install"><code class="function">gdk_rgb_set_install()</code></a>, <a 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="/usr/share/gtk-doc/html/gdk/gdk-GdkRGB.html#gdk-rgb-get-cmap"><code class="function">gdk_rgb_get_cmap()</code></a>,
<a 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="/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="/usr/share/gtk-doc/html/gtk/GtkPreview.html#gtk-preview-set-gamma"><code class="function">gtk_preview_set_gamma()</code></a>.
<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>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
Generated by GTK-Doc V1.18</div>
</body>
</html>