Devhelp.BookList¶

Subclasses:: Devhelp.BookListDirectory

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_default` ()
class	`new` ()
	`add_book` (book)
	`get_books` ()
	`remove_book` (book)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_add_book` (book)
	`do_get_books` ()
	`do_remove_book` (book)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`add-book`	The `::add-book` signal is emitted when a `Devhelp.Book` is added to a `Devhelp.BookList`.
`remove-book`	The `::remove-book` signal is emitted when a `Devhelp.Book` is removed from a `Devhelp.BookList`.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Devhelp.BookList(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Devhelp.BookListClass

classmethod get_default()¶

Returns:: the default Devhelp.BookList object.
Return type:: Devhelp.BookList

Gets the default Devhelp.BookList object. It is created with Devhelp.BookListBuilder, Devhelp.BookListBuilder.add_default_sub_book_lists() is called, and Devhelp.BookListBuilder.read_books_disabled_setting() is called with the default Devhelp.Settings object as returned by Devhelp.Settings.get_default().

New in version 3.30.

classmethod new()¶

Returns:: a new empty Devhelp.BookList object.
Return type:: Devhelp.BookList

New in version 3.30.

add_book(book)¶

Parameters:: book (Devhelp.Book) – a Devhelp.Book.

Emits the Devhelp.BookList ::add-book signal.

It is a programmer error to call this function if book is already inserted in self.

New in version 3.30.

get_books()¶

Returns:: the GLib.List of Devhelp.Book's part of self.
Return type:: [Devhelp.Book]

Gets the list of Devhelp.Book's part of self, in no particular order. Each book ID in the list is unique (see Devhelp.Book.get_id()).

New in version 3.30.

remove_book(book)¶

Parameters:: book (Devhelp.Book) – a Devhelp.Book.

Emits the Devhelp.BookList ::remove-book signal.

It is a programmer error to call this function if book is not present in self.

New in version 3.30.

do_add_book(book) virtual¶

Parameters:: book (Devhelp.Book) – a Devhelp.Book.

Emits the Devhelp.BookList ::add-book signal.

It is a programmer error to call this function if book is already inserted in book_list.

New in version 3.30.

do_get_books() virtual¶

Returns:: the GLib.List of Devhelp.Book's part of book_list.
Return type:: [Devhelp.Book]

Gets the list of Devhelp.Book's part of book_list, in no particular order. Each book ID in the list is unique (see Devhelp.Book.get_id()).

New in version 3.30.

do_remove_book(book) virtual¶

Parameters:: book (Devhelp.Book) – a Devhelp.Book.

Emits the Devhelp.BookList ::remove-book signal.

It is a programmer error to call this function if book is not present in book_list.

New in version 3.30.

Signal Details¶

Devhelp.BookList.signals.add_book(book_list, book)¶

Signal Name:

add-book

Flags:

RUN_LAST

Parameters:

book_list (Devhelp.BookList) – The object which received the signal
book (Devhelp.Book) – the Devhelp.Book being added.

The ::add-book signal is emitted when a Devhelp.Book is added to a Devhelp.BookList.

The default object method handler adds book to the internal GLib.List of book_list after verifying that book is not already present in the list.

New in version 3.30.

Devhelp.BookList.signals.remove_book(book_list, book)¶

Signal Name:

remove-book

Flags:

RUN_LAST

Parameters:

book_list (Devhelp.BookList) – The object which received the signal
book (Devhelp.Book) – the Devhelp.Book being removed.

The ::remove-book signal is emitted when a Devhelp.Book is removed from a Devhelp.BookList.

The default object method handler removes book from the internal GLib.List of book_list, and verifies that book was present in the list and that book was not inserted several times.

New in version 3.30.