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