Fixes NB#63571
[modest] / src / modest-platform.h
index e9715b5..8268d73 100644 (file)
@@ -52,7 +52,17 @@ typedef enum _ModestSortDialogType {
  * Returns: TRUE if succeeded, FALSE otherwise
  */
 gboolean modest_platform_init (int argc, char *argv[]);
-       
+
+
+/**
+ * modest_platform_platform_init:
+ *
+ * platform specific un-initialization function
+ * 
+ * Returns: TRUE if succeeded, FALSE otherwise
+ */
+gboolean modest_platform_uninit (void);
+
 
 /**
  * modest_platform_get_new_device:
@@ -249,14 +259,6 @@ gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_
 gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
 
 /**
- * modest_platform_is_network_folderstore:
- * @folder_store: The folder store (folder or account) that needs to
- * decide if need a connection in subsequent operations.
- * @return value: Whether a connection is necessary for this folder_store.
- */
-gboolean modest_platform_is_network_folderstore (TnyFolderStore *folder_store);
-
-/**
  * modest_platform_set_update_interval:
  * @minutes: The number of minutes between updates, or 0 for no updates.
  * 
@@ -295,17 +297,6 @@ void modest_platform_show_help (GtkWindow *parent_window,
                                const gchar *help_id);
 
 /**
- * modest_platform_set_dialog_help:
- * @dialog: a #GtkDialog
- * @help_id: the help topic id to be shown on requesting
- * help in the dialog
- * 
- * attachs a help topic to the dialog
- **/
-void modest_platform_set_dialog_help (GtkDialog *parent_window, 
-                                     const gchar *help_id);
-
-/**
  * modest_platform_show_search_messages:
  * @parent_window: window the dialog will be child of
  *
@@ -356,7 +347,7 @@ gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *accoun
  *
  *  Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
  **/
-gboolean modest_platform_run_certificate_conformation_dialog (const gchar* server_name,
+gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
                                                              const gchar *certificate);
 
 
@@ -380,6 +371,54 @@ gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_ques
  **/
 void modest_platform_remove_new_mail_notifications (void);
 
+/* ModestConnectedPerformer:
+ * @canceled: whether or not the user canceled
+ * @err: whether an error occured during connecting, or NULL of not
+ * @parent_window: the parent window or NULL
+ * @account: the account or NULL
+ * @user_data: your own user data
+ * 
+ * This is the callback for the modest_platform_connect_and_perform* functions
+ */
+typedef void (*ModestConnectedPerformer) (gboolean canceled, 
+                                         GError *err,
+                                         GtkWindow *parent_window, 
+                                         TnyAccount *account, 
+                                         gpointer user_data);
+
+/*
+ * modest_platform_connect_and_perform:
+ * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
+ * @account: The account to be used.
+ * @callback: will be called when finished, can be NULL
+ * @user_data: user data for @callback
+ * 
+ * Attempts to make a connection, possibly showing interactive UI to achieve this.
+ * This will return immediately if a connection is already open, which results in an instant
+ * call of @callback. While making a connection, @account, if not NULL, will go online too. If
+ * @account is NULL, only a network connection is made using the platform's device.
+ */            
+void modest_platform_connect_and_perform (GtkWindow *parent_window, 
+                                         TnyAccount *account, 
+                                         ModestConnectedPerformer callback, 
+                                         gpointer user_data);
+               
+/*
+ * modest_platform_connect_if_remote_and_perform:
+ * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
+ * @folder_store: The folder store (folder or account) that might need a connection in subsequent operations.
+ * @callback: will be called when finished, can be NULL
+ * @user_data: user data for @callback
+ * 
+ * Like modest_platform_connect_and_perform(), but only attempts to make a connection if the 
+ * folder store uses the network. For instance, this just returns for local maildir folders. It
+ * will in that case synchronously and instantly perform the @callback
+ */
+void modest_platform_connect_if_remote_and_perform (GtkWindow *parent_window, 
+                                                                TnyFolderStore *folder_store,
+                                                                ModestConnectedPerformer callback, 
+                                                                gpointer user_data);
+
 G_END_DECLS
 
 #endif /* __MODEST_PLATFORM_UTILS_H__ */