66dd14571280d938199f631898304edb5780c454
[modest] / src / hildon2 / modest-hildon2-window.c
1 /* Copyright (c) 2008, 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 <hildon/hildon-banner.h>
31 #include <modest-platform.h>
32 #include <hildon/hildon-program.h>
33 #include "modest-marshal.h"
34 #include <modest-maemo-utils.h>
35 #include <modest-defs.h>
36 #include <modest-ui-dimming-rules.h>
37 #include <modest-ui-dimming-manager.h>
38 #include <modest-window-priv.h>
39 #include <modest-hildon2-window.h>
40 #include <modest-ui-actions.h>
41 #include "modest-text-utils.h"
42 #include <hildon/hildon-edit-toolbar.h>
43
44 typedef struct _EditModeRegister {
45         gchar *description;
46         gchar *button_label;
47         GtkWidget *tree_view;
48         GtkSelectionMode mode;
49         ModestHildon2EditModeCallback action;
50 } EditModeRegister;
51
52 /* 'private'/'protected' functions */
53 static void modest_hildon2_window_class_init  (gpointer klass, gpointer class_data);
54 static void modest_hildon2_window_instance_init (GTypeInstance *instance, gpointer g_class);
55 static void modest_hildon2_window_dispose     (GObject *obj);
56
57 static gboolean on_zoom_minus_plus_not_implemented (ModestWindow *window);
58 static void modest_hildon2_window_show_progress (ModestWindow *window,
59                                                  gboolean show);
60 static void setup_menu (ModestHildon2Window *self);
61
62 static void modest_hildon2_window_show_toolbar (ModestWindow *self,
63                                                  gboolean show_toolbar);
64 static void modest_hildon2_window_add_toolbar (ModestWindow *self,
65                                                GtkToolbar *toolbar);
66 static void modest_hildon2_window_add_to_menu (ModestWindow *window,
67                                                const gchar *label,
68                                                const gchar *accelerator,
69                                                ModestWindowMenuCallback callback,
70                                                ModestDimmingCallback dimming_callback);
71 static void modest_hildon2_window_add_item_to_menu (ModestWindow *window,
72                                                     GtkWidget *item,
73                                                     ModestDimmingCallback dimming_callback);
74 static void modest_hildon2_window_set_title (ModestWindow *self,
75                                              const gchar *title);
76 static gboolean modest_hildon2_window_toggle_menu (HildonWindow *window,
77                                                     guint button,
78                                                     guint32 time);
79 static EditModeRegister *edit_mode_register_new (const gchar *description,
80                                                  const gchar *button_label,
81                                                  GtkTreeView *tree_view,
82                                                  GtkSelectionMode mode,
83                                                  ModestHildon2EditModeCallback action);
84 static void edit_mode_register_destroy (gpointer data);
85 static void edit_toolbar_button_clicked (HildonEditToolbar *toolbar,
86                                          ModestHildon2Window *self);
87 static void edit_toolbar_arrow_clicked (HildonEditToolbar *toolbar,
88                                         ModestHildon2Window *self);
89
90 typedef struct _ModestHildon2WindowPrivate ModestHildon2WindowPrivate;
91 struct _ModestHildon2WindowPrivate {
92
93         GtkWidget *app_menu;
94         ModestDimmingRulesGroup *app_menu_dimming_group;
95         GtkAccelGroup *accel_group;
96
97         /* Edit mode support */
98         gboolean edit_mode;
99         gint edit_command;
100         GtkWidget *edit_toolbar;
101         GtkWidget *current_edit_tree_view;
102         GHashTable *edit_mode_registry;
103 };
104 #define MODEST_HILDON2_WINDOW_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE((o), \
105                                                                             MODEST_TYPE_HILDON2_WINDOW, \
106                                                                             ModestHildon2WindowPrivate))
107
108 /* list my signals */
109 enum {
110         EDIT_MODE_CHANGED_SIGNAL,
111         LAST_SIGNAL
112 };
113
114 /* globals */
115 static GtkWindowClass *parent_class = NULL;
116
117 /* uncomment the following if you have defined any signals */
118 static guint signals[LAST_SIGNAL] = {0};
119
120 /************************************************************************/
121
122 GType
123 modest_hildon2_window_get_type (void)
124 {
125         static GType my_type = 0;
126         if (!my_type) {
127                 static const GTypeInfo my_info = {
128                         sizeof(ModestHildon2WindowClass),
129                         NULL,           /* base init */
130                         NULL,           /* base finalize */
131                         (GClassInitFunc) modest_hildon2_window_class_init,
132                         NULL,           /* class finalize */
133                         NULL,           /* class data */
134                         sizeof(ModestHildon2Window),
135                         1,              /* n_preallocs */
136                         (GInstanceInitFunc) modest_hildon2_window_instance_init,
137                         NULL
138                 };
139                 my_type = g_type_register_static (MODEST_TYPE_WINDOW,
140                                                   "ModestHildon2Window",
141                                                   &my_info, 0);
142         }
143         return my_type;
144 }
145
146 static void
147 modest_hildon2_window_class_init (gpointer klass, gpointer class_data)
148 {
149         GObjectClass *gobject_class;
150         gobject_class = (GObjectClass*) klass;
151         ModestWindowClass *modest_window_class = (ModestWindowClass *) klass;
152         HildonWindowClass *hildon_window_class = (HildonWindowClass *) klass;
153
154         parent_class            = g_type_class_peek_parent (klass);
155         gobject_class->dispose  = modest_hildon2_window_dispose;
156
157         signals[EDIT_MODE_CHANGED_SIGNAL] =
158                 g_signal_new ("edit-mode-changed",
159                               G_TYPE_FROM_CLASS (gobject_class),
160                               G_SIGNAL_RUN_FIRST,
161                               G_STRUCT_OFFSET (ModestHildon2WindowClass, edit_mode_changed),
162                               NULL, NULL,
163                               modest_marshal_VOID__INT_BOOLEAN,
164                               G_TYPE_NONE, 2, G_TYPE_INT, G_TYPE_BOOLEAN);
165
166         g_type_class_add_private (gobject_class, sizeof(ModestHildon2WindowPrivate));
167         
168         hildon_window_class->toggle_menu = modest_hildon2_window_toggle_menu;
169
170         modest_window_class->zoom_minus_func = on_zoom_minus_plus_not_implemented;
171         modest_window_class->zoom_plus_func = on_zoom_minus_plus_not_implemented;
172         modest_window_class->show_toolbar_func = modest_hildon2_window_show_toolbar;
173         modest_window_class->add_toolbar_func = modest_hildon2_window_add_toolbar;
174         modest_window_class->add_to_menu_func = modest_hildon2_window_add_to_menu;
175         modest_window_class->add_item_to_menu_func = modest_hildon2_window_add_item_to_menu;
176         modest_window_class->set_title_func = modest_hildon2_window_set_title;
177         modest_window_class->show_progress_func = modest_hildon2_window_show_progress;
178
179 }
180
181 static void
182 modest_hildon2_window_dispose (GObject *obj)
183 {
184         ModestHildon2WindowPrivate *priv;
185
186         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE(obj);
187
188         if (priv->app_menu_dimming_group) {
189                 g_object_unref (priv->app_menu_dimming_group);
190                 priv->app_menu_dimming_group = NULL;
191         }
192
193         if (priv->edit_mode_registry) {
194                 g_hash_table_unref (priv->edit_mode_registry);
195                 priv->edit_mode_registry = NULL;
196         }
197
198         G_OBJECT_CLASS(parent_class)->dispose (obj);
199 }
200
201 static void
202 modest_hildon2_window_instance_init (GTypeInstance *instance, gpointer g_class)
203 {
204         ModestHildon2Window *self = NULL;       
205         ModestWindowPrivate *parent_priv = NULL;
206         ModestHildon2WindowPrivate *priv = NULL;
207
208         self = (ModestHildon2Window *) instance;
209         parent_priv = MODEST_WINDOW_GET_PRIVATE (self);
210         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
211
212         priv->accel_group = gtk_accel_group_new ();
213
214         priv->edit_mode = FALSE;
215         priv->edit_toolbar = NULL;
216         priv->current_edit_tree_view = NULL;
217         priv->edit_command = MODEST_HILDON2_WINDOW_EDIT_MODE_NONE;
218         priv->edit_mode_registry = g_hash_table_new_full (g_direct_hash, g_direct_equal,
219                                                           NULL, edit_mode_register_destroy);
220
221         parent_priv->ui_dimming_manager = modest_ui_dimming_manager_new();
222         priv->app_menu_dimming_group = modest_dimming_rules_group_new (MODEST_DIMMING_RULES_MENU, FALSE);
223         gtk_window_add_accel_group (GTK_WINDOW (self), priv->accel_group);
224
225         setup_menu (self);
226
227         modest_ui_dimming_manager_insert_rules_group (parent_priv->ui_dimming_manager, 
228                                                       priv->app_menu_dimming_group);
229
230         /* Dont't restore settings here, 
231          * because it requires a gtk_widget_show(), 
232          * and we don't want to do that until later,
233          * so that the UI is not visible for non-menu D-Bus activation.
234          */
235 }
236
237 static gboolean
238 on_zoom_minus_plus_not_implemented (ModestWindow *window)
239 {
240         g_return_val_if_fail (MODEST_IS_HILDON2_WINDOW (window), FALSE);
241
242         hildon_banner_show_information (NULL, NULL, _CS("ckct_ib_cannot_zoom_here"));
243         return FALSE;
244 }
245 void 
246 modest_hildon2_window_add_item_to_menu (ModestWindow *self,
247                                         GtkWidget *button,
248                                         ModestDimmingCallback dimming_callback)
249 {
250         ModestHildon2WindowPrivate *priv;
251
252         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
253         g_return_if_fail (GTK_IS_BUTTON (button));
254         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
255
256         modest_ui_dimming_manager_set_widget_dimming_mode (GTK_WIDGET (button),
257                                                            MODEST_UI_DIMMING_MODE_HIDE);
258
259         if (dimming_callback)
260                 modest_dimming_rules_group_add_widget_rule (priv->app_menu_dimming_group,
261                                                             GTK_WIDGET (button),
262                                                             (GCallback) dimming_callback,
263                                                             MODEST_WINDOW (self));
264         hildon_app_menu_append (HILDON_APP_MENU (priv->app_menu), GTK_BUTTON (button));
265         gtk_widget_show (GTK_WIDGET (button));
266 }
267
268 static void
269 modest_hildon2_window_add_to_menu (ModestWindow *self,
270                                    const gchar *label,
271                                    const gchar *accelerator,
272                                    ModestWindowMenuCallback callback,
273                                    ModestDimmingCallback dimming_callback)
274 {
275         ModestHildon2WindowPrivate *priv = NULL;
276         GtkWidget *button;
277
278         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
279         g_return_if_fail (label && label[0] != '\0');
280         g_return_if_fail (callback != NULL);
281
282         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
283
284         button = gtk_button_new_with_label (label);
285         g_signal_connect_after (G_OBJECT (button), "clicked",
286                                 G_CALLBACK (callback), (gpointer) self);
287
288         if (accelerator != NULL) {
289                 guint accel_key;
290                 GdkModifierType accel_mods;
291
292                 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
293                 gtk_widget_add_accelerator (button, "clicked", priv->accel_group,
294                                             accel_key, accel_mods, 0);
295         }
296
297         modest_window_add_item_to_menu (MODEST_WINDOW (self), GTK_WIDGET (button), dimming_callback);
298 }
299
300 static void setup_menu (ModestHildon2Window *self)
301 {
302         ModestHildon2WindowPrivate *priv = NULL;
303
304         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
305
306         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
307
308         priv->app_menu = hildon_app_menu_new ();
309
310         /* we expect that the app menu is filled in children using the expected 
311          * add_to_menu methods */
312
313         hildon_stackable_window_set_main_menu (HILDON_STACKABLE_WINDOW (self), 
314                                                HILDON_APP_MENU (priv->app_menu));
315 }
316
317 static gboolean 
318 modest_hildon2_window_toggle_menu (HildonWindow *window,
319                                     guint button,
320                                     guint32 time)
321 {
322         ModestHildon2WindowPrivate *priv = NULL;
323
324         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (window);
325
326         modest_ui_actions_check_menu_dimming_rules (MODEST_WINDOW (window));
327
328         gtk_widget_queue_resize (priv->app_menu);
329
330         return HILDON_WINDOW_CLASS (parent_class)->toggle_menu (window, button, time);
331 }
332
333 static void
334 modest_hildon2_window_show_toolbar (ModestWindow *self,
335                                     gboolean show_toolbar)
336 {
337         /* Empty implementation: Hildon 2.2 implementation
338          * doesn't switch toolbar visibility */
339 }
340
341 static void
342 modest_hildon2_window_add_toolbar (ModestWindow *self,
343                                    GtkToolbar *toolbar)
344 {
345         hildon_window_add_toolbar (HILDON_WINDOW (self),
346                                    toolbar);
347 }
348
349 static void
350 modest_hildon2_window_set_title (ModestWindow *self,
351                                  const gchar *title)
352 {
353         gtk_window_set_title (GTK_WINDOW (self),
354                               title);
355 }
356
357 static void
358 modest_hildon2_window_show_progress (ModestWindow *self,
359                                      gboolean show)
360 {
361         hildon_gtk_window_set_progress_indicator (GTK_WINDOW (self),
362                                                   show);
363 }
364
365 void 
366 modest_hildon2_window_register_edit_mode (ModestHildon2Window *self,
367                                           gint edit_mode_id,
368                                           const gchar *description,
369                                           const gchar *button_label,
370                                           GtkTreeView *tree_view,
371                                           GtkSelectionMode mode,
372                                           ModestHildon2EditModeCallback action)
373 {
374         ModestHildon2WindowPrivate *priv = NULL;
375         EditModeRegister *reg;
376
377         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
378         g_return_if_fail (edit_mode_id >= 0);
379         g_return_if_fail (description);
380         g_return_if_fail (button_label);
381         g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
382
383         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
384
385         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id));
386         g_return_if_fail (reg == NULL);
387
388         reg = edit_mode_register_new (description, button_label, tree_view, mode, action);
389         g_hash_table_insert (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id), (gpointer) reg);
390 }
391
392 void
393 modest_hildon2_window_set_edit_mode (ModestHildon2Window *self,
394                                      gint edit_mode_id)
395 {
396         ModestHildon2WindowPrivate *priv = NULL;
397         EditModeRegister *reg;
398         GtkTreeSelection *selection;
399
400         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
401         g_return_if_fail (edit_mode_id >= 0);
402
403         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
404         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id));
405         g_return_if_fail (reg != NULL);
406
407         if (priv->edit_mode) {
408                 modest_hildon2_window_unset_edit_mode (self);
409         }
410
411         priv->edit_mode = TRUE;
412         priv->edit_command = edit_mode_id;
413
414         priv->current_edit_tree_view = reg->tree_view;
415         g_object_set (G_OBJECT (priv->current_edit_tree_view),
416                       "hildon-ui-mode", HILDON_UI_MODE_EDIT,
417                       NULL);
418
419         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->current_edit_tree_view));
420         gtk_tree_selection_set_mode (selection, reg->mode);
421         if (reg->mode == GTK_SELECTION_SINGLE || reg->mode == GTK_SELECTION_BROWSE) {
422                 GtkTreeModel *model;
423                 GtkTreeIter iter;
424
425                 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->current_edit_tree_view));
426                 if (gtk_tree_model_get_iter_first (model, &iter)) {
427                         gtk_tree_view_scroll_to_point (GTK_TREE_VIEW (priv->current_edit_tree_view), 0, 0);
428                         gtk_tree_selection_select_iter (selection, &iter);
429                 }
430         } else {
431                 gtk_tree_selection_unselect_all (selection);
432         }
433
434         priv->edit_toolbar = hildon_edit_toolbar_new ();
435         hildon_edit_toolbar_set_label (HILDON_EDIT_TOOLBAR (priv->edit_toolbar),
436                                        reg->description);
437         hildon_edit_toolbar_set_button_label (HILDON_EDIT_TOOLBAR (priv->edit_toolbar),
438                                               reg->button_label);
439         modest_window_pack_toolbar (MODEST_WINDOW (self), GTK_PACK_START,
440                                     priv->edit_toolbar);
441
442         g_signal_connect (G_OBJECT (priv->edit_toolbar), "button-clicked",
443                           G_CALLBACK (edit_toolbar_button_clicked), (gpointer) self);
444         g_signal_connect (G_OBJECT (priv->edit_toolbar), "arrow-clicked",
445                           G_CALLBACK (edit_toolbar_arrow_clicked), (gpointer) self);
446
447         gtk_widget_show (priv->edit_toolbar);
448         gtk_widget_queue_resize (priv->current_edit_tree_view);
449         gtk_window_fullscreen (GTK_WINDOW (self));
450
451         g_signal_emit (G_OBJECT (self), signals[EDIT_MODE_CHANGED_SIGNAL], 0,
452                        priv->edit_command, priv->edit_mode);
453 }
454
455 void 
456 modest_hildon2_window_unset_edit_mode (ModestHildon2Window *self)
457 {
458         ModestHildon2WindowPrivate *priv = NULL;
459
460         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
461         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
462
463         if (priv->edit_toolbar) {
464                 gtk_widget_destroy (priv->edit_toolbar);
465                 priv->edit_toolbar = NULL;
466         }
467
468         if (priv->edit_mode) {
469                 priv->edit_mode = FALSE;
470                 if (priv->current_edit_tree_view) {
471                         g_object_set (G_OBJECT (priv->current_edit_tree_view), 
472                                       "hildon-ui-mode", HILDON_UI_MODE_NORMAL, 
473                                       NULL);
474                         gtk_widget_queue_resize (priv->current_edit_tree_view);
475                         priv->current_edit_tree_view = NULL;
476                 }
477                 gtk_window_unfullscreen (GTK_WINDOW (self));
478                 g_signal_emit (G_OBJECT (self), signals[EDIT_MODE_CHANGED_SIGNAL], 0,
479                                priv->edit_command, priv->edit_mode);
480                 priv->edit_command = MODEST_HILDON2_WINDOW_EDIT_MODE_NONE;
481         }
482 }
483
484 static EditModeRegister *
485 edit_mode_register_new (const gchar *description,
486                         const gchar *button_label,
487                         GtkTreeView *tree_view,
488                         GtkSelectionMode mode,
489                         ModestHildon2EditModeCallback action)
490 {
491         EditModeRegister *reg;
492
493         reg = g_slice_new (EditModeRegister);
494
495         reg->description = g_strdup (description);
496         reg->button_label = g_strdup (button_label);
497         reg->tree_view = g_object_ref (tree_view);
498         reg->mode = mode;
499         reg->action = action;
500
501         return reg;
502 }
503
504 static void 
505 edit_mode_register_destroy (gpointer data)
506 {
507         EditModeRegister *reg = (EditModeRegister *) data;
508
509         g_free (reg->description);
510         g_free (reg->button_label);
511         g_object_unref (reg->tree_view);
512
513         g_slice_free (EditModeRegister, reg);
514 }
515
516 static void
517 edit_toolbar_button_clicked (HildonEditToolbar *toolbar,
518                              ModestHildon2Window *self)
519 {
520         ModestHildon2WindowPrivate *priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
521         EditModeRegister *reg;
522
523         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
524
525         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, 
526                                                         GINT_TO_POINTER (priv->edit_command));
527
528         if (reg) {
529                 if ((reg->action == NULL) || reg->action (MODEST_WINDOW (self)))
530                         modest_hildon2_window_unset_edit_mode (self);
531         } else {
532                 modest_hildon2_window_unset_edit_mode (self);
533         }
534 }
535
536 static void
537 edit_toolbar_arrow_clicked (HildonEditToolbar *toolbar,
538                             ModestHildon2Window *self)
539 {
540         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
541
542         modest_hildon2_window_unset_edit_mode (self);
543 }
544