Enable address search.
[claws.git] / src / addritem.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2002 Hiroyuki Yamamoto
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  * Address item data.
22  */
23
24 #ifndef __ADDRITEM_H__
25 #define __ADDRITEM_H__
26
27 #include <stdio.h>
28 #include <glib.h>
29
30 #define ADDRITEM_OBJECT(obj)    ((AddrItemObject *)obj)
31 #define ADDRITEM_TYPE(obj)      (ADDRITEM_OBJECT(obj)->type)
32 #define ADDRITEM_NAME(obj)      (ADDRITEM_OBJECT(obj)->name)
33 #define ADDRITEM_ID(obj)        (ADDRITEM_OBJECT(obj)->uid)
34 #define ADDRITEM_PARENT(obj)    (ADDRITEM_OBJECT(obj)->parent)
35 #define ADDRITEM_SUBTYPE(obj)   (ADDRITEM_OBJECT(obj)->subType)
36
37 typedef enum {
38         ITEMTYPE_NONE,
39         ITEMTYPE_PERSON,
40         ITEMTYPE_EMAIL,
41         ITEMTYPE_FOLDER,
42         ITEMTYPE_GROUP,
43         ITEMTYPE_INDEX,
44         ITEMTYPE_INTERFACE,
45         ITEMTYPE_DATASOURCE
46 } ItemObjectType;
47
48 typedef enum {
49         ADDRFOLDER_NONE,
50         ADDRFOLDER_ROOT,
51         ADDRFOLDER_REGULAR,
52         ADDRFOLDER_CATEGORY,
53         ADDRFOLDER_LDAP_QUERY
54 } AddressFolderType;
55
56 typedef struct _AddrItemObject AddrItemObject;
57 struct _AddrItemObject {
58         ItemObjectType type;
59         gchar          *name;
60         gchar          *uid;
61         AddrItemObject *parent;
62         gint           subType;
63 };
64
65 typedef struct _ItemPerson ItemPerson;
66 struct _ItemPerson {
67         AddrItemObject obj;
68         gchar    *firstName;
69         gchar    *lastName;
70         gchar    *nickName;
71         gchar    *externalID;
72         GList    *listEMail;
73         GList    *listAttrib;
74         gboolean isOpened;
75 };
76
77 typedef struct _ItemEMail ItemEMail;
78 struct _ItemEMail {
79         AddrItemObject obj;
80         gchar *address;
81         gchar *remarks;
82 };
83
84 typedef struct _UserAttribute UserAttribute;
85 struct _UserAttribute {
86         gchar *uid;
87         gchar *name;
88         gchar *value;
89 };
90
91 typedef struct _ItemFolder ItemFolder;
92 struct _ItemFolder {
93         AddrItemObject obj;
94         gchar    *remarks;
95         gboolean isRoot;        /* TRUE if root folder */
96         GList    *listItems;    /* Used for temporary items only */
97         GList    *listFolder;   /* List of contained (child) folders */
98         GList    *listPerson;   /* List of contained persons */
99         GList    *listGroup;    /* List of contained (child) groups */
100         AddressFolderType folderType;   /* Folder type */
101         gpointer *folderData;           /* Pointer to folder's data */
102 };
103
104 typedef struct _ItemGroup ItemGroup;
105 struct _ItemGroup {
106         AddrItemObject obj;
107         gchar *remarks;
108         GList *listEMail;
109 };
110
111 /* Function prototypes */
112 ItemEMail *addritem_create_item_email   ( void );
113 ItemEMail *addritem_copy_item_email     ( ItemEMail *item );
114 ItemEMail *addritem_copyfull_item_email ( ItemEMail *item );
115 void addritem_email_set_id              ( ItemEMail *email, const gchar *value );
116 void addritem_email_set_alias           ( ItemEMail *email, const gchar *value );
117 void addritem_email_set_address         ( ItemEMail *email, const gchar *value );
118 void addritem_email_set_remarks         ( ItemEMail *email, const gchar *value );
119 void addritem_free_item_email           ( ItemEMail *item );
120
121 UserAttribute *addritem_create_attribute( void );
122 UserAttribute *addritem_copy_attribute  ( UserAttribute *item );
123 void addritem_attrib_set_id             ( UserAttribute *item, const gchar *value );
124 void addritem_attrib_set_name           ( UserAttribute *item, const gchar *value );
125 void addritem_attrib_set_value          ( UserAttribute *item, const gchar *value );
126 void addritem_free_attribute            ( UserAttribute *item );
127
128 ItemPerson *addritem_create_item_person ( void );
129 ItemPerson *addritem_copy_item_person   ( ItemPerson *item );
130 void addritem_person_set_id             ( ItemPerson *person, const gchar *value );
131 void addritem_person_set_first_name     ( ItemPerson *person, const gchar *value );
132 void addritem_person_set_last_name      ( ItemPerson *person, const gchar *value );
133 void addritem_person_set_nick_name      ( ItemPerson *person, const gchar *value );
134 void addritem_person_set_common_name    ( ItemPerson *person, const gchar *value );
135 void addritem_person_set_external_id    ( ItemPerson *person, const gchar *value );
136 void addritem_person_set_opened         ( ItemPerson *person, const gboolean value );
137 void addritem_free_item_person          ( ItemPerson *person );
138 gboolean addritem_person_empty          ( ItemPerson *person );
139 void addritem_free_list_email           ( GList *list );
140 void addritem_free_list_attribute       ( GList *list );
141
142 ItemGroup *addritem_create_item_group   ( void );
143 ItemGroup *addritem_copy_item_group     ( ItemGroup *item );
144 void addritem_free_item_group           ( ItemGroup *group );
145 void addritem_group_set_id              ( ItemGroup *group, const gchar *value );
146 void addritem_group_set_name            ( ItemGroup *group, const gchar *value );
147 void addritem_group_set_remarks         ( ItemGroup *group, const gchar *value );
148
149 void addritem_print_item_email          ( ItemEMail *item, FILE *stream );
150 void addritem_print_attribute           ( UserAttribute *item, FILE *stream );
151 void addritem_print_item_person         ( ItemPerson *person, FILE *stream );
152 void addritem_print_item_group          ( ItemGroup *group, FILE *stream );
153 void addritem_print_item_folder         ( ItemFolder *folder, FILE *stream );
154 void addritem_print_item                ( AddrItemObject *aio, FILE *stream );
155
156 gboolean addritem_person_add_email              ( ItemPerson *person, ItemEMail *email );
157 ItemEMail *addritem_person_get_email            ( ItemPerson *person, const gchar *eid );
158 ItemEMail *addritem_person_remove_email_id      ( ItemPerson *person, const gchar *eid );
159 ItemEMail *addritem_person_remove_email         ( ItemPerson *person, ItemEMail *email );
160
161 void addritem_person_add_attribute              ( ItemPerson *person, UserAttribute *attrib );
162 UserAttribute *addritem_person_get_attribute    ( ItemPerson *person, const gchar *aid );
163 UserAttribute *addritem_person_remove_attrib_id ( ItemPerson *person, const gchar *aid );
164 UserAttribute *addritem_person_remove_attribute ( ItemPerson *person, UserAttribute *attrib );
165
166 ItemFolder *addritem_create_item_folder ( void );
167 ItemFolder *addritem_copy_item_folder   ( ItemFolder *item );
168 void addritem_folder_set_id             ( ItemFolder *folder, const gchar *value );
169 void addritem_folder_set_name           ( ItemFolder *folder, const gchar *value );
170 void addritem_folder_set_remarks        ( ItemFolder *folder, const gchar *value );
171 void addritem_free_item_folder          ( ItemFolder *folder );
172 void addritem_free_item_folder_recurse  ( ItemFolder *parent );
173
174 gboolean addritem_group_add_email       ( ItemGroup *group, ItemEMail *email );
175 ItemEMail *addritem_group_remove_email  ( ItemGroup *group, ItemEMail *email );
176 ItemEMail *addritem_group_remove_email_id( ItemGroup *group, const gchar *eid );
177
178 gboolean addritem_folder_add_person     ( ItemFolder *folder, ItemPerson *item );
179 gboolean addritem_folder_add_folder     ( ItemFolder *folder, ItemFolder *item );
180 gboolean addritem_folder_add_group      ( ItemFolder *folder, ItemGroup *item );
181 void addritem_folder_free_person        ( ItemFolder *folder );
182 GList *addritem_folder_get_person_list  ( ItemFolder *folder );
183 GList *addritem_folder_get_group_list   ( ItemFolder *folder );
184
185 ItemEMail *addritem_move_email_before   ( ItemPerson *person,
186                                           ItemEMail *itemMove,
187                                           ItemEMail *itemTarget );
188 ItemEMail *addritem_move_email_after    ( ItemPerson *person,
189                                           ItemEMail *itemMove,
190                                           ItemEMail *itemTarget );
191
192 void addritem_parse_first_last          ( ItemPerson *person );
193 GList *addritem_folder_path             ( const ItemFolder *folder,
194                                           const gboolean seq );
195 gchar *addritem_format_email            ( ItemEMail *email );
196
197 #endif /* __ADDRITEM_H__ */