This is a manual merge of branch drop split view intro trunk.
[modest] / src / widgets / modest-window-mgr.h
index 2518f5f..2398be2 100644 (file)
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
 /* convenience macros */
 #define MODEST_TYPE_WINDOW_MGR             (modest_window_mgr_get_type())
 #define MODEST_WINDOW_MGR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW_MGR,ModestWindowMgr))
-#define MODEST_WINDOW_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW_MGR,GObject))
+#define MODEST_WINDOW_MGR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW_MGR,ModestWindowMgrClass))
 #define MODEST_IS_WINDOW_MGR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW_MGR))
 #define MODEST_IS_WINDOW_MGR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW_MGR))
 #define MODEST_WINDOW_MGR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW_MGR,ModestWindowMgrClass))
@@ -52,6 +52,35 @@ struct _ModestWindowMgr {
 
 struct _ModestWindowMgrClass {
        GObjectClass parent_class;
+
+       /* Virtuals */
+       gboolean              (*register_window)                (ModestWindowMgr *self,
+                                                                ModestWindow *window,
+                                                                ModestWindow *parent);
+       void                  (*unregister_window)              (ModestWindowMgr *self,
+                                                                ModestWindow *window);
+       void                  (*set_fullscreen_mode)            (ModestWindowMgr *self,
+                                                                gboolean on);
+       gboolean              (*get_fullscreen_mode)            (ModestWindowMgr *self);
+       void                  (*show_toolbars)                  (ModestWindowMgr *self,
+                                                                GType window_type,
+                                                                gboolean show_toolbars,
+                                                                gboolean fullscreen);
+       ModestWindow *        (*get_main_window)                (ModestWindowMgr *self,
+                                                                gboolean show);
+       gboolean              (*close_all_windows)              (ModestWindowMgr *self);
+       GtkWindow *           (*get_modal)                      (ModestWindowMgr *self);
+       void                  (*set_modal)                      (ModestWindowMgr *self,
+                                                                GtkWindow *window,
+                                                                GtkWindow *parent);
+       gboolean              (*find_registered_header)         (ModestWindowMgr *self,
+                                                                TnyHeader *header,
+                                                                ModestWindow **win);
+       GList *               (*get_window_list)                (ModestWindowMgr *self);
+       ModestWindow *        (*show_initial_window)            (ModestWindowMgr *self);
+
+       /* Signals */
+       void (*window_list_empty) (ModestWindowMgr *self);
 };
 
 
@@ -70,8 +99,9 @@ ModestWindowMgr*    modest_window_mgr_new         (void);
  * Registers a new window in the window manager. The window manager
  * will keep a reference.
  **/
-void           modest_window_mgr_register_window       (ModestWindowMgr *self, 
-                                                       ModestWindow *window);
+gboolean           modest_window_mgr_register_window       (ModestWindowMgr *self, 
+                                                           ModestWindow *window,
+                                                           ModestWindow *parent);
 
 /**
  * modest_window_mgr_unregister_window:
@@ -84,7 +114,21 @@ void           modest_window_mgr_register_window       (ModestWindowMgr *self,
 void           modest_window_mgr_unregister_window     (ModestWindowMgr *self, 
                                                        ModestWindow *window);
 
+/**
+ * modest_window_mgr_register_banner:
+ * @self: a #ModestWindowMgr
+ *
+ * Increase the count of pending banners in the window manager
+ */
+void           modest_window_mgr_register_banner (ModestWindowMgr *self);
 
+/**
+ * modest_window_mgr_unregister_banner:
+ * @self: a #ModestWindowMgr
+ *
+ * Decrease the count of pending banners in the window manager
+ */
+void           modest_window_mgr_unregister_banner (ModestWindowMgr *self);
 
 /**
  * modest_window_mgr_set_fullscreen_mode:
@@ -128,39 +172,59 @@ void           modest_window_mgr_show_toolbars         (ModestWindowMgr *self,
 /**
  * modest_window_mgr_get_main_window:
  * @self: a #ModestWindowMgr
+ * @show: if TRUE, create the main window and show it if it was not existing.
  *
- * get the main window, or create if it's not there. don't destroy
- * it.
+ * get the main window, and depending on @create, create one if it does not exist yet
  *
- * Returns: the main window or NULL in case of error
+ * Returns: the main window or NULL in case of error, or the main-window
+ * did not yet exist
  **/
-ModestWindow*  modest_window_mgr_get_main_window       (ModestWindowMgr *self);
+ModestWindow*  modest_window_mgr_get_main_window       (ModestWindowMgr *self,
+                                                       gboolean show);
+
+/**
+ * modest_window_mgr_set_main_window:
+ * @self: a #ModestWindowMgr
+ * @main_win: a #ModestMainWindow
+ */
+void modest_window_mgr_set_main_window (ModestWindowMgr *self, ModestWindow *main_win);
 
 
 /**
- * modest_window_mgr_get_easysetup_dialog:
+ * modest_window_mgr_main_window_exists:
  * @self: a #ModestWindowMgr
  *
- * get the easysetup dialog; if it's NULL, there's no active dialog
+ * do we have a main window?
  *
- * Returns: the easy setup dialog or NULL
+ * Returns: TRUE if there's a main window, FALSE otherwise
  **/
-GtkDialog*    modest_window_mgr_get_easysetup_dialog  (ModestWindowMgr *self);
+gboolean  modest_window_mgr_main_window_exists       (ModestWindowMgr *self);
+
 
 
 /**
- * modest_window_mgr_get_easysetup_dialog:
+ * modest_window_mgr_get_modal:
  * @self: a #ModestWindowMgr
  *
- * set the easysetup dialog; set it to NULL after destroying the dialog
+ * get the modal window; if it's NULL, there's no active modal window
  *
- * Returns: the easy setup dialog just set
+ * Returns: the modal window or NULL
  **/
-GtkDialog*    modest_window_mgr_set_easysetup_dialog  (ModestWindowMgr *self,
-                                                      GtkDialog *dialog);
+GtkWindow*    modest_window_mgr_get_modal  (ModestWindowMgr *self);
 
 
 /**
+ * modest_window_mgr_get_easysetup_dialog:
+ * @self: a #ModestWindowMgr
+ *
+ * set the modal dialog; set it to NULL after destroying the dialog
+ *
+ **/
+void          modest_window_mgr_set_modal  (ModestWindowMgr *self,
+                                           GtkWindow *window,
+                                           GtkWindow *parent);
+
+/**
  * modest_window_mgr_prevent_hibernation_while_window_is_shown:
  * @self: a #ModestWindowMgr
  * @window: The window that should prevent hibernation while it is shown.
@@ -176,6 +240,34 @@ void modest_window_mgr_prevent_hibernation_while_window_is_shown (ModestWindowMg
        GtkWindow *window);
 
 
+
+/**
+ * modest_window_mgr_register_help_id
+ * @self: a #ModestWindowMgr
+ * @win: some window
+ * @help_id: the help_id for this window
+ * 
+ * register a help id for a window
+ **/
+void
+modest_window_mgr_register_help_id (ModestWindowMgr *self, GtkWindow *win, const gchar* help_id);
+
+
+/**
+ * modest_window_mgr_get_help_id:
+ * @self: a #ModestWindowMgr
+ * @win: some window
+ * 
+ * get the help id for a window; if the window is the main-window and some folder is
+ * selected, it will return the proper help_id for that
+ *
+ * Returns: a help _id
+ **/
+const gchar*
+modest_window_mgr_get_help_id (ModestWindowMgr *self, GtkWindow *win);
+
+
+
 /**
  * modest_window_mgr_find_registered_header
  * @self: a #ModestWindowMgr
@@ -189,18 +281,37 @@ void modest_window_mgr_prevent_hibernation_while_window_is_shown (ModestWindowMg
 gboolean modest_window_mgr_find_registered_header (ModestWindowMgr *self,  TnyHeader *header,
                                               ModestWindow **win);
 
+/**
+ * modest_window_mgr_get_window_list:
+ * @self: a #ModestWindowMgr
+ *
+ * get the list of windows registered in window mgr.
+ *
+ * Returns: a #GList, that caller should free
+ */
+GList *modest_window_mgr_get_window_list (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_close_all_windows
+ * @self: a #ModestWindowMgr
+ * 
+ * Close all registered windows. If failed (for example because
+ * one confirmation dialog rejected the operation), return %FALSE
+ **/
+gboolean modest_window_mgr_close_all_windows (ModestWindowMgr *self);
 
 /**
  * modest_window_mgr_register_header
  * @self: a #ModestWindowMgr
  * @header: a valid #TnyHeader
+ * @alt_uid: alternative uid in case @header does not provide one
  * 
  * register the uid, even before the window is created. thus, we know when
  * some window creation might already be underway. the uid will automatically be
  * removed when the window itself will registered
  * 
  **/
-void  modest_window_mgr_register_header   (ModestWindowMgr *self,  TnyHeader *header);
+void  modest_window_mgr_register_header   (ModestWindowMgr *self,  TnyHeader *header, const gchar *alt_uid);
        
 
 /**
@@ -236,8 +347,52 @@ gboolean modest_window_mgr_get_hibernation_is_prevented (ModestWindowMgr *self);
  * application hibernation.
  **/
 void modest_window_mgr_save_state_for_all_windows (ModestWindowMgr *self);
-       
+
+/**
+ * modest_window_mgr_get_num_windows:
+ * @self: a #ModestWindowMgr
+ * 
+ * Gets the number of already registered windows, and pending banners
+ *
+ * Returns: the number of already registered windows, and pending banners
+ **/
+guint modest_window_mgr_get_num_windows (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_get_msg_view_window:
+ * @self: a #ModestWindowMgr
+ *
+ * obtain a cached #ModestMsgViewWindow if available, or construct a new
+ * one.
+ *
+ * Returns: a #ModestMsgViewWindow
+ */
+GtkWidget *   modest_window_mgr_get_msg_view_window (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_get_msg_edit_window:
+ * @self: a #ModestWindowMgr
+ *
+ * obtain a cached #ModestMsgEditWindow if available, or construct a new
+ * one.
+ *
+ * Returns: a #ModestMsgEditWindow
+ */
+GtkWidget *   modest_window_mgr_get_msg_edit_window (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_show_initial_window:
+ * @self: a #ModestWindowMgr
+ *
+ * This function determines which is the window that should be
+ * initially launched. After that it shows that window. If there is no
+ * account available this function also launches the account setup
+ * wizard.
+ *
+ * Returns: the initial window. NULL if something goes wrong
+ **/
+ModestWindow* modest_window_mgr_show_initial_window (ModestWindowMgr *self);
+
 G_END_DECLS
 
 #endif /* __MODEST_WINDOW_MGR_H__ */
-