EDataBook.DataBookViewWatcherMemory

g EBookContacts.BookIndicesUpdater EBookContacts.BookIndicesUpdater EDataBook.DataBookViewWatcherMemory EDataBook.DataBookViewWatcherMemory EBookContacts.BookIndicesUpdater->EDataBook.DataBookViewWatcherMemory GObject.Object GObject.Object GObject.Object->EBookContacts.BookIndicesUpdater

Subclasses:

None

Methods

Inherited:

EBookContacts.BookIndicesUpdater (4), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new (backend, view)

dup_contacts (range_start, range_length)

set_locale (locale)

take_sort_fields (sort_fields)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

EBookContacts.BookIndicesUpdater

r

Class Details

class EDataBook.DataBookViewWatcherMemory(**kwargs)
Bases:

EBookContacts.BookIndicesUpdater

Abstract:

No

Structure:

EDataBook.DataBookViewWatcherMemoryClass

A structure used as a default implementation to handle “manual query” views by the EDataBook.BookBackend.

New in version 3.50.

classmethod new(backend, view)
Parameters:
Returns:

a new EDataBook.DataBookViewWatcherMemory

Return type:

GObject.Object

Creates a new EDataBook.DataBookViewWatcherMemory, which will watch the view and will provide the information about indices and total contacts to the backend. The locale is taken from the backend during the creation process too.

New in version 3.50.

dup_contacts(range_start, range_length)
Parameters:
  • range_start (int) – range start, 0-based

  • range_length (int) – how many contacts to retrieve

Returns:

an array of EBookContacts.Contact-s, or None, when range_start is out of bounds.

Return type:

[EBookContacts.Contact] or None

Retrieves contacts in the given range. Returns None when the range_start is out of bounds. The function can return less than range_length contacts.

The returned array should be freed with g_ptr_array_unref(), when no longer needed.

New in version 3.50.

set_locale(locale)
Parameters:

locale (str or None) – a locale to set, or None

Sets a locale to use for sorting. When None, or when cannot use the provided locale, tries to use the system locale.

New in version 3.50.

take_sort_fields(sort_fields)
Parameters:

sort_fields (EBookContacts.BookClientViewSortFields or None) – an EBookContacts.BookClientViewSortFields, or None

Sets sort_fields as fields to sort the contacts by. If None, sorts by file-as field. The function assumes ownership of the sort_fields.

New in version 3.50.