* Fixes NB#91689. fixes a wrong check for ASCII
[modest] / src / modest-platform.h
index fca70aa..3a88865 100644 (file)
@@ -33,6 +33,7 @@
 #include <tny-device.h>
 #include "widgets/modest-window.h"
 #include "widgets/modest-folder-view.h"
+#include "widgets/modest-sort-criterium-view.h"
 
 G_BEGIN_DECLS
 
@@ -40,9 +41,10 @@ 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,
+} ModestConnectedVia;
 
 /**
  * modest_platform_platform_init:
@@ -127,10 +129,11 @@ gboolean modest_platform_show_uri_popup (const gchar *uri);
 /**
  * modest_platform_get_icon:
  * @name: the name of the icon
+ * @size: the icon size, use MODEST_ICON_SMALL or MODEST_ICON_BIG
  *
  * this function returns an icon, or NULL in case of error 
  */
-GdkPixbuf* modest_platform_get_icon (const gchar *name);
+GdkPixbuf* modest_platform_get_icon (const gchar *name, guint icon_size);
 
 
 /**
@@ -189,38 +192,45 @@ gint      modest_platform_run_rename_folder_dialog        (GtkWindow *parent_win
 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
                                                        const gchar *message);
 
+
 /**
- * modest_platform_run_yes_no_dialog:
+ * modest_platform_run_confirmation_dialog_with_buttons:
  * @parent_window: the parent #GtkWindow of the dialog
  * @message: the message to show to the user
+ * @button_accept: the text to show in the label of the accept button
+ * @button_cancel: the text to show in the label of the cancel button
  * 
- * runs a dialog that offers yes and no buttons.
+ * runs a confirmation dialog with the given values for the buttons
  * 
- * Returns: GTK_RESPONSE_YES or GTK_RESPONSE_NO
+ * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
  **/
-gint      modest_platform_run_yes_no_dialog      (GtkWindow *parent_window,
-                                                 const gchar *message);
-
+gint
+modest_platform_run_confirmation_dialog_with_buttons (GtkWindow *parent_window,
+                                                     const gchar *message,
+                                                     const gchar *button_accept,
+                                                     const gchar *button_cancel);
 
 /**
  * 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:
@@ -278,13 +288,23 @@ 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
+ * @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 (TnyList *header_list,
+                                             gboolean show_visual);
 
 /**
  * modest_platform_show_help:
@@ -319,6 +339,12 @@ void modest_platform_information_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,
+                                                     const gchar *text,
+                                                     gint timeout);
+
 GtkWidget *
 modest_platform_animation_banner (GtkWidget *parent,
                                  const gchar *annimation_name,
@@ -366,10 +392,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)
  *
  * Removes all the active new mail notifications
  **/
-void modest_platform_remove_new_mail_notifications (void);
+void modest_platform_remove_new_mail_notifications (gboolean only_visuals);
 
 /* ModestConnectedPerformer:
  * @canceled: whether or not the user canceled
@@ -386,8 +413,15 @@ typedef void (*ModestConnectedPerformer) (gboolean canceled,
                                          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
  * @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
@@ -399,6 +433,7 @@ typedef void (*ModestConnectedPerformer) (gboolean canceled,
  * @account is NULL, only a network connection is made using the platform's device.
  */            
 void modest_platform_connect_and_perform (GtkWindow *parent_window, 
+                                         gboolean force,
                                          TnyAccount *account, 
                                          ModestConnectedPerformer callback, 
                                          gpointer user_data);
@@ -415,30 +450,76 @@ void modest_platform_connect_and_perform (GtkWindow *parent_window,
  * 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);
+                                                   gboolean force,
+                                                   TnyFolderStore *folder_store,
+                                                   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 (GtkWindow *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
  */
-GtkWidget *modest_platform_get_account_settings_wizard ();
+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
+ * 
+ * Shows the header details dialog
+ **/
+void     modest_platform_run_header_details_dialog (GtkWindow *parent_window,
+                                                   TnyHeader *header);
+
 
 G_END_DECLS
 
 #endif /* __MODEST_PLATFORM_UTILS_H__ */
+