Make ui dimming manager dispose stop delayed handlers (fixes NB#97124)
[modest] / src / widgets / modest-window.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #include "modest-window.h"
31 #include "modest-window-priv.h"
32 #include "modest-ui-actions.h"
33 #include "modest-tny-platform-factory.h"
34 #include "modest-runtime.h"
35 #include "modest-window-mgr.h"
36 #include "modest-defs.h"
37 #include <string.h> /* for strcmp */
38 #include <gdk/gdkkeysyms.h>
39
40 /* 'private'/'protected' functions */
41 static void modest_window_class_init (ModestWindowClass *klass);
42 static void modest_window_init       (ModestWindow *obj);
43 static void modest_window_finalize   (GObject *obj);
44 static void modest_window_dispose    (GObject *obj);
45
46 static gdouble  modest_window_get_zoom_default           (ModestWindow *window);
47
48 static gboolean modest_window_zoom_plus_default          (ModestWindow *window);
49
50 static gboolean modest_window_zoom_minus_default         (ModestWindow *window);
51
52 static void     modest_window_disconnect_signals_default (ModestWindow *self);
53
54 static void     modest_window_show_toolbar_default       (ModestWindow *window,
55                                                           gboolean show_toolbar);
56
57 static void     modest_window_set_zoom_default           (ModestWindow *window,
58                                                           gdouble zoom);
59
60 static gboolean on_key_pressed (GtkWidget *self, GdkEventKey *event, gpointer user_data);
61
62
63 /* list my signals  */
64 enum {
65         LAST_SIGNAL
66 };
67
68 /* globals */
69 static GObjectClass *parent_class = NULL;
70
71 /* uncomment the following if you have defined any signals */
72 /* static guint signals[LAST_SIGNAL] = {0}; */
73
74 GType
75 modest_window_get_type (void)
76 {
77         static GType my_type = 0;
78         static GType parent_type = 0;
79         if (!my_type) {
80                 static const GTypeInfo my_info = {
81                         sizeof(ModestWindowClass),
82                         NULL,           /* base init */
83                         NULL,           /* base finalize */
84                         (GClassInitFunc) modest_window_class_init,
85                         NULL,           /* class finalize */
86                         NULL,           /* class data */
87                         sizeof(ModestWindow),
88                         1,              /* n_preallocs */
89                         (GInstanceInitFunc) modest_window_init,
90                         NULL
91                 };
92 #ifndef MODEST_TOOLKIT_GTK
93 #ifdef MODEST_TOOLKIT_HILDON2
94                 parent_type = HILDON_TYPE_STACKABLE_WINDOW;
95 #else
96                 parent_type = HILDON_TYPE_WINDOW;
97 #endif
98 #else
99                 parent_type = GTK_TYPE_WINDOW;
100 #endif 
101                 my_type = g_type_register_static (parent_type,
102                                                   "ModestWindow",
103                                                   &my_info, 
104                                                   G_TYPE_FLAG_ABSTRACT);
105         }
106         return my_type;
107 }
108
109 static void
110 modest_window_class_init (ModestWindowClass *klass)
111 {
112         GObjectClass *gobject_class;
113         gobject_class = (GObjectClass*) klass;
114
115         parent_class            = g_type_class_peek_parent (klass);
116         gobject_class->dispose  = modest_window_dispose;
117         gobject_class->finalize = modest_window_finalize;
118
119         klass->set_zoom_func = modest_window_set_zoom_default;
120         klass->get_zoom_func = modest_window_get_zoom_default;
121         klass->zoom_plus_func = modest_window_zoom_plus_default;
122         klass->zoom_minus_func = modest_window_zoom_minus_default;
123         klass->show_toolbar_func = modest_window_show_toolbar_default;
124         klass->disconnect_signals_func = modest_window_disconnect_signals_default;
125
126         g_type_class_add_private (gobject_class, sizeof(ModestWindowPrivate));
127 }
128
129 static void
130 modest_window_init (ModestWindow *obj)
131 {
132         ModestWindowPrivate *priv;
133
134         priv = MODEST_WINDOW_GET_PRIVATE(obj);
135
136         priv->ui_manager     = NULL;
137         priv->ui_dimming_manager     = NULL;
138         priv->toolbar        = NULL;
139         priv->menubar        = NULL;
140
141         priv->dimming_state = NULL;
142         priv->ui_dimming_enabled = TRUE;
143         priv->active_account = NULL;
144
145         /* Connect signals */
146         g_signal_connect (G_OBJECT (obj), 
147                           "key-press-event", 
148                           G_CALLBACK (on_key_pressed), NULL);
149 }
150
151 static void
152 modest_window_finalize (GObject *obj)
153 {
154         ModestWindowPrivate *priv;      
155
156         priv = MODEST_WINDOW_GET_PRIVATE(obj);
157
158         if (priv->dimming_state != NULL) {
159                 g_slice_free (DimmedState, priv->dimming_state);
160                 priv->dimming_state = NULL;
161         }
162
163         g_free (priv->active_account);
164         
165         G_OBJECT_CLASS(parent_class)->finalize (obj);
166 }
167
168 static void
169 modest_window_dispose (GObject *obj)
170 {
171         ModestWindowPrivate *priv;      
172
173         priv = MODEST_WINDOW_GET_PRIVATE(obj);
174
175         priv->ui_dimming_enabled = FALSE;
176
177         if (priv->ui_manager) {
178                 g_object_unref (G_OBJECT(priv->ui_manager));
179                 priv->ui_manager = NULL;
180         }
181         if (priv->ui_dimming_manager) {
182                 g_object_run_dispose (G_OBJECT (priv->ui_dimming_manager));
183                 g_object_unref (G_OBJECT(priv->ui_dimming_manager));
184                 priv->ui_dimming_manager = NULL;
185         }
186         G_OBJECT_CLASS(parent_class)->dispose (obj);
187 }
188
189
190
191 const gchar*
192 modest_window_get_active_account (ModestWindow *self)
193 {
194         g_return_val_if_fail (self, NULL);
195         //g_warning ("%s: %s", __FUNCTION__, MODEST_WINDOW_GET_PRIVATE(self)->active_account);
196         return MODEST_WINDOW_GET_PRIVATE(self)->active_account;
197 }
198
199 void
200 modest_window_set_active_account (ModestWindow *self, const gchar *active_account)
201 {
202         ModestWindowPrivate *priv;
203
204         g_return_if_fail (self);        
205         priv = MODEST_WINDOW_GET_PRIVATE(self);
206
207         //g_warning ("%s: %s", __FUNCTION__, active_account);
208         
209         /* only 'real' account should be set here; for example the email signature
210          * depends on the current account, so if you reply to a message in your
211          * archive, it should take the signature from the real active account,
212          * not the non-existing one from your mmc-pseudo-account
213          */
214         if (active_account && ((strcmp (active_account, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0) ||
215                                (strcmp (active_account, MODEST_MMC_ACCOUNT_ID) == 0))) {
216                         g_warning ("%s: %s is not a valid active account",
217                                    __FUNCTION__, active_account);
218                         return;
219         }
220         
221         if (active_account == priv->active_account)
222                 return;
223         else {
224                 g_free (priv->active_account);
225                 priv->active_account = NULL;
226                 if (active_account)
227                         priv->active_account = g_strdup (active_account);
228         }
229 }
230
231 void
232 modest_window_check_dimming_rules (ModestWindow *self)
233 {
234         ModestWindowPrivate *priv;      
235
236         g_return_if_fail (MODEST_IS_WINDOW (self));
237         priv = MODEST_WINDOW_GET_PRIVATE(self);
238
239         if (priv->ui_dimming_enabled)
240                 modest_ui_dimming_manager_process_dimming_rules (priv->ui_dimming_manager);
241 }
242
243 void
244 modest_window_check_dimming_rules_group (ModestWindow *self,
245                                          const gchar *group_name)
246 {
247         ModestWindowPrivate *priv;      
248
249         g_return_if_fail (MODEST_IS_WINDOW (self));
250         priv = MODEST_WINDOW_GET_PRIVATE(self);
251
252         if (priv->ui_dimming_enabled)
253                 modest_ui_dimming_manager_process_dimming_rules_group (priv->ui_dimming_manager, group_name);
254 }
255
256 void
257 modest_window_set_dimming_state (ModestWindow *window,
258                                  DimmedState *state)
259 {
260         ModestWindowPrivate *priv;      
261
262         g_return_if_fail (MODEST_IS_WINDOW (window));
263         priv = MODEST_WINDOW_GET_PRIVATE(window);
264
265         /* Free previous */
266         if (priv->dimming_state != NULL)
267                 g_slice_free (DimmedState, priv->dimming_state);
268
269         /* Set new state */
270         priv->dimming_state = state;
271 }
272
273 const DimmedState *
274 modest_window_get_dimming_state (ModestWindow *window)
275 {
276         ModestWindowPrivate *priv;      
277
278         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
279         priv = MODEST_WINDOW_GET_PRIVATE(window);
280
281         return priv->dimming_state;
282 }
283
284 void
285 modest_window_disable_dimming (ModestWindow *self)
286 {
287         ModestWindowPrivate *priv;      
288
289         g_return_if_fail (MODEST_IS_WINDOW (self));
290         priv = MODEST_WINDOW_GET_PRIVATE(self);
291
292         priv->ui_dimming_enabled = FALSE;
293 }
294
295 void
296 modest_window_enable_dimming (ModestWindow *self)
297 {
298         ModestWindowPrivate *priv;      
299
300         g_return_if_fail (MODEST_IS_WINDOW (self));
301         priv = MODEST_WINDOW_GET_PRIVATE(self);
302
303         priv->ui_dimming_enabled = TRUE;
304 }
305
306 GtkAction *
307 modest_window_get_action (ModestWindow *window, 
308                           const gchar *action_path) 
309 {
310         GtkAction *action = NULL;
311         ModestWindowPrivate *priv;      
312
313         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
314         priv = MODEST_WINDOW_GET_PRIVATE(window);
315
316         action = gtk_ui_manager_get_action (priv->ui_manager, action_path);     
317
318         return action;
319 }
320
321 GtkWidget *
322 modest_window_get_action_widget (ModestWindow *window, 
323                                  const gchar *action_path) 
324 {
325         GtkWidget *widget = NULL;
326         ModestWindowPrivate *priv;      
327
328         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
329         priv = MODEST_WINDOW_GET_PRIVATE(window);
330
331         widget = gtk_ui_manager_get_widget (priv->ui_manager, action_path);     
332
333         return widget;
334 }
335
336 void
337 modest_window_set_zoom (ModestWindow *window,
338                         gdouble zoom)
339 {
340         MODEST_WINDOW_GET_CLASS (window)->set_zoom_func (window, zoom);
341         return;
342 }
343
344 gdouble
345 modest_window_get_zoom (ModestWindow *window)
346 {
347         return MODEST_WINDOW_GET_CLASS (window)->get_zoom_func (window);
348 }
349
350 gboolean
351 modest_window_zoom_plus (ModestWindow *window)
352 {
353         return MODEST_WINDOW_GET_CLASS (window)->zoom_plus_func (window);
354 }
355
356 gboolean
357 modest_window_zoom_minus (ModestWindow *window)
358 {
359         return MODEST_WINDOW_GET_CLASS (window)->zoom_minus_func (window);
360 }
361
362 void 
363 modest_window_show_toolbar (ModestWindow *window,
364                             gboolean show_toolbar)
365 {
366         MODEST_WINDOW_GET_CLASS (window)->show_toolbar_func (window,
367                                                              show_toolbar);
368 }
369
370 void 
371 modest_window_disconnect_signals (ModestWindow *window)
372 {
373         MODEST_WINDOW_GET_CLASS (window)->disconnect_signals_func (window);
374 }
375
376
377 /* Default implementations */
378
379 static void
380 modest_window_set_zoom_default (ModestWindow *window,
381                                 gdouble zoom)
382 {
383         g_warning ("modest: You should implement %s", __FUNCTION__);
384
385 }
386
387 static gdouble
388 modest_window_get_zoom_default (ModestWindow *window)
389 {
390         g_warning ("modest: You should implement %s", __FUNCTION__);
391         return 1.0;
392 }
393
394 static gboolean
395 modest_window_zoom_plus_default (ModestWindow *window)
396 {
397         g_warning ("modest: You should implement %s", __FUNCTION__);
398         return FALSE;
399 }
400
401 static gboolean
402 modest_window_zoom_minus_default (ModestWindow *window)
403 {
404         g_warning ("modest: You should implement %s", __FUNCTION__);
405         return FALSE;
406 }
407
408 static void 
409 modest_window_show_toolbar_default (ModestWindow *window,
410                                     gboolean show_toolbar)
411 {
412         g_warning ("modest: You should implement %s", __FUNCTION__);
413 }
414
415 static void 
416 modest_window_disconnect_signals_default (ModestWindow *self)
417 {
418         g_warning ("modest: You should implement %s", __FUNCTION__);
419 }
420
421 void
422 modest_window_save_state (ModestWindow *window)
423 {
424         ModestWindowClass *klass = MODEST_WINDOW_GET_CLASS (window);
425         if (klass->save_state_func)
426                 klass->save_state_func (window);
427 }
428
429 static gboolean
430 on_key_pressed (GtkWidget *self,
431                 GdkEventKey *event,
432                 gpointer user_data)
433 {
434         ModestWindowMgr *mgr = NULL;
435
436         mgr = modest_runtime_get_window_mgr ();
437
438         switch (event->keyval) {
439         case GDK_F6: 
440                 modest_ui_actions_on_change_fullscreen (NULL, MODEST_WINDOW(self));
441                 return TRUE;
442         case GDK_F7: 
443                 modest_ui_actions_on_zoom_plus (NULL, MODEST_WINDOW(self));
444                 return TRUE;
445         case GDK_F8: 
446                 modest_ui_actions_on_zoom_minus (NULL, MODEST_WINDOW(self));
447                 return TRUE;
448         case GDK_Escape: 
449                 if (modest_window_mgr_get_fullscreen_mode (mgr))
450                         modest_ui_actions_on_change_fullscreen (NULL, MODEST_WINDOW(self));
451                 else if (MODEST_IS_MSG_VIEW_WINDOW (self))
452                         modest_ui_actions_on_close_window (NULL, MODEST_WINDOW (self));
453                 break;
454         }
455         
456         return FALSE;
457 }