EBookContacts.BookIndices¶

Fields¶

Name	Type	Access	Description
chr	`str`	r/w	a character for the index
index	`int`	r/w	0-based index of the first contact with this character

Methods¶

class	`get_ascending_sort` (self)
class	`set_ascending_sort` (self, ascending_sort)

Details¶

class EBookContacts.BookIndices¶

This is a structure describing indices of the contacts in the view. See e_book_client_view_dup_indices() for more information.

New in version 3.50.

classmethod get_ascending_sort(self)¶

Parameters:: self (EBookContacts.BookIndicesUpdater) – an EBookContacts.BookIndicesUpdater
Returns:: True, when considers contacts sorted in ascending order, False when in the descending order.
Return type:: bool

Returns whether the self considers contacts stored in the ascending order.

New in version 3.50.

classmethod set_ascending_sort(self, ascending_sort)¶

Parameters:

self (EBookContacts.BookIndicesUpdater) – an EBookContacts.BookIndicesUpdater
ascending_sort (bool) – the value to set

Sets whether the contacts are sorted in an ascending order; if not, then they are sorted in the descending order. That influences what indexes the indices have set.

New in version 3.50.