mail/em-folder-tree-model.h

   1 /*
   2  * This program is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU Lesser General Public
   4  * License as published by the Free Software Foundation; either
   5  * version 2 of the License, or (at your option) version 3.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  * Lesser General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU Lesser General Public
  13  * License along with the program; if not, see <http://www.gnu.org/licenses/>
  14  *
  15  *
  16  * Authors:
  17  *              Jeffrey Stedfast <fejj@ximian.com>
  18  *
  19  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
  20  *
  21  */
  22
  23 #ifndef EM_FOLDER_TREE_MODEL_H
  24 #define EM_FOLDER_TREE_MODEL_H
  25
  26 #include <gtk/gtk.h>
  27 #include <camel/camel.h>
  28
  29 #include <libemail-engine/e-mail-session.h>
  30
  31 /* Standard GObject macros */
  32 #define EM_TYPE_FOLDER_TREE_MODEL \
  33         (em_folder_tree_model_get_type ())
  34 #define EM_FOLDER_TREE_MODEL(obj) \
  35         (G_TYPE_CHECK_INSTANCE_CAST \
  36         ((obj), EM_TYPE_FOLDER_TREE_MODEL, EMFolderTreeModel))
  37 #define EM_FOLDER_TREE_MODEL_CLASS(cls) \
  38         (G_TYPE_CHECK_CLASS_CAST \
  39         ((cls), EM_TYPE_FOLDER_TREE_MODEL, EMFolderTreeModelClass))
  40 #define EM_IS_FOLDER_TREE_MODEL(obj) \
  41         (G_TYPE_CHECK_INSTANCE_TYPE \
  42         ((obj), EM_TYPE_FOLDER_TREE_MODEL))
  43 #define EM_IS_FOLDER_TREE_MODEL_CLASS(cls) \
  44         (G_TYPE_CHECK_CLASS_TYPE \
  45         ((cls), EM_TYPE_FOLDER_TREE_MODEL))
  46 #define EM_FOLDER_TREE_MODEL_GET_CLASS(obj) \
  47         (G_TYPE_INSTANCE_GET_CLASS \
  48         ((obj), EM_TYPE_FOLDER_TREE_MODEL, EMFolderTreeModelClass))
  49
  50 G_BEGIN_DECLS
  51
  52 typedef struct _EMFolderTreeModel EMFolderTreeModel;
  53 typedef struct _EMFolderTreeModelClass EMFolderTreeModelClass;
  54 typedef struct _EMFolderTreeModelPrivate EMFolderTreeModelPrivate;
  55 typedef struct _EMFolderTreeModelStoreInfo EMFolderTreeModelStoreInfo;
  56
  57 enum {
  58         COL_STRING_DISPLAY_NAME,        /* string that appears in the tree */
  59         COL_POINTER_CAMEL_STORE,        /* CamelStore object */
  60         COL_STRING_FULL_NAME,           /* if node is a folder, the full path
  61                                          * name of the folder, no leading / */
  62         COL_STRING_ICON_NAME,           /* icon name for the folder */
  63         COL_UINT_UNREAD,                /* unread count */
  64         COL_UINT_FLAGS,                 /* FolderInfo.flags */
  65
  66         COL_BOOL_IS_STORE,              /* toplevel store node? */
  67         COL_BOOL_IS_FOLDER,             /* folder (not a store) */
  68         COL_BOOL_LOAD_SUBDIRS,          /* %TRUE only if the store/folder
  69                                          * has subfolders which have not yet
  70                                          * been added to the tree */
  71         COL_UINT_UNREAD_LAST_SEL,       /* last known unread count */
  72         COL_BOOL_IS_DRAFT,              /* %TRUE for a draft folder */
  73         NUM_COLUMNS
  74 };
  75
  76 struct _EMFolderTreeModelStoreInfo {
  77         CamelStore *store;
  78         GtkTreeRowReference *row;
  79
  80         /* CamelFolderInfo::full_name -> GtkTreeRowReference */
  81         GHashTable *full_hash;
  82
  83         guint created_id;
  84         guint deleted_id;
  85         guint renamed_id;
  86         guint subscribed_id;
  87         guint unsubscribed_id;
  88 };
  89
  90 struct _EMFolderTreeModel {
  91         GtkTreeStore parent;
  92         EMFolderTreeModelPrivate *priv;
  93 };
  94
  95 struct _EMFolderTreeModelClass {
  96         GtkTreeStoreClass parent_class;
  97
  98         /* signals */
  99         void            (*loading_row)          (EMFolderTreeModel *model,
 100                                                  GtkTreePath *path,
 101                                                  GtkTreeIter *iter);
 102
 103         void            (*loaded_row)           (EMFolderTreeModel *model,
 104                                                  GtkTreePath *path,
 105                                                  GtkTreeIter *iter);
 106 };
 107
 108 GType           em_folder_tree_model_get_type   (void);
 109 EMFolderTreeModel *
 110                 em_folder_tree_model_new        (void);
 111 EMFolderTreeModel *
 112                 em_folder_tree_model_get_default (void);
 113 GtkTreeSelection *
 114                 em_folder_tree_model_get_selection
 115                                         (EMFolderTreeModel *model);
 116 void            em_folder_tree_model_set_selection
 117                                         (EMFolderTreeModel *model,
 118                                          GtkTreeSelection *selection);
 119 EMailSession *  em_folder_tree_model_get_session
 120                                         (EMFolderTreeModel *model);
 121 void            em_folder_tree_model_set_session
 122                                         (EMFolderTreeModel *model,
 123                                          EMailSession *session);
 124 void            em_folder_tree_model_set_folder_info
 125                                         (EMFolderTreeModel *model,
 126                                          GtkTreeIter *iter,
 127                                          EMFolderTreeModelStoreInfo *si,
 128                                          CamelFolderInfo *fi,
 129                                          gint fully_loaded);
 130 void            em_folder_tree_model_add_store
 131                                         (EMFolderTreeModel *model,
 132                                          CamelStore *store);
 133 void            em_folder_tree_model_remove_store
 134                                         (EMFolderTreeModel *model,
 135                                          CamelStore *store);
 136 GList *         em_folder_tree_model_list_stores
 137                                         (EMFolderTreeModel *model);
 138 void            em_folder_tree_model_remove_folders
 139                                         (EMFolderTreeModel *model,
 140                                          EMFolderTreeModelStoreInfo *si,
 141                                          GtkTreeIter *toplevel);
 142 gboolean        em_folder_tree_model_is_type_inbox
 143                                         (EMFolderTreeModel *model,
 144                                          CamelStore *store,
 145                                          const gchar *full);
 146 gchar *         em_folder_tree_model_get_folder_name
 147                                         (EMFolderTreeModel *model,
 148                                          CamelStore *store,
 149                                          const gchar *full);
 150 EMFolderTreeModelStoreInfo *
 151                 em_folder_tree_model_lookup_store_info
 152                                         (EMFolderTreeModel *model,
 153                                          CamelStore *store);
 154 GtkTreeRowReference *
 155                 em_folder_tree_model_lookup_uri
 156                                         (EMFolderTreeModel *model,
 157                                          const gchar *folder_uri);
 158 void            em_folder_tree_model_user_marked_unread
 159                                         (EMFolderTreeModel *model,
 160                                          CamelFolder *folder,
 161                                          guint n_marked);
 162
 163 G_END_DECLS
 164
 165 #endif /* EM_FOLDER_TREE_MODEL_H */