camel/camel-vee-folder.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   4  *
   5  * Authors: Michael Zucchi <notzed@ximian.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of version 2 of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #if !defined (__CAMEL_H_INSIDE__) && !defined (CAMEL_COMPILATION)
  23 #error "Only <camel/camel.h> can be included directly."
  24 #endif
  25
  26 #ifndef CAMEL_VEE_FOLDER_H
  27 #define CAMEL_VEE_FOLDER_H
  28
  29 #include <camel/camel-folder.h>
  30 #include <camel/camel-folder-search.h>
  31 #include <camel/camel-store.h>
  32 #include <camel/camel-vee-summary.h>
  33
  34 /* Standard GObject macros */
  35 #define CAMEL_TYPE_VEE_FOLDER \
  36         (camel_vee_folder_get_type ())
  37 #define CAMEL_VEE_FOLDER(obj) \
  38         (G_TYPE_CHECK_INSTANCE_CAST \
  39         ((obj), CAMEL_TYPE_VEE_FOLDER, CamelVeeFolder))
  40 #define CAMEL_VEE_FOLDER_CLASS(cls) \
  41         (G_TYPE_CHECK_CLASS_CAST \
  42         ((cls), CAMEL_TYPE_VEE_FOLDER, CamelVeeFolderClass))
  43 #define CAMEL_IS_VEE_FOLDER(obj) \
  44         (G_TYPE_CHECK_INSTANCE_TYPE \
  45         ((obj), CAMEL_TYPE_VEE_FOLDER))
  46 #define CAMEL_IS_VEE_FOLDER_CLASS(cls) \
  47         (G_TYPE_CHECK_CLASS_TYPE \
  48         ((cls), CAMEL_TYPE_VEE_FOLDER))
  49 #define CAMEL_VEE_FOLDER_GET_CLASS(obj) \
  50         (G_TYPE_INSTANCE_GET_CLASS \
  51         ((obj), CAMEL_TYPE_VEE_FOLDER, CamelVeeFolderClass))
  52
  53 G_BEGIN_DECLS
  54
  55 typedef struct _CamelVeeFolder CamelVeeFolder;
  56 typedef struct _CamelVeeFolderClass CamelVeeFolderClass;
  57 typedef struct _CamelVeeFolderPrivate CamelVeeFolderPrivate;
  58
  59 /**
  60  * CamelVeeFolderLock:
  61  *
  62  * Since: 2.32
  63  **/
  64 typedef enum {
  65         CAMEL_VEE_FOLDER_SUMMARY_LOCK,
  66         CAMEL_VEE_FOLDER_SUBFOLDER_LOCK,
  67         CAMEL_VEE_FOLDER_CHANGED_LOCK
  68 } CamelVeeFolderLock;
  69
  70 struct _CamelVeeFolder {
  71         CamelFolder parent;
  72         CamelVeeFolderPrivate *priv;
  73
  74         guint32 flags;          /* folder open flags */
  75 };
  76
  77 struct _CamelVeeFolderClass {
  78         CamelFolderClass parent_class;
  79
  80         /* TODO: Some of this may need some additional work/thinking through, it works for now*/
  81
  82         void            (*add_folder)           (CamelVeeFolder *vee_folder,
  83                                                  CamelFolder *folder,
  84                                                  GCancellable *cancellable);
  85         void            (*remove_folder)        (CamelVeeFolder *vee_folder,
  86                                                  CamelFolder *folder,
  87                                                  GCancellable *cancellable);
  88         void            (*rebuild_folder)       (CamelVeeFolder *vee_folder,
  89                                                  CamelFolder *folder,
  90                                                  GCancellable *cancellable);
  91
  92         void            (*set_expression)       (CamelVeeFolder *vee_folder,
  93                                                  const gchar *expression);
  94
  95         /* Called for a folder-changed event on a source folder */
  96         void            (*folder_changed)       (CamelVeeFolder *vee_folder,
  97                                                  CamelFolder *subfolder,
  98                                                  CamelFolderChangeInfo *changes);
  99 };
 100
 101 #define CAMEL_UNMATCHED_NAME "UNMATCHED"
 102
 103 GType           camel_vee_folder_get_type               (void);
 104 CamelFolder *   camel_vee_folder_new                    (CamelStore *parent_store,
 105                                                          const gchar *full,
 106                                                          guint32 flags);
 107 void            camel_vee_folder_construct              (CamelVeeFolder *vf,
 108                                                          guint32 flags);
 109
 110 CamelFolder *   camel_vee_folder_get_location           (CamelVeeFolder *vf,
 111                                                          const struct _CamelVeeMessageInfo *vinfo,
 112                                                          gchar **realuid);
 113 CamelFolder *   camel_vee_folder_get_vee_uid_folder     (CamelVeeFolder *vf,
 114                                                          const gchar *vee_message_uid);
 115 void            camel_vee_folder_set_auto_update        (CamelVeeFolder *vfolder,
 116                                                          gboolean auto_update);
 117 gboolean        camel_vee_folder_get_auto_update        (CamelVeeFolder *vfolder);
 118 void            camel_vee_folder_add_folder             (CamelVeeFolder *vfolder,
 119                                                          CamelFolder *subfolder,
 120                                                          GCancellable *cancellable);
 121 void            camel_vee_folder_remove_folder          (CamelVeeFolder *vfolder,
 122                                                          CamelFolder *subfolder,
 123                                                          GCancellable *cancellable);
 124 void            camel_vee_folder_set_folders            (CamelVeeFolder *vf,
 125                                                          GList *folders,
 126                                                          GCancellable *cancellable);
 127 void            camel_vee_folder_add_vuid               (CamelVeeFolder *vfolder,
 128                                                          struct _CamelVeeMessageInfoData *mi_data,
 129                                                          CamelFolderChangeInfo *changes);
 130 void            camel_vee_folder_remove_vuid            (CamelVeeFolder *vfolder,
 131                                                          struct _CamelVeeMessageInfoData *mi_data,
 132                                                          CamelFolderChangeInfo *changes);
 133
 134 void            camel_vee_folder_rebuild_folder         (CamelVeeFolder *vfolder,
 135                                                          CamelFolder *subfolder,
 136                                                          GCancellable *cancellable);
 137 void            camel_vee_folder_set_expression         (CamelVeeFolder *vfolder,
 138                                                          const gchar *expr);
 139 const gchar *   camel_vee_folder_get_expression         (CamelVeeFolder *vfolder);
 140
 141 void            camel_vee_folder_ignore_next_changed_event
 142                                                         (CamelVeeFolder *vfolder,
 143                                                          CamelFolder *subfolder);
 144
 145 void            camel_vee_folder_lock                   (CamelVeeFolder *folder,
 146                                                          CamelVeeFolderLock lock);
 147 void            camel_vee_folder_unlock                 (CamelVeeFolder *folder,
 148                                                          CamelVeeFolderLock lock);
 149
 150 G_END_DECLS
 151
 152 #endif /* CAMEL_VEE_FOLDER_H */