Blame docs/reference/html/DhLink.html

Packit 116408
Packit 116408
<html>
Packit 116408
<head>
Packit 116408
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 116408
<title>DhLink: Devhelp Reference Manual</title>
Packit 116408
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 116408
<link rel="home" href="index.html" title="Devhelp Reference Manual">
Packit 116408
<link rel="up" href="data.html" title="The Data">
Packit 116408
<link rel="prev" href="DhBook.html" title="DhBook">
Packit 116408
<link rel="next" href="side-panel.html" title="Side Panel">
Packit 116408
<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
Packit 116408
<link rel="stylesheet" href="style.css" type="text/css">
Packit 116408
</head>
Packit 116408
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 116408
Packit 116408
Packit 116408
Top  | 
Packit 116408
                  Description  | 
Packit 116408
                  Object Hierarchy
Packit 116408
Packit 116408
Home
Packit 116408
Up
Packit 116408
Prev
Packit 116408
Next
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

DhLink

Packit 116408

DhLink — A link inside a DhBook

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Functions

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhLink *
Packit 116408
Packit 116408
Packit 116408
dh_link_new_book ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhLink *
Packit 116408
Packit 116408
Packit 116408
dh_link_new ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhLink *
Packit 116408
Packit 116408
Packit 116408
dh_link_ref ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
Packit 116408
Packit 116408
dh_link_unref ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhLinkType
Packit 116408
Packit 116408
Packit 116408
dh_link_get_link_type ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhLinkFlags
Packit 116408
Packit 116408
Packit 116408
dh_link_get_flags ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
Packit 116408
Packit 116408
dh_link_set_flags ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
const gchar *
Packit 116408
Packit 116408
Packit 116408
dh_link_get_name ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gboolean
Packit 116408
Packit 116408
Packit 116408
dh_link_match_relative_url ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gboolean
Packit 116408
Packit 116408
Packit 116408
dh_link_belongs_to_page ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gchar *
Packit 116408
Packit 116408
Packit 116408
dh_link_get_uri ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
const gchar *
Packit 116408
Packit 116408
Packit 116408
dh_link_get_book_title ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
const gchar *
Packit 116408
Packit 116408
Packit 116408
dh_link_get_book_id ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gint
Packit 116408
Packit 116408
Packit 116408
dh_link_compare ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
const gchar *
Packit 116408
Packit 116408
Packit 116408
dh_link_type_to_string ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Types and Values

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
 
Packit 116408
DhLink
Packit 116408
Packit 116408
Packit 116408
enum
Packit 116408
DhLinkType
Packit 116408
Packit 116408
Packit 116408
enum
Packit 116408
DhLinkFlags
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Object Hierarchy

Packit 116408
    GBoxed
Packit 116408
    ╰── DhLink
Packit 116408
    GEnum
Packit 116408
    ╰── DhLinkType
Packit 116408
    GFlags
Packit 116408
    ╰── DhLinkFlags
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Includes

Packit 116408
#include <devhelp/devhelp.h>
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Description

Packit 116408

A DhLink represents a link to an HTML page or somewhere inside a page (with

Packit 116408
an anchor) that is inside a DhBook. The link can point to a specific symbol,
Packit 116408
or a page, or the top-level page of the DhBook.

Packit 116408

A DhLink has a type that can be retrieved with dh_link_get_link_type().

Packit 116408

There is exactly one DhLink of type DH_LINK_TYPE_BOOK per DhBook object.

Packit 116408
Packit 116408
Packit 116408

Functions

Packit 116408
Packit 116408

dh_link_new_book ()

Packit 116408
DhLink *
Packit 116408
dh_link_new_book (const gchar *base_path,
Packit 116408
                  const gchar *book_id,
Packit 116408
                  const gchar *book_title,
Packit 116408
                  const gchar *relative_url);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

base_path

Packit 116408

the base path for the book.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book_id

Packit 116408

the book ID.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book_title

Packit 116408

the name of the link.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

relative_url

Packit 116408

the URL relative to the book base_path

Packit 116408
. Can contain an
Packit 116408
anchor. Usually the index.html page.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

a new DhLink of type DH_LINK_TYPE_BOOK.

Packit 116408
Packit 116408

Since: 3.28

Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_new ()

Packit 116408
DhLink *
Packit 116408
dh_link_new (DhLinkType type,
Packit 116408
             DhLink *book_link,
Packit 116408
             const gchar *name,
Packit 116408
             const gchar *relative_url);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

type

Packit 116408

the DhLinkType. Must be different than DH_LINK_TYPE_BOOK.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book_link

Packit 116408

the DhLink of type DH_LINK_TYPE_BOOK for the book that the link

Packit 116408
is contained in.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

name

Packit 116408

the name of the link.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

relative_url

Packit 116408

the URL relative to the book base path. Can contain an anchor.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

a new DhLink.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_ref ()

Packit 116408
DhLink *
Packit 116408
dh_link_ref (DhLink *link);
Packit 116408

Increases the reference count of link

Packit 116408
.

Packit 116408

Not thread-safe.

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the link

Packit 116408
. 

Packit 116408

[transfer full]

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_unref ()

Packit 116408
void
Packit 116408
dh_link_unref (DhLink *link);
Packit 116408

Decreases the reference count of link

Packit 116408
.

Packit 116408

Not thread-safe.

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_link_type ()

Packit 116408
DhLinkType
Packit 116408
dh_link_get_link_type (DhLink *link);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the DhLinkType of link

