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

71
devel-docs/libgimpwidgets/html/libgimpwidgets-GimpHelpUI.html
View File

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Widgets Library Reference Manual: GimpHelpUI</title>
<title>GimpHelpUI: GIMP Widgets Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
<link rel="prev" href="libgimpwidgets-GimpCairoUtils.html" title="GimpCairo-utils">
<link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox">
<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">
@ -121,8 +121,8 @@ help system.</p>
<div class="refsect2">
<a name="GimpHelpFunc"></a><h3>GimpHelpFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpHelpFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> help_data</code></em>);</pre>
<span class="c_punctuation">(</span>*GimpHelpFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
<p>This is the prototype for all functions you pass as <em class="parameter"><code>help_func</code></em>
to
the various GIMP dialog constructors like <a class="link" href="GimpDialog.html#gimp-dialog-new" title="gimp_dialog_new ()"><code class="function">gimp_dialog_new()</code></a>,
@ -132,10 +132,10 @@ which page to display.</p>
<p>All these dialog constructors functions call <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect" title="gimp_help_connect ()"><code class="function">gimp_help_connect()</code></a>.</p>
<p>In most cases it will be ok to use <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func" title="gimp_standard_help_func ()"><code class="function">gimp_standard_help_func()</code></a> which
does nothing but passing the <em class="parameter"><code>help_id</code></em>
string to <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a>. If
string to <code class="function">gimp_help()</code>. If
your plug-in needs some more sophisticated help handling you can
provide your own <em class="parameter"><code>help_func</code></em>
which has to call <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a> to
which has to call <code class="function">gimp_help()</code> to
actually display the help.</p>
<div class="refsect3">
<a name="id-1.7.3.5.2.8"></a><h4>Parameters</h4>
@ -165,8 +165,8 @@ actually display the help.</p>
<a name="GIMP-HELP-ID:CAPS"></a><h3>GIMP_HELP_ID</h3>
<pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre>
<p>The <span class="type">GQuark</span> used to attach GIMP help IDs to widgets.</p>
<p class="since">Since GIMP 2.2</p>
<p>The <a href="https://developer.gnome.org/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> used to attach GIMP help IDs to widgets.</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
@ -175,7 +175,7 @@ actually display the help.</p>
gimp_help_enable_tooltips (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Enable tooltips to be shown in the GIMP user interface.</p>
<p>As a plug-in author, you don't need to care about this as this
function is called for you from <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
function is called for you from <code class="function">gimp_ui_init()</code>. This ensures that
the user setting from the GIMP preferences dialog is respected in
all plug-in dialogs.</p>
</div>
@ -186,7 +186,7 @@ all plug-in dialogs.</p>
gimp_help_disable_tooltips (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Disable tooltips to be shown in the GIMP user interface.</p>
<p>As a plug-in author, you don't need to care about this as this
function is called for you from <a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimpui.html#gimp-ui-init"><code class="function">gimp_ui_init()</code></a>. This ensures that
function is called for you from <code class="function">gimp_ui_init()</code>. This ensures that
the user setting from the GIMP preferences dialog is respected in
all plug-in dialogs.</p>
</div>
@ -194,10 +194,10 @@ all plug-in dialogs.</p>
<div class="refsect2">
<a name="gimp-standard-help-func"></a><h3>gimp_standard_help_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_standard_help_func (<em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> help_data</code></em>);</pre>
gimp_standard_help_func (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
<p>This is the standard GIMP help function which does nothing but calling
<a href="/local/head/share/gtk-doc/html/libgimp/libgimp-gimphelp.html#gimp-help"><code class="function">gimp_help()</code></a>. It is the right function to use in almost all cases.</p>
<code class="function">gimp_help()</code>. It is the right function to use in almost all cases.</p>
<div class="refsect3">
<a name="id-1.7.3.5.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
@ -226,10 +226,10 @@ passed to <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect
<div class="refsect2">
<a name="gimp-help-connect"></a><h3>gimp_help_connect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_help_connect (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
gimp_help_connect (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code><a class="link" href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc" title="GimpHelpFunc ()"><span class="type">GimpHelpFunc</span></a> help_func</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> help_data</code></em>);</pre>
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> help_data</code></em>);</pre>
<p>Note that this function is automatically called by all libgimp dialog
constructors. You only have to call it for windows/dialogs you created
"manually".</p>
@ -245,7 +245,7 @@ constructors. You only have to call it for windows/dialogs you created
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The widget you want to connect the help accelerator for. Will
be a <span class="type">GtkWindow</span> in most cases.</p></td>
be a <a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> in most cases.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
@ -275,14 +275,14 @@ pointer which will be passed to <em class="parameter"><code>help_func</code></em
<div class="refsect2">
<a name="gimp-help-set-help-data"></a><h3>gimp_help_set_help_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_help_set_help_data (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>);</pre>
<p>The reason why we don't use <code class="function">gtk_widget_set_tooltip_text()</code> is that
gimp_help_set_help_data (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
<p>The reason why we don't use <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a> is that
elements in the GIMP user interface should, if possible, also have
a <em class="parameter"><code>help_id</code></em>
set for context-sensitive help.</p>
<p>This function can be called with <span class="type">NULL</span> for <em class="parameter"><code>tooltip</code></em>
<p>This function can be called with <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> for <em class="parameter"><code>tooltip</code></em>
. Use this feature
if you want to set a help link for a widget which shouldn't have
a visible tooltip.</p>
@ -297,20 +297,20 @@ a visible tooltip.</p>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The <span class="type">GtkWidget</span> you want to set a <em class="parameter"><code>tooltip</code></em>
<td class="parameter_description"><p>The <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em>
and/or <em class="parameter"><code>help_id</code></em>
for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The text for this widget's tooltip (or <code class="literal">NULL</code>).</p></td>
<td class="parameter_description"><p>The text for this widget's tooltip (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_id</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>help_id</code></em>
for the <span class="type">GtkTipsQuery</span> tooltips inspector.</p></td>
for the <a href="http://library.gnome.org/devel/gtk3/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
@ -321,9 +321,9 @@ for the <span class="type">GtkTipsQuery</span> tooltips inspector.</p></td>
<div class="refsect2">
<a name="gimp-help-set-help-data-with-markup"></a><h3>gimp_help_set_help_data_with_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_help_set_help_data_with_markup (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tooltip</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *help_id</code></em>);</pre>
gimp_help_set_help_data_with_markup (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *help_id</code></em>);</pre>
<p>Just like <a class="link" href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data" title="gimp_help_set_help_data ()"><code class="function">gimp_help_set_help_data()</code></a>, but it allows to pass text which
is marked up with</p>
Pango text markup language.
@ -338,32 +338,32 @@ Pango text markup language.
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>The <span class="type">GtkWidget</span> you want to set a <em class="parameter"><code>tooltip</code></em>
<td class="parameter_description"><p>The <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> you want to set a <em class="parameter"><code>tooltip</code></em>
and/or <em class="parameter"><code>help_id</code></em>
for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>The markup for this widget's tooltip (or <code class="literal">NULL</code>).</p></td>
<td class="parameter_description"><p>The markup for this widget's tooltip (or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>help_id</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>help_id</code></em>
for the <span class="type">GtkTipsQuery</span> tooltips inspector.</p></td>
for the <a href="http://library.gnome.org/devel/gtk3/GtkTipsQuery.html"><span class="type">GtkTipsQuery</span></a> tooltips inspector.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since GIMP 2.6</p>
<p class="since">Since: GIMP 2.6</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-context-help"></a><h3>gimp_context_help ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_context_help (<em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>);</pre>
gimp_context_help (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<p>This function invokes the context help inspector.</p>
<p>The mouse cursor will turn turn into a question mark and the user can
click on any widget of the application which started the inspector.</p>
@ -384,7 +384,7 @@ case at least for every window/dialog).</p>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>Any <span class="type">GtkWidget</span> on the screen.</p></td>
<td class="parameter_description"><p>Any <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="type">GtkWidget</span></a> on the screen.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
@ -396,7 +396,6 @@ case at least for every window/dialog).</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>