/usr/share/gtk-doc/html/libgimp/libgimp-gimpui.html is in libgimp2.0-doc 2.8.16-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgimp-gimpui.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpui.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimpui-hierarchy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpexport.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpui"></a><div class="titlepage"></div>
<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>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpui.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpui.html#gimp-ui-init" title="gimp_ui_init ()">gimp_ui_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
</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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkWindow</span> *
</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>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpui.html#gimp-window-set-transient" title="gimp_window_set_transient ()">gimp_window_set_transient</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</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/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>
<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>
</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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> 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 <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.</p>
</div>
<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> *
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 <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.</p>
</div>
<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>
</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><a href="/usr/share/gtk-doc/html/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 <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>
</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.24</div>
</body>
</html>
|