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