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
|
/* gnome-help.h
* Copyright (C) 2001 Sid Vicious
* All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Cambridge, MA 02139, USA.
*/
/*
@NOTATION@
*/
#ifndef GNOME_HELP_H
#define GNOME_HELP_H
#include <glib/gmacros.h>
#include <libgnome/gnome-program.h>
G_BEGIN_DECLS
/**
* GnomeHelpError:
* @GNOME_HELP_ERROR_INTERNAL: Something went wrong interally. This should
* never happen (could possibly be caused by lack of memory).
* @GNOME_HELP_ERROR_NOT_FOUND: Help file does not exist.
**/
typedef enum {
GNOME_HELP_ERROR_INTERNAL,
GNOME_HELP_ERROR_NOT_FOUND
} GnomeHelpError;
#define GNOME_HELP_ERROR (gnome_help_error_quark ())
GQuark gnome_help_error_quark (void) G_GNUC_CONST;
/* Errors that could be returned can be from gnome-url
* and g-spawn */
gboolean gnome_help_display (GnomeProgram *program,
const char *doc_name,
const char *link_id,
GError **error);
gboolean gnome_help_display_desktop (GnomeProgram *program,
const char *doc_name,
const char *link_id,
GError **error);
gboolean gnome_help_display_uri (const char *help_uri,
GError **error);
G_END_DECLS
#endif /* GNOME_HELP_H */
|