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