/usr/include/libyelp/yelp-document.h is in libyelp-dev 3.18.1-1ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 169 170 | /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* Copyright (C) 2003-2009 Shaun McCance <shaunm@gnome.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Shaun McCance <shaunm@gnome.org>
*/
#ifndef __YELP_DOCUMENT_H__
#define __YELP_DOCUMENT_H__
#include <glib-object.h>
#include <gio/gio.h>
#include "yelp-uri.h"
G_BEGIN_DECLS
#define YELP_TYPE_DOCUMENT (yelp_document_get_type ())
#define YELP_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), YELP_TYPE_DOCUMENT, YelpDocument))
#define YELP_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), YELP_TYPE_DOCUMENT, YelpDocumentClass))
#define YELP_IS_DOCUMENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), YELP_TYPE_DOCUMENT))
#define YELP_IS_DOCUMENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), YELP_TYPE_DOCUMENT))
#define YELP_DOCUMENT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), YELP_TYPE_DOCUMENT, YelpDocumentClass))
typedef struct _YelpDocument YelpDocument;
typedef struct _YelpDocumentClass YelpDocumentClass;
typedef struct _YelpDocumentPriv YelpDocumentPriv;
typedef enum {
YELP_DOCUMENT_SIGNAL_CONTENTS,
YELP_DOCUMENT_SIGNAL_INFO,
YELP_DOCUMENT_SIGNAL_ERROR
} YelpDocumentSignal;
typedef void (*YelpDocumentCallback) (YelpDocument *document,
YelpDocumentSignal signal,
gpointer user_data,
GError *error);
struct _YelpDocument {
GObject parent;
YelpDocumentPriv *priv;
};
struct _YelpDocumentClass {
GObjectClass parent_class;
/* Virtual Functions */
gboolean (*request_page) (YelpDocument *document,
const gchar *page_id,
GCancellable *cancellable,
YelpDocumentCallback callback,
gpointer user_data);
const gchar * (*read_contents) (YelpDocument *document,
const gchar *page_id);
void (*finish_read) (YelpDocument *document,
const gchar *contents);
gchar * (*get_mime_type) (YelpDocument *document,
const gchar *page_id);
void (*index) (YelpDocument *document);
};
GType yelp_document_get_type (void);
YelpDocument * yelp_document_get_for_uri (YelpUri *uri);
YelpDocument * yelp_document_lookup_document_uri (const gchar *docuri);
YelpUri * yelp_document_get_uri (YelpDocument *document);
gboolean yelp_document_request_page (YelpDocument *document,
const gchar *page_id,
GCancellable *cancellable,
YelpDocumentCallback callback,
gpointer user_data);
void yelp_document_clear_contents (YelpDocument *document);
gchar ** yelp_document_get_requests (YelpDocument *document);
void yelp_document_give_contents (YelpDocument *document,
const gchar *page_id,
gchar *contents,
const gchar *mime);
gchar * yelp_document_get_mime_type (YelpDocument *document,
const gchar *page_id);
const gchar * yelp_document_read_contents (YelpDocument *document,
const gchar *page_id);
void yelp_document_finish_read (YelpDocument *document,
const gchar *contents);
void yelp_document_index (YelpDocument *document);
gchar ** yelp_document_list_page_ids (YelpDocument *document);
gchar * yelp_document_get_page_id (YelpDocument *document,
const gchar *id);
void yelp_document_set_page_id (YelpDocument *document,
const gchar *id,
const gchar *page_id);
gchar * yelp_document_get_root_id (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_root_id (YelpDocument *document,
const gchar *page_id,
const gchar *root_id);
gchar * yelp_document_get_prev_id (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_prev_id (YelpDocument *document,
const gchar *page_id,
const gchar *prev_id);
char * yelp_document_get_next_id (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_next_id (YelpDocument *document,
const gchar *page_id,
const gchar *next_id);
gchar * yelp_document_get_up_id (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_up_id (YelpDocument *document,
const gchar *page_id,
const gchar *up_id);
gchar * yelp_document_get_root_title (YelpDocument *document,
const gchar *page_id);
gchar * yelp_document_get_page_title (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_page_title (YelpDocument *document,
const gchar *page_id,
const gchar *title);
gchar * yelp_document_get_page_desc (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_page_desc (YelpDocument *document,
const gchar *page_id,
const gchar *desc);
gchar * yelp_document_get_page_icon (YelpDocument *document,
const gchar *page_id);
void yelp_document_set_page_icon (YelpDocument *document,
const gchar *page_id,
const gchar *icon);
gboolean yelp_document_has_page (YelpDocument *document,
const gchar *page_id);
void yelp_document_signal (YelpDocument *document,
const gchar *page_id,
YelpDocumentSignal signal,
const GError *error);
void yelp_document_error_pending (YelpDocument *document,
const GError *error);
G_END_DECLS
#endif /* __YELP_DOCUMENT_H__ */
|