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