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

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpui</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<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">
@ -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="#id2589403" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2658953" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2704409" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2729159" 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="id2589403"></a><span class="refentrytitle">gimpui</span>
<a name="id2658953"></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>
@ -53,34 +53,18 @@ Interface Library headers.</p>
void <a href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *prog_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> preview);
<a
href="../gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* <a href="libgimp-gimpui.html#gimp-ui-get-display-window">gimp_ui_get_display_window</a> (<a
href="../glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);
<a
href="../gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* <a href="libgimp-gimpui.html#gimp-ui-get-progress-window">gimp_ui_get_progress_window</a> (void);
void <a href="libgimp-gimpui.html#gimp-window-set-transient">gimp_window_set_transient</a> (<a
href="../gtk/GtkWindow.html"
>GtkWindow</a> *window);
void <a href="libgimp-gimpui.html#gimp-window-set-transient-for-display">gimp_window_set_transient_for_display</a>
(<a
href="../gtk/GtkWindow.html"
>GtkWindow</a> *window,
<a
href="../glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);
void <a class="link" href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a> (const gchar *prog_name,
gboolean preview);
GdkWindow* <a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window">gimp_ui_get_display_window</a> (guint32 gdisp_ID);
GdkWindow* <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> (GtkWindow *window);
void <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display">gimp_window_set_transient_for_display</a>
(GtkWindow *window,
guint32 gdisp_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2704409"></a><h2>Description</h2>
<a name="id2729159"></a><h2>Description</h2>
<p>
Common user interface functions. This header includes all other GIMP User
Interface Library headers.
@ -88,20 +72,14 @@ Interface Library headers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2704426"></a><h2>Details</h2>
<a name="id2729176"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2704436"></a><h3>
<a name="id2729186"></a><h3>
<a name="gimp-ui-init"></a>gimp_ui_init ()</h3>
<a class="indexterm" name="id2704448"></a><pre class="programlisting">void gimp_ui_init (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *prog_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> preview);</pre>
<a class="indexterm" name="id2726395"></a><pre class="programlisting">void gimp_ui_init (const gchar *prog_name,
gboolean preview);</pre>
<p>
This function initializes GTK+ with <a
href="../gtk/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>
@ -115,16 +93,14 @@ gimprc variables <em class="parameter"><code>min_colors</code></em> and <em clas
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>prog_name</code></em>&#160;:</span></td>
<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"
><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 or something.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>preview</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>preview</code></em>&#160;:</span></p></td>
<td> This parameter is unused and exists for historical
reasons only.
</td>
@ -134,25 +110,17 @@ href="../gtk/gtk-General.html#gtk-init"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2710759"></a><h3>
<a name="id2726506"></a><h3>
<a name="gimp-ui-get-display-window"></a>gimp_ui_get_display_window ()</h3>
<a class="indexterm" name="id2710772"></a><pre class="programlisting"><a
href="../gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* gimp_ui_get_display_window (<a
href="../glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);</pre>
<a class="indexterm" name="id2726519"></a><pre class="programlisting">GdkWindow* gimp_ui_get_display_window (guint32 gdisp_ID);</pre>
<p>
Returns the <a
href="../gdk/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="../gdk/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
<a href="libgimp-gimpui.html#gimp-window-set-transient-for-display"><code class="function">gimp_window_set_transient_for_display()</code></a> instead.</p>
<a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display"><code class="function">gimp_window_set_transient_for_display()</code></a> instead.</p>
<p>
</p>
@ -160,20 +128,14 @@ You shouldn't have to call this function directly. Use
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A reference to a <a
href="../gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> or <a
href="../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"
><code class="function">g_object_unref()</code></a> as soon as
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<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>
@ -185,38 +147,26 @@ href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712718"></a><h3>
<a name="id2730128"></a><h3>
<a name="gimp-ui-get-progress-window"></a>gimp_ui_get_progress_window ()</h3>
<a class="indexterm" name="id2712731"></a><pre class="programlisting"><a
href="../gdk/gdk-Windows.html#GdkWindow"
>GdkWindow</a>* gimp_ui_get_progress_window (void);</pre>
<a class="indexterm" name="id2730142"></a><pre class="programlisting">GdkWindow* gimp_ui_get_progress_window (void);</pre>
<p>
Returns the <a
href="../gdk/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="../gdk/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
<a href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a> instead.</p>
<a class="link" href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A reference to a <a
href="../gdk/gdk-Windows.html#GdkWindow"
><span class="type">GdkWindow</span></a> or <a
href="../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"
><code class="function">g_object_unref()</code></a> as soon as
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<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>
@ -227,25 +177,21 @@ href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712834"></a><h3>
<a name="id2730245"></a><h3>
<a name="gimp-window-set-transient"></a>gimp_window_set_transient ()</h3>
<a class="indexterm" name="id2712847"></a><pre class="programlisting">void gimp_window_set_transient (<a
href="../gtk/GtkWindow.html"
>GtkWindow</a> *window);</pre>
<a class="indexterm" name="id2730258"></a><pre class="programlisting">void gimp_window_set_transient (GtkWindow *window);</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
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>
started from. See also <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display"><code class="function">gimp_window_set_transient_for_display()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></td>
<td> the <a
href="../gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> that should become transient
<td><p><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></p></td>
<td> the <span class="type">GtkWindow</span> that should become transient
</td>
</tr></tbody>
</table></div>
@ -254,25 +200,19 @@ href="../gtk/GtkWindow.html"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2712926"></a><h3>
<a name="id2727222"></a><h3>
<a name="gimp-window-set-transient-for-display"></a>gimp_window_set_transient_for_display ()</h3>
<a class="indexterm" name="id2712939"></a><pre class="programlisting">void gimp_window_set_transient_for_display
(<a
href="../gtk/GtkWindow.html"
>GtkWindow</a> *window,
<a
href="../glib/glib-Basic-Types.html#guint32"
>guint32</a> gdisp_ID);</pre>
<a class="indexterm" name="id2727235"></a><pre class="programlisting">void gimp_window_set_transient_for_display
(GtkWindow *window,
guint32 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"
><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
<a href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a>.</p>
<a class="link" href="libgimp-gimpui.html#gimp-window-set-transient"><code class="function">gimp_window_set_transient()</code></a>.</p>
<p>
</p>
@ -280,14 +220,12 @@ Most of the time you will want to use the convenience function
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></td>
<td> the <a
href="../gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> that should become transient
<td><p><span class="term"><em class="parameter"><code>window</code></em>&#160;:</span></p></td>
<td> the <span class="type">GtkWindow</span> that should become transient
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>gdisp_ID</code></em>&#160;:</span></p></td>
<td> display ID of the image window that should become the parent
</td>
</tr>
@ -298,30 +236,12 @@ href="../gtk/GtkWindow.html"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2709741"></a><h2>See Also</h2>
<a name="id2727351"></a><h2>See Also</h2>
<p>
<a
href="../gtk/gtk-General.html#gtk-init"
><code class="function">gtk_init()</code></a>, <a
href="../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"
><code class="function">gdk_rgb_set_min_colors()</code></a>,
<a
href="../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"
><code class="function">gdk_rgb_get_visual()</code></a>, <a
href="../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"
><code class="function">gtk_widget_set_default_visual()</code></a>, <a
href="../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"
><code class="function">gtk_preview_set_gamma()</code></a>.
<code class="function">gtk_init()</code>, <code class="function">gdk_set_use_xshm()</code>, <code class="function">gdk_rgb_set_min_colors()</code>,
<code class="function">gdk_rgb_set_install()</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>.
</p>
</div>
</div>