2007-05-03 Murray Cumming <murrayc@murrayc.com>

[modest] / src / modest-platform.h

diff --git a/src/modest-platform.h b/src/modest-platform.h
index ffcd61a..d42bdbc 100644 (file)
--- a/src/modest-platform.h
+++ b/src/modest-platform.h
@@ -35,6 +35,19 @@
 
 G_BEGIN_DECLS
 
+typedef enum _ModestConfirmationDialogType {
+       MODEST_CONFIRMATION_DELETE_FOLDER,
+} ModestConfirmationDialogType;
+
+typedef enum _ModestInformationDialogType {
+       MODEST_INFORMATION_CREATE_FOLDER,
+       MODEST_INFORMATION_DELETE_FOLDER,
+} ModestInformationDialogType;
+
+typedef enum _ModestSortDialogType {
+       MODEST_SORT_HEADERS,
+} ModestSortDialogType;
+
 /**
  * modest_platform_platform_init:
  *
@@ -111,8 +124,76 @@ GdkPixbuf* modest_platform_get_icon (const gchar *name);
 const gchar* modest_platform_get_app_name (void);
 
 
-gboolean modest_platform_run_new_folder_dialog (ModestWindow *parent_window,
-                                               TnyFolderStore *parent);
+/**
+ * modest_platform_run_new_folder_dialog:
+ * @parent_window: a #GtkWindow
+ * @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
+ * 
+ * runs a "new folder" confirmation dialog. The dialog will suggest a
+ * folder name which depends of the platform if the #suggested_name
+ * parametter is NULL. If the user input a valid folder name it's
+ * returned in the #folder_name attribute.
+ * 
+ * Returns: the #GtkResponseType returned by the dialog
+ **/
+gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window,
+                                                       TnyFolderStore *parent,
+                                                       gchar *suggested_name,
+                                                       gchar **folder_name);
+
+/**
+ * modest_platform_run_confirmation_dialog:
+ * @parent_window: the parent #GtkWindow of the dialog
+ * @message: the message to show to the user
+ * 
+ * runs a confirmation dialog
+ * 
+ * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
+ **/
+gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
+                                                       const gchar *message);
+
+
+/**
+ * modest_platform_run_information_dialog:
+ * @parent_window: the parent #GtkWindow of the dialog
+ * @type: the type of information dialog
+ * 
+ * shows an information dialog
+ **/
+void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
+                                                       ModestInformationDialogType type);
+/**
+ * modest_platform_run_sort_dialog:
+ * @parent_window: the parent #GtkWindow of the dialog
+ * @type: the sort dialog type.
+ * 
+ * shows a sort dialog
+ **/
+void      modest_platform_run_sort_dialog       (GtkWindow *parent_window, 
+                                                ModestSortDialogType type);
+               
+/*
+ * modest_platform_connect_and_wait:
+ * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
+ * @return value: Whether a connection was made.
+ * 
+ * Attempts to make a connection, possibly showing interactive UI to achieve this.
+ * This will return TRUE immediately if a connection is already open.
+ * Otherwise, this function blocks until the connection attempt has either succeded or failed.
+ */            
+gboolean modest_platform_connect_and_wait (GtkWindow *parent_window);
+
+/**
+ * modest_platform_set_update_interval:
+ * @minutes: The number of minutes between updates, or 0 for no updates.
+ * 
+ * Set the number of minutes between automatic updates of email accounts.
+ * The platform will cause the send/receive action to happen repeatedly.
+ **/
+gboolean modest_platform_set_update_interval (guint minutes);
 
 G_END_DECLS