Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-platform.h
index 9e2d386..f92e0cc 100644 (file)
 #include <tny-device.h>
 #include "widgets/modest-window.h"
 #include "widgets/modest-folder-view.h"
+#include "widgets/modest-sort-criterium-view.h"
+#ifdef MODEST_PLATFORM_MAEMO
+#include <dbus/dbus.h>
+#include <libosso.h>
+#endif
 
 G_BEGIN_DECLS
 
@@ -40,15 +45,18 @@ typedef enum _ModestConfirmationDialogType {
        MODEST_CONFIRMATION_DELETE_FOLDER,
 } ModestConfirmationDialogType;
 
-typedef enum _ModestSortDialogType {
-       MODEST_SORT_HEADERS,
-} ModestSortDialogType;
+typedef enum _ModestConnectedVia {
+       MODEST_CONNECTED_VIA_WLAN_OR_WIMAX = 1,
+       MODEST_CONNECTED_VIA_ANY = 2,
+} ModestConnectedVia;
+
+#define MODEST_GTK_RESPONSE_NEW_FOLDER 1
 
 /**
  * modest_platform_platform_init:
  *
  * platform specific initialization function
- * 
+ *
  * Returns: TRUE if succeeded, FALSE otherwise
  */
 gboolean modest_platform_init (int argc, char *argv[]);
@@ -145,9 +153,10 @@ const gchar* modest_platform_get_app_name (void);
 /**
  * modest_platform_run_new_folder_dialog:
  * @parent_window: a #GtkWindow
- * @parent: the parent of the new folder
+ * @suggested_parent: the parent of the new folder
  * @suggested_name: the suggested name for the new folder
  * @folder_name: the folder name selected by the user for the new folder
+ * @parent: the chosen #TnyFolderStore (should be unreffed)
  * 
  * runs a "new folder" confirmation dialog. The dialog will suggest a
  * folder name which depends of the platform if the #suggested_name
@@ -157,9 +166,10 @@ const gchar* modest_platform_get_app_name (void);
  * Returns: the #GtkResponseType returned by the dialog
  **/
 gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
-                                                       TnyFolderStore *parent,
+                                                       TnyFolderStore *suggested_parent,
                                                        gchar *suggested_name,
-                                                       gchar **folder_name);
+                                                       gchar **folder_name,
+                                                       TnyFolderStore **parent);
 
 /**
  * modest_platform_run_rename_folder_dialog:
@@ -173,7 +183,7 @@ gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window
  * 
  * Returns: the #GtkResponseType returned by the dialog
  **/
-gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_window,
+gint      modest_platform_run_rename_folder_dialog        (ModestWindow *parent_window,
                                                           TnyFolderStore *parent,
                                                           const gchar *current_name,
                                                           gchar **folder_name);
@@ -209,37 +219,26 @@ modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
                                                      const gchar *button_cancel);
 
 /**
- * modest_platform_run_yes_no_dialog:
- * @parent_window: the parent #GtkWindow of the dialog
- * @message: the message to show to the user
- * 
- * runs a dialog that offers yes and no buttons.
- * 
- * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
- **/
-gint      modest_platform_run_yes_no_dialog      (GtkWindow *parent_window,
-                                                 const gchar *message);
-
-
-/**
  * modest_platform_run_information_dialog:
  * @parent_window: the parent #GtkWindow of the dialog
  * @message: the message to show
+ * @block: whether or not the dialog should block the main loop or not while running
  * 
  * shows an information dialog
  **/
 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
-                                                       const gchar *message);
+                                                       const gchar *message,
+                                                       gboolean block);
 
 /**
- * modest_platform_run_sort_dialog:
+ * modest_platform_create_sort_dialog:
  * @parent_window: the parent #GtkWindow of the dialog
- * @type: the sort dialog type.
  * 
- * shows a sort dialog
+ * creates a proper sort dialog for the platform
+ *
+ * Returns: a #GtkDialog implementing #ModestSortCriteriumView interface
  **/
-void      modest_platform_run_sort_dialog       (GtkWindow *parent_window, 
-                                                ModestSortDialogType type);
+GtkWidget *modest_platform_create_sort_dialog       (GtkWindow *parent_window);
                
 /*
  * modest_platform_connect_and_wait:
@@ -297,14 +296,22 @@ gboolean modest_platform_set_update_interval (guint minutes);
 GtkWidget* modest_platform_get_global_settings_dialog (void);
 
 /**
+ * modest_platform_push_email_notification:
+ *
+ * Notify the user when new e-mail arrives by playing a sound, making
+ * a light blink, etc.
+ */
+void modest_platform_push_email_notification(void);
+
+/**
  * modest_platform_on_new_headers_received:
- * @header_list: the list of new received headers
+ * @header_list: a list of #ModestMsgNotificationData
  * @show_visual: adds a visual notification 
  *
  * Performs the required actions when new headers are
  * received. Tipically it's useful for showing new email notifications
  **/
