DataBookCursor

---

Object Hierarchy:

Description:

Content:

Properties:

• public BookBackend backend { get; construct; }
  The backend which created this cursor
• public int position { get; }
  The current position of this cursor
• public int total { get; }
  The total results for this cursor

Creation methods:

• protected DataBookCursor ()

Methods:

• public virtual int compare_contact (Contact contact, out bool matches_sexp)
  The DataBookCursorCompareContactFunc delegate to compare an Contact with the cursor position
• public void contact_added (Contact contact)
  Should be called by addressbook backends whenever a contact is added.
• public void contact_removed (Contact contact)
  Should be called by addressbook backends whenever a contact is removed.
• public unowned BookBackend get_backend ()
  Gets the backend which created and owns this.
• public int get_position ()
  Fetch the current position of this in its result list.
• public int get_total ()
  Fetch the total number of contacts which match this's query expression.
• public virtual bool impl_get_position (out int total, out int position, Cancellable? cancellable = null) throws Error
• public virtual bool impl_load_locale (out string locale) throws Error
• public virtual bool impl_set_alphabetic_index (int index, string locale) throws Error
• public virtual bool impl_set_sexp (string? sexp) throws Error
• public bool load_locale (out string locale, Cancellable? cancellable = null) throws Error
  Load the current locale setting from the cursor's underlying database.
• public bool recalculate (Cancellable? cancellable = null) throws Error
  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.
• public bool register_gdbus_object (DBusConnection connection, string object_path) throws Error
  Places this on the connection at object_path
• public bool set_alphabetic_index (int index, string locale, Cancellable? cancellable = null) throws Error
  Sets the this position to an < link linkend="cursor-alphabet">Alphabetic Index</link> into the alphabet active in the locale of the addressbook.
• public bool set_sexp (string? sexp, Cancellable? cancellable = null) throws Error
  Sets the search expression for the cursor
• public virtual int step (string? revision_guard, BookCursorStepFlags flags, BookCursorOrigin origin, int count, out SList<string>? results, Cancellable? cancellable = null) throws Error
  Steps this through its sorted query by a maximum of count contacts starting from origin.

Inherited Members: