aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-folder.h
blob: 9df16156e44a18acb91ae4223899a3d4050bfb4c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelFolder.h : Abstract class for an email folder */

/* 
 *
 * Copyright (C) 1999 Bertrand Guiheneuf <Bertrand.Guiheneuf@inria.fr> .
 *
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * 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_FOLDER_H
#define CAMEL_FOLDER_H 1


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

#include <gtk/gtk.h>

typedef struct _CamelFolder CamelFolder;

#include "camel-store.h"

#define CAMEL_FOLDER_TYPE     (camel_folder_get_type ())
#define CAMEL_FOLDER(obj)     (GTK_CHECK_CAST((obj), CAMEL_FOLDER_TYPE, CamelFolder))
#define CAMEL_FOLDER_CLASS(k) (GTK_CHECK_CLASS_CAST ((k), CAMEL_FOLDER_TYPE, CamelFolderClass))
#define IS_CAMEL_FOLDER(o)    (GTK_CHECK_TYPE((o), CAMEL_FOLDER_TYPE))

typedef enum {
    FOLDER_OPEN,
    FOLDER_CLOSE
} CamelFolderState;

typedef enum {
    FOLDER_OPEN_UNKNOWN,   /* folder open mode is unknown */
    FOLDER_OPEN_READ,      /* folder is read only         */ 
    FOLDER_OPEN_READ_WRITE /* folder is read/write        */ 
} CamelFolderOpenMode;



struct _CamelFolder
{
    GtkObject parent_object;

    GList *message_list;
    gboolean can_hold_folders;
    gboolean can_hold_messages;
    gboolean exists_on_store;
    CamelFolderOpenMode open_mode;
    CamelFolderState open_state;
    GString *name;
    GString *full_name;
    CamelStore *parent_store;
    CamelFolder *parent_folder;
    
};



typedef struct {
    GtkObjectClass parent_class;

    /* Virtual methods */   
    void   (*init_with_store) (CamelFolder *folder, CamelStore *parent_store);
    void   (*open) (CamelFolder *object);
    void   (*close) (CamelFolder *folder, gboolean expunge);
    void   (*set_name) (CamelFolder *folder, GString *name);
    void   (*set_full_name) (CamelFolder *folder, GString *name);
    GString *  (*get_name) (CamelFolder *folder);
    GString *  (*get_full_name) (CamelFolder *folder);
    gboolean   (*can_hold_folders) (CamelFolder *folder);
    gboolean   (*can_hold_messages) (CamelFolder *folder);
    gboolean   (*exists) (CamelFolder *folder);
    gboolean   (*is_open) (CamelFolder *folder);
    CamelFolder *  (*get_folder) (CamelFolder *folder, GString *folder_name);
    gboolean   (*create) (CamelFolder *folder);
    gboolean   (*delete) (CamelFolder *folder, gboolean recurse);
    gboolean   (*delete_messages) (CamelFolder *folder);
} CamelFolderClass;



/* Standard Gtk function */
GtkType camel_folder_get_type (void);


/* public methods */
gboolean camel_folder_create(CamelFolder *folder);
gboolean camel_folder_delete (CamelFolder *folder, gboolean recurse);
gboolean camel_folder_delete_messages (CamelFolder *folder);



#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* CAMEL_FOLDER_H */