| Top |  |  |  |  | 
| DhLinkDhLink — A link inside a DhBook | 
| DhLink * | dh_link_new_book () | 
| DhLink * | dh_link_new () | 
| DhLink * | dh_link_ref () | 
| void | dh_link_unref () | 
| DhLinkType | dh_link_get_link_type () | 
| DhLinkFlags | dh_link_get_flags () | 
| void | dh_link_set_flags () | 
| const gchar * | dh_link_get_name () | 
| gboolean | dh_link_match_relative_url () | 
| gboolean | dh_link_belongs_to_page () | 
| gchar * | dh_link_get_uri () | 
| const gchar * | dh_link_get_book_title () | 
| const gchar * | dh_link_get_book_id () | 
| gint | dh_link_compare () | 
| const gchar * | dh_link_type_to_string () | 
A DhLink represents a link to an HTML page or somewhere inside a page (with an anchor) that is inside a DhBook. The link can point to a specific symbol, or a page, or the top-level page of the DhBook.
A DhLink has a type that can be retrieved with dh_link_get_link_type().
There is exactly one DhLink of type DH_LINK_TYPE_BOOK per DhBook object.
DhLink * dh_link_new_book (const gchar *base_path,const gchar *book_id,const gchar *book_title,const gchar *relative_url);
| base_path | the base path for the book. | |
| book_id | the book ID. | |
| book_title | the name of the link. | |
| relative_url | the URL relative to the book  | 
Since: 3.28
DhLink * dh_link_new (DhLinkType type,DhLink *book_link,const gchar *name,const gchar *relative_url);
| type | the DhLinkType. Must be different than  | |
| book_link | the DhLink of type  | |
| name | the name of the link. | |
| relative_url | the URL relative to the book base path. Can contain an anchor. | 
DhLink *
dh_link_ref (DhLink *link);
Increases the reference count of link
.
Not thread-safe.
void
dh_link_unref (DhLink *link);
Decreases the reference count of link
.
Not thread-safe.
void dh_link_set_flags (DhLink *link,DhLinkFlags flags);
Sets the flags of the link.
gboolean dh_link_match_relative_url (DhLink *link,const gchar *relative_url);
| link | a DhLink. | |
| relative_url | an URL relative to the book base path. Can contain an anchor. | 
 whether the relative URL of link
matches with relative_url
. There
is a special case for the index.html page, it can also match the empty
string.
Since: 3.28
gboolean dh_link_belongs_to_page (DhLink *link,const gchar *page_id);
This function permits to know if link
 belongs to a certain page.
page_id
 is usually the HTML filename without the .html extension. More
generally, page_id
 must be a relative URL (relative to the book base path),
without the anchor nor the file extension.
For example if link
 has the relative URL "DhLink.html#dh-link-ref", then
this function will return TRUE if the page_id
 is "DhLink".
Since: 3.28
gchar *
dh_link_get_uri (DhLink *link);
Gets the link
 URI, by concateneting the book base path with the link
relative URL.
gint dh_link_compare (gconstpointer a,gconstpointer b);
Compares the links a
 and b
. This function is used to determine in which
order the links should be displayed.
The type of the content the link points to.
| The top-level page of a DhBook. | ||
| A page. | ||
| Another kind of keyword. | ||
| A function keyword. | ||
| A struct keyword. | ||
| A macro keyword. | ||
| An enum keyword. | ||
| A typedef keyword. | ||
| A property keyword. | ||
| A signal keyword. |