aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-attachment.h
blob: cfacbf335b7616f3f930d86c6f51c9c5a01676bc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*
 * e-attachment.h
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif

#ifndef E_ATTACHMENT_H
#define E_ATTACHMENT_H

#include <gtk/gtk.h>
#include <camel/camel.h>

/* Standard GObject macros */
#define E_TYPE_ATTACHMENT \
    (e_attachment_get_type ())
#define E_ATTACHMENT(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_ATTACHMENT, EAttachment))
#define E_ATTACHMENT_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_ATTACHMENT, EAttachmentClass))
#define E_IS_ATTACHMENT(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_ATTACHMENT))
#define E_IS_ATTACHMENT_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_ATTACHMENT))
#define E_ATTACHMENT_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), E_TYPE_ATTACHMENT, EAttachmentClass))

G_BEGIN_DECLS

typedef struct _EAttachment EAttachment;
typedef struct _EAttachmentClass EAttachmentClass;
typedef struct _EAttachmentPrivate EAttachmentPrivate;

struct _EAttachment {
    GObject parent;
    EAttachmentPrivate *priv;
};

struct _EAttachmentClass {
    GObjectClass parent_class;
};

GType       e_attachment_get_type       (void) G_GNUC_CONST;
EAttachment *   e_attachment_new        (void);
EAttachment *   e_attachment_new_for_path   (const gchar *path);
EAttachment *   e_attachment_new_for_uri    (const gchar *uri);
EAttachment *   e_attachment_new_for_message    (CamelMimeMessage *message);
void        e_attachment_add_to_multipart   (EAttachment *attachment,
                         CamelMultipart *multipart,
                         const gchar *default_charset);
void        e_attachment_cancel     (EAttachment *attachment);
gboolean    e_attachment_get_can_show   (EAttachment *attachment);
void        e_attachment_set_can_show   (EAttachment *attachment,
                         gboolean can_show);
const gchar *   e_attachment_get_disposition    (EAttachment *attachment);
gchar *     e_attachment_dup_disposition    (EAttachment *attachment);
void        e_attachment_set_disposition    (EAttachment *attachment,
                         const gchar *disposition);
GFile *     e_attachment_ref_file       (EAttachment *attachment);
void        e_attachment_set_file       (EAttachment *attachment,
                         GFile *file);
GFileInfo * e_attachment_ref_file_info  (EAttachment *attachment);
void        e_attachment_set_file_info  (EAttachment *attachment,
                         GFileInfo *file_info);
gchar *     e_attachment_dup_mime_type  (EAttachment *attachment);
GIcon *     e_attachment_ref_icon       (EAttachment *attachment);
gboolean    e_attachment_get_loading    (EAttachment *attachment);
CamelMimePart * e_attachment_ref_mime_part  (EAttachment *attachment);
void        e_attachment_set_mime_part  (EAttachment *attachment,
                         CamelMimePart *mime_part);
gint        e_attachment_get_percent    (EAttachment *attachment);
GtkTreeRowReference *
        e_attachment_get_reference  (EAttachment *attachment);
void        e_attachment_set_reference  (EAttachment *attachment,
                         GtkTreeRowReference *reference);
gboolean    e_attachment_get_saving     (EAttachment *attachment);
gboolean    e_attachment_get_shown      (EAttachment *attachment);
void        e_attachment_set_shown      (EAttachment *attachment,
                         gboolean shown);
camel_cipher_validity_encrypt_t
        e_attachment_get_encrypted  (EAttachment *attachment);
void        e_attachment_set_encrypted  (EAttachment *attachment,
                         camel_cipher_validity_encrypt_t encrypted);
camel_cipher_validity_sign_t
        e_attachment_get_signed     (EAttachment *attachment);
void        e_attachment_set_signed     (EAttachment *attachment,
                         camel_cipher_validity_sign_t signed_);
gchar *     e_attachment_dup_description    (EAttachment *attachment);
gchar *     e_attachment_dup_thumbnail_path (EAttachment *attachment);
gboolean    e_attachment_is_rfc822      (EAttachment *attachment);
GList *     e_attachment_list_apps      (EAttachment *attachment);

/* Asynchronous Operations */
void        e_attachment_load_async     (EAttachment *attachment,
                         GAsyncReadyCallback callback,
                         gpointer user_data);
gboolean    e_attachment_load_finish    (EAttachment *attachment,
                         GAsyncResult *result,
                         GError **error);
gboolean    e_attachment_load       (EAttachment *attachment,
                         GError **error);
void        e_attachment_open_async     (EAttachment *attachment,
                         GAppInfo *app_info,
                         GAsyncReadyCallback callback,
                         gpointer user_data);
gboolean    e_attachment_open_finish    (EAttachment *attachment,
                         GAsyncResult *result,
                         GError **error);
gboolean    e_attachment_open       (EAttachment *attachment,
                         GAppInfo *app_info,
                         GError **error);
void        e_attachment_save_async     (EAttachment *attachment,
                         GFile *destination,
                         GAsyncReadyCallback callback,
                         gpointer user_data);
GFile *     e_attachment_save_finish    (EAttachment *attachment,
                         GAsyncResult *result,
                         GError **error);
gboolean    e_attachment_save       (EAttachment *attachment,
                         GFile *in_destination,
                         GFile **out_destination,
                         GError **error);

/* Handy GAsyncReadyCallback Functions */
void        e_attachment_load_handle_error  (EAttachment *attachment,
                         GAsyncResult *result,
                         GtkWindow *parent);
void        e_attachment_open_handle_error  (EAttachment *attachment,
                         GAsyncResult *result,
                         GtkWindow *parent);
void        e_attachment_save_handle_error  (EAttachment *attachment,
                         GAsyncResult *result,
                         GtkWindow *parent);

G_END_DECLS

#endif /* E_ATTACHMENT_H */