git.maemo.org Git - modest/blob - src/widgets/modest-header-view.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_HEADER_VIEW_H__
  31 #define __MODEST_HEADER_VIEW_H__
  32
  33 #include <tny-folder.h>
  34 #include <tny-folder-change.h>
  35 #include <tny-gtk-account-list-model.h>
  36 #include <tny-msg.h>
  37 #include <tny-header.h>
  38 #include <tny-gtk-header-list-model.h>
  39
  40 G_BEGIN_DECLS
  41
  42 /* convenience macros */
  43 #define MODEST_TYPE_HEADER_VIEW             (modest_header_view_get_type())
  44 #define MODEST_HEADER_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderView))
  45 #define MODEST_HEADER_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  46 #define MODEST_IS_HEADER_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HEADER_VIEW))
  47 #define MODEST_IS_HEADER_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HEADER_VIEW))
  48 #define MODEST_HEADER_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  49
  50 typedef struct _ModestHeaderView      ModestHeaderView;
  51 typedef struct _ModestHeaderViewClass ModestHeaderViewClass;
  52
  53 struct _ModestHeaderView {
  54          GtkTreeView parent;
  55         /* insert public members, if any */
  56 };
  57
  58 #define MODEST_HEADER_VIEW_COLUMN    "header-view-column"
  59 #define MODEST_HEADER_VIEW_FLAG_SORT "header-view-flags-sort"
  60
  61 typedef enum _ModestHeaderViewColumn {
  62         MODEST_HEADER_VIEW_COLUMN_FROM                  = 0,
  63         MODEST_HEADER_VIEW_COLUMN_TO                    = 1,
  64         MODEST_HEADER_VIEW_COLUMN_SUBJECT               = 2,
  65         MODEST_HEADER_VIEW_COLUMN_SENT_DATE             = 3,
  66         MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE         = 4,
  67         MODEST_HEADER_VIEW_COLUMN_MSGTYPE               = 5,
  68         MODEST_HEADER_VIEW_COLUMN_ATTACH                = 6,
  69         MODEST_HEADER_VIEW_COLUMN_SIZE                  = 7,
  70         MODEST_HEADER_VIEW_COLUMN_STATUS                = 8,
  71
  72         /*
  73          * these two are for compact display on small devices,
  74          * with two line display with all relevant headers
  75          */
  76         MODEST_HEADER_VIEW_COLUMN_COMPACT_FLAG          = 9, /* priority and attachments */
  77         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN     = 10, /* incoming mail */
  78         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT    = 11,/* outgoing mail */
  79         MODEST_HEADER_VIEW_COLUMN_COMPACT_SENT_DATE     = 12,
  80         MODEST_HEADER_VIEW_COLUMN_COMPACT_RECEIVED_DATE = 13,
  81
  82         MODEST_HEADER_VIEW_COLUMN_NUM
  83
  84 } ModestHeaderViewColumn;
  85
  86 /*
  87  * this can be extended with more style thingies,
  88  * to make a small-device specific display
  89  */
  90 typedef enum _ModestHeaderViewStyle {
  91         MODEST_HEADER_VIEW_STYLE_DETAILS   = 0, /* many columns, single line, col headers visible */
  92         MODEST_HEADER_VIEW_STYLE_TWOLINES  = 1, /* two-line headers, col headers invisible */
  93
  94         MODEST_HEADER_VIEW_STYLE_NUM
  95 } ModestHeaderViewStyle;
  96
  97 typedef enum _ModestItemType {
  98         MODEST_ITEM_TYPE_MESSAGE,
  99         MODEST_ITEM_TYPE_FOLDER,
 100         MODEST_ITEM_TYPE_NUM
 101 } ModestItemType;
 102
 103
 104 struct _ModestHeaderViewClass {
 105         GtkTreeViewClass parent_class;
 106
 107         void (*header_selected) (ModestHeaderView* self,
 108                                  TnyHeader *header,
 109                                  gpointer user_data);
 110
 111         void (*item_not_found) (ModestHeaderView* self,
 112                                 ModestItemType type,
 113                                 gpointer user_data);
 114
 115         void (*header_activated) (ModestHeaderView* self,
 116                                   TnyHeader *header,
 117                                   gpointer user_data);
 118
 119         void (*msg_count_changed) (ModestHeaderView* self,
 120                                    TnyFolder *folder,
 121                                    TnyFolderChange *change,
 122                                    gpointer user_data);
 123 };
 124
 125 /**
 126  * modest_header_view_get_type:
 127  *
 128  * get the GType for ModestHeaderView
 129  *
 130  * Returns: the GType
 131  */
 132 GType        modest_header_view_get_type    (void) G_GNUC_CONST;
 133
 134
 135 /**
 136  * modest_header_view_new:
 137  * @folder: a TnyMsgFolder object
 138  * @style: a ModestHeaderViewColumn with the style of this listview
 139  *  (   MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
 140  *
 141  * create a new ModestHeaderView instance, based on a folder iface
 142  *
 143  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 144  */
 145 GtkWidget*   modest_header_view_new        (TnyFolder *folder,
 146                                             ModestHeaderViewStyle style);
 147
 148 /**
 149  * modest_header_view_set_folder:
 150  * @self: a ModestHeaderView instance
 151  * @folder: a TnyFolder object
 152  *
 153  * set the folder for this ModestHeaderView
 154  */
 155 void         modest_header_view_set_folder (ModestHeaderView *self,
 156                                             TnyFolder *folder);
 157
 158 /**
 159  * modest_header_view_get_folder:
 160  * @self: a ModestHeaderView instance
 161  *
 162  * get the folder in this ModestHeaderView
 163  *
 164  * Returns: the tny folder instance or NULL if there is none
 165  */
 166 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
 167
 168
 169 /**
 170  * modest_header_view_set_columns:
 171  * @self: a ModestHeaderView instance
 172  * @columns: a list of ModestHeaderViewColumn
 173  * @type: #TnyFolderType type
 174  *
 175  * set the columns for this ModestHeaderView.
 176  *
 177  * Returns: TRUE if it succeeded, FALSE otherwise
 178  */
 179 gboolean modest_header_view_set_columns (ModestHeaderView *self,
 180                                          const GList *columns,
 181                                          TnyFolderType type);
 182 /**
 183  * modest_header_view_get_columns:
 184  * @self: a ModestHeaderView instance
 185  *
 186  * get the GtkTreeColumns for this ModestHeaderView. Each one of the
 187  * tree columns will have property  than can be retrieved
 188  * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
 189  * and which contains the corresponding ModestHeaderViewColumn
 190  *
 191  * Returns: newly allocated list of #GtkTreeViewColumns objects, or NULL in case of no columns or error
 192  * You must free the list with g_list_free
 193  */
 194 GList*  modest_header_view_get_columns (ModestHeaderView *self);
 195
 196
 197 /**
 198  * modest_header_view_set_style:
 199  * @self: a ModestHeaderView instance
 200  * @style: the style for this tree view
 201  *
 202  * set the style for this ModestHeaderView
 203  *
 204  * Returns: TRUE if it succeeded, FALSE otherwise
 205  */
 206 gboolean   modest_header_view_set_style (ModestHeaderView *self,
 207                                          ModestHeaderViewStyle style);
 208
 209 /**
 210  * modest_header_view_set_folder:
 211  * @self: a ModestHeaderView instance
 212  *
 213  * get the style for this ModestHeaderView
 214  *
 215  * Returns: the current style
 216  */
 217 ModestHeaderViewStyle   modest_header_view_get_style (ModestHeaderView *self);
 218
 219 /**
 220  * modest_header_view_get_selected_headers:
 221  * @self: a ModestHeaderView instance
 222  *
 223  * get the list of the currently selected TnyHeader's. The list and
 224  * the headers should be freed by the caller
 225  *
 226  * Returns: the list with the currently selected headers
 227  */
 228 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
 229
 230
 231 /**
 232  * modest_header_view_is_empty:
 233  * @self: a valid ModestHeaderView instance
 234  *
 235  * see if this header view is empty; use this function instead of
 236  * using the GtkTreeView parent directly, as 'empty' in this case
 237  * may mean that there is one "This is empty"-message, and of course
 238  * GtkTreeView then thinks it is *not* empty
 239  *
 240  * Returns: TRUE if the header view is empty, FALSE otherwise
 241  */
 242 gboolean  modest_header_view_is_empty (ModestHeaderView *self);
 243
 244
 245
 246 /**
 247  * modest_header_view_select_next:
 248  * @self: a #ModestHeaderView
 249  *
 250  * Selects the header next to the current selected one
 251  **/
 252 void         modest_header_view_select_next          (ModestHeaderView *self);
 253
 254 /**
 255  * modest_header_view_select_prev:
 256  * @self: a #ModestHeaderView
 257  *
 258  * Selects the previous header of the current selected one
 259  **/
 260 void         modest_header_view_select_prev          (ModestHeaderView *self);
 261
 262
 263 /* PROTECTED method. It's useful when we want to force a given
 264    selection to reload a msg. For example if we have selected a header
 265    in offline mode, when Modest become online, we want to reload the
 266    message automatically without an user click over the header */
 267 void
 268 _modest_header_view_change_selection (GtkTreeSelection *selection,
 269                                       gpointer user_data);
 270
 271 /**
 272  * modest_header_view_get_sort_column_id:
 273  * @self: a #ModestHeaderView
 274  * @type: #TnyFolderType type
 275  *
 276  * Gets the selected logical columnd id for sorting.
 277  **/
 278 gint
 279 modest_header_view_get_sort_column_id (ModestHeaderView *self, TnyFolderType type);
 280
 281 /**
 282  * modest_header_view_get_sort_type:
 283  * @self: a #ModestHeaderView
 284  * @type: #TnyFolderType type
 285  *
 286  * Gets the selected sort type.
 287  **/
 288 GtkSortType
 289 modest_header_view_get_sort_type (ModestHeaderView *self, TnyFolderType type);
 290
 291 /**
 292  * modest_header_view_set_sort_params:
 293  * @self: a #ModestHeaderView
 294  * @sort_colid: logical column id to sort
 295  * @sort_type: #GtkSortType sort type
 296  * @type: #TnyFolderType type
 297  *
 298  * Sets the logical columnd id and sort type for sorting operations.
 299  **/
 300 void
 301 modest_header_view_set_sort_params (ModestHeaderView *self, guint sort_colid, GtkSortType sort_type, TnyFolderType type);
 302
 303 /**
 304  * modest_header_view_set_sort_params:
 305  * @self: a #ModestHeaderView
 306  * @sort_colid: logical column id to sort
 307  * @sort_type: #GtkSortType sort type
 308  *
 309  * Sorts headers treeview by logical column id, @sort_colid, using a
 310  * @sort_type sorting method. In addition, new headder settings will be
 311  * stored in @self object.
 312  **/
 313 void
 314 modest_header_view_sort_by_column_id (ModestHeaderView *self,
 315                                       guint sort_colid,
 316                                       GtkSortType sort_type);
 317
 318
 319 G_END_DECLS
 320
 321
 322
 323 #endif /* __MODEST_HEADER_VIEW_H__ */
 324