New address book.
[claws.git] / src / addrbook.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright            (C) 2001 Match Grun
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  *              (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Definitions necessary to access external address book files.
22  */
23
24 #ifndef __ADDRBOOK_H__
25 #define __ADDRBOOK_H__
26
27 #include <stdio.h>
28 #include <glib.h>
29 #include <setjmp.h>
30
31 #include "addritem.h"
32 #include "addrcache.h"
33
34 // Address book file.
35 typedef struct _AddressBookFile AddressBookFile;
36 struct _AddressBookFile {
37         gchar *name;
38         gchar *path;
39         gchar *fileName;
40         AddressCache *addressCache;
41         gint  retVal;
42         gint  maxValue;
43         GList *tempList;
44         GHashTable *tempHash;
45         gboolean readFlag;
46         gboolean dirtyFlag;
47         gboolean modifyFlag;
48         gboolean accessFlag;
49         jmp_buf jumper;
50 };
51
52 // Function prototypes
53
54 AddressBookFile *addrbook_create_book   ( void );
55 void addrbook_empty_book                ( AddressBookFile *book );
56 void addrbook_free_book                 ( AddressBookFile *book );
57 void addrbook_print_book                ( AddressBookFile *book, FILE *stream );
58 void addrbook_dump_hash                 ( AddressBookFile *book, FILE *stream );
59 void addrbook_dump_book                 ( AddressBookFile *book, FILE *stream );
60 void addrbook_set_name                  ( AddressBookFile *book, const gchar *value );
61 void addrbook_set_path                  ( AddressBookFile *book, const gchar *value );
62 void addrbook_set_file                  ( AddressBookFile *book, const gchar *value );
63 void addrbook_set_accessed              ( AddressBookFile *book, const gboolean value );
64 gboolean addrbook_get_modified          ( AddressBookFile *book );
65 gboolean addrbook_get_accessed          ( AddressBookFile *book );
66 gboolean addrbook_get_read_flag         ( AddressBookFile *book );
67 gint addrbook_get_status                ( AddressBookFile *book );
68 ItemFolder *addrbook_get_root_folder    ( AddressBookFile *book );
69 GList *addrbook_get_list_folder         ( AddressBookFile *book );
70 GList *addrbook_get_list_person         ( AddressBookFile *book );
71 gchar *addrbook_get_name                ( AddressBookFile *book );
72
73 ItemPerson *addrbook_remove_person      ( AddressBookFile *book, ItemPerson *person );
74 ItemGroup *addrbook_remove_group        ( AddressBookFile *book, ItemGroup *group );
75 ItemEMail *addrbook_person_remove_email ( AddressBookFile *book, ItemPerson *person,
76                                           ItemEMail *email );
77
78 gint addrbook_read_data                 ( AddressBookFile *book );
79 gint addrbook_save_data                 ( AddressBookFile *book );
80
81 ItemEMail *addrbook_move_email_before   ( AddressBookFile *book, ItemPerson *person,
82                                           ItemEMail *itemMove, ItemEMail *itemTarget );
83 ItemEMail *addrbook_move_email_after    ( AddressBookFile *book, ItemPerson *person,
84                                           ItemEMail *itemMove, ItemEMail *itemTarget );
85
86 void addrbook_update_address_list       ( AddressBookFile *book, ItemPerson *person,
87                                           GList *listEMail );
88 ItemPerson *addrbook_add_address_list   ( AddressBookFile *book, ItemFolder *folder,
89                                           GList *listEMail );
90 GList *addrbook_get_available_email_list( AddressBookFile *book, ItemGroup *group );
91 void addrbook_update_group_list         ( AddressBookFile *book, ItemGroup *group,
92                                           GList *listEMail );
93 ItemGroup *addrbook_add_group_list      ( AddressBookFile *book, ItemFolder *folder,
94                                           GList *listEMail );
95 ItemFolder *addrbook_add_new_folder     ( AddressBookFile *book, ItemFolder *parent );
96
97 ItemFolder *addrbook_remove_folder      ( AddressBookFile *book, ItemFolder *folder );
98 ItemFolder *addrbook_remove_folder_delete( AddressBookFile *book, ItemFolder *folder );
99
100 GList *addrbook_get_bookfile_list       ( AddressBookFile *book );
101 gchar *addrbook_gen_new_file_name       ( gint fileNum );
102 gint addrbook_test_read_file            ( AddressBookFile *book, gchar *fileName );
103
104 GList *addrbook_get_all_persons         ( AddressBookFile *book );
105
106 ItemPerson *addrbook_add_contact        ( AddressBookFile *book, ItemFolder *folder,
107                                           const gchar *name, const gchar *address,
108                                           const gchar *remarks );
109
110 #endif /* __ADDRBOOK_H__ */
111
112 /*
113 * End of Source.
114 */
115
116