libgnome-gnome-help.html

最新gtk中文资料集

href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to default to empty string.
(app_id) of the specified <em class="parameter"><code>program</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em>&#160;:</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em>&#160;:</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
<td> child's environment, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to inherit parent's.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).

</td>
</tr>
</tbody>
</table></div>
<p>Since  2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2816188"></a><h3>
<a name="gnome-help-display-desktop"></a>gnome_help_display_desktop ()</h3>
<a class="indexterm" name="id2816202"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gnome_help_display_desktop      (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
                                             const char *doc_id,
                                             const char *file_name,
                                             const char *link_id,
                                             <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Displays the GNOME system help file specified by <em class="parameter"><code>file_name</code></em> at location
<em class="parameter"><code>link_id</code></em> in the preferred help browser of the user.  This is done by creating
a "ghelp" URI, by looking for <em class="parameter"><code>file_name</code></em> in the system help domain
(<a href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>) and it's app_id.  This domain is determined when
the library is compiled.  If a matching file cannot be found, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> is
returned and <em class="parameter"><code>error</code></em> is set.
</p>
<p>
Please note that this only displays system help.  To display help files
for an application, you will want to use <a href="libgnome-gnome-help.html#gnome-help-display"><code class="function">gnome_help_display()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>program</code></em>&#160;:</span></td>
<td> The current application object, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> for the default one.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>doc_id</code></em>&#160;:</span></td>
<td> The name of the help file relative to the system's help domain
(<a href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em>&#160;:</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em>&#160;:</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2816492"></a><h3>
<a name="gnome-help-display-desktop-with-env"></a>gnome_help_display_desktop_with_env ()</h3>
<a class="indexterm" name="id2816508"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gnome_help_display_desktop_with_env
                                            (<a href="libgnome-gnome-program.html#GnomeProgram">GnomeProgram</a> *program,
                                             const char *doc_id,
                                             const char *file_name,
                                             const char *link_id,
                                             char **envp,
                                             <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a href="libgnome-gnome-help.html#gnome-help-display-desktop"><code class="function">gnome_help_display_desktop()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
will become the url viewer's environment rather than inheriting
from the parents environment.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>program</code></em>&#160;:</span></td>
<td> The current application object, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> for the default one.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>doc_id</code></em>&#160;:</span></td>
<td> The name of the help file relative to the system's help domain
(<a href="libgnome-gnome-program.html#GNOME-FILE-DOMAIN-HELP:CAPS"><span class="type">GNOME_FILE_DOMAIN_HELP</span></a>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>file_name</code></em>&#160;:</span></td>
<td> The name of the help document to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>link_id</code></em>&#160;:</span></td>
<td> Can be <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>. If set, refers to an anchor or section id within the
requested document.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
<td> child's environment, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to inherit parent's.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).

</td>
</tr>
</tbody>
</table></div>
<p>Since  2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2816789"></a><h3>
<a name="gnome-help-display-uri"></a>gnome_help_display_uri ()</h3>
<a class="indexterm" name="id2816802"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gnome_help_display_uri          (const char *help_uri,
                                             <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Displays <em class="parameter"><code>help_uri</code></em> in the user's preferred viewer. You should never need to
call this function directly in code, since it is just a wrapper for
<a href="libgnome-gnome-url.html#gnome-url-show"><code class="function">gnome_url_show()</code></a> and consequently the viewer used to display the results
depends upon the scheme of the URI (so it is not strictly a help-only
function).</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_uri</code></em>&#160;:</span></td>
<td> The URI to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2816952"></a><h3>
<a name="gnome-help-display-uri-with-env"></a>gnome_help_display_uri_with_env ()</h3>
<a class="indexterm" name="id2816968"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gnome_help_display_uri_with_env (const char *help_uri,
                                             char **envp,
                                             <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Like <a href="libgnome-gnome-help.html#gnome-help-display-uri"><code class="function">gnome_help_display_uri()</code></a>, but the the contents of <em class="parameter"><code>envp</code></em>
will become the help viewer's environment rather than inheriting
from the parents environment.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>help_uri</code></em>&#160;:</span></td>
<td> The URI to display.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>envp</code></em>&#160;:</span></td>
<td> child's environment, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> to inherit parent's.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
><span class="type">GError</span></a> instance that will hold the specifics of any error which
occurs during processing, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise (in which case <em class="parameter"><code>error</code></em> will
contain the actual error).

</td>
</tr>
</tbody>
</table></div>
<p>Since  2.2
</p>
</div>
</div>
</div>
</body>
</html>