* check for a valid foldername
[modest] / src / modest-platform.h
index 84aa8cd..c1bdd14 100644 (file)
@@ -32,6 +32,7 @@
 
 #include <tny-device.h>
 #include "widgets/modest-window.h"
+#include "widgets/modest-folder-view.h"
 
 G_BEGIN_DECLS
 
@@ -39,10 +40,9 @@ 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:
@@ -51,8 +51,8 @@ typedef enum _ModestInformationDialogType {
  * 
  * Returns: TRUE if succeeded, FALSE otherwise
  */
-gboolean modest_platform_init (void);
-
+gboolean modest_platform_init (int argc, char *argv[]);
+       
 
 /**
  * modest_platform_get_new_device:
@@ -94,6 +94,17 @@ gchar*  modest_platform_get_file_icon_name (const gchar* name, const gchar* mime
 gboolean modest_platform_activate_uri (const gchar *uri);
 
 /**
+ * modest_platform_activate_file:
+ * @path: the path to activate
+ * @mime_type: the mime type of the path, or %NULL to guess
+ *
+ * This function activates a file
+ *
+ * Returns: %TRUE if successful, %FALSE if not.
+ **/
+gboolean modest_platform_activate_file (const gchar *path, const gchar *mime_type);
+
+/**
  * modest_platform_show_uri_popup:
  * @uri: an URI with the string
  *
@@ -113,7 +124,7 @@ GdkPixbuf* modest_platform_get_icon (const gchar *name);
 
 
 /**
- * modest_platform_get_application_name:
+ * modest_platform_get_app_name:
  *
  * this function returns the name of the application. Do not modify.
  */
@@ -140,40 +151,162 @@ gint      modest_platform_run_new_folder_dialog        (GtkWindow *parent_window
                                                        gchar **folder_name);
 
 /**
+ * modest_platform_run_rename_folder_dialog:
+ * @parent_window: a #GtkWindow
+ * @parent: the parent of the folder
+ * @suggested_name: current name of the folder
+ * @folder_name: the new folder name selected by the user for the folder
+ * 
+ * runs a "rename folder" confirmation dialog. 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_rename_folder_dialog        (GtkWindow *parent_window,
+                                                          TnyFolderStore *parent,
+                                                          const gchar *current_name,
+                                                          gchar **folder_name);
+
+/**
  * modest_platform_run_confirmation_dialog:
  * @parent_window: the parent #GtkWindow of the dialog
- * @type: the type of confirmation dialog
- * @user_data: user data
+ * @message: the message to show to the user
  * 
- * runs a confirmation dialog of type #type.
+ * runs a confirmation dialog
  * 
  * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
  **/
 gint      modest_platform_run_confirmation_dialog      (GtkWindow *parent_window,
-                                                       ModestConfirmationDialogType type,
-                                                       gpointer user_data);
+                                                       const gchar *message);
+
+/**
+ * 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
- * @type: the type of information dialog
+ * @message: the message to show
  * 
  * shows an information dialog
  **/
 void      modest_platform_run_information_dialog       (GtkWindow *parent_window,
-                                                       ModestInformationDialogType type);
+                                                       const gchar *message);
+
+/**
+ * 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 make.
+ * @account: The account to be used.
+ * @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.
+ * This also sets the account to online, if it is a store account, in case it has been set to offline mode.
  */            
-gboolean modest_platform_connect_and_wait (GtkWindow *parent_window);
+gboolean modest_platform_connect_and_wait (GtkWindow *parent_window, TnyAccount *account);
+
+               
+/*
+ * modest_platform_connect_and_wait_if_network_account:
+ * @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
+ * @account: The account that might need a connection in subsequent operations.
+ * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
+ * 
+ * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the 
+ * account uses the network. For instance, this just returns TRUE for local maildir accounts. 
+ */
+gboolean modest_platform_connect_and_wait_if_network_account (GtkWindow *parent_window, TnyAccount *account);
+
+/*
+ * modest_platform_connect_and_wait_if_network_account:
+ * @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.
+ * @return value: Whether a connection was made. Also returns TRUE if no connection is necessary.
+ * 
+ * Like modest_platform_connect_and_wait(), but only attempts to make a connection if the 
+ * folder store uses the network. For instance, this just returns TRUE for local maildir folders. 
+ */
+gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
+
+/**
+ * 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);
+
+/**
+ * modest_platform_get_global_settings_dialog:
+ * @void: 
+ * 
+ * returns the global settings dialog
+ * 
+ * Return value: a new #ModestGlobalSettingsDialog dialog
+ **/
+GtkWidget* modest_platform_get_global_settings_dialog (void);
+
+void modest_platform_on_new_msg (void);
+
+
+/**
+ * modest_platform_show_help:
+ * @parent_window: 
+ * @help_id: the help topic id to be shown in the help dialog
+ * 
+ * shows the application help dialog
+ **/
+void modest_platform_show_help (GtkWindow *parent_window, 
+                               const gchar *help_id);
+
+/**
+ * modest_platform_show_search_messages:
+ * @parent_window: window the dialog will be child of
+ *
+ * shows the search messages dialog
+ **/
+void modest_platform_show_search_messages (GtkWindow *parent_window);
+
+/**
+ * modest_platform_show_addressbook:
+ * @parent_window: window the dialog will be child of
+ *
+ * shows the addressbook
+ **/
+void modest_platform_show_addressbook (GtkWindow *parent_window);
+
+
+GtkWidget* modest_platform_create_folder_view (TnyFolderStoreQuery *query);
+
+void modest_platform_information_banner (GtkWidget *widget,
+                                        const gchar *icon_name,
+                                        const gchar *text);
+
+GtkWidget *
+modest_platform_animation_banner (GtkWidget *parent,
+                                 const gchar *annimation_name,
+                                 const gchar *text);
 
 G_END_DECLS