Packit 116408
.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_flags ()

Packit 116408
DhLinkFlags
Packit 116408
dh_link_get_flags (DhLink *link);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the DhLinkFlags of link

Packit 116408
.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_set_flags ()

Packit 116408
void
Packit 116408
dh_link_set_flags (DhLink *link,
Packit 116408
                   DhLinkFlags flags);
Packit 116408

Sets the flags of the link.

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

flags

Packit 116408

the new flags of the link.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_name ()

Packit 116408
const gchar *
Packit 116408
dh_link_get_name (DhLink *link);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the name of the link

Packit 116408
. For a link of type DH_LINK_TYPE_BOOK,
Packit 116408
returns the book title.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_match_relative_url ()

Packit 116408
gboolean
Packit 116408
dh_link_match_relative_url (DhLink *link,
Packit 116408
                            const gchar *relative_url);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

relative_url

Packit 116408

an URL relative to the book base path. Can contain an anchor.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

whether the relative URL of link

Packit 116408
matches with relative_url
Packit 116408
. There
Packit 116408
is a special case for the index.html page, it can also match the empty
Packit 116408
string.

Packit 116408
Packit 116408

Since: 3.28

Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_belongs_to_page ()

Packit 116408
gboolean
Packit 116408
dh_link_belongs_to_page (DhLink *link,
Packit 116408
                         const gchar *page_id);
Packit 116408

This function permits to know if link

Packit 116408
 belongs to a certain page.

Packit 116408

page_id

Packit 116408
 is usually the HTML filename without the .html extension. More
Packit 116408
generally, page_id
Packit 116408
 must be a relative URL (relative to the book base path),
Packit 116408
without the anchor nor the file extension.

Packit 116408

For example if link

Packit 116408
 has the relative URL "DhLink.html#dh-link-ref", then
Packit 116408
this function will return TRUE if the page_id
Packit 116408
 is "DhLink".

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

page_id

Packit 116408

a page ID, i.e. the filename without its extension.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

whether link

Packit 116408
belongs to page_id
Packit 116408
.

Packit 116408
Packit 116408

Since: 3.28

Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_uri ()

Packit 116408
gchar *
Packit 116408
dh_link_get_uri (DhLink *link);
Packit 116408

Gets the link

Packit 116408
 URI, by concateneting the book base path with the link
Packit 116408
Packit 116408
relative URL.

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the link

Packit 116408
URI, or NULL if getting the URI failed. Free
Packit 116408
with g_free() when no longer needed. 

Packit 116408

[nullable]

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_book_title ()

Packit 116408
const gchar *
Packit 116408
dh_link_get_book_title (DhLink *link);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the title of the book that the link

Packit 116408
is contained in.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_get_book_id ()

Packit 116408
const gchar *
Packit 116408
dh_link_get_book_id (DhLink *link);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link

Packit 116408

a DhLink.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the ID of the book that the link

Packit 116408
is contained in.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_compare ()

Packit 116408
gint
Packit 116408
dh_link_compare (gconstpointer a,
Packit 116408
                 gconstpointer b);
Packit 116408

Compares the links a

Packit 116408
 and b
Packit 116408
. This function is used to determine in which
Packit 116408
order the links should be displayed.

Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

a

Packit 116408

a DhLink.

Packit 116408
[type DhLink]
Packit 116408
Packit 116408
Packit 116408

b

Packit 116408

a DhLink.

Packit 116408
[type DhLink]
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

an integer less than zero if a

Packit 116408
should appear before b
Packit 116408
; zero if
Packit 116408
there are no preferences; an integer greater than zero if b
Packit 116408
should appear
Packit 116408
before a
Packit 116408
.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_link_type_to_string ()

Packit 116408
const gchar *
Packit 116408
dh_link_type_to_string (DhLinkType link_type);
Packit 116408
Packit 116408

Parameters

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

link_type

Packit 116408

a DhLinkType.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

a string representation of the DhLinkType, translated in the

Packit 116408
current language.

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Types and Values

Packit 116408
Packit 116408

DhLink

Packit 116408
typedef struct _DhLink DhLink;
Packit 116408
Packit 116408

Packit 116408
Packit 116408

enum DhLinkType

Packit 116408

The type of the content the link points to.

Packit 116408
Packit 116408

Members

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_BOOK

Packit 116408
Packit 116408

The top-level page of a DhBook.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_PAGE

Packit 116408
Packit 116408

A page.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_KEYWORD

Packit 116408
Packit 116408

Another kind of keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_FUNCTION

Packit 116408
Packit 116408

A function keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_STRUCT

Packit 116408
Packit 116408

A struct keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_MACRO

Packit 116408
Packit 116408

A macro keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_ENUM

Packit 116408
Packit 116408

An enum keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_TYPEDEF

Packit 116408
Packit 116408

A typedef keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_PROPERTY

Packit 116408
Packit 116408

A property keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_TYPE_SIGNAL

Packit 116408
Packit 116408

A signal keyword.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

enum DhLinkFlags

Packit 116408
Packit 116408

Members

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

DH_LINK_FLAGS_NONE

Packit 116408
Packit 116408

No flags set.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

DH_LINK_FLAGS_DEPRECATED

Packit 116408
Packit 116408

The symbol that the link points to is deprecated.

Packit 116408
Packit 116408
 
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Generated by GTK-Doc V1.28.1
Packit 116408
</body>
Packit 116408
</html>