path: root/camel/camel-vee-folder.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2000 Ximian Inc.
 *
 * Authors: Michael Zucchi <notzed@ximian.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef _CAMEL_VEE_FOLDER_H
#define _CAMEL_VEE_FOLDER_H

#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus */

#include <glib.h>
#include <camel/camel-folder.h>
#include <camel/camel-vee-summary.h>

#define CAMEL_VEE_FOLDER(obj)         CAMEL_CHECK_CAST (obj, camel_vee_folder_get_type (), CamelVeeFolder)
#define CAMEL_VEE_FOLDER_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_vee_folder_get_type (), CamelVeeFolderClass)
#define CAMEL_IS_VEE_FOLDER(obj)      CAMEL_CHECK_TYPE (obj, camel_vee_folder_get_type ())

typedef struct _CamelVeeFolder      CamelVeeFolder;
typedef struct _CamelVeeFolderClass CamelVeeFolderClass;

struct _CamelVeeFolder {
    CamelFolder parent;

    struct _CamelVeeFolderPrivate *priv;

    char *expression;   /* query expression */

    guint32 flags;      /* folder open flags */

    CamelFolderChangeInfo *changes;
    CamelFolderSearch *search;

    /* only set-up if our parent is a vee-store, used also as a flag to
     * say that this folder is part of the unmatched folder */
    struct _CamelVeeStore *parent_vee_store;
};

struct _CamelVeeFolderClass {
    CamelFolderClass parent_class;

    /* TODO: Some of this may need some additional work/thinking through, it works for now*/

    void (*add_folder)(CamelVeeFolder *, CamelFolder *);
    void (*remove_folder)(CamelVeeFolder *, CamelFolder *);
    int (*rebuild_folder)(CamelVeeFolder *, CamelFolder *, CamelException *);

    void (*set_expression)(CamelVeeFolder *, const char *);

    /* Called for a folder-changed event on a source folder */
    void (*folder_changed)(CamelVeeFolder *, CamelFolder *sub, CamelFolderChangeInfo *changes);
    /* Called for a folder-renamed event on a source folder */
    void (*folder_renamed)(CamelVeeFolder *, CamelFolder *sub, const char *old);
};

#define CAMEL_UNMATCHED_NAME "UNMATCHED"

CamelType         camel_vee_folder_get_type     (void);
CamelFolder  *camel_vee_folder_new      (CamelStore *parent_store, const char *name, guint32 flags);
void         camel_vee_folder_construct     (CamelVeeFolder *vf, CamelStore *parent_store, const char *name, guint32 flags);

CamelFolder *camel_vee_folder_get_location(CamelVeeFolder *vf, const struct _CamelVeeMessageInfo *vinfo, char **realuid);

void         camel_vee_folder_add_folder        (CamelVeeFolder *vf, CamelFolder *sub);
void         camel_vee_folder_remove_folder     (CamelVeeFolder *vf, CamelFolder *sub);
void         camel_vee_folder_set_folders   (CamelVeeFolder *vf, GList *folders);
int          camel_vee_folder_rebuild_folder(CamelVeeFolder *vf, CamelFolder *sub, CamelException *ex);
void         camel_vee_folder_set_expression    (CamelVeeFolder *vf, const char *expr);

void         camel_vee_folder_hash_folder   (CamelFolder *folder, char buffer[8]);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* ! _CAMEL_VEE_FOLDER_H */