| 1 | /* gnome-help.h |
|---|
| 2 | * Copyright (C) 2001 Sid Vicious |
|---|
| 3 | * All rights reserved. |
|---|
| 4 | * |
|---|
| 5 | * This library is free software; you can redistribute it and/or |
|---|
| 6 | * modify it under the terms of the GNU Library General Public |
|---|
| 7 | * License as published by the Free Software Foundation; either |
|---|
| 8 | * version 2 of the License, or (at your option) any later version. |
|---|
| 9 | * |
|---|
| 10 | * This library is distributed in the hope that it will be useful, |
|---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|---|
| 13 | * Library General Public License for more details. |
|---|
| 14 | * |
|---|
| 15 | * You should have received a copy of the GNU Library General Public |
|---|
| 16 | * License along with this library; if not, write to the Free Software |
|---|
| 17 | * Foundation, Inc., 59 Temple Place - Suite 330, Cambridge, MA 02139, USA. |
|---|
| 18 | */ |
|---|
| 19 | /* |
|---|
| 20 | @NOTATION@ |
|---|
| 21 | */ |
|---|
| 22 | |
|---|
| 23 | #ifndef GNOME_HELP_H |
|---|
| 24 | #define GNOME_HELP_H |
|---|
| 25 | |
|---|
| 26 | #include <glib/gmacros.h> |
|---|
| 27 | #include <libgnome/gnome-program.h> |
|---|
| 28 | |
|---|
| 29 | G_BEGIN_DECLS |
|---|
| 30 | |
|---|
| 31 | typedef enum { |
|---|
| 32 | GNOME_HELP_ERROR_INTERNAL, |
|---|
| 33 | GNOME_HELP_ERROR_NOT_FOUND |
|---|
| 34 | } GnomeHelpError; |
|---|
| 35 | |
|---|
| 36 | #define GNOME_HELP_ERROR (gnome_help_error_quark ()) |
|---|
| 37 | GQuark gnome_help_error_quark (void) G_GNUC_CONST; |
|---|
| 38 | |
|---|
| 39 | /* Errors that could be returned can be from gnome-url |
|---|
| 40 | * and g-spawn */ |
|---|
| 41 | |
|---|
| 42 | gboolean gnome_help_display (const char *file_name, |
|---|
| 43 | const char *link_id, |
|---|
| 44 | GError **error); |
|---|
| 45 | gboolean gnome_help_display_with_doc_id (GnomeProgram *program, |
|---|
| 46 | const char *doc_id, |
|---|
| 47 | const char *file_name, |
|---|
| 48 | const char *link_id, |
|---|
| 49 | GError **error); |
|---|
| 50 | gboolean gnome_help_display_desktop (GnomeProgram *program, |
|---|
| 51 | const char *doc_id, |
|---|
| 52 | const char *file_name, |
|---|
| 53 | const char *link_id, |
|---|
| 54 | GError **error); |
|---|
| 55 | gboolean gnome_help_display_uri (const char *help_uri, |
|---|
| 56 | GError **error); |
|---|
| 57 | |
|---|
| 58 | gboolean gnome_help_display_uri_with_env (const char *help_uri, |
|---|
| 59 | char **envp, |
|---|
| 60 | GError **error); |
|---|
| 61 | gboolean gnome_help_display_with_doc_id_and_env (GnomeProgram *program, |
|---|
| 62 | const char *doc_id, |
|---|
| 63 | const char *file_name, |
|---|
| 64 | const char *link_id, |
|---|
| 65 | char **envp, |
|---|
| 66 | GError **error); |
|---|
| 67 | gboolean gnome_help_display_desktop_with_env (GnomeProgram *program, |
|---|
| 68 | const char *doc_id, |
|---|
| 69 | const char *file_name, |
|---|
| 70 | const char *link_id, |
|---|
| 71 | char **envp, |
|---|
| 72 | GError **error); |
|---|
| 73 | |
|---|
| 74 | G_END_DECLS |
|---|
| 75 | |
|---|
| 76 | #endif /* GNOME_HELP_H */ |
|---|
