X-Git-Url: http://git.maemo.org/git/?a=blobdiff_plain;f=src%2Fwidgets%2Fmodest-window-mgr.h;h=d5eece0ed3042869b3d4407c72cc2c67de6b511f;hb=beae686e790fa6f231fbfeee19795330f0443a3a;hp=455f17c067948b83b465befea47f862029339903;hpb=63f8fe0a7c7eeae9c390bc87fb97703fe54438d8;p=modest diff --git a/src/widgets/modest-window-mgr.h b/src/widgets/modest-window-mgr.h index 455f17c..d5eece0 100644 --- a/src/widgets/modest-window-mgr.h +++ b/src/widgets/modest-window-mgr.h @@ -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)) @@ -48,15 +48,44 @@ typedef struct _ModestWindowMgrClass 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); + 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); + ModestWindow * (*get_current_top) (ModestWindowMgr *self); + gboolean (*screen_is_on) (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; @@ -72,8 +101,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: @@ -86,7 +116,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: @@ -113,6 +157,7 @@ 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 @@ -123,10 +168,63 @@ gboolean modest_window_mgr_get_fullscreen_mode (ModestWindowMgr *self); * 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_main_window: + * @self: a #ModestWindowMgr + * @show: if TRUE, create the main window and show it if it was not existing. + * + * 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, or the main-window + * did not yet exist + **/ +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_main_window_exists: + * @self: a #ModestWindowMgr + * + * do we have a main window? + * + * Returns: TRUE if there's a main window, FALSE otherwise + **/ +gboolean modest_window_mgr_main_window_exists (ModestWindowMgr *self); + + + +/** + * 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); -ModestWindow* modest_window_mgr_get_main_window (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: @@ -144,6 +242,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 @@ -157,18 +283,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); /** @@ -204,8 +349,104 @@ 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); + +/** + * 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); + G_END_DECLS #endif /* __MODEST_WINDOW_MGR_H__ */ -