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-gtk-account-list-model.h>
  35 #include <tny-msg.h>
  36 #include <tny-header.h>
  37 #include <tny-gtk-header-list-model.h>
  38
  39 G_BEGIN_DECLS
  40
  41 /* convenience macros */
  42 #define MODEST_TYPE_HEADER_VIEW             (modest_header_view_get_type())
  43 #define MODEST_HEADER_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderView))
  44 #define MODEST_HEADER_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  45 #define MODEST_IS_HEADER_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HEADER_VIEW))
  46 #define MODEST_IS_HEADER_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HEADER_VIEW))
  47 #define MODEST_HEADER_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
  48
  49 typedef struct _ModestHeaderView      ModestHeaderView;
  50 typedef struct _ModestHeaderViewClass ModestHeaderViewClass;
  51
  52 struct _ModestHeaderView {
  53          GtkTreeView parent;
  54         /* insert public members, if any */
  55 };
  56
  57 #define MODEST_HEADER_VIEW_COLUMN    "header-view-column"
  58
  59 typedef enum _ModestHeaderViewColumn {
  60         MODEST_HEADER_VIEW_COLUMN_FROM            = 0,
  61         MODEST_HEADER_VIEW_COLUMN_TO,
  62         MODEST_HEADER_VIEW_COLUMN_SUBJECT,
  63         MODEST_HEADER_VIEW_COLUMN_SENT_DATE,
  64         MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE,
  65         MODEST_HEADER_VIEW_COLUMN_MSGTYPE,
  66         MODEST_HEADER_VIEW_COLUMN_ATTACH,
  67         MODEST_HEADER_VIEW_COLUMN_SIZE,
  68         /*
  69          * these two are for compact display on small devices,
  70          * with two line display with all relevant headers
  71          */
  72         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN,  /* incoming mail */
  73         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT, /* outgoing mail */
  74
  75         MODEST_HEADER_VIEW_COLUMN_NUM
  76
  77 } ModestHeaderViewColumn;
  78
  79 /*
  80  * this can be extended with more style thingies,
  81  * to make a small-device specific display
  82  */
  83 typedef enum _ModestHeaderViewStyle {
  84         MODEST_HEADER_VIEW_STYLE_DETAILS, /* many columns, single line, col headers visible */
  85         MODEST_HEADER_VIEW_STYLE_TWOLINES, /* two-line headers, col headers invisible */
  86
  87         MODEST_HEADER_VIEW_STYLE_NUM
  88 } ModestHeaderViewStyle;
  89
  90 typedef enum _ModestItemType {
  91         MODEST_ITEM_TYPE_MESSAGE,
  92         MODEST_ITEM_TYPE_FOLDER,
  93         MODEST_ITEM_TYPE_NUM
  94 } ModestItemType;
  95
  96
  97 struct _ModestHeaderViewClass {
  98         GtkTreeViewClass parent_class;
  99
 100         void (*header_selected) (ModestHeaderView* self,
 101                                  TnyHeader *header,
 102                                  gpointer user_data);
 103
 104         void (*item_not_found) (ModestHeaderView* self,
 105                                 ModestItemType type,
 106                                 gpointer user_data);
 107
 108         /* msg == NULL implies that the operation is finished, ie.
 109          * the progress indictation can be hidden */
 110         void (*status_update) (ModestHeaderView* self,
 111                                const gchar* msg,
 112                                gint num, gint total,
 113                                gpointer user_data);
 114 };
 115
 116 /**
 117  * modest_header_view_get_type:
 118  *
 119  * get the GType for ModestHeaderView
 120  *
 121  * Returns: the GType
 122  */
 123 GType        modest_header_view_get_type    (void) G_GNUC_CONST;
 124
 125
 126 /**
 127  * modest_header_view_new:
 128  * @folder: a TnyMsgFolder object
 129  * @style: a ModestHeaderViewColumn with the style of this listview
 130  *  (   MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
 131  *
 132  * create a new ModestHeaderView instance, based on a folder iface
 133  *
 134  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 135  */
 136 GtkWidget*   modest_header_view_new        (TnyFolder *folder,
 137                                             ModestHeaderViewStyle style);
 138
 139 /**
 140  * modest_header_view_set_folder:
 141  * @self: a ModestHeaderView instance
 142  * @folder: a TnyFolder object
 143  *
 144  * set the folder for this ModestHeaderView
 145  *
 146  * Returns: TRUE if it succeeded, FALSE otherwise
 147  */
 148 gboolean     modest_header_view_set_folder (ModestHeaderView *self,
 149                                             TnyFolder *folder);
 150
 151 /**
 152  * modest_header_view_get_folder:
 153  * @self: a ModestHeaderView instance
 154  *
 155  * get the folder in this ModestHeaderView
 156  *
 157  * Returns: the tny folder instance or NULL if there is none
 158  */
 159 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
 160
 161
 162 /**
 163  * modest_header_view_set_columns:
 164  * @self: a ModestHeaderView instance
 165  * @columns: a list of ModestHeaderViewColumn
 166  *
 167  * set the columns for this ModestHeaderView.
 168  *
 169  * Returns: TRUE if it succeeded, FALSE otherwise
 170  */
 171 gboolean modest_header_view_set_columns (ModestHeaderView *self,
 172                                          const GList *columns);
 173 /**
 174  * modest_header_view_get_columns:
 175  * @self: a ModestHeaderView instance
 176  *
 177  * get the GtkTreeColumns for this ModestHeaderView. Each one of the
 178  * tree columns will have property  than can be retrieved
 179  * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
 180  * and which contains the corresponding ModestHeaderViewColumn
 181  *
 182  * Returns: newly allocated list of column ids, or NULL in case of no columns or error
 183  * You must free the list with g_list_free
 184  */
 185 GList*  modest_header_view_get_columns (ModestHeaderView *self);
 186
 187
 188 /**
 189  * modest_header_view_set_style:
 190  * @self: a ModestHeaderView instance
 191  * @style: the style for this tree view
 192  *
 193  * set the style for this ModestHeaderView
 194  *
 195  * Returns: TRUE if it succeeded, FALSE otherwise
 196  */
 197 gboolean   modest_header_view_set_style (ModestHeaderView *self,
 198                                          ModestHeaderViewStyle style);
 199
 200 /**
 201  * modest_header_view_set_folder:
 202  * @self: a ModestHeaderView instance
 203  *
 204  * get the style for this ModestHeaderView
 205  *
 206  * Returns: the current style
 207  */
 208 ModestHeaderViewStyle   modest_header_view_get_style (ModestHeaderView *self);
 209
 210 /**
 211  * modest_header_view_get_selected_headers:
 212  * @self: a ModestHeaderView instance
 213  *
 214  * get the list of the currently selected TnyHeader's
 215  *
 216  * Returns: the list with the currently selected headers
 217  */
 218 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
 219
 220
 221 /**
 222  * modest_header_view_is_empty:
 223  * @self: a valid ModestHeaderView instance
 224  *
 225  * see if this header view is empty; use this function instead of
 226  * using the GtkTreeView parent directly, as 'empty' in this case
 227  * may mean that there is one "This is empty"-message, and of course
 228  * GtkTreeView then thinks it is *not* empty
 229  *
 230  * Returns: TRUE if the header view is empty, FALSE otherwise
 231  */
 232 gboolean  modest_header_view_is_empty (ModestHeaderView *self);
 233
 234
 235
 236 /**
 237  * modest_header_view_select_next:
 238  * @self: a #ModestHeaderView
 239  *
 240  * Selects the header next to the current selected one
 241  **/
 242 void         modest_header_view_select_next          (ModestHeaderView *self);
 243
 244
 245 /* PROTECTED method. It's useful when we want to force a given
 246    selection to reload a msg. For example if we have selected a header
 247    in offline mode, when Modest become online, we want to reload the
 248    message automatically without an user click over the header */
 249 void
 250 _modest_header_view_change_selection (GtkTreeSelection *selection,
 251                                       gpointer user_data);
 252
 253 G_END_DECLS
 254
 255
 256 #endif /* __MODEST_HEADER_VIEW_H__ */
 257