camel/camel-vee-folder.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2000 Ximian Inc.
   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
  23 #ifndef _CAMEL_VEE_FOLDER_H
  24 #define _CAMEL_VEE_FOLDER_H
  25
  26 #include <glib.h>
  27 #include <camel/camel-folder.h>
  28 #include <camel/camel-vee-summary.h>
  29
  30 #define CAMEL_VEE_FOLDER(obj)         CAMEL_CHECK_CAST (obj, camel_vee_folder_get_type (), CamelVeeFolder)
  31 #define CAMEL_VEE_FOLDER_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_vee_folder_get_type (), CamelVeeFolderClass)
  32 #define CAMEL_IS_VEE_FOLDER(obj)      CAMEL_CHECK_TYPE (obj, camel_vee_folder_get_type ())
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _CamelVeeFolder      CamelVeeFolder;
  37 typedef struct _CamelVeeFolderClass CamelVeeFolderClass;
  38
  39 struct _CamelVeeFolder {
  40         CamelFolder parent;
  41
  42         struct _CamelVeeFolderPrivate *priv;
  43
  44         char *expression;       /* query expression */
  45
  46         guint32 flags;          /* folder open flags */
  47
  48         CamelFolderChangeInfo *changes;
  49         CamelFolderSearch *search;
  50
  51         /* only set-up if our parent is a vee-store, used also as a flag to
  52          * say that this folder is part of the unmatched folder */
  53         struct _CamelVeeStore *parent_vee_store;
  54 };
  55
  56 struct _CamelVeeFolderClass {
  57         CamelFolderClass parent_class;
  58
  59         /* TODO: Some of this may need some additional work/thinking through, it works for now*/
  60
  61         void (*add_folder)(CamelVeeFolder *, CamelFolder *);
  62         void (*remove_folder)(CamelVeeFolder *, CamelFolder *);
  63         int (*rebuild_folder)(CamelVeeFolder *, CamelFolder *, CamelException *);
  64
  65         void (*set_expression)(CamelVeeFolder *, const char *);
  66
  67         /* Called for a folder-changed event on a source folder */
  68         void (*folder_changed)(CamelVeeFolder *, CamelFolder *sub, CamelFolderChangeInfo *changes);
  69         /* Called for a folder-renamed event on a source folder */
  70         void (*folder_renamed)(CamelVeeFolder *, CamelFolder *sub, const char *old);
  71 };
  72
  73 #define CAMEL_UNMATCHED_NAME "UNMATCHED"
  74
  75 CamelType             camel_vee_folder_get_type         (void);
  76 CamelFolder  *camel_vee_folder_new              (CamelStore *parent_store, const char *name, guint32 flags);
  77 void         camel_vee_folder_construct         (CamelVeeFolder *vf, CamelStore *parent_store, const char *full, const char *name, guint32 flags);
  78
  79 CamelFolder *camel_vee_folder_get_location(CamelVeeFolder *vf, const struct _CamelVeeMessageInfo *vinfo, char **realuid);
  80
  81 void         camel_vee_folder_add_folder        (CamelVeeFolder *vf, CamelFolder *sub);
  82 void         camel_vee_folder_remove_folder     (CamelVeeFolder *vf, CamelFolder *sub);
  83 void         camel_vee_folder_set_folders       (CamelVeeFolder *vf, GList *folders);
  84 int          camel_vee_folder_rebuild_folder(CamelVeeFolder *vf, CamelFolder *sub, CamelException *ex);
  85 void         camel_vee_folder_set_expression    (CamelVeeFolder *vf, const char *expr);
  86
  87 void         camel_vee_folder_hash_folder       (CamelFolder *folder, char buffer[8]);
  88
  89 G_END_DECLS
  90
  91 #endif /* ! _CAMEL_VEE_FOLDER_H */