#define __MODEST_WINDOW_MGR_H__
#include <glib-object.h>
-#include "widgets/modest-msg-view-window.h"
+#include "modest-window.h"
+#include <tny-header.h>
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))
struct _ModestWindowMgr {
GObject parent;
- /* insert public members, if any */
};
struct _ModestWindowMgrClass {
GObjectClass parent_class;
- /* insert signal callback declarations, eg. */
- /* void (* my_event) (ModestWindowMgr* obj); */
+
+ /* 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);
+ 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);
+ gboolean (*find_registered_message_uid) (ModestWindowMgr *self,
+ const gchar *msg_uid,
+ ModestWindow **win);
+ GList * (*get_window_list) (ModestWindowMgr *self);
+ ModestWindow * (*show_initial_window) (ModestWindowMgr *self);
+ ModestWindow * (*get_current_top) (ModestWindowMgr *self);
+ gboolean (*close_all_but_initial) (ModestWindowMgr *self);
+
+ gboolean (*screen_is_on) (ModestWindowMgr *self);
+ void (*create_caches) (ModestWindowMgr *self);
+
+ ModestWindow * (*get_folder_window) (ModestWindowMgr *self);
+
+ /* Signals */
+ void (*window_list_empty) (ModestWindowMgr *self);
+ void (*progress_list_changed) (ModestWindowMgr *self);
};
+
/* member functions */
GType modest_window_mgr_get_type (void) G_GNUC_CONST;
* 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:
* @self: the #ModestWindowMgr
* @window: a #ModestWindow
*
- * Unegisters a given window from the window manager. The window
+ * Unregisters a given window from the window manager. The window
* manager will free its reference to it.
**/
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_find_window_by_msguid:
- * @self: the #ModestWindowMgr
- * @msgid: the message uid
- *
- * Looks for a #ModestWindow that shows the message specified by the
- * message uid passed as argument
+ * modest_window_mgr_unregister_banner:
+ * @self: a #ModestWindowMgr
*
- * Return value: the #ModestWindow if found, else NULL
- **/
-ModestWindow* modest_window_mgr_find_window_by_msguid (ModestWindowMgr *self,
- const gchar *msguid);
+ * Decrease the count of pending banners in the window manager
+ */
+void modest_window_mgr_unregister_banner (ModestWindowMgr *self);
/**
* modest_window_mgr_set_fullscreen_mode:
- * @self:
- * @on:
+ * @self: a #ModestWindowMgr
+ * @on: a #gboolean
*
* sets/unsets the application windows in fullscreen mode
**/
void modest_window_mgr_set_fullscreen_mode (ModestWindowMgr *self,
gboolean on);
+
+/**
+ * modest_window_mgr_get_fullscreen_mode:
+ * @self: a #ModestWindowMgr
+ *
+ * gets the application current fullscreen mode
+ *
+ * Return value: TRUE is the application is in fullscrenn mode,
+ * otherwise FALSE
+ **/
+gboolean modest_window_mgr_get_fullscreen_mode (ModestWindowMgr *self);
+
+
+/**
+ * modest_window_mgr_show_toolbars:
+ * @self: a #ModestWindowMgr
+ * @window_type: apply the show toolbars command only to the windows of this type
+ * @show_toolbar: whether or not the toolbars should be shown
+ * @fullscreen: TRUE/FALSE for show/hide in fullscreen mode, otherwise
+ * it applies to normal mode
+ *
+ * shows or hides the toolbars of the registered windows. Note that if
+ * the #fullscreen attribute is TRUE and the application is in normal
+ * mode, you will not see the changes until the application switches
+ * to fullscreen mode and viceversa
+ **/
+void modest_window_mgr_show_toolbars (ModestWindowMgr *self,
+ GType window_type,
+ gboolean show_toolbars,
+ gboolean fullscreen);
+
+/**
+ * modest_window_mgr_get_modal:
+ * @self: a #ModestWindowMgr
+ *
+ * get the modal window; if it's NULL, there's no active modal window
+ *
+ * Returns: the modal window or NULL
+ **/
+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.
+ *
+ * Call this if hibernation should not be allowed because
+ * windows are open whose state cannot sensible be saved, such as Account
+ * Settings dialogs.
+ * This causes modest_window_mgr_get_hibernation_is_prevented() to return TRUE
+ * until all such windows have been closed. That means, until the windows have
+ * been hidden - window destruction or other memory management is not relevant.
+ **/
+void modest_window_mgr_prevent_hibernation_while_window_is_shown (ModestWindowMgr *self,
+ 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
+ * @header: a valid #TnyHeader
+ *
+ * search for the given uid in both the list of preregistered uids and in the window list;
+ * if it's available in the window list, fill the *win out-param
+ *
+ * returns TRUE if found, FALSE otherwise
+ **/
+gboolean modest_window_mgr_find_registered_header (ModestWindowMgr *self, TnyHeader *header,
+ ModestWindow **win);
+
+
+/**
+ * modest_window_mgr_find_registered_header
+ * @self: a #ModestWindowMgr
+ * @msg_uid: a message uid
+ *
+ * search for the given uid in both the list of preregistered uids and in the window list;
+ * if it's available in the window list, fill the *win out-param
+ *
+ * returns TRUE if found, FALSE otherwise
+ **/
+gboolean modest_window_mgr_find_registered_message_uid (ModestWindowMgr *self, const gchar *msg_uid,
+ 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, const gchar *alt_uid);
+
+
+/**
+ * modest_window_mgr_unregister_header
+ * @self: a #ModestWindowMgr
+ * @header: a valid #TnyHeader
+ *
+ * unregister the uid. We could need to do that if there is any error
+ * retrieving a message. In that case the window will not be
+ * registered and thus the header will not be removed, so we must do
+ * it manually
+ **/
+void modest_window_mgr_unregister_header (ModestWindowMgr *self, TnyHeader *header);
+
+/**
+ * modest_window_mgr_get_hibernation_is_prevented:
+ * @self: a #ModestWindowMgr
+ * @result: Whether any windows are currently preventing hibernation.
+ *
+ * Use this to discover whether hibernation should not be allowed because
+ * windows are open whose state cannot sensible be saved, such as Account
+ * Settings dialogs. This function will return true after someone has called
+ * modest_window_mgr_prevent_hibernation_while_window_is_shown() and before
+ * that window has been closed.
+ **/
+gboolean modest_window_mgr_get_hibernation_is_prevented (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_save_state_for_all_windows:
+ * @self: a #ModestWindowMgr
+ *
+ * Save any state for all windows. For instance, call this before allowing
+ * 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);
+
+/**
+ * modest_window_mgr_get_current_top:
+ * @self: a #ModestWindowMgr
+ *
+ * this function returns the ModestWindow that is currently on top of all the others
+ *
+ * Returns: the topmost #ModestWindow
+ **/
+ModestWindow* modest_window_mgr_get_current_top (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_screen_is_on:
+ * @self: a #ModestWindowMgr
+ *
+ * this function returns if device display is on or not
+ *
+ * Returns: %TRUE if screen is on, %FALSE if not
+ */
+gboolean modest_window_mgr_screen_is_on (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_get_progress_operations:
+ * @self: a #ModestWindowMgr
+ *
+ * get a list of operations in progress
+ *
+ * Returns: a newly allocated #TnyList
+ */
+TnyList *modest_window_mgr_get_progress_operations (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_has_progress_operation:
+ * @self: a #ModestWindowMgr
+ *
+ * is there are send/receive or receive operations in progress for any account.
+ *
+ * Returns: %TRUE if receive progress operations are in progress.
+ */
+gboolean modest_window_mgr_has_progress_operation (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_has_progress_operation_on_account:
+ * @self: a #ModestWindowMgr
+ * @account_name: a string
+ *
+ * is there are send/receive or receive operations in progress for @account_name.
+ *
+ * Returns: %TRUE if receive progress operations are in progress.
+ */
+gboolean modest_window_mgr_has_progress_operation_on_account (ModestWindowMgr *self,
+ const gchar *account_name);
+
+/**
+ * modest_window_mgr_create_caches:
+ * @self: a #ModestWindowMgr
+ *
+ * creates cached windows. This is called in modest main, just before the show-ui
+ * code. So it should be valid for the two startup ways (with --show-ui and without).
+ */
+void modest_window_mgr_create_caches (ModestWindowMgr *self);
+
+/**
+ * modest_window_mgr_close_all_but_initial:
+ * @self: a #ModestWindowMgr
+ *
+ * closes all but the initial window.
+ *
+ * Returns: %TRUE if the initial window is returned in @initial_window
+ * and it does not have any other dialog or window on top, otherwhise
+ * %FALSE
+ */
+gboolean modest_window_mgr_close_all_but_initial (ModestWindowMgr *self);
+
+ModestWindow *modest_window_mgr_get_folder_window (ModestWindowMgr *self);
+
+
G_END_DECLS
#endif /* __MODEST_WINDOW_MGR_H__ */
-
projects / modest / blobdiff