* Added some missing rules to the xfer_folder and xfer_msgs operations

[modest] / src / modest-mail-operation.h

diff --git a/src/modest-mail-operation.h b/src/modest-mail-operation.h
index caae5fb..3928049 100644 (file)
--- a/src/modest-mail-operation.h
+++ b/src/modest-mail-operation.h
@@ -99,7 +99,7 @@ struct _ModestMailOperationClass {
 typedef void (*ErrorCheckingUserCallback) (const GObject *obj, gpointer user_data);
 
 /**
- * GetMsgAsynUserCallback:
+ * GetMsgAsyncUserCallback:
  *
  * @obj: a #GObject generic object which has created current mail operation.
  * @msg: a #TnyMsg message retrieved by async operation.
@@ -109,7 +109,10 @@ typedef void (*ErrorCheckingUserCallback) (const GObject *obj, gpointer user_dat
  * used as tinymail operation callback. The private function fills private 
  * fields of mail operation and calls user defined callback if it exists.
  */
-typedef void (*GetMsgAsynUserCallback) (const GObject *obj, TnyMsg *msg, gpointer user_data);
+typedef void (*GetMsgAsyncUserCallback) (ModestMailOperation *mail_op, 
+                                        TnyHeader *header, 
+                                        TnyMsg *msg, 
+                                        gpointer user_data);
 
 /**
  * XferMsgAsynUserCallback:
@@ -186,6 +189,17 @@ gboolean
 modest_mail_operation_is_mine (ModestMailOperation *self, 
                               GObject *me);
 
+/**
+ * modest_mail_operation_get_source
+ * @self: a #ModestMailOperation
+ *
+ * returns a new reference to the object that created the mail
+ * operation passed to the constructor, or NULL if none. The caller
+ * must free the new reference
+ **/
+GObject *
+modest_mail_operation_get_source (ModestMailOperation *self);
+
 /* fill in other public functions, eg.: */
 
 /**
@@ -359,36 +373,12 @@ void          modest_mail_operation_rename_folder  (ModestMailOperation *self,
  * If @delete_original is TRUE this function moves the original
  * folder, if it is FALSE the it just copies it
  *
- * Returns: the newly transfered folder
  **/
-TnyFolder*    modest_mail_operation_xfer_folder    (ModestMailOperation *self,
+void          modest_mail_operation_xfer_folder    (ModestMailOperation *self,
                                                    TnyFolder *folder,
                                                    TnyFolderStore *parent,
                                                    gboolean delete_original);
 
-
-
-/**
- * modest_mail_operation_xfer_folder:
- * @self: a #ModestMailOperation
- * @folder: a #TnyFolder
- * @parent: the new parent of the folder as #TnyFolderStore
- * @delete_original: wheter or not delete the original folder
- * 
- * Sets the given @folder as child of a provided #TnyFolderStore. This
- * operation also transfers all the messages contained in the folder
- * and all of his children folders with their messages as well. This
- * operation is synchronous, so the #ModestMailOperation should not be
- * added to any #ModestMailOperationQueue.
- *
- * If @delete_original is TRUE this function moves the original
- * folder, if it is FALSE the it just copies it
- *
- **/
-void    modest_mail_operation_xfer_folder_async    (ModestMailOperation *self,
-                                                   TnyFolder *folder, 
-                                                   TnyFolderStore *parent,
-                                                   gboolean delete_original);
 /* Functions that performs msg operations */
 
 /**
@@ -447,7 +437,7 @@ void          modest_mail_operation_remove_msg     (ModestMailOperation *self,
  * modest_mail_operation_get_msg:
  * @self: a #ModestMailOperation
  * @header_list: the #TnyHeader of the message to get
- * @user_callback: a #GetMsgAsynUserCallback function to call after tinymail callback execution.
+ * @user_callback: a #GetMsgAsyncUserCallback function to call after tinymail callback execution.
  * @user_data: generic user data which will be passed to @user_callback function.
  * 
  * Gets a message from header using an user defined @callback function
@@ -456,7 +446,7 @@ void          modest_mail_operation_remove_msg     (ModestMailOperation *self,
  **/
 void          modest_mail_operation_get_msg     (ModestMailOperation *self,
                                                 TnyHeader *header, 
-                                                GetMsgAsynUserCallback user_callback,
+                                                GetMsgAsyncUserCallback user_callback,
                                                 gpointer user_data);
 /**
  * modest_mail_operation_get_msgs_full:
@@ -471,7 +461,7 @@ void          modest_mail_operation_get_msg     (ModestMailOperation *self,
  **/
 void          modest_mail_operation_get_msgs_full   (ModestMailOperation *self,
                                                     TnyList *headers_list,
-                                                    GetMsgAsynUserCallback user_callback,
+                                                    GetMsgAsyncUserCallback user_callback,
                                                     gpointer user_data,
                                                     GDestroyNotify notify);
 
@@ -555,18 +545,6 @@ gboolean  modest_mail_operation_cancel          (ModestMailOperation *self);
 void      modest_mail_operation_refresh_folder  (ModestMailOperation *self,
                                                 TnyFolder *folder);
 
-/**
- *
- * This function is a workarround. It emits the progress-changed
- * signal. It's used by the mail operation queue to notify the
- * observers attached to that signal that the operation finished. We
- * need to use that for the moment because tinymail does not give us
- * the progress of a given operation very well. So we must delete it
- * when tinymail has that functionality and remove the call to it in
- * the queue as well.
- */
-void _modest_mail_operation_notify_end (ModestMailOperation *self);
-
 G_END_DECLS
 
 #endif /* __MODEST_MAIL_OPERATION_H__ */