* 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:
gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
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:
/*
* modest_platform_connect_and_wait:
* @parent_window: the parent #GtkWindow for any interactive or progress feedback UI.
+ * @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:
**/
GtkWidget* modest_platform_get_global_settings_dialog (void);
-void modest_platform_on_new_msg (void);
-
+/**
+ * modest_platform_on_new_headers_received:
+ * @header_list: the list of new received headers
+ *
+ * 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);
/**
* modest_platform_show_help:
const gchar *icon_name,
const gchar *text);
+GtkWidget *
+modest_platform_animation_banner (GtkWidget *parent,
+ const gchar *annimation_name,
+ const gchar *text);
+
+/* TODO: This isn't platform-dependent, so this isn't the best place for this. */
+/* Return TRUE immediately if the account is already online,
+ * otherwise check every second for NUMBER_OF_TRIES seconds and return TRUE as
+ * soon as the account is online, or FALSE if the account does
+ * not become online in the NUMBER_OF_TRIES seconds.
+ * This is useful when the D-Bus method was run immediately after
+ * the application was started (when using D-Bus activation),
+ * because the account usually takes a short time to go online.
+ * The return value is maybe not very useful.
+ */
+gboolean modest_platform_check_and_wait_for_account_is_online(TnyAccount *account);
+
+
+
+/**
+ * modest_platform_run_certificate_confirmation_dialog:
+ * @server_name: name of the server we get this dialog for
+ * @certificate: the text representation of the certificate
+ *
+ * show the unknown-certificate confirmation dialog
+ *
+ * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
+ **/
+gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
+ const gchar *certificate);
+
+
+/**
+ * modest_platform_run_alert_dialog:
+ * @prompt: prompt for the dialog
+ * @is_question: is it a question dialog?
+ *
+ * show the alert dialog for TnyAlerts
+ * if it's a aquest
+ *
+ * Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
+ **/
+gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
+
+
+/**
+ * modest_platform_remove_new_mail_notifications:
+ *
+ * Removes all the active new mail notifications
+ **/
+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__ */
projects / modest / blobdiff