TnyGtkHeaderListModel

TnyGtkHeaderListModel — A tree model for header instances

Synopsis




#define             TNY_TYPE_GTK_HEADER_LIST_MODEL_COLUMN
                    TnyGtkHeaderListModel;
GType               tny_gtk_header_list_model_column_get_type
                                                        (void);
GtkTreeModel*       tny_gtk_header_list_model_new       (void);
void                tny_gtk_header_list_model_set_folder
                                                        (TnyGtkHeaderListModel *self,
                                                         TnyFolder *folder,
                                                         gboolean refresh,
                                                         TnyGetHeadersCallback callback,
                                                         TnyStatusCallback status_callback,
                                                         gpointer user_data);
gint                tny_gtk_header_list_model_received_date_sort_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *a,
                                                         GtkTreeIter *b,
                                                         gpointer user_data);
gint                tny_gtk_header_list_model_sent_date_sort_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *a,
                                                         GtkTreeIter *b,
                                                         gpointer user_data);

Object Hierarchy


  GObject
   +----TnyGtkHeaderListModel

Implemented Interfaces

TnyGtkHeaderListModel implements GtkTreeModel and TnyList.

Description

It implements both GtkTreeModel and TnyList

It's very important to unreference the instance you will get when doing something like this:

TnyHeader *header;
gtk_tree_model_get (model, &iter, 
  TNY_HEADER_LIST_MODEL_INSTANCE_COLUMN, 
  &header, -1);
/* use header */
g_object_unref (G_OBJECT(header));

The column is indeed a G_TYPE_OBJECT column and getting it from the GtkTreeModel will indeed add a reference.

Details

TNY_TYPE_GTK_HEADER_LIST_MODEL_COLUMN

#define TNY_TYPE_GTK_HEADER_LIST_MODEL_COLUMN (tny_gtk_header_list_model_column_get_type())


TnyGtkHeaderListModel

typedef struct _TnyGtkHeaderListModel TnyGtkHeaderListModel;


tny_gtk_header_list_model_column_get_type ()

GType               tny_gtk_header_list_model_column_get_type
                                                        (void);

GType system helper function

Returns : a GType

tny_gtk_header_list_model_new ()

GtkTreeModel*       tny_gtk_header_list_model_new       (void);

Create a new GtkTreeModel for TnyHeader instances

Returns : (caller-owns): a new GtkTreeModel for TnyHeader instances

Since 1.0 audience: application-developer


tny_gtk_header_list_model_set_folder ()

void                tny_gtk_header_list_model_set_folder
                                                        (TnyGtkHeaderListModel *self,
                                                         TnyFolder *folder,
                                                         gboolean refresh,
                                                         TnyGetHeadersCallback callback,
                                                         TnyStatusCallback status_callback,
                                                         gpointer user_data);

Set the folder of self where TnyHeader instances are located

self : a TnyGtkHeaderListModel
folder : a TnyFolder
refresh : refresh first
callback : (null-ok): a TnyGetHeadersCallback or NULL
status_callback : (null-ok): a TnyStatusCallback or NULL
user_data : (null-ok): user data for the callbacks

Since 1.0 audience: application-developer


tny_gtk_header_list_model_received_date_sort_func ()

gint                tny_gtk_header_list_model_received_date_sort_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *a,
                                                         GtkTreeIter *b,
                                                         gpointer user_data);

A GtkTreeIterCompareFunc that sorts using the received date

model : a GtkTreeModel the comparison is within
a : a GtkTreeIter in model
b : another GtkTreeIter in model
user_data : (null-ok): user data passed
Returns : a negative integer, zero, or a positive integer

Since 1.0 audience: application-developer, tinymail-developer


tny_gtk_header_list_model_sent_date_sort_func ()

gint                tny_gtk_header_list_model_sent_date_sort_func
                                                        (GtkTreeModel *model,
                                                         GtkTreeIter *a,
                                                         GtkTreeIter *b,
                                                         gpointer user_data);

A GtkTreeIterCompareFunc that sorts using the sent date

model : the GtkTreeModel the comparison is within
a : a GtkTreeIter in model
b : another GtkTreeIter in model
user_data : (null-ok): user data passed
Returns : a negative integer, zero, or a positive integer

Since 1.0 audience: application-developer, tinymail-developer

See Also

TnyList, GtkTreeModel, TnyHeader, TnyGtkHeaderListModelColumn