250 lines
11 KiB
HTML
250 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<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">
|
|
<link rel="start" 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.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
|
|
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
|
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
<tr valign="middle">
|
|
<td><a accesskey="p" href="libgimpui-hierarchy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
<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="#id2594443" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2711053" 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="id2594443"></a><span class="refentrytitle">gimpui</span>
|
|
</h2>
|
|
<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">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
void <a href="libgimp-gimpui.html#gimp-ui-init">gimp_ui_init</a> (const gchar *prog_name,
|
|
gboolean preview);
|
|
GdkWindow* <a href="libgimp-gimpui.html#gimp-ui-get-display-window">gimp_ui_get_display_window</a> (guint32 gdisp_ID);
|
|
GdkWindow* <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> (GtkWindow *window);
|
|
void <a 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="id2711053"></a><h2>Description</h2>
|
|
<p>
|
|
Common user interface functions. This header includes all other GIMP User
|
|
Interface Library headers.
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2711070"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2711080"></a><h3>
|
|
<a name="gimp-ui-init"></a>gimp_ui_init ()</h3>
|
|
<a class="indexterm" name="id2711092"></a><pre class="programlisting">void gimp_ui_init (const gchar *prog_name,
|
|
gboolean preview);</pre>
|
|
<p>
|
|
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>
|
|
<p>
|
|
The GIMP's colormap policy can be determinded by the user with the
|
|
gimprc variables <em class="parameter"><code>min_colors</code></em> and <em class="parameter"><code>install_cmap</code></em>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>prog_name</code></em> :</span></td>
|
|
<td> The name of the plug-in which will be passed as argv[0] to
|
|
<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> :</span></td>
|
|
<td> This parameter is unused and exists for historical
|
|
reasons only.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2707517"></a><h3>
|
|
<a name="gimp-ui-get-display-window"></a>gimp_ui_get_display_window ()</h3>
|
|
<a class="indexterm" name="id2707530"></a><pre class="programlisting">GdkWindow* gimp_ui_get_display_window (guint32 gdisp_ID);</pre>
|
|
<p>
|
|
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 <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>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>gdisp_ID</code></em> :</span></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2709149"></a><h3>
|
|
<a name="gimp-ui-get-progress-window"></a>gimp_ui_get_progress_window ()</h3>
|
|
<a class="indexterm" name="id2709163"></a><pre class="programlisting">GdkWindow* gimp_ui_get_progress_window (void);</pre>
|
|
<p>
|
|
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 <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>
|
|
<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> :</span></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>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2712646"></a><h3>
|
|
<a name="gimp-window-set-transient"></a>gimp_window_set_transient ()</h3>
|
|
<a class="indexterm" name="id2712660"></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>
|
|
<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> :</span></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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2712738"></a><h3>
|
|
<a name="gimp-window-set-transient-for-display"></a>gimp_window_set_transient_for_display ()</h3>
|
|
<a class="indexterm" name="id2712752"></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 <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>
|
|
<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> :</span></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> :</span></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" lang="en">
|
|
<a name="id2710057"></a><h2>See Also</h2>
|
|
<p>
|
|
<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>
|
|
</body>
|
|
</html>
|