* 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:
/**
* 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);
/**
gint modest_platform_run_confirmation_dialog (GtkWindow *parent_window,
const gchar *message);
+
+/**
+ * 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 confirmation dialog with the given values for the buttons
+ *
+ * Returns: GTK_RESPONSE_OK or GTK_RESPONSE_CANCEL
+ **/
+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_yes_no_dialog:
* @parent_window: the parent #GtkWindow of the dialog
gboolean modest_platform_connect_and_wait_if_network_folderstore (GtkWindow *parent_window, TnyFolderStore *folder_store);
/**
- * modest_platform_is_network_folderstore:
- * @folder_store: The folder store (folder or account) that needs to
- * decide if need a connection in subsequent operations.
- * @return value: Whether a connection is necessary for this folder_store.
- */
-gboolean modest_platform_is_network_folderstore (TnyFolderStore *folder_store);
-
-/**
* modest_platform_set_update_interval:
* @minutes: The number of minutes between updates, or 0 for no updates.
*
**/
GtkWidget* modest_platform_get_global_settings_dialog (void);
-void modest_platform_on_new_header_received (TnyHeader *header);
-
+/**
+ * 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,
+ gboolean show_visual);
/**
* modest_platform_show_help:
const gchar *help_id);
/**
- * modest_platform_set_dialog_help:
- * @dialog: a #GtkDialog
- * @help_id: the help topic id to be shown on requesting
- * help in the dialog
- *
- * attachs a help topic to the dialog
- **/
-void modest_platform_set_dialog_help (GtkDialog *parent_window,
- const gchar *help_id);
-
-/**
* modest_platform_show_search_messages:
* @parent_window: window the dialog will be child of
*
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,
*
* Returns: TRUE (Ok-pressed) or FALSE (cancel pressed)
**/
-gboolean modest_platform_run_certificate_conformation_dialog (const gchar* server_name,
+gboolean modest_platform_run_certificate_confirmation_dialog (const gchar* server_name,
const gchar *certificate);
gboolean modest_platform_run_alert_dialog (const gchar* prompt, gboolean is_question);
+/**
+ * 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 (gboolean only_visuals);
+
+/* 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);
+
+/**
+ * modest_platform_get_account_settings_dialog:
+ * @settings: a #ModestAccountSettings
+ *
+ * creates a dialog for editing @settings
+ *
+ * Returns: the newly created dialog.
+ */
+GtkWidget *modest_platform_get_account_settings_dialog (ModestAccountSettings *settings);
+
+/**
+ * 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_wizard ();
+
G_END_DECLS
#endif /* __MODEST_PLATFORM_UTILS_H__ */
projects / modest / blobdiff