Class

EDataBookDataBookCursor

since: 3.12

Description [src]

abstract class EDataBook.DataBookCursor : GObject.Object
{
  /* No available fields */
}

An opaque handle for an addressbook cursor.

Available since: 3.12

Hierarchy

hierarchy this EDataBookCursor ancestor_0 GObject ancestor_0--this

Ancestors

Instance methods

e_data_book_cursor_contact_added

Should be called by addressbook backends whenever a contact is added.

since: 3.12

e_data_book_cursor_contact_removed

Should be called by addressbook backends whenever a contact is removed.

since: 3.12

e_data_book_cursor_get_backend

Gets the backend which created and owns cursor.

since: 3.12

e_data_book_cursor_get_position

Fetch the current position of cursor in its result list.

since: 3.12

e_data_book_cursor_get_total

Fetch the total number of contacts which match cursors query expression.

since: 3.12

e_data_book_cursor_load_locale

Load the current locale setting from the cursor’s underlying database.

since: 3.12

e_data_book_cursor_recalculate

Recalculates the cursor’s total and position, this is meant for cursor created in Direct Read Access mode to synchronously recalculate the position and total values when the addressbook revision has changed.

since: 3.12

e_data_book_cursor_register_gdbus_object

Places cursor on the connection at object_path.

since: 3.12

e_data_book_cursor_set_alphabetic_index

Sets the cursor position to an Alphabetic Index into the alphabet active in the locale of the addressbook.

since: 3.12

e_data_book_cursor_set_sexp

Sets the search expression for the cursor.

since: 3.12

e_data_book_cursor_step

Steps cursor through its sorted query by a maximum of count contacts starting from origin.

since: 3.12

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

EDataBook.DataBookCursor:backend

The backend which created this cursor.

EDataBook.DataBookCursor:position

The current position of this cursor.

EDataBook.DataBookCursor:total

The total results for this cursor.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct EDataBookDataBookCursorClass {
  EDataBookCursorSetSexpFunc set_sexp;
  EDataBookCursorStepFunc step;
  EDataBookCursorSetAlphabetIndexFunc set_alphabetic_index;
  EDataBookCursorGetPositionFunc get_position;
  EDataBookCursorCompareContactFunc compare_contact;
  EDataBookCursorLoadLocaleFunc load_locale;
  
}

Methods to implement on an EDataBookCursor concrete class.

Class members
set_sexp: EDataBookCursorSetSexpFunc

The EDataBookCursorSetSexpFunc delegate to set the search expression.

step: EDataBookCursorStepFunc

The EDataBookCursorStepFunc delegate to navigate the cursor.

set_alphabetic_index: EDataBookCursorSetAlphabetIndexFunc

The EDataBookCursorSetAlphabetIndexFunc delegate to set the alphabetic position.

get_position: EDataBookCursorGetPositionFunc

The EDataBookCursorGetPositionFunc delegate to calculate the current total and position values.

compare_contact: EDataBookCursorCompareContactFunc

The EDataBookCursorCompareContactFunc delegate to compare an EContact with the cursor position.

load_locale: EDataBookCursorLoadLocaleFunc

The EDataBookCursorLoadLocaleFunc delegate used to reload the locale setting.

Virtual methods

EDataBook.DataBookCursorClass.compare_contact

The EDataBookCursorCompareContactFunc delegate to compare an EContact with the cursor position.

EDataBook.DataBookCursorClass.get_position

The EDataBookCursorGetPositionFunc delegate to calculate the current total and position values.

EDataBook.DataBookCursorClass.load_locale

The EDataBookCursorLoadLocaleFunc delegate used to reload the locale setting.

EDataBook.DataBookCursorClass.set_alphabetic_index

The EDataBookCursorSetAlphabetIndexFunc delegate to set the alphabetic position.

EDataBook.DataBookCursorClass.set_sexp

The EDataBookCursorSetSexpFunc delegate to set the search expression.

EDataBook.DataBookCursorClass.step

Steps cursor through its sorted query by a maximum of count contacts starting from origin.

since: 3.12