EDataBook.DataBookCursorSqlite¶

Subclasses:: None

Methods¶

Inherited:: EDataBook.DataBookCursor (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class

new (backend, ebsql, revision_key, sort_fields, sort_types)

Virtual Methods¶

Inherited:: EDataBook.DataBookCursor (6), GObject.Object (7)

Properties¶

Inherited:: EDataBook.DataBookCursor (3)

Name	Type	Flags	Short Description
`cursor`	`int`	w/co	The `EDataBook.bSqlCursor` pointer
`ebsql`	`EDataBook.BookSqlite`	w/co	The `EDataBook.BookSqlite` to use for queries
`revision-key`	`str`	w/co	The key name to fetch the revision from the sqlite backend

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`EDataBook.DataBookCursor`	r

Class Details¶

class EDataBook.DataBookCursorSqlite(**kwargs)¶

Bases:: EDataBook.DataBookCursor
Abstract:: No
Structure:: EDataBook.DataBookCursorSqliteClass

An opaque handle for the SQLite cursor instance.

New in version 3.12.

classmethod new(backend, ebsql, revision_key, sort_fields, sort_types)¶

Parameters:

backend (EDataBook.BookBackend) – the EDataBook.BookBackend creating this cursor
ebsql (EDataBook.BookSqlite) – the EDataBook.BookSqlite object to base this cursor on
revision_key (str) – The key name to consult for the current overall contacts database revision
sort_fields ([EBookContacts.ContactField]) – an array of EBookContacts.ContactFields as sort keys in order of priority
sort_types ([EBookContacts.BookCursorSortType]) – an array of EBookContacts.BookCursorSortTypes, one for each field in sort_fields

Raises:

Returns:

A newly created EDataBook.DataBookCursor, or None if cursor creation failed.

Return type:

EDataBook.DataBookCursor

Creates an EDataBook.DataBookCursor and implements all of the cursor methods using the delegate ebsql object.

This is a suitable cursor type for any backend which stores its contacts using the EDataBook.BookSqlite object.

New in version 3.12.

Property Details¶

EDataBook.DataBookCursorSqlite.props.cursor¶

Name:: cursor
Type:: int
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The EDataBook.bSqlCursor pointer

EDataBook.DataBookCursorSqlite.props.ebsql¶

Name:: ebsql
Type:: EDataBook.BookSqlite
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The EDataBook.BookSqlite to use for queries

EDataBook.DataBookCursorSqlite.props.revision_key¶

Name:: revision-key
Type:: str
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The key name to fetch the revision from the sqlite backend