EBookView

typedef struct _EBookView EBookView;

All the fields of this structure are private to the object's implementation and should never be accessed directly.

e_book_view_new ()

EBookView*          e_book_view_new                     (EBook *book,
                                                         EBookQuery *query,
                                                         DBusGProxy *view_proxy);

Creates a new EBookView based on EBook and listening to view_proxy. This is a private function, applications should call e_book_get_book_view or e_book_async_get_book_view.

e_book_view_start ()

void                e_book_view_start                   (EBookView *book_view);

Tells book_view to start processing events.

e_book_view_stop ()

void                e_book_view_stop                    (EBookView *book_view);

Tells book_view to stop processing events.

e_book_view_get_book ()

struct _EBook*      e_book_view_get_book                (EBookView *book_view);

Retrieves book_view's parent EBook. This is owned by the EBookView, so use g_object_ref() and g_object_unref() as necessary.

e_book_view_get_parse_vcards ()

gboolean            e_book_view_get_parse_vcards        (EBookView *book_view);

Describes whether book_view parses contact vCards into EContact objects. See e_book_view_set_parse_vcards().

e_book_view_set_parse_vcards ()

void                e_book_view_set_parse_vcards        (EBookView *book_view,
                                                         gboolean parse_vcards);

Tells the book_view how to send vCards in its signals. When parse_vcards is FALSE the unparsed vCards are emitted as NULL terminated array of strings. The receiver is responsible for parsing them. When passing TRUE a GList of EContact instances is emitted. This is the default behavior.

e_book_view_get_query ()

struct EBookQuery*  e_book_view_get_query               (EBookView *book_view);

Retrieves book_view's EBookQuery. This is owned by the EBookView, so use g_object_ref() and g_object_unref() as necessary.

e_book_view_is_freezable ()

gboolean            e_book_view_is_freezable            (EBookView *book_view);

Describes whether book_view is freezable. See e_book_view_set_freezable().

e_book_view_set_freezable ()

void                e_book_view_set_freezable           (EBookView *book_view,
                                                         gboolean freezable);

If freezable is TRUE and the back-end supports being frozen, this will prevent book_view's subsequent EBookView::contacts-added signals from being emitted. Once e_book_view_thaw() is called on book_view, these signals will be emitted at once.

Note that book_view will continue "freezing" until e_book_view_set_freezable() is called with freezable set to FALSE, even if you call e_book_view_thaw() on it.

e_book_view_set_sort_order ()

void                e_book_view_set_sort_order          (EBookView *book_view,
                                                         const gchar *query_term);

Sets the retrieval ordering of the book view to be based on the provided query_term.

e_book_view_thaw ()

void                e_book_view_thaw                    (EBookView *book_view);

Enables notifications from book_view and emits all the signals that were halted while book_view was frozen. See e_book_view_set_freezable().

The "contacts-added" signal

void                user_function                      (EBookView *view,
                                                        gpointer   vcards,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when contacts are added to the addressbook. When a large number of contacts are changed at once, the change notifications may be split up into smaller batches. When the final batch notification is sent, "sequence-complete" will be emitted.

The "contacts-changed" signal

void                user_function                      (EBookView *view,
                                                        gpointer   vcards,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when contacts in the addressbook are modified. A batch of contacts may be split into several emissions. When a large number of contacts are changed at once, the change notifications may be split up into smaller batches. When the final batch notification is sent, "sequence-complete" will be emitted.

The "contacts-removed" signal

void                user_function                      (EBookView *view,
                                                        gpointer   ids,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when contacts are removed from the addressbook. When a large number of contacts are changed at once, the change notifications may be split up into smaller batches. When the final batch notification is sent, "sequence-complete" will be emitted.

The "sequence-complete" signal

void                user_function                      (EBookView *view,
                                                        gint       status,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when the view has finished transmitting contacts for "contacts-added", "contacts-changed", or "contacts-removed" sequences.

The "status-message" signal

void                user_function                      (EBookView *view,
                                                        gchar     *message,
                                                        gpointer   user_data)      : Run Last

This signal is emitted when the back-end sends a status message (such as "Loading...").

It is not generally useful, and can safely be ignored.