BookClientCursor

---

Object Hierarchy:

Description:

Content:

Properties:

• public string[] alphabet { owned get; }
  The currently <link linkend="cursor-alphabet">active alphabet </link>.
• public BookClient client { owned get; construct; }
  The BookClient which this cursor was created for
• public DBusConnection connection { construct; }
  The DBusConnection to the addressbook server.
• public MainContext context { construct; }
  The MainContext in which the BookClient created this cursor.
• public string object_path { construct; }
  The D-Bus object path to find the server side cursor object.
• public int position { get; }
  The current cursor position in the cursor's result list.
• public string[] sort_fields { construct; }
  The ContactField names to sort this cursor with
• public int total { get; }
  The total number of contacts which satisfy the cursor's query.

Creation methods:

• protected BookClientCursor ()

Methods:

• public unowned string[] get_alphabet (out int n_labels, out int underflow, out int inflow, out int overflow)
  Fetches the array of displayable labels for the <link linkend="cursor-alphabet">active alphabet</link>.
• public int get_contact_alphabetic_index (Contact contact)
  Checks which alphabetic index contact would be sorted into according to this.
• public int get_position ()
  Fetches the number of contacts leading up to the current cursor position, inclusive of the current cursor position.
• public int get_total ()
  Fetches the total number of contacts in the addressbook which match this's query
• public BookClient ref_client ()
  Returns the client associated with this.
• public async bool set_alphabetic_index (int index, Cancellable? cancellable) throws Error
  Sets the current cursor position to point to an <link linkend="cursor-alphabet">Alphabetic Index</link>.
• public bool set_alphabetic_index_sync (int index, Cancellable? cancellable = null) throws Error
  Sets the cursor to point to an <link linkend="cursor-alphabet"> Alphabetic Index</link>.
• public async bool set_sexp (string sexp, Cancellable? cancellable) throws Error
  Sets the <link linkend="cursor-search">Search Expression< /link> for the cursor.
• public bool set_sexp_sync (string sexp, Cancellable? cancellable = null) throws Error
  Sets the <link linkend="cursor-search">Search Expression< /link> for the cursor.
• public async int step (BookCursorStepFlags flags, BookCursorOrigin origin, int count, Cancellable? cancellable, out SList<Contact> out_contacts) throws Error
  <link linkend="cursor-iteration">Steps the cursor through the results</link> by a maximum of count and fetch the results traversed.
• public int step_sync (BookCursorStepFlags flags, BookCursorOrigin origin, int count, out SList<Contact> out_contacts, Cancellable? cancellable = null) throws Error
  <link linkend="cursor-iteration">Steps the cursor through the results</link> by a maximum of count and fetch the results traversed.

Signals:

• public virtual signal void refresh ()
  Indicates that the addressbook has been modified and that any content currently being displayed from the current cursor position should be reloaded.

Inherited Members: