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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpHelpUI</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="prev" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="next" href="libgimpwidgets-GimpQueryBox.html" title="GimpQueryBox"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="PartII.GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="PartIII.GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="PartVI.Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimpwidgets-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-utils.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 Widgets Library Reference Manual</th><td><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimpwidgets-GimpHelpUI"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpHelpUI</span></h2><p>GimpHelpUI — Functions for setting <a
href="../gtk/GtkTooltips.html"
><span class="type">GtkTooltips</span></a> and help identifier used by GIMP help
system.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
void (<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">*GimpHelpFunc</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
#define <a href="libgimpwidgets-GimpHelpUI.html#GIMP-HELP-ID--CAPS">GIMP_HELP_ID</a>
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-enable-tooltips">gimp_help_enable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-disable-tooltips">gimp_help_disable_tooltips</a> (void);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func">gimp_standard_help_func</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect">gimp_help_connect</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data">gimp_help_set_help_data</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);
void <a href="libgimpwidgets-GimpHelpUI.html#gimp-context-help">gimp_context_help</a> (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget);
</pre></div><div class="refsect1" lang="en"><a name="id2597247"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2600552"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2600557"></a><h3><a name="GimpHelpFunc"></a>GimpHelpFunc ()</h3><a class="indexterm" name="id2600565"></a><pre class="programlisting">void (*GimpHelpFunc) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre><p>
This is the prototype for all functions you pass as <i class="parameter"><tt>help_func</tt></i> to the
various GIMP dialog constructors like <a href="GimpDialog.html#gimp-dialog-new"><tt class="function">gimp_dialog_new()</tt></a>,
<a href="libgimpwidgets-GimpQueryBox.html#gimp-query-int-box"><tt class="function">gimp_query_int_box()</tt></a> etc.
</p><p>
Help IDs are textual identifiers the help system uses to figure which
page to display.
</p><p>
All these dialog constructors functions call <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><tt class="function">gimp_help_connect()</tt></a>.
</p><p>
In most cases it will be ok to use <a href="libgimpwidgets-GimpHelpUI.html#gimp-standard-help-func"><tt class="function">gimp_standard_help_func()</tt></a> which does
nothing but passing the <i class="parameter"><tt>help_id</tt></i> string to <a
href="../libgimp/libgimp-gimphelp.html#gimp-help"
><tt class="function">gimp_help()</tt></a>. If your
plug-in needs some more sophisticated help handling you can provide
your own <i class="parameter"><tt>help_func</tt></i> which has to call <a
href="../libgimp/libgimp-gimphelp.html#gimp-help"
><tt class="function">gimp_help()</tt></a> to actually display
the help.
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>help_id</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_data</tt></i>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2600680"></a><h3><a name="GIMP-HELP-ID--CAPS"></a>GIMP_HELP_ID</h3><a class="indexterm" name="id2605828"></a><pre class="programlisting">#define GIMP_HELP_ID (gimp_help_id_quark ())
</pre><p>
Since: GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2605838"></a><h3><a name="gimp-help-enable-tooltips"></a>gimp_help_enable_tooltips ()</h3><a class="indexterm" name="id2605847"></a><pre class="programlisting">void gimp_help_enable_tooltips (void);</pre><p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-enable"
><tt class="function">gtk_tooltips_enable()</tt></a>.</p><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2605871"></a><h3><a name="gimp-help-disable-tooltips"></a>gimp_help_disable_tooltips ()</h3><a class="indexterm" name="id2605879"></a><pre class="programlisting">void gimp_help_disable_tooltips (void);</pre><p>
This function calls <a
href="../gtk/GtkTooltips.html#gtk-tooltips-disable"
><tt class="function">gtk_tooltips_disable()</tt></a>.</p><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2605903"></a><h3><a name="gimp-standard-help-func"></a>gimp_standard_help_func ()</h3><a class="indexterm" name="id2605912"></a><pre class="programlisting">void gimp_standard_help_func (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</pre><p>
This is the standard GIMP help function which does nothing but calling
<a
href="../libgimp/libgimp-gimphelp.html#gimp-help"
><tt class="function">gimp_help()</tt></a>. It is the right function to use in almost all cases.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>help_id</tt></i>:</span></td><td> A unique help identifier.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_data</tt></i>:</span></td><td> The <i class="parameter"><tt>help_data</tt></i> passed to <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-connect"><tt class="function">gimp_help_connect()</tt></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2605985"></a><h3><a name="gimp-help-connect"></a>gimp_help_connect ()</h3><a class="indexterm" name="id2605993"></a><pre class="programlisting">void gimp_help_connect (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
<a href="libgimpwidgets-GimpHelpUI.html#GimpHelpFunc">GimpHelpFunc</a> help_func,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> help_data);</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><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>widget</tt></i>:</span></td><td> The widget you want to connect the help accelerator for. Will
be a <a
href="../gtk/GtkWindow.html"
><span class="type">GtkWindow</span></a> in most cases.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_func</tt></i>:</span></td><td> The function which will be called if the user presses "F1".
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_id</tt></i>:</span></td><td> The <i class="parameter"><tt>help_id</tt></i> which will be passed to <i class="parameter"><tt>help_func</tt></i>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_data</tt></i>:</span></td><td> The <i class="parameter"><tt>help_data</tt></i> pointer which will be passed to <i class="parameter"><tt>help_func</tt></i>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2603563"></a><h3><a name="gimp-help-set-help-data"></a>gimp_help_set_help_data ()</h3><a class="indexterm" name="id2603571"></a><pre class="programlisting">void gimp_help_set_help_data (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *help_id);</pre><p>
The reason why we don't use <a
href="../gtk/GtkTooltips.html#gtk-tooltips-set-tip"
><tt class="function">gtk_tooltips_set_tip()</tt></a> is that it's
impossible to set a <i class="parameter"><tt>private_tip</tt></i> (aka <i class="parameter"><tt>help_id</tt></i>) without a visible
<i class="parameter"><tt>tooltip</tt></i>.
</p><p>
This function can be called with <a
href="../glib/glib-Standard-Macros.html#NULL--CAPS"
><span class="type">NULL</span></a> for <i class="parameter"><tt>tooltip</tt></i>. Use this feature
if you want to set a help link for a widget which shouldn't have
a visible tooltip.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>widget</tt></i>:</span></td><td> The <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> you want to set a <i class="parameter"><tt>tooltip</tt></i> and/or <i class="parameter"><tt>help_id</tt></i> for.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>tooltip</tt></i>:</span></td><td> The text for this widget's tooltip (or <tt class="literal">NULL</tt>).
</td></tr><tr><td><span class="term"><i class="parameter"><tt>help_id</tt></i>:</span></td><td> The <i class="parameter"><tt>help_id</tt></i> for the <a
href="../gtk/GtkTipsQuery.html"
><span class="type">GtkTipsQuery</span></a> tooltips inspector.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2603698"></a><h3><a name="gimp-context-help"></a>gimp_context_help ()</h3><a class="indexterm" name="id2603706"></a><pre class="programlisting">void gimp_context_help (<a
href="../gtk/GtkWidget.html"
>GtkWidget</a> *widget);</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><p>
If the widget the user clicked on has a <i class="parameter"><tt>help_id</tt></i> string attached
(see <a href="libgimpwidgets-GimpHelpUI.html#gimp-help-set-help-data"><tt class="function">gimp_help_set_help_data()</tt></a>), the corresponding help page will
be displayed. Otherwise the help system will ascend the widget hierarchy
until it finds an attached <i class="parameter"><tt>help_id</tt></i> string (which should be the
case at least for every window/dialog).</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>widget</tt></i>:</span></td><td> Any <a
href="../gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> on the screen.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpwidgets-utils.html"><b><<PartV.GIMP Widgets Utilities</b></a></td><td align="right"><a accesskey="n" href="libgimpwidgets-GimpQueryBox.html"><b>GimpQueryBox>></b></a></td></tr></table></body></html>
|
