Fixes NB#111978, show the proper plural form if we have multiple attachments in a...
[modest] / src / widgets / modest-attachments-view.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_ATTACHMENTS_VIEW_H
31 #define MODEST_ATTACHMENTS_VIEW_H
32 #include <gtk/gtk.h>
33 #include <glib-object.h>
34 #include <tny-msg.h>
35
36 #define MODEST_ATTACHMENTS_VIEW_SELECTION_PREFIX "modest-attachment:"
37 #define MODEST_ATTACHMENTS_VIEW_CLIPBOARD_TYPE "MODEST_ATTACHMENT"
38 #define MODEST_ATTACHMENTS_VIEW_CLIPBOARD_TYPE_INDEX 0
39
40 G_BEGIN_DECLS
41
42 #define MODEST_TYPE_ATTACHMENTS_VIEW             (modest_attachments_view_get_type ())
43 #define MODEST_ATTACHMENTS_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), MODEST_TYPE_ATTACHMENTS_VIEW, ModestAttachmentsView))
44 #define MODEST_ATTACHMENTS_VIEW_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), MODEST_TYPE_ATTACHMENTS_VIEW, ModestAttachmentsViewClass))
45 #define MODEST_IS_ATTACHMENTS_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MODEST_TYPE_ATTACHMENTS_VIEW))
46 #define MODEST_IS_ATTACHMENTS_VIEW_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), MODEST_TYPE_ATTACHMENTS_VIEW))
47 #define MODEST_ATTACHMENTS_VIEW_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), MODEST_TYPE_ATTACHMENTS_VIEW, ModestAttachmentsViewClass))
48
49 typedef enum _ModestAttachmentsViewStyle {
50         MODEST_ATTACHMENTS_VIEW_STYLE_SELECTABLE,
51         MODEST_ATTACHMENTS_VIEW_STYLE_LINKS,
52         MODEST_ATTACHMENTS_VIEW_STYLE_NO_FOCUS,
53 } ModestAttachmentsViewStyle;
54
55 typedef struct _ModestAttachmentsView ModestAttachmentsView;
56 typedef struct _ModestAttachmentsViewClass ModestAttachmentsViewClass;
57
58 struct _ModestAttachmentsView
59 {
60         GtkEventBox parent;
61
62 };
63
64 struct _ModestAttachmentsViewClass
65 {
66         GtkEventBoxClass parent_class;
67
68         void (*activate)           (ModestAttachmentsView *attachments_view, TnyMimePart *mime_part);
69         void (*delete)             (ModestAttachmentsView *attachments_view, TnyMimePart *mime_part);
70 };
71
72 GType modest_attachments_view_get_type (void);
73
74 GtkWidget* modest_attachments_view_new (TnyMsg *msg);
75
76 void modest_attachments_view_set_message (ModestAttachmentsView *attachments_view, TnyMsg *msg);
77 void modest_attachments_view_add_attachment (ModestAttachmentsView *attachments_view, TnyMimePart *part,
78                                              gboolean detect_size, guint64 size);
79 void modest_attachments_view_remove_attachment (ModestAttachmentsView *attachments_view, TnyMimePart *part);
80 void modest_attachments_view_remove_attachment_by_id (ModestAttachmentsView *attachments_view, const gchar *att_id);
81 TnyList *modest_attachments_view_get_attachments (ModestAttachmentsView *attachments_view);
82 TnyList *modest_attachments_view_get_selection (ModestAttachmentsView *attachments_view);
83 void modest_attachments_view_select_all (ModestAttachmentsView *attachments_view);
84
85 gboolean modest_attachments_view_has_attachments (ModestAttachmentsView *attachments_view);
86
87 void modest_attachments_view_get_sizes (ModestAttachmentsView *attachments_view,
88                                         gint *attachments_count,
89                                         guint64 *attachments_size);
90
91 void modest_attachments_view_set_style (ModestAttachmentsView *attachments_view,
92                                         ModestAttachmentsViewStyle style);
93 guint modest_attachments_view_get_num_attachments (ModestAttachmentsView *atts_view);
94 G_END_DECLS
95
96 #endif