Replaced modest_folder_window_finalize by dispose
[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 #include <gdk/gdk.h>
40 #include <gdk/gdkx.h>
41 #include <X11/Xatom.h>
42 #include <X11/XKBlib.h>
43 #include <X11/Xdmcp.h>
44 #ifdef MODEST_TOOLKIT_HILDON2
45 #include <hildon/hildon-defines.h>
46 #endif
47
48 /* 'private'/'protected' functions */
49 static void modest_window_class_init (ModestWindowClass *klass);
50 static void modest_window_init       (ModestWindow *obj);
51 static void modest_window_finalize   (GObject *obj);
52 static void modest_window_dispose    (GObject *obj);
53
54 static gdouble  modest_window_get_zoom_default           (ModestWindow *window);
55
56 static gboolean modest_window_zoom_plus_default          (ModestWindow *window);
57
58 static gboolean modest_window_zoom_minus_default         (ModestWindow *window);
59
60 static void     modest_window_disconnect_signals_default (ModestWindow *self);
61
62 static void     modest_window_show_toolbar_default       (ModestWindow *window,
63                                                           gboolean show_toolbar);
64
65 static void     modest_window_set_zoom_default           (ModestWindow *window,
66                                                           gdouble zoom);
67
68 static gboolean on_key_pressed (GtkWidget *self, GdkEventKey *event, gpointer user_data);
69 static void _make_zoom_buttons_grabeable (GtkWidget* widget);
70 static gboolean _modest_window_map_event (GtkWidget *widget,
71                                           GdkEvent *event,
72                                           gpointer userdata);
73
74 /* list my signals  */
75 enum {
76         LAST_SIGNAL
77 };
78
79 /* globals */
80 static GObjectClass *parent_class = NULL;
81
82 /* uncomment the following if you have defined any signals */
83 /* static guint signals[LAST_SIGNAL] = {0}; */
84
85 GType
86 modest_window_get_type (void)
87 {
88         static GType my_type = 0;
89         static GType parent_type = 0;
90         if (!my_type) {
91                 static const GTypeInfo my_info = {
92                         sizeof(ModestWindowClass),
93                         NULL,           /* base init */
94                         NULL,           /* base finalize */
95                         (GClassInitFunc) modest_window_class_init,
96                         NULL,           /* class finalize */
97                         NULL,           /* class data */
98                         sizeof(ModestWindow),
99                         1,              /* n_preallocs */
100                         (GInstanceInitFunc) modest_window_init,
101                         NULL
102                 };
103 #ifndef MODEST_TOOLKIT_GTK
104 #ifdef MODEST_TOOLKIT_HILDON2
105                 parent_type = HILDON_TYPE_STACKABLE_WINDOW;
106 #else
107                 parent_type = HILDON_TYPE_WINDOW;
108 #endif
109 #else
110                 parent_type = GTK_TYPE_WINDOW;
111 #endif 
112                 my_type = g_type_register_static (parent_type,
113                                                   "ModestWindow",
114                                                   &my_info, 
115                                                   G_TYPE_FLAG_ABSTRACT);
116         }
117         return my_type;
118 }
119
120 static void
121 modest_window_class_init (ModestWindowClass *klass)
122 {
123         GObjectClass *gobject_class;
124         gobject_class = (GObjectClass*) klass;
125
126         parent_class            = g_type_class_peek_parent (klass);
127         gobject_class->dispose  = modest_window_dispose;
128         gobject_class->finalize = modest_window_finalize;
129
130         klass->set_zoom_func = modest_window_set_zoom_default;
131         klass->get_zoom_func = modest_window_get_zoom_default;
132         klass->zoom_plus_func = modest_window_zoom_plus_default;
133         klass->zoom_minus_func = modest_window_zoom_minus_default;
134         klass->show_toolbar_func = modest_window_show_toolbar_default;
135         klass->disconnect_signals_func = modest_window_disconnect_signals_default;
136
137         g_type_class_add_private (gobject_class, sizeof(ModestWindowPrivate));
138 }
139
140 static void
141 modest_window_init (ModestWindow *obj)
142 {
143         ModestWindowPrivate *priv;
144
145         priv = MODEST_WINDOW_GET_PRIVATE(obj);
146
147         priv->ui_manager     = NULL;
148         priv->ui_dimming_manager     = NULL;
149         priv->toolbar        = NULL;
150         priv->menubar        = NULL;
151
152         priv->dimming_state = NULL;
153         priv->ui_dimming_enabled = TRUE;
154         priv->active_account = NULL;
155         priv->active_mailbox = NULL;
156
157         /* Connect signals */
158         g_signal_connect (G_OBJECT (obj), 
159                           "key-press-event", 
160                           G_CALLBACK (on_key_pressed), NULL);
161         g_signal_connect (G_OBJECT (obj), "map-event",
162                           G_CALLBACK (_modest_window_map_event),
163                           G_OBJECT (obj));
164 }
165
166 static void
167 modest_window_finalize (GObject *obj)
168 {
169         ModestWindowPrivate *priv;      
170
171         priv = MODEST_WINDOW_GET_PRIVATE(obj);
172
173         if (priv->dimming_state != NULL) {
174                 g_slice_free (DimmedState, priv->dimming_state);
175                 priv->dimming_state = NULL;
176         }
177
178         g_free (priv->active_account);
179         g_free (priv->active_mailbox);
180         
181         G_OBJECT_CLASS(parent_class)->finalize (obj);
182 }
183
184 static void
185 modest_window_dispose (GObject *obj)
186 {
187         ModestWindowPrivate *priv;
188
189         priv = MODEST_WINDOW_GET_PRIVATE(obj);
190
191         priv->ui_dimming_enabled = FALSE;
192
193         if (priv->ui_manager) {
194                 g_object_unref (G_OBJECT(priv->ui_manager));
195                 priv->ui_manager = NULL;
196         }
197         if (priv->ui_dimming_manager) {
198                 g_object_run_dispose (G_OBJECT (priv->ui_dimming_manager));
199                 g_object_unref (G_OBJECT(priv->ui_dimming_manager));
200                 priv->ui_dimming_manager = NULL;
201         }
202
203         G_OBJECT_CLASS(parent_class)->dispose (obj);
204 }
205
206
207
208 const gchar*
209 modest_window_get_active_account (ModestWindow *self)
210 {
211         g_return_val_if_fail (self, NULL);
212         //g_warning ("%s: %s", __FUNCTION__, MODEST_WINDOW_GET_PRIVATE(self)->active_account);
213         return MODEST_WINDOW_GET_PRIVATE(self)->active_account;
214 }
215
216 void
217 modest_window_set_active_account (ModestWindow *self, const gchar *active_account)
218 {
219         ModestWindowPrivate *priv;
220
221         g_return_if_fail (self);        
222         priv = MODEST_WINDOW_GET_PRIVATE(self);
223
224         //g_warning ("%s: %s", __FUNCTION__, active_account);
225         
226         /* only 'real' account should be set here; for example the email signature
227          * depends on the current account, so if you reply to a message in your
228          * archive, it should take the signature from the real active account,
229          * not the non-existing one from your mmc-pseudo-account
230          */
231         if (active_account && ((strcmp (active_account, MODEST_LOCAL_FOLDERS_ACCOUNT_ID) == 0) ||
232                                (strcmp (active_account, MODEST_MMC_ACCOUNT_ID) == 0))) {
233                         g_warning ("%s: %s is not a valid active account",
234                                    __FUNCTION__, active_account);
235                         return;
236         }
237         
238         if (active_account == priv->active_account)
239                 return;
240         else {
241                 g_free (priv->active_account);
242                 priv->active_account = NULL;
243                 if (active_account)
244                         priv->active_account = g_strdup (active_account);
245         }
246 }
247
248 const gchar*
249 modest_window_get_active_mailbox (ModestWindow *self)
250 {
251         g_return_val_if_fail (self, NULL);
252         return MODEST_WINDOW_GET_PRIVATE(self)->active_mailbox;
253 }
254
255 void
256 modest_window_set_active_mailbox (ModestWindow *self, const gchar *active_mailbox)
257 {
258         ModestWindowPrivate *priv;
259
260         g_return_if_fail (self);        
261         priv = MODEST_WINDOW_GET_PRIVATE(self);
262
263         if (active_mailbox == priv->active_mailbox)
264                 return;
265         else {
266                 g_free (priv->active_mailbox);
267                 priv->active_mailbox = NULL;
268                 if (active_mailbox)
269                         priv->active_mailbox = g_strdup (active_mailbox);
270         }
271 }
272
273 void
274 modest_window_check_dimming_rules (ModestWindow *self)
275 {
276         ModestWindowPrivate *priv;      
277
278         g_return_if_fail (MODEST_IS_WINDOW (self));
279         priv = MODEST_WINDOW_GET_PRIVATE(self);
280
281         if (priv->ui_dimming_enabled)
282                 modest_ui_dimming_manager_process_dimming_rules (priv->ui_dimming_manager);
283 }
284
285 void
286 modest_window_check_dimming_rules_group (ModestWindow *self,
287                                          const gchar *group_name)
288 {
289         ModestWindowPrivate *priv;      
290
291         g_return_if_fail (MODEST_IS_WINDOW (self));
292         priv = MODEST_WINDOW_GET_PRIVATE(self);
293
294         if (priv->ui_dimming_enabled)
295                 modest_ui_dimming_manager_process_dimming_rules_group (priv->ui_dimming_manager, group_name);
296 }
297
298 void
299 modest_window_set_dimming_state (ModestWindow *window,
300                                  DimmedState *state)
301 {
302         ModestWindowPrivate *priv;      
303
304         g_return_if_fail (MODEST_IS_WINDOW (window));
305         priv = MODEST_WINDOW_GET_PRIVATE(window);
306
307         /* Free previous */
308         if (priv->dimming_state != NULL)
309                 g_slice_free (DimmedState, priv->dimming_state);
310
311         /* Set new state */
312         priv->dimming_state = state;
313 }
314
315 const DimmedState *
316 modest_window_get_dimming_state (ModestWindow *window)
317 {
318         ModestWindowPrivate *priv;      
319
320         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
321         priv = MODEST_WINDOW_GET_PRIVATE(window);
322
323         return priv->dimming_state;
324 }
325
326 void
327 modest_window_disable_dimming (ModestWindow *self)
328 {
329         ModestWindowPrivate *priv;      
330
331         g_return_if_fail (MODEST_IS_WINDOW (self));
332         priv = MODEST_WINDOW_GET_PRIVATE(self);
333
334         priv->ui_dimming_enabled = FALSE;
335 }
336
337 void
338 modest_window_enable_dimming (ModestWindow *self)
339 {
340         ModestWindowPrivate *priv;      
341
342         g_return_if_fail (MODEST_IS_WINDOW (self));
343         priv = MODEST_WINDOW_GET_PRIVATE(self);
344
345         priv->ui_dimming_enabled = TRUE;
346 }
347
348 GtkAction *
349 modest_window_get_action (ModestWindow *window, 
350                           const gchar *action_path) 
351 {
352         GtkAction *action = NULL;
353         ModestWindowPrivate *priv;      
354
355         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
356         priv = MODEST_WINDOW_GET_PRIVATE(window);
357
358         action = gtk_ui_manager_get_action (priv->ui_manager, action_path);     
359
360         return action;
361 }
362
363 GtkWidget *
364 modest_window_get_action_widget (ModestWindow *window, 
365                                  const gchar *action_path) 
366 {
367         GtkWidget *widget = NULL;
368         ModestWindowPrivate *priv;      
369
370         g_return_val_if_fail (MODEST_IS_WINDOW (window), NULL);
371         priv = MODEST_WINDOW_GET_PRIVATE(window);
372
373         widget = gtk_ui_manager_get_widget (priv->ui_manager, action_path);     
374
375         return widget;
376 }
377
378 void
379 modest_window_set_zoom (ModestWindow *window,
380                         gdouble zoom)
381 {
382         MODEST_WINDOW_GET_CLASS (window)->set_zoom_func (window, zoom);
383         return;
384 }
385
386 gdouble
387 modest_window_get_zoom (ModestWindow *window)
388 {
389         return MODEST_WINDOW_GET_CLASS (window)->get_zoom_func (window);
390 }
391
392 gboolean
393 modest_window_zoom_plus (ModestWindow *window)
394 {
395         return MODEST_WINDOW_GET_CLASS (window)->zoom_plus_func (window);
396 }
397
398 gboolean
399 modest_window_zoom_minus (ModestWindow *window)
400 {
401         return MODEST_WINDOW_GET_CLASS (window)->zoom_minus_func (window);
402 }
403
404 void 
405 modest_window_show_toolbar (ModestWindow *window,
406                             gboolean show_toolbar)
407 {
408         MODEST_WINDOW_GET_CLASS (window)->show_toolbar_func (window,
409                                                              show_toolbar);
410 }
411
412 void 
413 modest_window_disconnect_signals (ModestWindow *window)
414 {
415         MODEST_WINDOW_GET_CLASS (window)->disconnect_signals_func (window);
416 }
417
418
419 /* Default implementations */
420
421 static void
422 modest_window_set_zoom_default (ModestWindow *window,
423                                 gdouble zoom)
424 {
425         g_warning ("modest: You should implement %s", __FUNCTION__);
426
427 }
428
429 static gdouble
430 modest_window_get_zoom_default (ModestWindow *window)
431 {
432         g_warning ("modest: You should implement %s", __FUNCTION__);
433         return 1.0;
434 }
435
436 static gboolean
437 modest_window_zoom_plus_default (ModestWindow *window)
438 {
439         g_warning ("modest: You should implement %s", __FUNCTION__);
440         return FALSE;
441 }
442
443 static gboolean
444 modest_window_zoom_minus_default (ModestWindow *window)
445 {
446         g_warning ("modest: You should implement %s", __FUNCTION__);
447         return FALSE;
448 }
449
450 static void 
451 modest_window_show_toolbar_default (ModestWindow *window,
452                                     gboolean show_toolbar)
453 {
454         g_warning ("modest: You should implement %s", __FUNCTION__);
455 }
456
457 static void 
458 modest_window_disconnect_signals_default (ModestWindow *self)
459 {
460         g_warning ("modest: You should implement %s", __FUNCTION__);
461 }
462
463 void
464 modest_window_save_state (ModestWindow *window)
465 {
466         ModestWindowClass *klass = MODEST_WINDOW_GET_CLASS (window);
467         if (klass->save_state_func)
468                 klass->save_state_func (window);
469 }
470
471 static gboolean
472 on_key_pressed (GtkWidget *self,
473                 GdkEventKey *event,
474                 gpointer user_data)
475 {
476         ModestWindowMgr *mgr = NULL;
477
478         mgr = modest_runtime_get_window_mgr ();
479
480         switch (event->keyval) {
481         case GDK_F6: 
482                 modest_ui_actions_on_change_fullscreen (NULL, MODEST_WINDOW(self));
483                 return TRUE;
484 #ifdef MODEST_TOOLKIT_HILDON2
485         case HILDON_HARDKEY_INCREASE: 
486                 modest_ui_actions_on_zoom_plus (NULL, MODEST_WINDOW(self));
487                 return TRUE;
488         case HILDON_HARDKEY_DECREASE: 
489                 modest_ui_actions_on_zoom_minus (NULL, MODEST_WINDOW(self));
490                 return TRUE;
491 #else
492         case GDK_F7: 
493                 modest_ui_actions_on_zoom_plus (NULL, MODEST_WINDOW(self));
494                 return TRUE;
495         case GDK_F8: 
496                 modest_ui_actions_on_zoom_minus (NULL, MODEST_WINDOW(self));
497                 return TRUE;
498 #endif
499         case GDK_Escape: 
500                 if (modest_window_mgr_get_fullscreen_mode (mgr))
501                         modest_ui_actions_on_change_fullscreen (NULL, MODEST_WINDOW(self));
502                 else if (MODEST_IS_MSG_VIEW_WINDOW (self))
503                         modest_ui_actions_on_close_window (NULL, MODEST_WINDOW (self));
504                 break;
505         }
506         
507         return FALSE;
508 }
509
510 static gboolean 
511 _modest_window_map_event (GtkWidget *widget,
512                           GdkEvent *event,
513                           gpointer userdata)
514 {
515         _make_zoom_buttons_grabeable (GTK_WIDGET (widget));
516         return FALSE;
517 }
518
519 static void
520 _make_zoom_buttons_grabeable (GtkWidget* widget)
521 {
522     GdkDisplay *display;
523     Atom atom;
524     unsigned long val = 1;
525
526     display = gdk_drawable_get_display (widget->window);
527     atom = gdk_x11_get_xatom_by_name_for_display (display, "_HILDON_ZOOM_KEY_ATOM");
528     XChangeProperty (GDK_DISPLAY_XDISPLAY (display),
529                      GDK_WINDOW_XID (widget->window), atom,
530                      XA_INTEGER, 32, PropModeReplace,
531                      (unsigned char *) &val, 1);
532 }