| Top |
| DhBook * | dh_book_new () |
| GList * | dh_book_get_keywords () |
| GList * | dh_book_get_completions () |
| GNode * | dh_book_get_tree () |
| const gchar * | dh_book_get_name () |
| const gchar * | dh_book_get_title () |
| const gchar * | dh_book_get_language () |
| const gchar * | dh_book_get_path () |
| gboolean | dh_book_get_enabled () |
| void | dh_book_set_enabled () |
| gint | dh_book_cmp_by_path () |
| gint | dh_book_cmp_by_name () |
| gint | dh_book_cmp_by_title () |
A DhBook usually contains the documentation for one library (or
application), for example GLib or GTK+. There is one DhBook for each index
file found and parsed (an index file is a file with the extension *.devhelp
or *.devhelp2).
GNode *
dh_book_get_tree (DhBook *book);
Gets the general structure of the book, as a tree. The tree contains only
DhLink's of type DH_LINK_TYPE_BOOK or DH_LINK_TYPE_PAGE. The other
DhLink's are not contained in the tree. To have a list of
all DhLink's part of the book, you need to call
dh_book_get_keywords().
void dh_book_set_enabled (DhBook *book,gboolean enabled);
Enables or disables the book.
gint dh_book_cmp_by_path (DhBook *a,DhBook *b);
Compares the DhBook's by their path to the index file.
gint dh_book_cmp_by_name (DhBook *a,DhBook *b);
Compares the DhBook's by their name.
“deleted” signalvoid user_function (DhBook *book, gpointer user_data)
book |
the book on which the signal is emitted. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“disabled” signalvoid user_function (DhBook *book, gpointer user_data)
book |
the book on which the signal is emitted. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“enabled” signalvoid user_function (DhBook *book, gpointer user_data)
book |
the book on which the signal is emitted. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last