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         MODEST_HEADER_VIEW_STYLE_EMPTY,   /* empty view (for empty folders) */
  87
  88         MODEST_HEADER_VIEW_STYLE_NUM
  89 } ModestHeaderViewStyle;
  90
  91 typedef enum _ModestItemType {
  92         MODEST_ITEM_TYPE_MESSAGE,
  93         MODEST_ITEM_TYPE_FOLDER,
  94         MODEST_ITEM_TYPE_NUM
  95 } ModestItemType;
  96
  97
  98 struct _ModestHeaderViewClass {
  99         GtkTreeViewClass parent_class;
 100
 101         void (*header_selected) (ModestHeaderView* self,
 102                                  TnyHeader *header,
 103                                  gpointer user_data);
 104
 105         void (*item_not_found) (ModestHeaderView* self,
 106                                 ModestItemType type,
 107                                 gpointer user_data);
 108
 109         /* msg == NULL implies that the operation is finished, ie.
 110          * the progress indictation can be hidden */
 111         void (*status_update) (ModestHeaderView* self,
 112                                const gchar* msg,
 113                                gint num, gint total,
 114                                gpointer user_data);
 115 };
 116
 117 /**
 118  * modest_header_view_get_type:
 119  *
 120  * get the GType for ModestHeaderView
 121  *
 122  * Returns: the GType
 123  */
 124 GType        modest_header_view_get_type    (void) G_GNUC_CONST;
 125
 126
 127 /**
 128  * modest_header_view_new:
 129  * @folder: a TnyMsgFolder object
 130  * @columns: a list of ModestHeaderViewColumn
 131  * @style: a ModestHeaderViewColumn with the style of this listview
 132  *  (   MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
 133  *
 134  * create a new ModestHeaderView instance, based on a folder iface
 135  *
 136  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 137  */
 138 GtkWidget*   modest_header_view_new        (TnyFolder *folder,
 139                                             const GList *columns,
 140                                             ModestHeaderViewStyle style);
 141
 142 /**
 143  * modest_header_view_set_folder:
 144  * @self: a ModestHeaderView instance
 145  * @folder: a TnyFolder object
 146  *
 147  * set the folder for this ModestHeaderView
 148  *
 149  * Returns: TRUE if it succeeded, FALSE otherwise
 150  */
 151 gboolean     modest_header_view_set_folder (ModestHeaderView *self,
 152                                             TnyFolder *folder);
 153
 154
 155
 156
 157 /**
 158  * modest_header_view_get_folder:
 159  * @self: a ModestHeaderView instance
 160  *
 161  * get the folder in this ModestHeaderView
 162  *
 163  * Returns: the tny folder instance or NULL if there is none
 164  */
 165 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
 166
 167
 168 /**
 169  * modest_header_view_set_columns:
 170  * @self: a ModestHeaderView instance
 171  * @columns: a list of ModestHeaderViewColumn
 172  *
 173  * set the columns for this ModestHeaderView.
 174  *
 175  * Returns: TRUE if it succeeded, FALSE otherwise
 176  */
 177 gboolean modest_header_view_set_columns (ModestHeaderView *self,
 178                                          const GList *columns);
 179 /**
 180  * modest_header_view_get_columns:
 181  * @self: a ModestHeaderView instance
 182  *
 183  * get the GtkTreeColumns for this ModestHeaderView. Each one of the
 184  * tree columns will have property  than can be retrieved
 185  * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
 186  * and which contains the corresponding ModestHeaderViewColumn
 187  *
 188  * Returns: newly allocated list of column ids, or NULL in case of no columns or error
 189  * You must free the list with g_list_free
 190  */
 191 GList*  modest_header_view_get_columns (ModestHeaderView *self);
 192
 193
 194 /**
 195  * modest_header_view_set_style:
 196  * @self: a ModestHeaderView instance
 197  * @style: the style for this tree view
 198  *
 199  * set the style for this ModestHeaderView
 200  *
 201  * Returns: TRUE if it succeeded, FALSE otherwise
 202  */
 203 gboolean   modest_header_view_set_style (ModestHeaderView *self,
 204                                          ModestHeaderViewStyle style);
 205
 206 /**
 207  * modest_header_view_set_folder:
 208  * @self: a ModestHeaderView instance
 209  *
 210  * get the style for this ModestHeaderView
 211  *
 212  * Returns: the current style
 213  */
 214 ModestHeaderViewStyle   modest_header_view_get_style (ModestHeaderView *self);
 215
 216 /**
 217  * modest_header_view_get_selected_headers:
 218  * @self: a ModestHeaderView instance
 219  *
 220  * get the list of the currently selected TnyHeader's
 221  *
 222  * Returns: the list with the currently selected headers
 223  */
 224 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
 225
 226
 227 /**
 228  * modest_header_view_select_next:
 229  * @self: a #ModestHeaderView
 230  *
 231  * Selects the header next to the current selected one
 232  **/
 233 void     modest_header_view_select_next          (ModestHeaderView *self);
 234
 235
 236
 237 /* PROTECTED method. It's useful when we want to force a given
 238    selection to reload a msg. For example if we have selected a header
 239    in offline mode, when Modest become online, we want to reload the
 240    message automatically without an user click over the header */
 241 void
 242 _modest_header_view_change_selection (GtkTreeSelection *selection,
 243                                       gpointer user_data);
 244
 245 G_END_DECLS
 246
 247
 248 #endif /* __MODEST_HEADER_VIEW_H__ */
 249