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

New upstream version 2.10.0~RC1

Browse Source
This commit is contained in:
Jeremy Bicha
2018-03-28 12:37:30 -04:00
parent 4e910d9e95 956ca8e3a3
commit 6ee700fd3d
8195 changed files with 1939281 additions and 1033470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,7 @@
<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.25 (XML mode)">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -27,7 +27,8 @@
<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</p>
<p>gimpui — Common user interface functions. This header includes
all other GIMP User Interface Library headers.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -49,7 +50,7 @@
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gdk2gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
<a href="../gdk2/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>
@ -57,7 +58,7 @@
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gdk2gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
<a href="../gdk2/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>
@ -84,50 +85,175 @@
</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 <a href="/usr/share/gtk-doc/html/glibglib-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/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);</pre>
gimp_ui_init (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prog_name</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preview</code></em>);</pre>
<p>This function initializes GTK+ with <a href="../gtk2/gtk2-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>
<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="gimp-ui-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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
<a href="../gtk2/gtk2-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.</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>
</div>
<hr>
<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/gdk2gdk2-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/glibglib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
<pre class="programlisting"><a href="../gdk2/gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
gimp_ui_get_display_window (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<p>Returns the <a href="../gdk2/gdk2-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="../gdk2/gdk2-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
<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="gimp-ui-get-display-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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="gimp-ui-get-display-window.returns"></a><h4>Returns</h4>
<p> A reference to a <a href="../gdk2/gdk2-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
you don't need it any longer.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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="/usr/share/gtk-doc/html/gdk2gdk2-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> *
<pre class="programlisting"><a href="../gdk2/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 class="since">Since: GIMP 2.4</p>
<p>Returns the <a href="../gdk2/gdk2-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="../gdk2/gdk2-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
<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="gimp-ui-get-progress-window.returns"></a><h4>Returns</h4>
<p> A reference to a <a href="../gdk2/gdk2-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
you don't need it any longer.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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><a href="/usr/share/gtk-doc/html/gtk2GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
gimp_window_set_transient (<em class="parameter"><code><a href="../gtk2/GtkWindow.html#GtkWindow-struct"><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
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="gimp-window-set-transient.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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 <a href="../gtk2/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> that should become transient</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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><a href="/usr/share/gtk-doc/html/gtk2GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="type">guint32</span></a> gdisp_ID</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
gimp_window_set_transient_for_display (<em class="parameter"><code><a href="../gtk2/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> *window</code></em>,
<em class="parameter"><code><a href="../glib/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="../gdk2/gdk2-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
<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="gimp-window-set-transient-for-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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 <a href="../gtk2/GtkWindow.html#GtkWindow-struct"><span class="type">GtkWindow</span></a> 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: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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(), <a href="../gdk2/gdk2-General.html#gdk-set-use-xshm"><code class="function">gdk_set_use_xshm()</code></a>, <a href="../gdk2/gdk2-GdkRGB.html#gdk-rgb-get-visual"><code class="function">gdk_rgb_get_visual()</code></a>,
<a href="../gdk2/gdk2-GdkRGB.html#gdk-rgb-get-cmap"><code class="function">gdk_rgb_get_cmap()</code></a>, <a href="../gtk2/GtkWidget.html#gtk-widget-set-default-visual"><code class="function">gtk_widget_set_default_visual()</code></a>,
<a href="../gtk2/GtkWidget.html#gtk-widget-set-default-colormap"><code class="function">gtk_widget_set_default_colormap()</code></a>, <a href="../gtk2/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.25</div>
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>