EBookView 3 LIBEBOOK Library
EBookView Represents a search against an EBook.

## Synopsis

                EBookView;
    EBookView*  e_book_view_new                 (GNOME_Evolution_Addressbook_BookView corba_book_view,
                                                 EBookViewListener *listener);
    void        e_book_view_set_book            (EBookView *book_view,
                                                 struct _EBook *book);
    void        e_book_view_start               (EBookView *book_view);
    void        e_book_view_stop                (EBookView *book_view);

## Object Hierarchy

      GObject
       +----EBookView

## Signals

    "contacts-added"
                void        user_function      (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last
    "contacts-changed"
                void        user_function      (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last
    "contacts-removed"
                void        user_function      (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last
    "sequence-complete"
                void        user_function      (EBookView *ebookview,
                                                gint       arg1,
                                                gpointer   user_data)      : Run last
    "status-message"
                void        user_function      (EBookView *ebookview,
                                                gchar     *arg1,
                                                gpointer   user_data)      : Run last

## Description

Event notifications and callbacks from EBookView go to the EBookViewListener. Contrast EBookView with EBook, which represents the addressbook itself.

## Details

### EBookView

    typedef struct _EBookView EBookView;

EBookView has no publicly available members.

EBookView

### e_book_view_new ()

    EBookView*  e_book_view_new                 (GNOME_Evolution_Addressbook_BookView corba_book_view,
                                                 EBookViewListener *listener);

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

corba_book_view :

  a CORBA BookView object

listener :

  an EBookViewListener

Returns :

  A new EBookView.

e_book_view_new

### e_book_view_set_book ()

    void        e_book_view_set_book            (EBookView *book_view,
                                                 struct _EBook *book);

Makes book_view listen to changes in book. This function apparently has no effect for the time being.

book_view :

  an EBookView

book :

  an EBook

e_book_view_set_book

### e_book_view_start ()

    void        e_book_view_start               (EBookView *book_view);

Tells book_view to start processing events.

book_view :

  an EBookView

e_book_view_start

### e_book_view_stop ()

    void        e_book_view_stop                (EBookView *book_view);

Tells book_view to stop processing events.

book_view :

  an EBookView

e_book_view_stop

## Signal Details

### The "contacts-added" signal

    void        user_function                  (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last

Fired when more contacts are found. Each contact in the list will be unref'd when done, and the list freed, so simply reference any contacts you want to keep.

ebookview :

  the object which received the signal.

arg1 :

  a GList of EContact objects that were added to the view

user_data :

  user data set when the signal handler was connected.

EBookView::contacts-added

### The "contacts-changed" signal

    void        user_function                  (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last

Fired when contacts are changed. Each contact in the list will be unref'd when done, and the list freed, so simply reference any contacts you want to keep.

ebookview :

  the object which received the signal.

arg1 :

  a GList of EContact objects that were modified

user_data :

  user data set when the signal handler was connected.

EBookView::contacts-changed

### The "contacts-removed" signal

    void        user_function                  (EBookView *ebookview,
                                                gpointer   arg1,
                                                gpointer   user_data)      : Run last

Fired when contacts are removed from the view. The IDs and the list will be freed, so copy any IDs you want to keep.

ebookview :

  the object which received the signal.

arg1 :

  a GList of contact IDs (char*) that were removed from the view

user_data :

  user data set when the signal handler was connected.

EBookView::contacts-removed

### The "sequence-complete" signal

    void        user_function                  (EBookView *ebookview,
                                                gint       arg1,
                                                gpointer   user_data)      : Run last

Fired when there are currently no more contacts to send. This is fired once after the initial set of contacts-added signals, and after every future change.

ebookview :

  the object which received the signal.

arg1 :

  an EBookViewStatus

user_data :

  user data set when the signal handler was connected.

EBookView::sequence-complete

### The "status-message" signal

    void        user_function                  (EBookView *ebookview,
                                                gchar     *arg1,
                                                gpointer   user_data)      : Run last

Fired with a status message reporting the progress of the view.

ebookview :

  the object which received the signal.

arg1 :

  a const char* message

user_data :

  user data set when the signal handler was connected.

EBookView::status-message

## See Also

EBookViewListener, EBook.