Prev Up Home Osso Addressbook Reference Manual Next

OssoABookContactView

OssoABookContactView — View of contacts.

Synopsis




            OssoABookContactView;
GtkWidget*  osso_abook_contact_view_new     (OssoABookContactModel *model,
                                             OssoABookFilterModel *filter_model);
GtkWidget*  osso_abook_contact_view_new_basic
                                            (OssoABookContactModel *model);
GList*      osso_abook_contact_view_get_selection
                                            (OssoABookContactView *view);
EContact*   osso_abook_contact_view_get_focus
                                            (OssoABookContactView *view);
void        osso_abook_contact_view_enable_drag_source
                                            (OssoABookContactView *view);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkScrolledWindow
                                 +----OssoABookTreeView
                                       +----OssoABookContactView
                                             +----OssoABookContactSelector

Implemented Interfaces

OssoABookContactView implements AtkImplementorIface.

Signal Prototypes


"contact-activated"
            void        user_function      (OssoABookContactView *ossoabookcontactview,
                                            EContact *arg1,
                                            gpointer user_data);
"selection-changed"
            void        user_function      (OssoABookContactView *ossoabookcontactview,
                                            guint arg1,
                                            gpointer user_data);

Description

OssoABookContactView is a widget that displays the contents of an OssoABookContactModel as a list

Details

OssoABookContactView

typedef struct _OssoABookContactView OssoABookContactView;

There are no public fields in OssoABookContactView.

osso_abook_contact_view_new ()

GtkWidget*  osso_abook_contact_view_new     (OssoABookContactModel *model,
                                             OssoABookFilterModel *filter_model);

Creates a new OssoABookContactView object exposing the contents of model, as filtered by filter_model (if non-NULL).

model : An OssoABookContactModel whose contents are to be exposed
filter_model : An OssoABookFilterModel filtering model, or NULL
Returns : A new OssoABookContactView object.

osso_abook_contact_view_new_basic ()

GtkWidget*  osso_abook_contact_view_new_basic
                                            (OssoABookContactModel *model);

Creates a new OssoABookContactView object exposing the contents of model, as filtered through OssoABookAllGroup: all non-blocked contacts.

model : An OssoABookContactModel whose contents are to be exposed
Returns : A new OssoABookContactView object.

osso_abook_contact_view_get_selection ()

GList*      osso_abook_contact_view_get_selection
                                            (OssoABookContactView *view);

Retreives the set of selected rows as a GList of EContact objects. The returned GList should be freed manually, but don't g_object_unref() the elements.

view : An OssoABookContactView
Returns : A newly allocated GList of EContact objects.

osso_abook_contact_view_get_focus ()

EContact*   osso_abook_contact_view_get_focus
                                            (OssoABookContactView *view);

Retreives the EContact whose row is focused, if any.

view : An OssoABookContactView
Returns : The EContact whose row is focused, or NULL. The contact is owned by libosso-abook and should not be g_object_unref()'ed.

osso_abook_contact_view_enable_drag_source ()

void        osso_abook_contact_view_enable_drag_source
                                            (OssoABookContactView *view);

Turns view into a drag source for EContact UID drags.

view : An OssoABookGroupView

Signals

The "contact-activated" signal

void        user_function                  (OssoABookContactView *ossoabookcontactview,
                                            EContact *arg1,
                                            gpointer user_data);

The contact-activated signal is emitted when a contact's row has been activated.

ossoabookcontactview : the object which received the signal.
arg1 : the EContact whose row was activated.
user_data : user data set when the signal handler was connected.

The "selection-changed" signal

void        user_function                  (OssoABookContactView *ossoabookcontactview,
                                            guint arg1,
                                            gpointer user_data);

The selection-changed signal is emitted when the set of selected rows has changed.

ossoabookcontactview : the object which received the signal.
arg1 : the number of selected rows.
user_data : user data set when the signal handler was connected.

See Also

OssoABookContactModel, OssoABookContactSelector

<< OssoABookContactModel OssoABookContactSelector >>