Do ignore empty recipients when checking names
[modest] / src / widgets / modest-recpt-editor.h
1 /* Copyright (c) 2007, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef MODEST_RECPT_EDITOR_H
31 #define MODEST_RECPT_EDITOR_H
32 #include <glib-object.h>
33 #include <gtk/gtkhbox.h>
34 #include <gtk/gtksizegroup.h>
35 #include <gtk/gtktextbuffer.h>
36
37 G_BEGIN_DECLS
38
39 #define MODEST_TYPE_RECPT_EDITOR             (modest_recpt_editor_get_type ())
40 #define MODEST_RECPT_EDITOR(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), MODEST_TYPE_RECPT_EDITOR, ModestRecptEditor))
41 #define MODEST_RECPT_EDITOR_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), MODEST_TYPE_RECPT_EDITOR, ModestRecptEditorClass))
42 #define MODEST_IS_RECPT_EDITOR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MODEST_TYPE_RECPT_EDITOR))
43 #define MODEST_IS_RECPT_EDITOR_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), MODEST_TYPE_RECPT_EDITOR))
44 #define MODEST_RECPT_EDITOR_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), MODEST_TYPE_RECPT_EDITOR, ModestRecptEditorClass))
45
46 typedef struct _ModestRecptEditor ModestRecptEditor;
47 typedef struct _ModestRecptEditorClass ModestRecptEditorClass;
48
49 struct _ModestRecptEditor
50 {
51         GtkHBox parent;
52
53 };
54
55 struct _ModestRecptEditorClass
56 {
57         GtkHBoxClass parent_class;
58
59         /* signals */
60
61         void (*open_addressbook) (ModestRecptEditor *editor);
62 };
63
64 GType modest_recpt_editor_get_type (void);
65
66 GtkWidget* modest_recpt_editor_new (void);
67
68 void modest_recpt_editor_set_recipients (ModestRecptEditor *recpt_editor, const gchar *recipients);
69 const gchar *modest_recpt_editor_get_recipients (ModestRecptEditor *repct_editor);
70 void modest_recpt_editor_add_recipients (ModestRecptEditor *recpt_editor, const gchar *recipients);
71 void modest_recpt_editor_add_resolved_recipient (ModestRecptEditor *recpt_editor, 
72                                                  GSList *email_list, 
73                                                  const gchar * recipient_id);
74 void modest_recpt_editor_replace_with_resolved_recipient (ModestRecptEditor *recpt_editor, 
75                                                           GtkTextIter *start, GtkTextIter *end,
76                                                           GSList *email_list, 
77                                                           const gchar *recipient_id);
78
79 void modest_recpt_editor_replace_with_resolved_recipients (ModestRecptEditor *recpt_editor, 
80                                                            GtkTextIter *start, GtkTextIter *end,
81                                                            GSList *email_lists_list, 
82                                                            GSList *recipient_ids_list);
83
84 void modest_recpt_editor_set_field_size_group (ModestRecptEditor *recpt_editor, GtkSizeGroup *size_group);
85 GtkTextBuffer *modest_recpt_editor_get_buffer (ModestRecptEditor *recpt_editor);
86 void modest_recpt_editor_grab_focus (ModestRecptEditor *recpt_editor);
87 gboolean modest_recpt_editor_has_focus (ModestRecptEditor *recpt_editor);
88 void modest_recpt_editor_set_show_abook_button (ModestRecptEditor *recpt_editor, gboolean show);
89 gboolean modest_recpt_editor_get_show_abook_button (ModestRecptEditor *recpt_editor, gboolean show);
90
91 G_END_DECLS
92
93 #endif