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 #include "modest-mail-operation.h"
  40 #include "modest-header-view-observer.h"
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_HEADER_VIEW             (modest_header_view_get_type())
  46 #define MODEST_HEADER_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderView))
  47 #define MODEST_HEADER_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  48 #define MODEST_IS_HEADER_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HEADER_VIEW))
  49 #define MODEST_IS_HEADER_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HEADER_VIEW))
  50 #define MODEST_HEADER_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  51
  52 typedef struct _ModestHeaderView      ModestHeaderView;
  53 typedef struct _ModestHeaderViewClass ModestHeaderViewClass;
  54
  55 struct _ModestHeaderView {
  56          GtkTreeView parent;
  57         /* insert public members, if any */
  58 };
  59
  60 #define MODEST_HEADER_VIEW_COLUMN    "header-view-column"
  61 #define MODEST_HEADER_VIEW_FLAG_SORT "header-view-flags-sort"
  62
  63 typedef enum _ModestHeaderViewColumn {
  64         MODEST_HEADER_VIEW_COLUMN_FROM,
  65         MODEST_HEADER_VIEW_COLUMN_TO,
  66         MODEST_HEADER_VIEW_COLUMN_SUBJECT,
  67         MODEST_HEADER_VIEW_COLUMN_SENT_DATE,
  68         MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE,
  69         MODEST_HEADER_VIEW_COLUMN_ATTACH,
  70         MODEST_HEADER_VIEW_COLUMN_SIZE,
  71         MODEST_HEADER_VIEW_COLUMN_STATUS,
  72
  73         /*
  74          * these two are for compact display on small devices,
  75          * with two line display with all relevant headers
  76          */
  77         MODEST_HEADER_VIEW_COLUMN_COMPACT_FLAG, /* priority and attachments */
  78         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, /* incoming mail */
  79         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT,/* outgoing mail */
  80         MODEST_HEADER_VIEW_COLUMN_COMPACT_SENT_DATE,
  81         MODEST_HEADER_VIEW_COLUMN_COMPACT_RECEIVED_DATE,
  82
  83         MODEST_HEADER_VIEW_COLUMN_NUM
  84
  85 } ModestHeaderViewColumn;
  86
  87 /*
  88  * this can be extended with more style thingies,
  89  * to make a small-device specific display
  90  */
  91 typedef enum _ModestHeaderViewStyle {
  92         MODEST_HEADER_VIEW_STYLE_DETAILS   = 0, /* many columns, single line, col headers visible */
  93         MODEST_HEADER_VIEW_STYLE_TWOLINES  = 1, /* two-line headers, col headers invisible */
  94
  95         MODEST_HEADER_VIEW_STYLE_NUM
  96 } ModestHeaderViewStyle;
  97
  98 typedef enum _ModestItemType {
  99         MODEST_ITEM_TYPE_MESSAGE,
 100         MODEST_ITEM_TYPE_FOLDER,
 101         MODEST_ITEM_TYPE_NUM
 102 } ModestItemType;
 103
 104
 105 struct _ModestHeaderViewClass {
 106         GtkTreeViewClass parent_class;
 107
 108         void (*header_selected) (ModestHeaderView* self,
 109                                  TnyHeader *header,
 110                                  gpointer user_data);
 111
 112         void (*item_not_found) (ModestHeaderView* self,
 113                                 ModestItemType type,
 114                                 gpointer user_data);
 115
 116         void (*header_activated) (ModestHeaderView* self,
 117                                   TnyHeader *header,
 118                                   gpointer user_data);
 119
 120         void (*msg_count_changed) (ModestHeaderView* self,
 121                                    TnyFolder *folder,
 122                                    TnyFolderChange *change,
 123                                    gpointer user_data);
 124
 125         void (*updating_msg_list) (ModestHeaderView *self,
 126                                    gboolean starting,
 127                                    gpointer user_data);
 128 };
 129
 130 /**
 131  * modest_header_view_get_type:
 132  *
 133  * get the GType for ModestHeaderView
 134  *
 135  * Returns: the GType
 136  */
 137 GType        modest_header_view_get_type    (void) G_GNUC_CONST;
 138
 139
 140 /**
 141  * modest_header_view_new:
 142  * @folder: a TnyMsgFolder object
 143  * @style: a ModestHeaderViewColumn with the style of this listview
 144  *  (   MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
 145  *
 146  * create a new ModestHeaderView instance, based on a folder iface
 147  *
 148  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 149  */
 150 GtkWidget*   modest_header_view_new        (TnyFolder *folder,
 151                                             ModestHeaderViewStyle style);
 152
 153 /**
 154  * modest_header_view_set_folder:
 155  * @self: a ModestHeaderView instance
 156  * @folder: a TnyFolder object
 157  *
 158  * set the folder for this ModestHeaderView
 159  */
 160 void         modest_header_view_set_folder (ModestHeaderView *self,
 161                                             TnyFolder *folder,
 162                                             gboolean refresh,
 163                                             RefreshAsyncUserCallback callback,
 164                                             gpointer user_data);
 165
 166 /**
 167  * modest_header_view_get_folder:
 168  * @self: a ModestHeaderView instance
 169  *
 170  * get the folder in this ModestHeaderView
 171  *
 172  * Returns: the tny folder instance or NULL if there is none
 173  */
 174 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
 175
 176
 177 /**
 178  * modest_header_view_set_columns:
 179  * @self: a ModestHeaderView instance
 180  * @columns: a list of gint ModestHeaderViewColumn column IDs, using GINT_TO_POINTER() and GPOINTER_TO_INT().
 181  * @type: #TnyFolderType type
 182  *
 183  * set the columns for this ModestHeaderView.
 184  *
 185  * Returns: TRUE if it succeeded, FALSE otherwise
 186  */
 187 gboolean modest_header_view_set_columns (ModestHeaderView *self,
 188                                          const GList *columns,
 189                                          TnyFolderType type);
 190 /**
 191  * modest_header_view_get_columns:
 192  * @self: a ModestHeaderView instance
 193  *
 194  * get the GtkTreeColumns for this ModestHeaderView. Each one of the
 195  * tree columns will have property  than can be retrieved
 196  * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
 197  * and which contains the corresponding ModestHeaderViewColumn
 198  *
 199  * Returns: newly allocated list of #GtkTreeViewColumns objects, or NULL in case of no columns or error
 200  * You must free the list with g_list_free
 201  */
 202 GList*  modest_header_view_get_columns (ModestHeaderView *self);
 203
 204
 205 /**
 206  * modest_header_view_set_style:
 207  * @self: a ModestHeaderView instance
 208  * @style: the style for this tree view
 209  *
 210  * set the style for this ModestHeaderView
 211  *
 212  * Returns: TRUE if it succeeded, FALSE otherwise
 213  */
 214 gboolean   modest_header_view_set_style (ModestHeaderView *self,
 215                                          ModestHeaderViewStyle style);
 216
 217 /**
 218  * modest_header_view_set_folder:
 219  * @self: a ModestHeaderView instance
 220  *
 221  * get the style for this ModestHeaderView
 222  *
 223  * Returns: the current style
 224  */
 225 ModestHeaderViewStyle   modest_header_view_get_style (ModestHeaderView *self);
 226
 227 /**
 228  * modest_header_view_count_selected_headers:
 229  * @self: a ModestHeaderView instance
 230  *
 231  * Check selected headers counter.
 232  * Returns: the number of selected headers.
 233  */
 234 guint
 235 modest_header_view_count_selected_headers (ModestHeaderView *self);
 236
 237 /**
 238  * modest_header_view_has_selected_headers:
 239  * @self: a ModestHeaderView instance
 240  *
 241  * Check if any row is selected on headers tree view.
 242  * Returns: TRUE if any header is selected, FALSE otherwise.
 243  */
 244 gboolean
 245 modest_header_view_has_selected_headers (ModestHeaderView *self);
 246
 247 /**
 248  * modest_header_view_get_selected_headers:
 249  * @self: a ModestHeaderView instance
 250  *
 251  * get the list of the currently selected TnyHeader's. The list and
 252  * the headers should be freed by the caller
 253  *
 254  * Returns: the list with the currently selected headers
 255  */
 256 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
 257
 258
 259 /**
 260  * modest_header_view_is_empty:
 261  * @self: a valid ModestHeaderView instance
 262  *
 263  * see if this header view is empty; use this function instead of
 264  * using the GtkTreeView parent directly, as 'empty' in this case
 265  * may mean that there is one "This is empty"-message, and of course
 266  * GtkTreeView then thinks it is *not* empty
 267  *
 268  * Returns: TRUE if the header view is empty, FALSE otherwise
 269  */
 270 gboolean  modest_header_view_is_empty (ModestHeaderView *self);
 271
 272
 273
 274 /**
 275  * modest_header_view_select_next:
 276  * @self: a #ModestHeaderView
 277  *
 278  * Selects the header next to the current selected one
 279  **/
 280 void         modest_header_view_select_next          (ModestHeaderView *self);
 281
 282 /**
 283  * modest_header_view_select_prev:
 284  * @self: a #ModestHeaderView
 285  *
 286  * Selects the previous header of the current selected one
 287  **/
 288 void         modest_header_view_select_prev          (ModestHeaderView *self);
 289
 290
 291 /* PROTECTED method. It's useful when we want to force a given
 292    selection to reload a msg. For example if we have selected a header
 293    in offline mode, when Modest become online, we want to reload the
 294    message automatically without an user click over the header */
 295 void
 296 _modest_header_view_change_selection (GtkTreeSelection *selection,
 297                                       gpointer user_data);
 298
 299 /**
 300  * modest_header_view_get_sort_column_id:
 301  * @self: a #ModestHeaderView
 302  * @type: #TnyFolderType type
 303  *
 304  * Gets the selected logical columnd id for sorting.
 305  **/
 306 gint
 307 modest_header_view_get_sort_column_id (ModestHeaderView *self, TnyFolderType type);
 308
 309 /**
 310  * modest_header_view_get_sort_type:
 311  * @self: a #ModestHeaderView
 312  * @type: #TnyFolderType type
 313  *
 314  * Gets the selected sort type.
 315  **/
 316 GtkSortType
 317 modest_header_view_get_sort_type (ModestHeaderView *self, TnyFolderType type);
 318
 319 /**
 320  * modest_header_view_set_sort_params:
 321  * @self: a #ModestHeaderView
 322  * @sort_colid: logical column id to sort
 323  * @sort_type: #GtkSortType sort type
 324  * @type: #TnyFolderType type
 325  *
 326  * Sets the logical columnd id and sort type for sorting operations.
 327  **/
 328 void
 329 modest_header_view_set_sort_params (ModestHeaderView *self, guint sort_colid, GtkSortType sort_type, TnyFolderType type);
 330
 331 /**
 332  * modest_header_view_set_sort_params:
 333  * @self: a #ModestHeaderView
 334  * @sort_colid: logical column id to sort
 335  * @sort_type: #GtkSortType sort type
 336  *
 337  * Sorts headers treeview by logical column id, @sort_colid, using a
 338  * @sort_type sorting method. In addition, new headder settings will be
 339  * stored in @self object.
 340  **/
 341 void
 342 modest_header_view_sort_by_column_id (ModestHeaderView *self,
 343                                       guint sort_colid,
 344                                       GtkSortType sort_type);
 345
 346 /**
 347  * modest_header_view_clear:
 348  * @self: a #ModestHeaderView
 349  *
 350  * Clear the contents of a header view. It internally calls the
 351  * set_folder function with last three arguments as NULL
 352  **/
 353 void
 354 modest_header_view_clear (ModestHeaderView *self);
 355
 356 /**
 357  * modest_header_view_copy_selection:
 358  * @self: a #ModestHeaderView
 359  *
 360  * Stores a #TnyList of selected headers in the own clibpoard of
 361  * @self header view.
 362  **/
 363 void
 364 modest_header_view_copy_selection (ModestHeaderView *header_view);
 365
 366 /**
 367  * modest_header_view_cut_selection:
 368  * @self: a #ModestHeaderView
 369  *
 370  * Stores a #TnyList of selected headers in the own clibpoard of
 371  * @self header view and filter them into headers tree model to
 372  * hide these rows in treeview.
 373  **/
 374 void
 375 modest_header_view_cut_selection (ModestHeaderView *header_view);
 376
 377
 378 /**
 379  * modest_header_view_paste_selection:
 380  * @self: a #ModestHeaderView
 381  * @headers: ouput parameter with a #TnyList of headers which will be returned.
 382  * @delete: output parameter with indication about delete or not the selected headers.
 383  *
 384  * Gets the selected headers to copy/cut.
 385  **/
 386 void
 387 modest_header_view_paste_selection (ModestHeaderView *header_view,
 388                                     TnyList **headers,
 389                                     gboolean *delete);
 390
 391 void modest_header_view_refilter (ModestHeaderView *header_view);
 392
 393 /**
 394  * modest_header_view_add_observer:
 395  * @header_view: a #ModestHeaderView
 396  * @observer: The observer to notify.
 397  *
 398  * Registers a new observer. Warning! Each added observer object must
 399  * removed using @modest_header_view_remove_observer before destroying
 400  * the observer, or at least when it is under destruction. Also you
 401  * should care about that the observer's #update function might be
 402  * called any time until the observer is removed.
 403  **/
 404 void modest_header_view_add_observer(
 405                 ModestHeaderView *header_view,
 406                 ModestHeaderViewObserver *observer);
 407
 408 /**
 409  * modest_header_view_remove_observer:
 410  * @header_view: a #ModestHeaderView
 411  * @observer: The observer to remove.
 412  *
 413  * Removes exactly one observer from the notification list. If you
 414  * added an observer twice, you should call this remove funtion twice
 415  * as well.
 416  **/
 417 void modest_header_view_remove_observer(
 418                 ModestHeaderView *header_view,
 419                 ModestHeaderViewObserver *observer);
 420
 421 G_END_DECLS
 422
 423
 424
 425 #endif /* __MODEST_HEADER_VIEW_H__ */
 426