1 /* Copyright (c) 2006,2007 Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #ifndef __MODEST_WINDOW_MGR_H__
31 #define __MODEST_WINDOW_MGR_H__
33 #include <glib-object.h>
34 #include "widgets/modest-msg-view-window.h"
38 /* convenience macros */
39 #define MODEST_TYPE_WINDOW_MGR (modest_window_mgr_get_type())
40 #define MODEST_WINDOW_MGR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WINDOW_MGR,ModestWindowMgr))
41 #define MODEST_WINDOW_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WINDOW_MGR,ModestWindowMgrClass))
42 #define MODEST_IS_WINDOW_MGR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WINDOW_MGR))
43 #define MODEST_IS_WINDOW_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WINDOW_MGR))
44 #define MODEST_WINDOW_MGR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WINDOW_MGR,ModestWindowMgrClass))
46 typedef struct _ModestWindowMgr ModestWindowMgr;
47 typedef struct _ModestWindowMgrClass ModestWindowMgrClass;
49 struct _ModestWindowMgr {
53 struct _ModestWindowMgrClass {
54 GObjectClass parent_class;
57 gboolean (*register_window) (ModestWindowMgr *self,
59 ModestWindow *parent);
60 void (*unregister_window) (ModestWindowMgr *self,
61 ModestWindow *window);
62 void (*set_fullscreen_mode) (ModestWindowMgr *self,
64 gboolean (*get_fullscreen_mode) (ModestWindowMgr *self);
65 void (*show_toolbars) (ModestWindowMgr *self,
67 gboolean show_toolbars,
69 ModestWindow * (*get_main_window) (ModestWindowMgr *self,
71 gboolean (*close_all_windows) (ModestWindowMgr *self);
72 GtkWindow * (*get_modal) (ModestWindowMgr *self);
73 void (*set_modal) (ModestWindowMgr *self,
76 gboolean (*find_registered_header) (ModestWindowMgr *self,
79 GList * (*get_window_list) (ModestWindowMgr *self);
80 ModestWindow * (*show_initial_window) (ModestWindowMgr *self);
81 ModestWindow * (*get_current_top) (ModestWindowMgr *self);
82 gboolean (*screen_is_on) (ModestWindowMgr *self);
84 void (*window_list_empty) (ModestWindowMgr *self);
85 void (*progress_list_changed) (ModestWindowMgr *self);
89 /* member functions */
90 GType modest_window_mgr_get_type (void) G_GNUC_CONST;
92 /* typical parameter-less _new function */
93 ModestWindowMgr* modest_window_mgr_new (void);
97 * modest_window_mgr_register_window:
98 * @self: the #ModestWindowMgr
99 * @window: a #ModestWindow
101 * Registers a new window in the window manager. The window manager
102 * will keep a reference.
104 gboolean modest_window_mgr_register_window (ModestWindowMgr *self,
105 ModestWindow *window,
106 ModestWindow *parent);
109 * modest_window_mgr_unregister_window:
110 * @self: the #ModestWindowMgr
111 * @window: a #ModestWindow
113 * Unregisters a given window from the window manager. The window
114 * manager will free its reference to it.
116 void modest_window_mgr_unregister_window (ModestWindowMgr *self,
117 ModestWindow *window);
120 * modest_window_mgr_register_banner:
121 * @self: a #ModestWindowMgr
123 * Increase the count of pending banners in the window manager
125 void modest_window_mgr_register_banner (ModestWindowMgr *self);
128 * modest_window_mgr_unregister_banner:
129 * @self: a #ModestWindowMgr
131 * Decrease the count of pending banners in the window manager
133 void modest_window_mgr_unregister_banner (ModestWindowMgr *self);
136 * modest_window_mgr_set_fullscreen_mode:
137 * @self: a #ModestWindowMgr
140 * sets/unsets the application windows in fullscreen mode
142 void modest_window_mgr_set_fullscreen_mode (ModestWindowMgr *self,
146 * modest_window_mgr_get_fullscreen_mode:
147 * @self: a #ModestWindowMgr
149 * gets the application current fullscreen mode
151 * Return value: TRUE is the application is in fullscrenn mode,
154 gboolean modest_window_mgr_get_fullscreen_mode (ModestWindowMgr *self);
158 * modest_window_mgr_show_toolbars:
159 * @self: a #ModestWindowMgr
160 * @window_type: apply the show toolbars command only to the windows of this type
161 * @show_toolbar: whether or not the toolbars should be shown
162 * @fullscreen: TRUE/FALSE for show/hide in fullscreen mode, otherwise
163 * it applies to normal mode
165 * shows or hides the toolbars of the registered windows. Note that if
166 * the #fullscreen attribute is TRUE and the application is in normal
167 * mode, you will not see the changes until the application switches
168 * to fullscreen mode and viceversa
170 void modest_window_mgr_show_toolbars (ModestWindowMgr *self,
172 gboolean show_toolbars,
173 gboolean fullscreen);
175 * modest_window_mgr_get_main_window:
176 * @self: a #ModestWindowMgr
177 * @show: if TRUE, create the main window and show it if it was not existing.
179 * get the main window, and depending on @create, create one if it does not exist yet
181 * Returns: the main window or NULL in case of error, or the main-window
184 ModestWindow* modest_window_mgr_get_main_window (ModestWindowMgr *self,
188 * modest_window_mgr_set_main_window:
189 * @self: a #ModestWindowMgr
190 * @main_win: a #ModestMainWindow
192 void modest_window_mgr_set_main_window (ModestWindowMgr *self, ModestWindow *main_win);
196 * modest_window_mgr_main_window_exists:
197 * @self: a #ModestWindowMgr
199 * do we have a main window?
201 * Returns: TRUE if there's a main window, FALSE otherwise
203 gboolean modest_window_mgr_main_window_exists (ModestWindowMgr *self);
208 * modest_window_mgr_get_modal:
209 * @self: a #ModestWindowMgr
211 * get the modal window; if it's NULL, there's no active modal window
213 * Returns: the modal window or NULL
215 GtkWindow* modest_window_mgr_get_modal (ModestWindowMgr *self);
219 * modest_window_mgr_get_easysetup_dialog:
220 * @self: a #ModestWindowMgr
222 * set the modal dialog; set it to NULL after destroying the dialog
225 void modest_window_mgr_set_modal (ModestWindowMgr *self,
230 * modest_window_mgr_prevent_hibernation_while_window_is_shown:
231 * @self: a #ModestWindowMgr
232 * @window: The window that should prevent hibernation while it is shown.
234 * Call this if hibernation should not be allowed because
235 * windows are open whose state cannot sensible be saved, such as Account
237 * This causes modest_window_mgr_get_hibernation_is_prevented() to return TRUE
238 * until all such windows have been closed. That means, until the windows have
239 * been hidden - window destruction or other memory management is not relevant.
241 void modest_window_mgr_prevent_hibernation_while_window_is_shown (ModestWindowMgr *self,
247 * modest_window_mgr_register_help_id
248 * @self: a #ModestWindowMgr
250 * @help_id: the help_id for this window
252 * register a help id for a window
255 modest_window_mgr_register_help_id (ModestWindowMgr *self, GtkWindow *win, const gchar* help_id);
259 * modest_window_mgr_get_help_id:
260 * @self: a #ModestWindowMgr
263 * get the help id for a window; if the window is the main-window and some folder is
264 * selected, it will return the proper help_id for that
266 * Returns: a help _id
269 modest_window_mgr_get_help_id (ModestWindowMgr *self, GtkWindow *win);
274 * modest_window_mgr_find_registered_header
275 * @self: a #ModestWindowMgr
276 * @header: a valid #TnyHeader
278 * search for the given uid in both the list of preregistered uids and in the window list;
279 * if it's available in the window list, fill the *win out-param
281 * returns TRUE if found, FALSE otherwise
283 gboolean modest_window_mgr_find_registered_header (ModestWindowMgr *self, TnyHeader *header,
287 * modest_window_mgr_get_window_list:
288 * @self: a #ModestWindowMgr
290 * get the list of windows registered in window mgr.
292 * Returns: a #GList, that caller should free
294 GList *modest_window_mgr_get_window_list (ModestWindowMgr *self);
297 * modest_window_mgr_close_all_windows
298 * @self: a #ModestWindowMgr
300 * Close all registered windows. If failed (for example because
301 * one confirmation dialog rejected the operation), return %FALSE
303 gboolean modest_window_mgr_close_all_windows (ModestWindowMgr *self);
306 * modest_window_mgr_register_header
307 * @self: a #ModestWindowMgr
308 * @header: a valid #TnyHeader
309 * @alt_uid: alternative uid in case @header does not provide one
311 * register the uid, even before the window is created. thus, we know when
312 * some window creation might already be underway. the uid will automatically be
313 * removed when the window itself will registered
316 void modest_window_mgr_register_header (ModestWindowMgr *self, TnyHeader *header, const gchar *alt_uid);
320 * modest_window_mgr_unregister_header
321 * @self: a #ModestWindowMgr
322 * @header: a valid #TnyHeader
324 * unregister the uid. We could need to do that if there is any error
325 * retrieving a message. In that case the window will not be
326 * registered and thus the header will not be removed, so we must do
329 void modest_window_mgr_unregister_header (ModestWindowMgr *self, TnyHeader *header);
332 * modest_window_mgr_get_hibernation_is_prevented:
333 * @self: a #ModestWindowMgr
334 * @result: Whether any windows are currently preventing hibernation.
336 * Use this to discover whether hibernation should not be allowed because
337 * windows are open whose state cannot sensible be saved, such as Account
338 * Settings dialogs. This function will return true after someone has called
339 * modest_window_mgr_prevent_hibernation_while_window_is_shown() and before
340 * that window has been closed.
342 gboolean modest_window_mgr_get_hibernation_is_prevented (ModestWindowMgr *self);
345 * modest_window_mgr_save_state_for_all_windows:
346 * @self: a #ModestWindowMgr
348 * Save any state for all windows. For instance, call this before allowing
349 * application hibernation.
351 void modest_window_mgr_save_state_for_all_windows (ModestWindowMgr *self);
354 * modest_window_mgr_get_num_windows:
355 * @self: a #ModestWindowMgr
357 * Gets the number of already registered windows, and pending banners
359 * Returns: the number of already registered windows, and pending banners
361 guint modest_window_mgr_get_num_windows (ModestWindowMgr *self);
364 * modest_window_mgr_get_msg_view_window:
365 * @self: a #ModestWindowMgr
367 * obtain a cached #ModestMsgViewWindow if available, or construct a new
370 * Returns: a #ModestMsgViewWindow
372 GtkWidget * modest_window_mgr_get_msg_view_window (ModestWindowMgr *self);
375 * modest_window_mgr_get_msg_edit_window:
376 * @self: a #ModestWindowMgr
378 * obtain a cached #ModestMsgEditWindow if available, or construct a new
381 * Returns: a #ModestMsgEditWindow
383 GtkWidget * modest_window_mgr_get_msg_edit_window (ModestWindowMgr *self);
386 * modest_window_mgr_show_initial_window:
387 * @self: a #ModestWindowMgr
389 * This function determines which is the window that should be
390 * initially launched. After that it shows that window. If there is no
391 * account available this function also launches the account setup
394 * Returns: the initial window. NULL if something goes wrong
396 ModestWindow* modest_window_mgr_show_initial_window (ModestWindowMgr *self);
399 * modest_window_mgr_get_current_top:
400 * @self: a #ModestWindowMgr
402 * this function returns the ModestWindow that is currently on top of all the others
404 * Returns: the topmost #ModestWindow
406 ModestWindow* modest_window_mgr_get_current_top (ModestWindowMgr *self);
409 * modest_window_mgr_screen_is_on:
410 * @self: a #ModestWindowMgr
412 * this function returns if device display is on or not
414 * Returns: %TRUE if screen is on, %FALSE if not
416 gboolean modest_window_mgr_screen_is_on (ModestWindowMgr *self);
419 * modest_window_mgr_get_progress_operations:
420 * @self: a #ModestWindowMgr
422 * get a list of operations in progress
424 * Returns: a newly allocated #TnyList
426 TnyList *modest_window_mgr_get_progress_operations (ModestWindowMgr *self);
429 * modest_window_mgr_has_progress_operation:
430 * @self: a #ModestWindowMgr
432 * is there are send/receive or receive operations in progress for any account.
434 * Returns: %TRUE if receive progress operations are in progress.
436 gboolean modest_window_mgr_has_progress_operation (ModestWindowMgr *self);
439 * modest_window_mgr_has_progress_operation_on_account:
440 * @self: a #ModestWindowMgr
441 * @account_name: a string
443 * is there are send/receive or receive operations in progress for @account_name.
445 * Returns: %TRUE if receive progress operations are in progress.
447 gboolean modest_window_mgr_has_progress_operation_on_account (ModestWindowMgr *self,
448 const gchar *account_name);
452 #endif /* __MODEST_WINDOW_MGR_H__ */