YelpDocument

YelpDocument

Synopsis

                    YelpDocumentPriv;
enum                YelpDocumentSignal;
void                (*YelpDocumentCallback)             (YelpDocument *document,
                                                         YelpDocumentSignal signal,
                                                         gpointer user_data,
                                                         GError *error);
                    YelpDocument;
YelpDocument *      yelp_document_get_for_uri           (YelpUri *uri);
gboolean            yelp_document_request_page          (YelpDocument *document,
                                                         const gchar *page_id,
                                                         GCancellable *cancellable,
                                                         YelpDocumentCallback callback,
                                                         gpointer user_data);
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);
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);
gchar *             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);

Object Hierarchy

  GObject
   +----YelpDocument
         +----YelpDocbookDocument
         +----YelpMallardDocument
         +----YelpSimpleDocument

Description

Details

YelpDocumentPriv

typedef struct _YelpDocumentPriv YelpDocumentPriv;


enum YelpDocumentSignal

typedef enum {
    YELP_DOCUMENT_SIGNAL_CONTENTS,
    YELP_DOCUMENT_SIGNAL_INFO,
    YELP_DOCUMENT_SIGNAL_ERROR
} YelpDocumentSignal;


YelpDocumentCallback ()

void                (*YelpDocumentCallback)             (YelpDocument *document,
                                                         YelpDocumentSignal signal,
                                                         gpointer user_data,
                                                         GError *error);

document :

signal :

user_data :

error :


YelpDocument

typedef struct _YelpDocument YelpDocument;


yelp_document_get_for_uri ()

YelpDocument *      yelp_document_get_for_uri           (YelpUri *uri);

uri :

Returns :


yelp_document_request_page ()

gboolean            yelp_document_request_page          (YelpDocument *document,
                                                         const gchar *page_id,
                                                         GCancellable *cancellable,
                                                         YelpDocumentCallback callback,
                                                         gpointer user_data);

document :

page_id :

cancellable :

callback :

user_data :

Returns :


yelp_document_give_contents ()

void                yelp_document_give_contents         (YelpDocument *document,
                                                         const gchar *page_id,
                                                         gchar *contents,
                                                         const gchar *mime);

document :

page_id :

contents :

mime :


yelp_document_get_mime_type ()

gchar *             yelp_document_get_mime_type         (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_read_contents ()

const gchar *       yelp_document_read_contents         (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_finish_read ()

void                yelp_document_finish_read           (YelpDocument *document,
                                                         const gchar *contents);

document :

contents :


yelp_document_list_page_ids ()

gchar **            yelp_document_list_page_ids         (YelpDocument *document);

document :

Returns :


yelp_document_get_page_id ()

gchar *             yelp_document_get_page_id           (YelpDocument *document,
                                                         const gchar *id);

document :

id :

Returns :


yelp_document_set_page_id ()

void                yelp_document_set_page_id           (YelpDocument *document,
                                                         const gchar *id,
                                                         const gchar *page_id);

document :

id :

page_id :


yelp_document_get_root_id ()

gchar *             yelp_document_get_root_id           (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_root_id ()

void                yelp_document_set_root_id           (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *root_id);

document :

page_id :

root_id :


yelp_document_get_prev_id ()

gchar *             yelp_document_get_prev_id           (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_prev_id ()

void                yelp_document_set_prev_id           (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *prev_id);

document :

page_id :

prev_id :


yelp_document_get_next_id ()

char *              yelp_document_get_next_id           (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_next_id ()

void                yelp_document_set_next_id           (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *next_id);

document :

page_id :

next_id :


yelp_document_get_up_id ()

gchar *             yelp_document_get_up_id             (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_up_id ()

void                yelp_document_set_up_id             (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *up_id);

document :

page_id :

up_id :


yelp_document_get_root_title ()

gchar *             yelp_document_get_root_title        (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_get_page_title ()

gchar *             yelp_document_get_page_title        (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_page_title ()

void                yelp_document_set_page_title        (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *title);

document :

page_id :

title :


yelp_document_get_page_desc ()

gchar *             yelp_document_get_page_desc         (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_page_desc ()

void                yelp_document_set_page_desc         (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *desc);

document :

page_id :

desc :


yelp_document_get_page_icon ()

gchar *             yelp_document_get_page_icon         (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_set_page_icon ()

gchar *             yelp_document_set_page_icon         (YelpDocument *document,
                                                         const gchar *page_id,
                                                         const gchar *icon);

document :

page_id :

icon :

Returns :


yelp_document_has_page ()

gboolean            yelp_document_has_page              (YelpDocument *document,
                                                         const gchar *page_id);

document :

page_id :

Returns :


yelp_document_signal ()

void                yelp_document_signal                (YelpDocument *document,
                                                         const gchar *page_id,
                                                         YelpDocumentSignal signal,
                                                         const GError *error);

document :

page_id :

signal :

error :


yelp_document_error_pending ()

void                yelp_document_error_pending         (YelpDocument *document,
                                                         const GError *error);

document :

error :