Added API to ModestAccountProtocol to fetch icons

[modest] / src / modest-account-protocol.h

diff --git a/src/modest-account-protocol.h b/src/modest-account-protocol.h
index eca9b0f..74604b6 100644 (file)
--- a/src/modest-account-protocol.h
+++ b/src/modest-account-protocol.h
@@ -35,6 +35,7 @@
 
 #include "widgets/modest-account-settings-dialog.h"
 #include "modest-protocol.h"
+#include "widgets/modest-wizard-dialog.h"
 #include "modest-pair.h"
 #include <tny-account.h>
 #include <tny-list.h>
@@ -52,6 +53,16 @@ G_BEGIN_DECLS
 typedef struct _ModestAccountProtocol      ModestAccountProtocol;
 typedef struct _ModestAccountProtocolClass ModestAccountProtocolClass;
 
+typedef enum {
+       MODEST_ACCOUNT_PROTOCOL_ICON_MAILBOX = 0,
+       MODEST_ACCOUNT_PROTOCOL_ICON_PROTOCOL,
+       MODEST_ACCOUNT_PROTOCOL_ICON_ACCOUNT,
+       MODEST_ACCOUNT_PROTOCOL_ICON_FOLDER,
+} ModestAccountProtocolIconType;
+
+typedef void (*ModestAccountProtocolCheckSupportFunc) (ModestAccountProtocol *self, 
+                                                      gboolean supported, gpointer userdata);
+
 
 struct _ModestAccountProtocol {
        ModestProtocol parent;
@@ -64,8 +75,16 @@ struct _ModestAccountProtocolClass {
        TnyAccount * (*create_account) (ModestAccountProtocol *self);
        ModestAccountSettingsDialog* (*create_account_settings_dialog) (ModestAccountProtocol* self);
        ModestPairList* (*get_easysetupwizard_tabs) (ModestAccountProtocol* self);
+       ModestWizardDialogResponseOverrideFunc (*get_wizard_response_override) (ModestAccountProtocol *self);
        void (*save_settings) (ModestAccountProtocol *self, ModestAccountSettingsDialog *dialog, ModestAccountSettings *settings);
        void (*save_wizard_settings) (ModestAccountProtocol *self, GList *wizard_pages, ModestAccountSettings *settings);
+       gboolean (*is_supported) (ModestAccountProtocol *self);
+       void (*check_support) (ModestAccountProtocol *self, ModestAccountProtocolCheckSupportFunc func, gpointer userdata);
+       gchar * (*get_from) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox);
+       ModestPairList * (*get_from_list) (ModestAccountProtocol *self, const gchar *account_id);
+       gchar * (*get_signature) (ModestAccountProtocol *self, const gchar *account_id, const gchar *mailbox, gboolean *has_signature);
+       const GdkPixbuf * (*get_icon) (ModestAccountProtocol *self, ModestAccountProtocolIconType icon_type, 
+                                      GObject *object, guint icon_size);
 };
 
 /**
@@ -272,6 +291,103 @@ void modest_account_protocol_save_wizard_settings (ModestAccountProtocol *self,
                                                   GList *wizard_pages,
                                                   ModestAccountSettings *settings);
 
+/**
+ * modest_account_protocol_get_wizard_response_override:
+ * @self: a #ModestAccountProtocol
+ *
+ * obtains the method that should be used to override wizard response behavior when the
+ * wizard is setting up this account type.
+ *
+ * Returns: a #ModestWizardDialogResponseOverrideFunc
+ */
+ModestWizardDialogResponseOverrideFunc modest_account_protocol_get_wizard_response_override (ModestAccountProtocol *self);
+
+
+/**
+ * modest_account_protocol_check_support:
+ * @self: a #ModestAccountProtocol
+ * @func: a #ModestAccountProtocolCheckSupportFunc
+ * @userdata: a gpointer
+ *
+ * This method checks asynchronously if the account protocol @self is
+ * supported. Once checked, @func will be called with the result in the
+ * mainloop.
+ *
+ * modest_account_protocol_is_supported() should return the cached response
+ * from this method.
+ */
+void modest_account_protocol_check_support (ModestAccountProtocol *self, 
+                                           ModestAccountProtocolCheckSupportFunc func, 
+                                           gpointer userdata);
+/**
+ * modest_account_protocol_is_supported:
+ * @self: a #ModestAccountProtocol
+ *
+ * Determines if the account protocol is supported on this device.
+ *
+ * Returns: %TRUE if the protocol is supported, %FALSE otherwise
+ */
+gboolean modest_account_protocol_is_supported (ModestAccountProtocol *self);
+
+/**
+ * modest_account_protocol_get_from:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the From: string for the account and mailbox. Should be used only
+ * with transports with multi mailbox support.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_account_protocol_get_from (ModestAccountProtocol *self,
+                                        const gchar *account_id,
+                                        const gchar *mailbox);
+
+/**
+ * modest_account_protocol_get_from_list:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ *
+ * Obtain a list of pairs (mailbox - From: string) for filling the From picker.
+ *
+ * Returns: a ModestPairList
+ */
+ModestPairList *modest_account_protocol_get_from_list (ModestAccountProtocol *self,
+                                                      const gchar *account_id);
+
+/**
+ * modest_account_protocol_get_signature:
+ * @self: a #ModestAccountProtocol
+ * @account_id: a transport account name
+ * @mailbox: a mailbox
+ *
+ * Obtain the signature string for the account and mailbox. Should be used only
+ * with transports with multi mailbox support.
+ *
+ * Returns: a newly allocated string
+ */
+gchar *modest_account_protocol_get_signature (ModestAccountProtocol *self,
+                                             const gchar *account_id,
+                                             const gchar *mailbox,
+                                             gboolean *has_signature);
+
+/**
+ * modest_account_protocol_get_icon:
+ * @self: a #ModestAccountProtocl
+ * @icon_type: a #ModestAccountProtocolIconType
+ * @object: a #GObject
+ * @icon_size: the icon size to get
+ *
+ * Returns a @self owned #GdkPixbuf with the icon for @icon_type and @object. @object type
+ * should match @icon_type.
+ *
+ * Returns: a #GdkPixbuf (don't free or manipulate this, just copy)
+ */
+const GdkPixbuf * modest_account_protocol_get_icon (ModestAccountProtocol *self, ModestAccountProtocolIconType icon_type, 
+                                                   GObject *object, guint icon_size);
+
+
 G_END_DECLS
 
 #endif /* __MODEST_ACCOUNT_PROTOCOL_H__ */