OssoABookTreeView

OssoABookTreeView — Base class for displaying contacts or accounts in a list.

Synopsis

                    OssoABookTreeView;
GtkTreeModel*       osso_abook_tree_view_get_model      (OssoABookTreeView *view);
void                osso_abook_tree_view_set_base_model (OssoABookTreeView *view,
                                                         OssoABookListStore *model);
OssoABookListStore* osso_abook_tree_view_get_base_model (OssoABookTreeView *view);
void                osso_abook_tree_view_set_filter_model
                                                        (OssoABookTreeView *view,
                                                         OssoABookFilterModel *model);
OssoABookFilterModel* osso_abook_tree_view_get_filter_model
                                                        (OssoABookTreeView *view);
GtkTreeView*        osso_abook_tree_view_get_tree_view  (OssoABookTreeView *view);
void                osso_abook_tree_view_select_first   (OssoABookTreeView *view);
void                osso_abook_tree_view_enable_drag_source
                                                        (OssoABookTreeView *view,
                                                         GtkTargetEntry *targets,
                                                         int n_targets);
void                osso_abook_tree_view_set_avatar_view
                                                        (OssoABookTreeView *view,
                                                         gboolean enable);

Description

OssoABookTreeView is a base class from which all other classes that display contacts as a list are derived.

Details

OssoABookTreeView

typedef struct {
} OssoABookTreeView;

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


osso_abook_tree_view_get_model ()

GtkTreeModel*       osso_abook_tree_view_get_model      (OssoABookTreeView *view);

Retreives the top contained GtkTreeModel. This can be either an OssoABookListStore subclass or an OssoABookFilterModel.

view : An OssoABookTreeView
Returns : The top contained GtkTreeModel.

osso_abook_tree_view_set_base_model ()

void                osso_abook_tree_view_set_base_model (OssoABookTreeView *view,
                                                         OssoABookListStore *model);

Changes the contained OssoABookRowModel.

view : An OssoABookTreeView
model : The new OssoABookRowModel.

osso_abook_tree_view_get_base_model ()

OssoABookListStore* osso_abook_tree_view_get_base_model (OssoABookTreeView *view);

Retreives the contained OssoABookRowModel.

view : An OssoABookTreeView
Returns : The contained OssoABookRowModel.

osso_abook_tree_view_set_filter_model ()

void                osso_abook_tree_view_set_filter_model
                                                        (OssoABookTreeView *view,
                                                         OssoABookFilterModel *model);

Changes the contained OssoABookFilterModel.

view : An OssoABookTreeView
model : The new OssoABookFilterModel, or NULL.

osso_abook_tree_view_get_filter_model ()

OssoABookFilterModel* osso_abook_tree_view_get_filter_model
                                                        (OssoABookTreeView *view);

Retreives the contained OssoABookFilterModel, if any.

view : An OssoABookTreeView
Returns : The contained OssoABookFilterModel, or NULL.

osso_abook_tree_view_get_tree_view ()

GtkTreeView*        osso_abook_tree_view_get_tree_view  (OssoABookTreeView *view);

Retreives the contained GtkTreeView widget.

view : An OssoABookTreeView
Returns : The contained GtkTreeView widget.

osso_abook_tree_view_select_first ()

void                osso_abook_tree_view_select_first   (OssoABookTreeView *view);

Selects the first row in view when the contained EBookView is done loading. It will not select if the view is empty, or if the user scrolls or selects a row before the EBookView is done loading.

view : An OssoABookTreeView

osso_abook_tree_view_enable_drag_source ()

void                osso_abook_tree_view_enable_drag_source
                                                        (OssoABookTreeView *view,
                                                         GtkTargetEntry *targets,
                                                         int n_targets);

Turns view into a drag source. This function is meant for use in subclasses.

view : An OssoABookTreeView
targets : the table of targets that the drag will support
n_targets : the number of items in targets

osso_abook_tree_view_set_avatar_view ()

void                osso_abook_tree_view_set_avatar_view
                                                        (OssoABookTreeView *view,
                                                         gboolean enable);

Enables the avatar view on view. An avatar will be displayed for each contact listed in the OssoABookTreeView widget.

view : a OssoABookTreeView
enable : TRUE to enable the avatar view