Class

EBookBookClientCursor

since: 3.12

Description [src]

class EBook.BookClientCursor : GObject.Object
  implements Gio.Initable {
  /* No available fields */
}

Contains only private data.

Available since: 3.12

Hierarchy

hierarchy this EBookClientCursor implements_0 GInitable this--implements_0 ancestor_0 GObject ancestor_0--this

Ancestors

Implements

Instance methods

e_book_client_cursor_get_alphabet

Fetches the array of displayable labels for the active alphabet.

since: 3.12

e_book_client_cursor_get_contact_alphabetic_index

Checks which alphabetic index contact would be sorted into according to cursor.

since: 3.12

e_book_client_cursor_get_position

Fetches the number of contacts leading up to the current cursor position, inclusive of the current cursor position.

since: 3.12

e_book_client_cursor_get_total

Fetches the total number of contacts in the addressbook which match cursors query.

since: 3.12

e_book_client_cursor_ref_client

Returns the EBookClientCursor:client associated with cursor.

since: 3.12

e_book_client_cursor_set_alphabetic_index

Sets the current cursor position to point to an Alphabetic Index.

since: 3.12

e_book_client_cursor_set_alphabetic_index_finish

Completes an asynchronous call initiated by e_book_client_cursor_set_alphabetic_index().

since: 3.12

e_book_client_cursor_set_alphabetic_index_sync

Sets the cursor to point to an Alphabetic Index.

since: 3.12

e_book_client_cursor_set_sexp

Sets the Search Expression for the cursor.

since: 3.12

e_book_client_cursor_set_sexp_finish

Completes an asynchronous call initiated by e_book_client_cursor_set_sexp(), reporting whether the new search expression was accepted.

since: 3.12

e_book_client_cursor_set_sexp_sync

Sets the Search Expression for the cursor.

since: 3.12

e_book_client_cursor_step

Steps the cursor through the results by a maximum of count and fetch the results traversed.

since: 3.12

e_book_client_cursor_step_finish

Completes an asynchronous call initiated by e_book_client_cursor_step(), fetching any contacts which might have been returned by the call.

since: 3.12

e_book_client_cursor_step_sync

Steps the cursor through the results by a maximum of count and fetch the results traversed.

since: 3.12

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GInitable (1)
g_initable_init

Initializes the object implementing the interface.

Properties

EBook.BookClientCursor:alphabet

The currently active alphabet.

since: 3.12

EBook.BookClientCursor:client

The EBookClient which this cursor was created for.

since: 3.12

EBook.BookClientCursor:connection

The GDBusConnection to the addressbook server.

since: 3.12

EBook.BookClientCursor:context

The GMainContext in which the EBookClient created this cursor.

since: 3.12

EBook.BookClientCursor:direct-cursor

The direct handle to the EDataBookCursor for direct read access mode.

since: 3.12

EBook.BookClientCursor:object-path

The D-Bus object path to find the server side cursor object.

since: 3.12

EBook.BookClientCursor:position

The current cursor position in the cursor’s result list.

since: 3.12

EBook.BookClientCursor:sort-fields

The EContactField names to sort this cursor with.

since: 3.12

EBook.BookClientCursor:total

The total number of contacts which satisfy the cursor’s query.

since: 3.12

Signals

EBook.BookClientCursor::refresh

Indicates that the addressbook has been modified and that any content currently being displayed from the current cursor position should be reloaded.

since: 3.12

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 EBookBookClientCursorClass {
  void (* refresh) (
    EBookClientCursor* cursor
  );
  
}

The cursor class structure.

Class members
refresh: void (* refresh) ( EBookClientCursor* cursor )

The class handler for the EBookClientCursor::refresh signal.

Virtual methods

EBook.BookClientCursorClass.refresh

The class handler for the EBookClientCursor::refresh signal.