1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_PROGRESS_OBJECT_H__
31 #define __MODEST_PROGRESS_OBJECT_H__
33 /* other include files */
34 #include "modest-mail-operation.h"
38 /* convenience macros */
39 #define MODEST_TYPE_PROGRESS_OBJECT (modest_progress_object_get_type())
40 #define MODEST_PROGRESS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PROGRESS_OBJECT,ModestProgressObject))
41 #define MODEST_IS_PROGRESS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PROGRESS_OBJECT))
42 #define MODEST_PROGRESS_OBJECT_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE((inst),MODEST_TYPE_PROGRESS_OBJECT,ModestProgressObjectIface))
44 typedef struct _ModestProgressObject ModestProgressObject;
45 typedef struct _ModestProgressObjectIface ModestProgressObjectIface;
47 struct _ModestProgressObjectIface {
48 GTypeInterface parent;
50 /* the 'vtable': declare function pointers here, eg.: */
51 void (*add_operation_func) (ModestProgressObject *self,
52 ModestMailOperation *mail_op);
53 void (*remove_operation_func) (ModestProgressObject *self,
54 ModestMailOperation *mail_op);
55 void (*cancel_current_operation_func) (ModestProgressObject *self);
56 void (*cancel_all_operations_func) (ModestProgressObject *self);
57 guint (*num_pending_operations_func) (ModestProgressObject *self);
60 GType modest_progress_object_get_type (void) G_GNUC_CONST;
62 void modest_progress_object_add_operation (ModestProgressObject *self,
63 ModestMailOperation *mail_op);
65 void modest_progress_object_remove_operation (ModestProgressObject *self,
66 ModestMailOperation *mail_op);
68 void modest_progress_object_cancel_current_operation (ModestProgressObject *self);
70 void modest_progress_object_cancel_all_operations (ModestProgressObject *self);
72 guint modest_progress_object_num_pending_operations (ModestProgressObject *self);
76 #endif /* __MODEST_PROGRESS_OBJECT_H__ */