DhBook

DhBook

Functions

Signals

Types and Values

struct DhBook
struct DhBookClass

Object Hierarchy

    GObject
    ╰── DhBook

Description

Functions

dh_book_new ()

DhBook *
dh_book_new (const gchar *book_path);

Create a new DhBook object.

Parameters

book_path

the path of the book

 

Returns

a new DhBook object


dh_book_get_keywords ()

GList *
dh_book_get_keywords (DhBook *book);

Get the GList of keywords associated with the book.

Parameters

book

a DhBook object

 

Returns

the keywords associated with the book.

[element-type utf8][transfer none][nullable]


dh_book_get_completions ()

GList *
dh_book_get_completions (DhBook *book);

Get the GList of completions associated with the book.

Parameters

book

a DhBook object

 

Returns

the completions associated with the book.

[element-type utf8][transfer full][nullable]


dh_book_get_tree ()

GNode *
dh_book_get_tree (DhBook *book);

Get the GNode representing the book tree.

Parameters

book

a DhBook object

 

Returns

the book tree.

[transfer none][nullable]


dh_book_get_name ()

const gchar *
dh_book_get_name (DhBook *book);

Get the book name.

Parameters

book

a DhBook object

 

Returns

the book name


dh_book_get_title ()

const gchar *
dh_book_get_title (DhBook *book);

Get the book title.

Parameters

book

a DhBook object

 

Returns

the book title


dh_book_get_language ()

const gchar *
dh_book_get_language (DhBook *book);

Get the book language.

Parameters

book

a DhBook object

 

Returns

the book language


dh_book_get_path ()

const gchar *
dh_book_get_path (DhBook *book);

Get the book path.

Parameters

book

a DhBook object

 

Returns

the book path


dh_book_get_enabled ()

gboolean
dh_book_get_enabled (DhBook *book);

Get the current state of the book.

Parameters

book

a DhBook object

 

Returns

TRUE if the book is enabled


dh_book_set_enabled ()

void
dh_book_set_enabled (DhBook *book,
                     gboolean enabled);

Enable or disable completely the book.

Parameters

book

a DhBook object

 

enabled

TRUE to enable the book

 

dh_book_cmp_by_path ()

gint
dh_book_cmp_by_path (DhBook *a,
                     DhBook *b);

Compare the DhBook a and b by their paths.

Parameters

a

a DhBook object

 

b

a second DhBook object

 

Returns

an integer less than, equal to, or greater than zero, if a is <, == or > than b .


dh_book_cmp_by_path_str ()

gint
dh_book_cmp_by_path_str (DhBook *a,
                         const gchar *b_path);

dh_book_cmp_by_path_str is deprecated and should not be used in newly-written code.

Compare the path of the DhBook a with b_path .

Parameters

a

a DhBook object

 

b_path

a path to a book

 

Returns

an integer less than, equal to, or greater than zero, if the path of a is <, == or > than b_path .


dh_book_cmp_by_name ()

gint
dh_book_cmp_by_name (DhBook *a,
                     DhBook *b);

Compare the DhBook a and b by their name.

Parameters

a

a DhBook object

 

b

a second DhBook object

 

Returns

an integer less than, equal to, or greater than zero, if a is <, == or > than b .


dh_book_cmp_by_name_str ()

gint
dh_book_cmp_by_name_str (DhBook *a,
                         const gchar *b_name);

dh_book_cmp_by_name_str is deprecated and should not be used in newly-written code.

Compare the name of the DhBook a with b_name .

Parameters

a

a DhBook object

 

b_name

a path to a book

 

Returns

an integer less than, equal to, or greater than zero, if the name of a is <, == or > than b_name .


dh_book_cmp_by_title ()

gint
dh_book_cmp_by_title (DhBook *a,
                      DhBook *b);

Compare the DhBook a and b by their title.

Parameters

a

a DhBook object

 

b

a second DhBook object

 

Returns

an integer less than, equal to, or greater than zero, if a is <, == or > than b .

Types and Values

struct DhBook

struct DhBook;

struct DhBookClass

struct DhBookClass {
        GObjectClass parent_class;
};

Signal Details

The “deleted” signal

void
user_function (DhBook  *book,
               gpointer user_data)

Parameters

book

the book on which the signal is emitted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “disabled” signal

void
user_function (DhBook  *book,
               gpointer user_data)

Parameters

book

the book on which the signal is emitted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “enabled” signal

void
user_function (DhBook  *book,
               gpointer user_data)

Parameters

book

the book on which the signal is emitted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “updated” signal

void
user_function (DhBook  *book,
               gpointer user_data)

Parameters

book

the book on which the signal is emitted

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last