OssoABookTreeView

OssoABookTreeView — Base class for displaying contacts in a list.

Synopsis




            OssoABookTreeView;
GtkTreeModel* osso_abook_tree_view_get_model
                                            (OssoABookTreeView *view);
OssoABookTreeModel* osso_abook_tree_view_get_base_model
                                            (OssoABookTreeView *view);
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);


Object Hierarchy


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

Implemented Interfaces

OssoABookTreeView implements AtkImplementorIface.

Properties


  "base-model"           OssoABookTreeModel    : Read / Write / Construct Only
  "filter-model"         OssoABookFilterModel  : Read / Write / Construct Only
  "model"                GtkTreeModel          : Read / Write / Construct Only
  "show-contact-name"    gboolean              : Write / Construct Only
  "show-loading-banner"  gboolean              : Read / Write / Construct Only
  "tree-view"            GtkTreeView           : Read

Description

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

Details

OssoABookTreeView

typedef struct _OssoABookTreeView OssoABookTreeView;

There are no public fields in OssoABookTreeView.


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 OssoABookTreeModel subclass or an OssoABookFilterModel.

view : An OssoABookTreeView
Returns : The top contained GtkTreeModel.

osso_abook_tree_view_get_base_model ()

OssoABookTreeModel* osso_abook_tree_view_get_base_model
                                            (OssoABookTreeView *view);

Retreives the contained OssoABookTreeModel.

view : An OssoABookTreeView
Returns : The contained OssoABookTreeModel.

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

Properties

The "base-model" property

  "base-model"           OssoABookTreeModel    : Read / Write / Construct Only

The contained OssoABookTreeModel.


The "filter-model" property

  "filter-model"         OssoABookFilterModel  : Read / Write / Construct Only

The contained OssoABookFilterModel, if any.


The "model" property

  "model"                GtkTreeModel          : Read / Write / Construct Only

The top contained GtkTreeModel.


The "show-contact-name" property

  "show-contact-name"    gboolean              : Write / Construct Only

TRUE if contact names should be shown.

Default value: TRUE


The "show-loading-banner" property

  "show-loading-banner"  gboolean              : Read / Write / Construct Only

TRUE if a banner should be shown while loading.

Default value: TRUE


The "tree-view" property

  "tree-view"            GtkTreeView           : Read

The contained GtkTreeView widget.

See Also

OssoABookTreeModel, OssoABookFilterModel, OssoABookContactView, OssoABookAccountView