-void modest_platform_on_new_headers_received (TnyList *header_list,
+void modest_platform_on_new_headers_received (GList *URI_list,
                                              gboolean show_visual);
 
 /**
@@ -340,6 +347,10 @@ void modest_platform_information_banner (GtkWidget *widget,
                                         const gchar *icon_name,
                                         const gchar *text);
 
+void modest_platform_system_banner (GtkWidget *widget,
+                                   const gchar *icon_name,
+                                   const gchar *text);
+
 /* Timeout is in miliseconds */
 void modest_platform_information_banner_with_timeout (GtkWidget *parent,
                                                      const gchar *icon_name,
@@ -394,10 +405,11 @@ gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_ques
 /**
  * modest_platform_remove_new_mail_notifications:
  * @only_visuals: remove only the visual notifications (like LEDs)
+ * @acc_name: account to remove notifications
  *
  * Removes all the active new mail notifications
  **/
-void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
+void modest_platform_remove_new_mail_notifications (gboolean only_visuals, const gchar *acc_name);
 
 /* ModestConnectedPerformer:
  * @canceled: whether or not the user canceled
@@ -410,10 +422,16 @@ void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
  */
 typedef void (*ModestConnectedPerformer) (gboolean canceled, 
                                          GError *err,
-                                         GtkWindow *parent_window, 
+                                         ModestWindow *parent_window,
                                          TnyAccount *account, 
                                          gpointer user_data);
 
+typedef struct {
+       TnyAccount *dst_account;
+       ModestConnectedPerformer callback;
+       gpointer data;
+} DoubleConnectionInfo;
+
 /*
  * modest_platform_connect_and_perform:
  * @force: force the device to connect if we're offline, if FALSE then it does not connect if required
@@ -427,10 +445,10 @@ typedef void (*ModestConnectedPerformer) (gboolean canceled,
  * 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, 
+void modest_platform_connect_and_perform (ModestWindow *parent_window,
                                          gboolean force,
-                                         TnyAccount *account, 
-                                         ModestConnectedPerformer callback, 
+                                         TnyAccount *account,
+                                         ModestConnectedPerformer callback,
                                          gpointer user_data);
                
 /*
@@ -444,31 +462,114 @@ void modest_platform_connect_and_perform (GtkWindow *parent_window,
  * 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, 
+void modest_platform_connect_if_remote_and_perform (ModestWindow *parent_window,
                                                    gboolean force,
                                                    TnyFolderStore *folder_store,
-                                                   ModestConnectedPerformer callback, 
+                                                   ModestConnectedPerformer callback,
                                                    gpointer user_data);
 
+/*
+ * modest_platform_double_connect_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
+ * @info: 
+ * 
+ */
+void modest_platform_double_connect_and_perform (ModestWindow *parent_window,
+                                                gboolean force,
+                                                TnyFolderStore *folder_store,
+                                                DoubleConnectionInfo *info);
+
 /**
- * modest_platform_get_account_settings_dialog:
+ * modest_platform_get_account_settings_wizard:
  * @settings: a #ModestAccountSettings
  *
  * creates a dialog for editing @settings
  *
  * Returns: the newly created dialog.
  */
-GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
+GtkWidget *modest_platform_get_account_settings_wizard (void);
+
+ModestConnectedVia modest_platform_get_current_connection (void);
+
+
+
 
 /**
- * modest_platform_get_account_settings_wizard:
- * @settings: a #ModestAccountSettings
+ * modest_platform_check_memory_low:
+ * 
+ * @win: a ModestWindow, or NULL
+ * @visuals: whether or not show visual information
  *
- * creates a dialog for editing @settings
+ * see if memory is too low for big memory consuming operations
+ * optionally show a warning dialog if @win was provided
  *
- * Returns: the newly created dialog.
+ * Returns: TRUE if we're in lowmem state, FALSE otherwise
+ */
+gboolean modest_platform_check_memory_low (ModestWindow *win,
+                                          gboolean visuals);
+
+
+/**
+ * modest_platform_run_folder_details_dialog:
+ * @parent_window: the parent #GtkWindow for the new dialog
+ * @folder: the #TnyFolder whose details will be shown
+ *
+ * Shows the folder details dialog
+ **/
+void     modest_platform_run_folder_details_dialog (GtkWindow *parent_window,
+                                                   TnyFolder *folder);
+
+/**
+ * modest_platform_run_header_details_dialog:
+ * @parent_window: the parent #GtkWindow for the new dialog
+ * @header: the #TnyHeader whose details will be shown
+ * @async_get_size: %TRUE if size is obtained asynchronously from @msg
+ * @msg: a #TnyMsg
+ *
+ * Shows the header details dialog
+ **/
+void     modest_platform_run_header_details_dialog (GtkWindow *parent_window,
+                                                   TnyHeader *header,
+                                                   gboolean async_get_size,
+                                                   TnyMsg *msg);
+
+/**
+ * modest_platform_on_runtime_initialized:
+ *
+ * This function will be used by platforms to connect objects between
+ * themselves once all the singletons have been created. So this
+ * function MUST be called *before* modest_init
+ **/
+void     modest_platform_on_runtime_initialized ();
+
+#ifdef MODEST_PLATFORM_MAEMO
+/**
+ * modest_platform_get_osso_context:
+ *
+ * Obtains the osso context pointer for the application
+ *
+ * Returns: the osso context pointer
  */
-GtkWidget *modest_platform_get_account_settings_wizard ();
+osso_context_t *modest_platform_get_osso_context (void);
+#endif
+
+
+
+GtkWidget* modest_platform_create_move_to_dialog (GtkWindow *parent_window,
+                                                 GtkWidget **folder_view);
+
+TnyList* modest_platform_get_list_to_move (ModestWindow *window);
+
+#ifdef MODEST_PLATFORM_MAEMO
+DBusConnection* modest_platform_get_dbus_connection (void);
+#endif
+
+void modest_platform_emit_folder_updated_signal (const gchar *account_id, const gchar *folder_id);
+void modest_platform_emit_account_created_signal (const gchar *account_id);
+void modest_platform_emit_account_removed_signal (const gchar *account_id);
+void modest_platform_emit_msg_read_changed_signal (const gchar *msg_uid, gboolean is_read);
 
 G_END_DECLS