![]() |
![]() |
![]() |
Yelp Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
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);
GObject +----YelpDocument +----YelpDocbookDocument +----YelpMallardDocument +----YelpSimpleDocument
typedef enum { YELP_DOCUMENT_SIGNAL_CONTENTS, YELP_DOCUMENT_SIGNAL_INFO, YELP_DOCUMENT_SIGNAL_ERROR } YelpDocumentSignal;
void (*YelpDocumentCallback) (YelpDocument *document, YelpDocumentSignal signal, gpointer user_data, GError *error);
|
|
|
|
|
|
|
YelpDocument * yelp_document_get_for_uri (YelpUri *uri);
|
|
Returns : |
gboolean yelp_document_request_page (YelpDocument *document, const gchar *page_id, GCancellable *cancellable, YelpDocumentCallback callback, gpointer user_data);
|
|
|
|
|
|
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
const gchar * yelp_document_read_contents (YelpDocument *document, const gchar *page_id);
|
|
|
|
Returns : |
void yelp_document_finish_read (YelpDocument *document, const gchar *contents);
|
|
|
gchar ** yelp_document_list_page_ids (YelpDocument *document);
|
|
Returns : |
gchar * yelp_document_get_page_id (YelpDocument *document, const gchar *id);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
gchar * yelp_document_get_page_title (YelpDocument *document, const gchar *page_id);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
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);
|
|
|
|
Returns : |
gchar * yelp_document_set_page_icon (YelpDocument *document, const gchar *page_id, const gchar *icon);
|
|
|
|
|
|
Returns : |
gboolean yelp_document_has_page (YelpDocument *document, const gchar *page_id);
|
|
|
|
Returns : |
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);
|
|
|