Class
EBookBookClientView
since: 3.2
Description [src]
class EBook.BookClientView : GObject.Object
implements Gio.Initable {
/* No available fields */
}
Contains only private data the should be read and manipulated using the functions below.
Available since: 3.2
Instance methods
e_book_client_view_dup_contacts
Asynchronously reads range_length contacts from index range_start.
When there are asked more than e_book_client_view_get_n_total()
contacts only those up to the total number of contacts are read.
Asking for out of range contacts results in an error.
since: 3.50
e_book_client_view_dup_contacts_finish
Finishes previous call of e_book_client_view_dup_contacts(); see it for further information.
since: 3.50
e_book_client_view_dup_indices
Returns a list of EBookIndices holding indices of the contacts
in the view. These are received from the first sort field set by
e_book_client_view_set_sort_fields_sync(). The last item of the returned
array is the one with chr member being NULL.
since: 3.50
e_book_client_view_get_client
Returns the EBookClientView:client associated with client_view.
deprecated: 3.10
e_book_client_view_get_connection
Returns the GDBusConnection used to create the D-Bus proxy.
since: 3.8
e_book_client_view_get_id
Returns an identifier of the self. It does not change
for the whole life time of the self.
since: 3.50
e_book_client_view_get_object_path
Returns the object path used to create the D-Bus proxy.
since: 3.8
e_book_client_view_ref_client
Returns the EBookClientView:client associated with client_view.
since: 3.10
e_book_client_view_set_fields_of_interest
Client can instruct server to which fields it is interested in only, thus
the server can return less data over the wire. The server can still return
complete objects, this is just a hint to it that the listed fields will
be used only. The UID field is returned always. Initial views has no fields
of interest and using NULL for fields_of_interest will unset any previous changes.
e_book_client_view_set_sort_fields_sync
Sets fields to sort the view by. The default is to sort by the file-as
field in ascending order. Not every field can be used for sorting,
usually available fields are E_CONTACT_FILE_AS,
E_CONTACT_GIVEN_NAME and E_CONTACT_FAMILY_NAME.
since: 3.50
Methods inherited from GInitable (1)
g_initable_init
Initializes the object implementing the interface.
Properties
EBook.BookClientView:direct-backend
The EBookBackend to fetch contact data from, if direct read access is enabled.
EBook.BookClientView:indices
A list of EBookIndices holding indices of the contacts in the view.
These are received from the first sort field set by
e_book_client_view_set_sort_fields_sync(). The last item of the returned
array is the one with chr member being NULL.
since: 3.50
Signals
EBook.BookClientView::content-changed
The signal is emitted whenever content of any contact in the client_view changes,
or a contact is added or removed. It may or may not change EBookClientView:n-total
property too.
since: 3.50
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 EBookBookClientViewClass {
void (* objects_added) (
EBookClientView* client_view,
const GSList* objects
);
void (* objects_modified) (
EBookClientView* client_view,
const GSList* objects
);
void (* objects_removed) (
EBookClientView* client_view,
const GSList* uids
);
void (* progress) (
EBookClientView* client_view,
guint percent,
const gchar* message
);
void (* complete) (
EBookClientView* client_view,
const GError* error
);
}
Class structure for the EBookClient class.
Class members
objects_added: void (* objects_added) ( EBookClientView* client_view, const GSList* objects )Signal emitted when contacts are added in the view.
objects_modified: void (* objects_modified) ( EBookClientView* client_view, const GSList* objects )Signal emitted when contacts in the view are modified.
objects_removed: void (* objects_removed) ( EBookClientView* client_view, const GSList* uids )Signal emitted when contacts are removed from the view.
progress: void (* progress) ( EBookClientView* client_view, guint percent, const gchar* message )Signal emitted intermittently while loading a view after calling e_book_client_view_start().
complete: void (* complete) ( EBookClientView* client_view, const GError* error )Notification that loading a view has completed, after calling e_book_client_view_start().
Virtual methods
EBook.BookClientViewClass.complete
Notification that loading a view has completed, after calling e_book_client_view_start().
EBook.BookClientViewClass.progress
Signal emitted intermittently while loading a view after calling e_book_client_view_start().