aboutsummaryrefslogtreecommitdiffstats
path: root/shell/e-storage.h
blob: bd0cc5da2214620a74257eec53656ad895e7a095 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-storage.h
 *
 * Copyright (C) 2000  Ximian, Inc.
 *
 * 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.
 *
 * Author: Ettore Perazzoli
 */

#ifndef _E_STORAGE_H_
#define _E_STORAGE_H_

#include <gtk/gtkobject.h>

#include "evolution-shell-component-client.h"

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

#define E_TYPE_STORAGE          (e_storage_get_type ())
#define E_STORAGE(obj)          (GTK_CHECK_CAST ((obj), E_TYPE_STORAGE, EStorage))
#define E_STORAGE_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), E_TYPE_STORAGE, EStorageClass))
#define E_IS_STORAGE(obj)       (GTK_CHECK_TYPE ((obj), E_TYPE_STORAGE))
#define E_IS_STORAGE_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((obj), E_TYPE_STORAGE))


typedef struct _EStorage        EStorage;
typedef struct _EStoragePrivate EStoragePrivate;
typedef struct _EStorageClass   EStorageClass;

enum _EStorageResult {
    E_STORAGE_OK,
    E_STORAGE_GENERICERROR,
    E_STORAGE_EXISTS,
    E_STORAGE_INVALIDTYPE,
    E_STORAGE_IOERROR,
    E_STORAGE_NOSPACE,
    E_STORAGE_NOTEMPTY,
    E_STORAGE_NOTFOUND,
    E_STORAGE_NOTIMPLEMENTED,
    E_STORAGE_PERMISSIONDENIED,
    E_STORAGE_UNSUPPORTEDOPERATION,
    E_STORAGE_UNSUPPORTEDTYPE,
    E_STORAGE_CANTCHANGESTOCKFOLDER,
    E_STORAGE_CANTMOVETODESCENDANT,
    E_STORAGE_NOTONLINE,
    E_STORAGE_INVALIDNAME
};
typedef enum _EStorageResult EStorageResult;

typedef void (* EStorageResultCallback) (EStorage *storage, EStorageResult result, void *data);
typedef void (* EStorageDiscoveryCallback) (EStorage *storage, EStorageResult result, const char *path, void *data);

#include "e-folder.h"

struct _EStorage {
    GtkObject parent;

    EStoragePrivate *priv;
};

struct _EStorageClass {
    GtkObjectClass parent_class;

    /* Signals.  */

    void (* new_folder)     (EStorage *storage, const char *path);
    void (* updated_folder) (EStorage *storage, const char *path);
    void (* removed_folder) (EStorage *storage, const char *path);
    void (* close_folder)   (EStorage *storage, const char *path);

    /* Virtual methods.  */

    GList      * (* get_subfolder_paths)     (EStorage *storage,
                          const char *path);
    EFolder    * (* get_folder)              (EStorage *storage,
                          const char *path);
    const char * (* get_name)                (EStorage *storage);

    void         (* async_create_folder)  (EStorage *storage,
                           const char *path,
                           const char *type,
                           const char *description,
                           EStorageResultCallback callback,
                           void *data);

    void         (* async_remove_folder)  (EStorage *storage,
                           const char *path,
                           EStorageResultCallback callback,
                           void *data);

    void         (* async_xfer_folder)    (EStorage *storage,
                           const char *source_path,
                           const char *destination_path,
                           const gboolean remove_source,
                           EStorageResultCallback callback,
                           void *data);

    void         (* async_open_folder)    (EStorage *storage,
                           const char *path,
                           EStorageDiscoveryCallback callback,
                           void *data);

    gboolean     (* supports_shared_folders)       (EStorage *storage);
    void         (* async_discover_shared_folder)  (EStorage *storage,
                                const char *owner,
                                const char *folder_name,
                                EStorageDiscoveryCallback callback,
                                void *data);
    void         (* cancel_discover_shared_folder) (EStorage *storage,
                            const char *owner,
                            const char *folder_name);
    void         (* async_remove_shared_folder)    (EStorage *storage,
                                const char *path,
                                EStorageResultCallback callback,
                                void *data);
};


GtkType     e_storage_get_type                (void);
void        e_storage_construct               (EStorage   *storage,
                           const char *name,
                           EFolder    *root_folder);
EStorage   *e_storage_new                     (const char *name,
                           EFolder    *root_folder);

gboolean    e_storage_path_is_relative        (const char *path);
gboolean    e_storage_path_is_absolute        (const char *path);

GList      *e_storage_get_subfolder_paths     (EStorage   *storage,
                           const char *path);
EFolder    *e_storage_get_folder              (EStorage   *storage,
                           const char *path);

const char *e_storage_get_name                (EStorage *storage);

/* Folder operations.  */

void  e_storage_async_create_folder  (EStorage               *storage,
                      const char             *path,
                      const char             *type,
                      const char             *description,
                      EStorageResultCallback  callback,
                      void                   *data);
void  e_storage_async_remove_folder  (EStorage               *storage,
                      const char             *path,
                      EStorageResultCallback  callback,
                      void                   *data);
void  e_storage_async_xfer_folder    (EStorage               *storage,
                      const char             *source_path,
                      const char             *destination_path,
                      const gboolean          remove_source,
                      EStorageResultCallback  callback,
                      void                   *data);
void  e_storage_async_open_folder    (EStorage                  *storage,
                      const char                *path,
                      EStorageDiscoveryCallback  callback,
                      void                      *data);

const char *e_storage_result_to_string  (EStorageResult result);

/* Shared folders.  */
gboolean    e_storage_supports_shared_folders       (EStorage                 *storage);
void        e_storage_async_discover_shared_folder  (EStorage                 *storage,
                             const char               *owner,
                             const char               *folder_name,
                             EStorageDiscoveryCallback callback,
                             void                     *data);
void        e_storage_cancel_discover_shared_folder (EStorage                 *storage,
                             const char               *owner,
                             const char               *folder_name);
void        e_storage_async_remove_shared_folder    (EStorage                 *storage,
                             const char               *path,
                             EStorageResultCallback    callback,
                             void                     *data);

/* Utility functions.  */

char *e_storage_get_path_for_physical_uri  (EStorage   *storage,
                        const char *physical_uri);

/* Protected.  C++ anyone?  */
gboolean e_storage_new_folder             (EStorage   *storage,
                       const char *path,
                       EFolder    *folder);
gboolean e_storage_removed_folder         (EStorage   *storage,
                       const char *path);

gboolean e_storage_declare_has_subfolders (EStorage   *storage,
                       const char *path,
                       const char *message);
gboolean e_storage_get_has_subfolders     (EStorage   *storage,
                       const char *path);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _E_STORAGE_H_ */