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 <gtk/gtk.h>
  34 #include <tny-folder.h>
  35 #include <tny-gtk-account-tree-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 /* typedef enum _ModestItemType ModestItemType; */
  59
  60
  61 typedef enum _ModestHeaderViewColumn {
  62         MODEST_HEADER_VIEW_COLUMN_FROM,
  63         MODEST_HEADER_VIEW_COLUMN_TO,
  64         MODEST_HEADER_VIEW_COLUMN_SUBJECT,
  65         MODEST_HEADER_VIEW_COLUMN_SENT_DATE,
  66         MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE,
  67         MODEST_HEADER_VIEW_COLUMN_MSGTYPE,
  68         MODEST_HEADER_VIEW_COLUMN_ATTACH,
  69         MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER,
  70
  71         MODEST_HEADER_VIEW_COLUMN_NUM
  72 } ModestHeaderViewColumn;
  73 /* typedef enum _ModestHeaderViewColumn ModestHeaderViewColumn; */
  74
  75 typedef enum _ModestHeaderViewStyle {
  76         MODEST_HEADER_VIEW_STYLE_NORMAL,
  77         MODEST_HEADER_VIEW_STYLE_COMPACT,
  78         MODEST_HEADER_VIEW_STYLE_NUM
  79 } ModestHeaderViewStyle;
  80 /* typedef enum _ModestHeaderViewStyle ModestHeaderViewStyle; */
  81
  82 typedef enum _ModestItemType {
  83         MODEST_ITEM_TYPE_MESSAGE,
  84         MODEST_ITEM_TYPE_FOLDER,
  85         MODEST_ITEM_TYPE_NUM
  86 } ModestItemType;
  87
  88 struct _ModestHeaderViewClass {
  89         GtkTreeViewClass parent_class;
  90
  91         void (*message_selected) (ModestHeaderView* self,
  92                                   TnyMsg *msg,
  93                                   gpointer user_data);
  94
  95         void (*item_not_found) (ModestHeaderView* self,
  96                                 ModestItemType type,
  97                                 gpointer user_data);
  98
  99         /* msg == NULL implies that the operation is finished, ie.
 100          * the progress indictation can be hidden */
 101         void (*status_update) (ModestHeaderView* self,
 102                                const gchar* msg,
 103                                gint status,
 104                                gpointer user_data);
 105 };
 106
 107 /**
 108  * modest_header_view_get_type:
 109  *
 110  * get the GType for ModestHeaderView
 111  *
 112  * Returns: the GType
 113  */
 114 GType        modest_header_view_get_type    (void) G_GNUC_CONST;
 115
 116
 117 /**
 118  * modest_header_view_new:
 119  * @folder: a TnyMsgFolder object
 120  * @columns: a list of ModestHeaderViewColumn
 121  * @style: a ModestHeaderViewColumn with the style of this listview
 122  *  (   MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
 123  *
 124  * create a new ModestHeaderView instance, based on a folder iface
 125  *
 126  * Returns: a new GtkWidget (a GtkTreeView-subclass)
 127  */
 128 GtkWidget*   modest_header_view_new        (TnyFolder *folder,
 129                                             GSList *columns,
 130                                             ModestHeaderViewStyle style);
 131
 132 /**
 133  * modest_header_view_set_folder:
 134  * @self: a ModestHeaderView instance
 135  * @folder: a TnyFolder object
 136  *
 137  * set the folder for this ModestHeaderView
 138  *
 139  * Returns: TRUE if it succeeded, FALSE otherwise
 140  */
 141 gboolean     modest_header_view_set_folder (ModestHeaderView *self,
 142                                             TnyFolder *folder);
 143
 144
 145 /**
 146  * modest_header_view_set_columns:
 147  * @self: a ModestHeaderView instance
 148  * @columns: a list of ModestHeaderViewColumn
 149  *
 150  * set the columns for this ModestHeaderView
 151  *
 152  * Returns: TRUE if it succeeded, FALSE otherwise
 153  */
 154 gboolean     modest_header_view_set_columns (ModestHeaderView *self,
 155                                              GSList *columns);
 156 /**
 157  * modest_header_view_get_columns:
 158  * @self: a ModestHeaderView instance
 159  * @folder: a TnyFolder object
 160  *
 161  * get the columns for this ModestHeaderView
 162  *
 163  * Returns: list of columms, or NULL in case of no columns or error
 164  */
 165 const GSList*   modest_header_view_get_columns (ModestHeaderView *self);
 166
 167
 168 /**
 169  * modest_header_view_set_style:
 170  * @self: a ModestHeaderView instance
 171  * @style: the style for this tree view
 172  *
 173  * set the style this ModestHeaderView
 174  *
 175  * Returns: TRUE if it succeeded, FALSE otherwise
 176  */
 177 gboolean   modest_header_view_set_style (ModestHeaderView *self,
 178                                          ModestHeaderViewStyle style);
 179
 180 /**
 181  * modest_header_view_set_folder:
 182  * @self: a ModestHeaderView instance
 183  *
 184  * get the style for this ModestHeaderView
 185  *
 186  * Returns: the current style
 187  */
 188 ModestHeaderViewStyle   modest_header_view_get_style (ModestHeaderView *self);
 189
 190 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
 191
 192 G_END_DECLS
 193
 194
 195 #endif /* __MODEST_HEADER_VIEW_H__ */
 196