EDataBookCursorSqlite

EDataBookCursorSqlite — The SQLite cursor implementation

Synopsis

#include <libedata-book/libedata-book.h>

struct              EDataBookCursorSqlite;
struct              EDataBookCursorSqliteClass;
EDataBookCursor *   e_data_book_cursor_sqlite_new       (EBookBackend *backend,
                                                         EBookBackendSqliteDB *ebsdb,
                                                         const gchar *folder_id,
                                                         EContactField *sort_fields,
                                                         EBookCursorSortType *sort_types,
                                                         guint n_fields,
                                                         GError **error);

Object Hierarchy

  GObject
   +----EDataBookCursor
         +----EDataBookCursorSqlite

Properties

  "cursor"                   gpointer              : Write / Construct Only
  "ebsdb"                    EBookBackendSqliteDB*  : Write / Construct Only
  "folder-id"                gchar*                : Write / Construct Only

Description

This cursor implementation can be used with any backend which stores contacts using EBookBackendSqliteDB.

Details

struct EDataBookCursorSqlite

struct EDataBookCursorSqlite;

An opaque handle for the SQLite cursor instance.

Since 3.12


struct EDataBookCursorSqliteClass

struct EDataBookCursorSqliteClass {
	EDataBookCursorClass parent;
};

The SQLite cursor class structure.

Since 3.12


e_data_book_cursor_sqlite_new ()

EDataBookCursor *   e_data_book_cursor_sqlite_new       (EBookBackend *backend,
                                                         EBookBackendSqliteDB *ebsdb,
                                                         const gchar *folder_id,
                                                         EContactField *sort_fields,
                                                         EBookCursorSortType *sort_types,
                                                         guint n_fields,
                                                         GError **error);

Creates an EDataBookCursor and implements all of the cursor methods using the delegate ebsdb object.

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

backend :

the EBookBackend creating this cursor

ebsdb :

the EBookBackendSqliteDB object to base this cursor on

folder_id :

the folder identifier to be used in EBookBackendSqliteDB API calls

sort_fields :

an array of EContactFields as sort keys in order of priority. [array length=n_fields]

sort_types :

an array of EBookCursorSortTypes, one for each field in sort_fields. [array length=n_fields]

n_fields :

the number of fields to sort results by.

error :

a return location to story any error that might be reported.

Returns :

A newly created EDataBookCursor, or NULL if cursor creation failed. [transfer full]

Since 3.12

Property Details

The "cursor" property

  "cursor"                   gpointer              : Write / Construct Only

The EbSdbCursor pointer.


The "ebsdb" property

  "ebsdb"                    EBookBackendSqliteDB*  : Write / Construct Only

The EBookBackendSqliteDB to use for queries.


The "folder-id" property

  "folder-id"                gchar*                : Write / Construct Only

The folder identifier to use with the EBookBackendSqliteDB object.

Default value: NULL