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

Imported Upstream version 2.8.16

Browse Source
This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: gimpui</title>
<title>gimpui: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -27,8 +27,7 @@
<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</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -50,7 +49,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
<a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpui.html#gimp-ui-get-display-window" title="gimp_ui_get_display_window ()">gimp_ui_get_display_window</a> <span class="c_punctuation">()</span>
@ -58,7 +57,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
<a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpui.html#gimp-ui-get-progress-window" title="gimp_ui_get_progress_window ()">gimp_ui_get_progress_window</a> <span class="c_punctuation">()</span>
@ -85,178 +84,50 @@
</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.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpui.functions_details"></a><h2>Functions</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 <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 <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>It also sets up various other things so that the plug-in user looks
and behaves like the GIMP core. This includes selecting the GTK+
theme and setting up the help system as chosen in the GIMP
preferences. Any plug-in that provides a user interface should call
this function.</p>
<div class="refsect3">
<a name="id-1.3.3.5.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prog_name</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>preview</p></td>
<td class="parameter_description"><p>This parameter is unused and exists for historical
reasons only.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
gimp_ui_init (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-ui-get-display-window"></a><h3>gimp_ui_get_display_window ()</h3>
<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 <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 class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()"><code class="function">gimp_window_set_transient_for_display()</code></a> instead.</p>
<div class="refsect3">
<a name="id-1.3.3.5.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>gdisp_ID</p></td>
<td class="parameter_description"><p>a <span class="type">GimpDisplay</span> ID.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.5.3.7"></a><h4>Returns</h4>
<p> 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.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
gimp_ui_get_display_window (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<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"><span class="returnvalue">GdkWindow</span> *
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk3/gdk2-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 <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 class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()"><code class="function">gimp_window_set_transient()</code></a> instead.</p>
<div class="refsect3">
<a name="id-1.3.3.5.4.6"></a><h4>Returns</h4>
<p> 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.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<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><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
started from. See also <a class="link" href="libgimp-gimpui.html#gimp-window-set-transient-for-display" title="gimp_window_set_transient_for_display ()"><code class="function">gimp_window_set_transient_for_display()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.3.5.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>the <span class="type">GtkWindow</span> that should become transient</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since GIMP 2.4</p>
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 class="since">Since: GIMP 2.4</p>
</div>
<hr>
<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><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 <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 class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()"><code class="function">gimp_window_set_transient()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.3.5.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>window</p></td>
<td class="parameter_description"><p>the <span class="type">GtkWindow</span> that should become transient</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gdisp_ID</p></td>
<td class="parameter_description"><p>display ID of the image window that should become the parent</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since GIMP 2.4</p>
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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="libgimp-gimpui.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="libgimp-gimpui.see-also"></a><h2>See Also</h2>
<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>.</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>