* modest-tny-send-queue.[ch]:
[modest] / src / modest-tny-send-queue.h
1 /* Copyright (c) 2006, 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
31 #ifndef __MODEST_TNY_SEND_QUEUE_H__
32 #define __MODEST_TNY_SEND_QUEUE_H__
33
34 #include <glib.h>
35 #include <glib-object.h>
36 #include <tny-send-queue.h>
37 #include <tny-msg.h>
38 #include <tny-camel-transport-account.h>
39
40 G_BEGIN_DECLS
41
42 /* convenience macros */
43 #define MODEST_TYPE_TNY_SEND_QUEUE             (modest_tny_send_queue_get_type())
44 #define MODEST_TNY_SEND_QUEUE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueue))
45 #define MODEST_TNY_SEND_QUEUE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_SEND_QUEUE,TnySendQueue))
46 #define MODEST_IS_TNY_SEND_QUEUE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_SEND_QUEUE))
47 #define MODEST_IS_TNY_SEND_QUEUE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_SEND_QUEUE))
48 #define MODEST_TNY_SEND_QUEUE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_SEND_QUEUE,ModestTnySendQueueClass))
49
50 typedef struct _ModestTnySendQueue      ModestTnySendQueue;
51 typedef struct _ModestTnySendQueueClass ModestTnySendQueueClass;
52
53 struct _ModestTnySendQueue {
54         GObject  parent;
55 };
56
57 struct _ModestTnySendQueueClass {
58         GObjectClass parent_class;
59         
60         void (*add_func)               (TnySendQueue *self, TnyMsg *msg);
61         TnyFolder* (*get_sentbox_func) (TnySendQueue *self);
62         TnyFolder* (*get_outbox_func)  (TnySendQueue *self);
63         void (*cancel_func)            (TnySendQueue *self, gboolean remove);   
64 };
65
66 /* member functions */
67 GType        modest_tny_send_queue_get_type    (void) G_GNUC_CONST;
68
69 /* typical parameter-less _new function */
70 /* if this is a kind of GtkWidget, it should probably return at GtkWidget* */
71 ModestTnySendQueue*    modest_tny_send_queue_new         (TnyTransportAccount *account);
72
73 G_END_DECLS
74
75 #endif /* __MODEST_TNY_SEND_QUEUE_H__ */
76