Blame docs/reference/html/DhBookManager.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>DhBookManager: 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="data.html" title="The Data">
Packit 116408
<link rel="next" href="DhBook.html" title="DhBook">
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
                  Properties  | 
Packit 116408
                  Signals
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

DhBookManager

Packit 116408

DhBookManager — Aggregation of all DhBook's

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
DhBookManager *
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_new ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
DhBookManager *
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_get_singleton ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_populate ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
GList *
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_get_books ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gboolean
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_get_group_by_language ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
Packit 116408
Packit 116408
dh_book_manager_set_group_by_language ()
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Properties

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
gboolean
Packit 116408
group-by-language
Packit 116408
Read / Write
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Signals

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
book-created
Packit 116408
Run Last
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
book-deleted
Packit 116408
Run Last
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
book-disabled
Packit 116408
Run Last
Packit 116408
Packit 116408
Packit 116408
void
Packit 116408
book-enabled
Packit 116408
Run Last
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
struct
Packit 116408
DhBookManager
Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Object Hierarchy

Packit 116408
    GObject
Packit 116408
    ╰── DhBookManager
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

DhBookManager is a singleton class containing all the DhBook's.

Packit 116408
Packit 116408
Packit 116408

Functions

Packit 116408
Packit 116408

dh_book_manager_new ()

Packit 116408
DhBookManager *
Packit 116408
dh_book_manager_new (void);
Packit 116408
Packit 116408

dh_book_manager_new has been deprecated since version 3.26 and should not be used in newly-written code.

Packit 116408

Call dh_book_manager_get_singleton() instead.

Packit 116408
Packit 116408
Packit 116408

Returns

Packit 116408

the DhBookManager singleton instance. You need to

Packit 116408
unref it when no longer needed. 

Packit 116408

[transfer full]

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_book_manager_get_singleton ()

Packit 116408
DhBookManager *
Packit 116408
dh_book_manager_get_singleton (void);
Packit 116408
Packit 116408

Returns

Packit 116408

the DhBookManager singleton instance.

Packit 116408

[transfer none]

Packit 116408
Packit 116408

Since: 3.26

Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_book_manager_populate ()

Packit 116408
void
Packit 116408
dh_book_manager_populate (DhBookManager *book_manager);
Packit 116408
Packit 116408

dh_book_manager_populate has been deprecated since version 3.26 and should not be used in newly-written code.

Packit 116408

The DhBookManager is now automatically populated when the

Packit 116408
object is created, there is no need to call this function anymore.

Packit 116408
Packit 116408

Populates the DhBookManager with all books found on the system and user

Packit 116408
directories.

Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

a DhBookManager.

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

Packit 116408
Packit 116408

dh_book_manager_get_books ()

Packit 116408
GList *
Packit 116408
dh_book_manager_get_books (DhBookManager *book_manager);
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

a DhBookManager.

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

Returns

Packit 116408

the list of all DhBook's

Packit 116408
found. 

Packit 116408

[element-type DhBook][transfer none]

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_book_manager_get_group_by_language ()

Packit 116408
gboolean
Packit 116408
dh_book_manager_get_group_by_language (DhBookManager *book_manager);
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

a DhBookManager.

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

Returns

Packit 116408

whether the books should be grouped by programming language.

Packit 116408
Packit 116408
Packit 116408

Packit 116408
Packit 116408

dh_book_manager_set_group_by_language ()

Packit 116408
void
Packit 116408
dh_book_manager_set_group_by_language (DhBookManager *book_manager,
Packit 116408
                                       gboolean group_by_language);
Packit 116408

Sets whether the books should be grouped by programming language.

Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

a DhBookManager.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

group_by_language

Packit 116408

the new value.

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

Types and Values

Packit 116408
Packit 116408

struct DhBookManager

Packit 116408
struct DhBookManager;
Packit 116408
Packit 116408
Packit 116408
Packit 116408

Property Details

Packit 116408
Packit 116408

The “group-by-language” property

Packit 116408
  “group-by-language”        gboolean
Packit 116408

Whether books should be grouped by programming language.

Packit 116408

Flags: Read / Write

Packit 116408

Default value: FALSE

Packit 116408
Packit 116408
Packit 116408
Packit 116408

Signal Details

Packit 116408
Packit 116408

The “book-created” signal

Packit 116408
void
Packit 116408
user_function (DhBookManager *book_manager,
Packit 116408
               DhBook        *book,
Packit 116408
               gpointer       user_data)
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

the DhBookManager.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book

Packit 116408

the created DhBook.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

user_data

Packit 116408

user data set when the signal handler was connected.

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

Flags: Run Last

Packit 116408
Packit 116408

Packit 116408
Packit 116408

The “book-deleted” signal

Packit 116408
void
Packit 116408
user_function (DhBookManager *book_manager,
Packit 116408
               DhBook        *book,
Packit 116408
               gpointer       user_data)
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

the DhBookManager.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book

Packit 116408

the deleted DhBook.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

user_data

Packit 116408

user data set when the signal handler was connected.

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

Flags: Run Last

Packit 116408
Packit 116408

Packit 116408
Packit 116408

The “book-disabled” signal

Packit 116408
void
Packit 116408
user_function (DhBookManager *book_manager,
Packit 116408
               DhBook        *book,
Packit 116408
               gpointer       user_data)
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

the DhBookManager.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book

Packit 116408

the disabled DhBook.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

user_data

Packit 116408

user data set when the signal handler was connected.

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

Flags: Run Last

Packit 116408
Packit 116408

Packit 116408
Packit 116408

The “book-enabled” signal

Packit 116408
void
Packit 116408
user_function (DhBookManager *book_manager,
Packit 116408
               DhBook        *book,
Packit 116408
               gpointer       user_data)
Packit 116408
Packit 116408

Parameters

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

book_manager

Packit 116408

the DhBookManager.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

book

Packit 116408

the enabled DhBook.

Packit 116408
 
Packit 116408
Packit 116408
Packit 116408

user_data

Packit 116408

user data set when the signal handler was connected.

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

Flags: Run Last

Packit 116408
Packit 116408
Packit 116408
Packit 116408
Packit 116408

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