9a472934f5
1999-05-04 bertrand <Bertrand.Guiheneuf@inria.fr> * camel/camel-service.c (camel_service_get_url): new method. * devel-docs/camel/camel-sections.txt: added function doc references * camel/camel-folder.c (__camel_folder_close): fixed indentation. (camel_folder_expunge): new method. (__camel_folder_close): used expunge flag svn path=/trunk/; revision=890
127 lines
3.9 KiB
C
127 lines
3.9 KiB
C
/* -*- 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, CamelFolderOpenMode mode);
|
|
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);
|
|
CamelFolder * (*get_parent_folder) (CamelFolder *folder);
|
|
CamelStore * (*get_parent_store) (CamelFolder *folder);
|
|
CamelFolderOpenMode (*get_mode) (CamelFolder *folder);
|
|
GList * (*list_subfolders) (CamelFolder *folder);
|
|
GList * (*expunge) (CamelFolder *folder);
|
|
} CamelFolderClass;
|
|
|
|
|
|
|
|
/* Standard Gtk function */
|
|
GtkType camel_folder_get_type (void);
|
|
|
|
|
|
/* public methods */
|
|
CamelFolder *camel_folder_get_folder(CamelFolder *folder, GString *folder_name);
|
|
gboolean camel_folder_create(CamelFolder *folder);
|
|
gboolean camel_folder_delete (CamelFolder *folder, gboolean recurse);
|
|
gboolean camel_folder_delete_messages (CamelFolder *folder);
|
|
CamelFolder *camel_folder_get_parent_folder (CamelFolder *folder);
|
|
CamelStore *camel_folder_get_parent_store (CamelFolder *folder);
|
|
CamelFolderOpenMode camel_folder_get_mode(CamelFolder *folder);
|
|
GList *camel_folder_list_subfolders(CamelFolder *folder);
|
|
GList *camel_folder_expunge(CamelFolder *folder);
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* CAMEL_FOLDER_H */
|