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