<HTML
><HEAD
><TITLE
>gnome-help</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.74b"><LINK
REL="HOME"
TITLE="Gnome Library Reference Manual"
HREF="book1.html"><LINK
REL="UP"
TITLE="Gnome Library"
HREF="libgnome.html"><LINK
REL="PREVIOUS"
TITLE="gnome-fileconvert"
HREF="gnome-gnome-fileconvert.html"><LINK
REL="NEXT"
TITLE="gnome-history"
HREF="gnome-gnome-history.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TH
COLSPAN="4"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="5"
>Gnome Library Reference Manual</FONT
></TH
></TR
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnome-gnome-fileconvert.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="libgnome.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnome-gnome-history.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
></TABLE
></DIV
><H1
><A
NAME="GNOME-GNOME-HELP"
>gnome-help</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1907"
></A
><H2
>Name</H2
>gnome-help -- Routines for displaying help</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1910"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> #include <gnome.h>
struct <A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
>;
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnome-gnome-help.html#GNOME-HELP-FILE-FIND-FILE"
>gnome_help_file_find_file</A
> (<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *app,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *path);
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* <A
HREF="gnome-gnome-help.html#GNOME-HELP-FILE-PATH"
>gnome_help_file_path</A
> (<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *app,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *path);
void <A
HREF="gnome-gnome-help.html#GNOME-HELP-DISPLAY"
>gnome_help_display</A
> (void *ignore,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);
void <A
HREF="gnome-gnome-help.html#GNOME-HELP-GOTO"
>gnome_help_goto</A
> (void *ignore,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *file);
void <A
HREF="gnome-gnome-help.html#GNOME-HELP-PBOX-DISPLAY"
>gnome_help_pbox_display</A
> (void *ignore,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> page_num,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);
void <A
HREF="gnome-gnome-help.html#GNOME-HELP-PBOX-GOTO"
>gnome_help_pbox_goto</A
> (void *ignore,
int ignore2,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1931"
></A
><H2
>Description</H2
><P
>These routines provide simple wrappers for invoking the help system in
GNOME. They will take care of invoking the help browser with the help
file you provide.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1934"
></A
><H2
>Details</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN1936"
></A
><H3
><A
NAME="GNOMEHELPMENUENTRY"
></A
>struct GnomeHelpMenuEntry</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>typedef struct {
gchar *name;
gchar *path;
} GnomeHelpMenuEntry;</PRE
></TD
></TR
></TABLE
><P
>This structure describes where to get the help from. The <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> field
is used to specify the name of the application (this is used to pull the
help files from the help directory where the files were installed).
The <TT
CLASS="PARAMETER"
><I
>path</I
></TT
> parameter is the name relative to the package's help
directory. </P
><P
>For example, the Gnumeric spreadsheet uses the structure like
this:</P
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>static GnomeHelpMenuEntry help_ref = { "gnumeric", "formatting.html" };</PRE
></TD
></TR
></TABLE
><P
>This identifies the application and the filename that is
displayed</P
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN1946"
></A
><H3
><A
NAME="GNOME-HELP-FILE-FIND-FILE"
></A
>gnome_help_file_find_file ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_help_file_find_file (<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *app,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *path);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN1955"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>app</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Name of this application</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>path</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> File that contains the help document</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a fully resolved file name for path. Use needs to g_free the path when
done. It looks in LANG, then unser C if LANG is not set
I added this because I didnt want to break all apps using
<A
HREF="gnome-gnome-help.html#GNOME-HELP-FILE-PATH"
>gnome_help_file_path</A
>() currently. We need a good solution (if this isnt it)
to handle case where locale file didnt exist</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN1973"
></A
><H3
><A
NAME="GNOME-HELP-FILE-PATH"
></A
>gnome_help_file_path ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
>* gnome_help_file_path (<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *app,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *path);</PRE
></TD
></TR
></TABLE
><P
></P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN1982"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>app</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> Name of this application</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>path</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> File that contains the help document</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Returns</I
></SPAN
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
>a fully resolved file name for path. Use needs to g_free the path when
done. It looks in LANG, then unser C if LANG is not set</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN1999"
></A
><H3
><A
NAME="GNOME-HELP-DISPLAY"
></A
>gnome_help_display ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_help_display (void *ignore,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);</PRE
></TD
></TR
></TABLE
><P
>Cause a help viewer to display help entry defined in <TT
CLASS="PARAMETER"
><I
>ref</I
></TT
>.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN2007"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ignore</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> value of this is ignored. To simplify hooking into clicked
signals</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ref</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A GnomeHelpMenuEntry.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN2020"
></A
><H3
><A
NAME="GNOME-HELP-GOTO"
></A
>gnome_help_goto ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_help_goto (void *ignore,
<GTKDOCLINK
HREF="GCHAR"
>gchar</GTKDOCLINK
> *file);</PRE
></TD
></TR
></TABLE
><P
>Cause a help viewer to display file.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN2027"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ignore</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> ignored.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>file</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> file to display in the help browser.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN2040"
></A
><H3
><A
NAME="GNOME-HELP-PBOX-DISPLAY"
></A
>gnome_help_pbox_display ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_help_pbox_display (void *ignore,
<GTKDOCLINK
HREF="GINT"
>gint</GTKDOCLINK
> page_num,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);</PRE
></TD
></TR
></TABLE
><P
>Cause a help viewer to display the help entry defined in ref. This
function is meant to be connected to the "help" signal of a
GnomePropertyBox. If ref is { "my-app", "properties-blah" }, and
the current page number is 3, then the help viewer will display
my-app/lang/properties-blah-3.html, which can be symlinked to the
appropriate file.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN2048"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ignore</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> ignored.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>page_num</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> The number of the current notebook page in the
properties box.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ref</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A GnomeHelpMenuEntry</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><HR><DIV
CLASS="REFSECT2"
><A
NAME="AEN2065"
></A
><H3
><A
NAME="GNOME-HELP-PBOX-GOTO"
></A
>gnome_help_pbox_goto ()</H3
><TABLE
BORDER="0"
BGCOLOR="#D6E8FF"
WIDTH="100%"
CELLPADDING="6"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>void gnome_help_pbox_goto (void *ignore,
int ignore2,
<A
HREF="gnome-gnome-help.html#GNOMEHELPMENUENTRY"
>GnomeHelpMenuEntry</A
> *ref);</PRE
></TD
></TR
></TABLE
><P
>Cause a help viewer to display the help entry defined in <TT
CLASS="PARAMETER"
><I
>ref</I
></TT
>. This
function is meant to be connected to the help button of a
GnomePropertyBox, when you don't want any munging of the help path
done. Most of the time, you can use gnome_help_pbox_display,
though.</P
><P
></P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN2073"
></A
><P
></P
><TABLE
BORDER="0"
WIDTH="100%"
BGCOLOR="#FFD0D0"
CELLSPACING="0"
CELLPADDING="4"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ignore</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> ignored.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ignore2</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> also ignored.</TD
></TR
><TR
><TD
WIDTH="20%"
ALIGN="RIGHT"
VALIGN="TOP"
><TT
CLASS="PARAMETER"
><I
>ref</I
></TT
> :</TD
><TD
WIDTH="80%"
ALIGN="LEFT"
VALIGN="TOP"
> A GnomeHelpMenuEntry</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><BR
CLEAR="all"><BR><TABLE
WIDTH="100%"
BORDER="0"
BGCOLOR="#000000"
CELLPADDING="1"
CELLSPACING="0"
><TR
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="left"
><A
HREF="gnome-gnome-fileconvert.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><<< Previous Page</B
></FONT
></A
></TD
><TD
WIDTH="25%"
BGCOLOR="#0000C0"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="book1.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Home</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#00C000"
ALIGN="center"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
><A
HREF="libgnome.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Up</B
></FONT
></A
></B
></FONT
></TD
><TD
WIDTH="25%"
BGCOLOR="#C00000"
ALIGN="right"
><A
HREF="gnome-gnome-history.html"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>Next Page >>></B
></FONT
></A
></TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="left"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>gnome-fileconvert</B
></FONT
></TD
><TD
COLSPAN="2"
ALIGN="right"
><FONT
COLOR="#FFFFFF"
SIZE="3"
><B
>gnome-history</B
></FONT
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
