OssoABookTreeModel

OssoABookTreeModel — A base class for representing contacts as a list

Synopsis




            OssoABookTreeModel;
guint       osso_abook_tree_model_get_contact_column
                                            (OssoABookTreeModel *model);
guint       osso_abook_tree_model_get_presence_column
                                            (OssoABookTreeModel *model);
void        osso_abook_tree_model_set_book_view
                                            (OssoABookTreeModel *model,
                                             EBookView *book_view);
EBookView*  osso_abook_tree_model_get_book_view
                                            (OssoABookTreeModel *model);
gboolean    osso_abook_tree_model_is_done_loading
                                            (OssoABookTreeModel *model);
void        osso_abook_tree_model_contact_changed
                                            (OssoABookTreeModel *model,
                                             EContact *contact);
void        osso_abook_tree_model_presence_changed
                                            (OssoABookTreeModel *model,
                                             OssoABookPresence *presence);
void        osso_abook_tree_model_set_done_loading
                                            (OssoABookTreeModel *model,
                                             gboolean done);


Object Hierarchy


  GObject
   +----GtkListStore
         +----OssoABookTreeModel
               +----OssoABookAccountModel
               +----OssoABookContactModel

Implemented Interfaces

OssoABookTreeModel implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest and GtkTreeSortable.

Properties


  "book-view"            EBookView             : Read / Write
  "contact-column"       guint                 : Read / Write / Construct Only
  "presence-column"      guint                 : Read / Write / Construct Only

Signal Prototypes


"done-loading"
            void        user_function      (OssoABookTreeModel *model,
                                            gpointer user_data);

Description

OssoABookTreeModel is a base class from which all other models derive.

Details

OssoABookTreeModel

typedef struct _OssoABookTreeModel OssoABookTreeModel;

There are no public fields in OssoABookTreeModel.


osso_abook_tree_model_get_contact_column ()

guint       osso_abook_tree_model_get_contact_column
                                            (OssoABookTreeModel *model);

Retreives the column containing the EContact objects.

model : An OssoABookTreeModel
Returns : The number of the column containing the EContact objects.

osso_abook_tree_model_get_presence_column ()

guint       osso_abook_tree_model_get_presence_column
                                            (OssoABookTreeModel *model);

Retreives the column containing the OssoABookPresence objects.

model : An OssoABookTreeModel
Returns : The number of the column containing the OssoABookPresence objects.

osso_abook_tree_model_set_book_view ()

void        osso_abook_tree_model_set_book_view
                                            (OssoABookTreeModel *model,
                                             EBookView *book_view);

Sets the EBookView whose contents are to be exposed.

model : An OssoABookTreeModel
book_view : The EBookView whose contents are to be exposed

osso_abook_tree_model_get_book_view ()

EBookView*  osso_abook_tree_model_get_book_view
                                            (OssoABookTreeModel *model);

Retrieves the EBookView whose contents are to be exposed.

model : An OssoABookTreeModel
Returns : The EBookView whose contents are to be exposed.

osso_abook_tree_model_is_done_loading ()

gboolean    osso_abook_tree_model_is_done_loading
                                            (OssoABookTreeModel *model);

Returns TRUE if model has seen the "sequence-completed" signal emitted by the contained EBookView.

model : An OssoABookTreeModel
Returns : TRUE if model has seen the "sequence-completed" signal, FALSE otherwise.

osso_abook_tree_model_contact_changed ()

void        osso_abook_tree_model_contact_changed
                                            (OssoABookTreeModel *model,
                                             EContact *contact);

Emits the "row-changed" signal for the row(s) associated with contact.

model : An OssoABookTreeModel
contact : An EContact

osso_abook_tree_model_presence_changed ()

void        osso_abook_tree_model_presence_changed
                                            (OssoABookTreeModel *model,
                                             OssoABookPresence *presence);

Emits the "row-changed" signal for the row(s) associated with presence.

model : An OssoABookTreeModel
presence : An OssoABookPresence

osso_abook_tree_model_set_done_loading ()

void        osso_abook_tree_model_set_done_loading
                                            (OssoABookTreeModel *model,
                                             gboolean done);

Manually set the done-loading flag to done. This is a internal function that should not be used by application code.

model : An OssoABookTreeModel
done : a gboolean

Properties

The "book-view" property

  "book-view"            EBookView             : Read / Write

The EBookView whose contents are exposed.


The "contact-column" property

  "contact-column"       guint                 : Read / Write / Construct Only

The column containing EContact objects.

Default value: 0


The "presence-column" property

  "presence-column"      guint                 : Read / Write / Construct Only

The column containing OssoABookPresence objects.

Default value: 0

Signals

The "done-loading" signal

void        user_function                  (OssoABookTreeModel *model,
                                            gpointer user_data);

Signal emitted whenever the model has finished loading.

model : The OssoABookTreeModel that emitted the signal.
user_data : user data set when the signal handler was connected.

See Also

OssoABookContactModel, OssoABookAccountModel, OssoABookTreeView