Refactor part of ModestWindow and ModestHildon2Window
[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         ModestHildon2WindowClass *modest_hildon2_window_class = (ModestHildon2WindowClass *) klass;
154
155         parent_class            = g_type_class_peek_parent (klass);
156         gobject_class->dispose  = modest_hildon2_window_dispose;
157
158         signals[EDIT_MODE_CHANGED_SIGNAL] =
159                 g_signal_new ("edit-mode-changed",
160                               G_TYPE_FROM_CLASS (gobject_class),
161                               G_SIGNAL_RUN_FIRST,
162                               G_STRUCT_OFFSET (ModestHildon2WindowClass, edit_mode_changed),
163                               NULL, NULL,
164                               modest_marshal_VOID__INT_BOOLEAN,
165                               G_TYPE_NONE, 2, G_TYPE_INT, G_TYPE_BOOLEAN);
166
167         g_type_class_add_private (gobject_class, sizeof(ModestHildon2WindowPrivate));
168         
169         hildon_window_class->toggle_menu = modest_hildon2_window_toggle_menu;
170
171         modest_window_class->zoom_minus_func = on_zoom_minus_plus_not_implemented;
172         modest_window_class->zoom_plus_func = on_zoom_minus_plus_not_implemented;
173         modest_window_class->show_toolbar_func = modest_hildon2_window_show_toolbar;
174         modest_window_class->add_toolbar_func = modest_hildon2_window_add_toolbar;
175         modest_window_class->add_to_menu_func = modest_hildon2_window_add_to_menu;
176         modest_window_class->add_item_to_menu_func = modest_hildon2_window_add_item_to_menu;
177         modest_window_class->set_title_func = modest_hildon2_window_set_title;
178         modest_window_class->show_progress_func = modest_hildon2_window_show_progress;
179
180 }
181
182 static void
183 modest_hildon2_window_dispose (GObject *obj)
184 {
185         ModestHildon2WindowPrivate *priv;
186
187         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE(obj);
188
189         if (priv->app_menu_dimming_group) {
190                 g_object_unref (priv->app_menu_dimming_group);
191                 priv->app_menu_dimming_group = NULL;
192         }
193
194         if (priv->edit_mode_registry) {
195                 g_hash_table_unref (priv->edit_mode_registry);
196                 priv->edit_mode_registry = NULL;
197         }
198
199         G_OBJECT_CLASS(parent_class)->dispose (obj);
200 }
201
202 static void
203 modest_hildon2_window_instance_init (GTypeInstance *instance, gpointer g_class)
204 {
205         ModestHildon2Window *self = NULL;       
206         ModestWindowPrivate *parent_priv = NULL;
207         ModestHildon2WindowPrivate *priv = NULL;
208
209         self = (ModestHildon2Window *) instance;
210         parent_priv = MODEST_WINDOW_GET_PRIVATE (self);
211         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
212
213         priv->accel_group = gtk_accel_group_new ();
214
215         priv->edit_mode = FALSE;
216         priv->edit_toolbar = NULL;
217         priv->current_edit_tree_view = NULL;
218         priv->edit_command = MODEST_HILDON2_WINDOW_EDIT_MODE_NONE;
219         priv->edit_mode_registry = g_hash_table_new_full (g_direct_hash, g_direct_equal,
220                                                           NULL, edit_mode_register_destroy);
221
222         parent_priv->ui_dimming_manager = modest_ui_dimming_manager_new();
223         priv->app_menu_dimming_group = modest_dimming_rules_group_new (MODEST_DIMMING_RULES_MENU, FALSE);
224         gtk_window_add_accel_group (GTK_WINDOW (self), priv->accel_group);
225
226         setup_menu (self);
227
228         modest_ui_dimming_manager_insert_rules_group (parent_priv->ui_dimming_manager, 
229                                                       priv->app_menu_dimming_group);
230
231         /* Dont't restore settings here, 
232          * because it requires a gtk_widget_show(), 
233          * and we don't want to do that until later,
234          * so that the UI is not visible for non-menu D-Bus activation.
235          */
236 }
237
238 static gboolean
239 on_zoom_minus_plus_not_implemented (ModestWindow *window)
240 {
241         g_return_val_if_fail (MODEST_IS_HILDON2_WINDOW (window), FALSE);
242
243         hildon_banner_show_information (NULL, NULL, _CS("ckct_ib_cannot_zoom_here"));
244         return FALSE;
245 }
246 void 
247 modest_hildon2_window_add_item_to_menu (ModestWindow *self,
248                                         GtkWidget *button,
249                                         ModestDimmingCallback dimming_callback)
250 {
251         ModestHildon2WindowPrivate *priv;
252
253         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
254         g_return_if_fail (GTK_IS_BUTTON (button));
255         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
256
257         modest_ui_dimming_manager_set_widget_dimming_mode (GTK_WIDGET (button),
258                                                            MODEST_UI_DIMMING_MODE_HIDE);
259
260         if (dimming_callback)
261                 modest_dimming_rules_group_add_widget_rule (priv->app_menu_dimming_group,
262                                                             GTK_WIDGET (button),
263                                                             (GCallback) dimming_callback,
264                                                             MODEST_WINDOW (self));
265         hildon_app_menu_append (HILDON_APP_MENU (priv->app_menu), GTK_BUTTON (button));
266         gtk_widget_show (GTK_WIDGET (button));
267 }
268
269 static void
270 modest_hildon2_window_add_to_menu (ModestWindow *self,
271                                    const gchar *label,
272                                    const gchar *accelerator,
273                                    ModestWindowMenuCallback callback,
274                                    ModestDimmingCallback dimming_callback)
275 {
276         ModestHildon2WindowPrivate *priv = NULL;
277         GtkWidget *button;
278
279         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
280         g_return_if_fail (label && label[0] != '\0');
281         g_return_if_fail (callback != NULL);
282
283         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
284
285         button = gtk_button_new_with_label (label);
286         g_signal_connect_after (G_OBJECT (button), "clicked",
287                                 G_CALLBACK (callback), (gpointer) self);
288
289         if (accelerator != NULL) {
290                 guint accel_key;
291                 GdkModifierType accel_mods;
292
293                 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
294                 gtk_widget_add_accelerator (button, "clicked", priv->accel_group,
295                                             accel_key, accel_mods, 0);
296         }
297
298         modest_window_add_item_to_menu (MODEST_WINDOW (self), GTK_WIDGET (button), dimming_callback);
299 }
300
301 static void setup_menu (ModestHildon2Window *self)
302 {
303         ModestHildon2WindowPrivate *priv = NULL;
304
305         g_return_if_fail (MODEST_IS_HILDON2_WINDOW(self));
306
307         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
308
309         priv->app_menu = hildon_app_menu_new ();
310
311         /* we expect that the app menu is filled in children using the expected 
312          * add_to_menu methods */
313
314         hildon_stackable_window_set_main_menu (HILDON_STACKABLE_WINDOW (self), 
315                                                HILDON_APP_MENU (priv->app_menu));
316 }
317
318 static gboolean 
319 modest_hildon2_window_toggle_menu (HildonWindow *window,
320                                     guint button,
321                                     guint32 time)
322 {
323         ModestHildon2WindowPrivate *priv = NULL;
324
325         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (window);
326
327         modest_ui_actions_check_menu_dimming_rules (MODEST_WINDOW (window));
328
329         gtk_widget_queue_resize (priv->app_menu);
330
331         return HILDON_WINDOW_CLASS (parent_class)->toggle_menu (window, button, time);
332 }
333
334 static void
335 modest_hildon2_window_show_toolbar (ModestWindow *self,
336                                     gboolean show_toolbar)
337 {
338         /* Empty implementation: Hildon 2.2 implementation
339          * doesn't switch toolbar visibility */
340 }
341
342 static void
343 modest_hildon2_window_add_toolbar (ModestWindow *self,
344                                    GtkToolbar *toolbar)
345 {
346         hildon_window_add_toolbar (HILDON_WINDOW (self),
347                                    toolbar);
348 }
349
350 static void
351 modest_hildon2_window_set_title (ModestWindow *self,
352                                  const gchar *title)
353 {
354         gtk_window_set_title (GTK_WINDOW (self),
355                               title);
356 }
357
358 static void
359 modest_hildon2_window_show_progress (ModestWindow *self,
360                                      gboolean show)
361 {
362         hildon_gtk_window_set_progress_indicator (GTK_WINDOW (self),
363                                                   show);
364 }
365
366 void 
367 modest_hildon2_window_register_edit_mode (ModestHildon2Window *self,
368                                           gint edit_mode_id,
369                                           const gchar *description,
370                                           const gchar *button_label,
371                                           GtkTreeView *tree_view,
372                                           GtkSelectionMode mode,
373                                           ModestHildon2EditModeCallback action)
374 {
375         ModestHildon2WindowPrivate *priv = NULL;
376         EditModeRegister *reg;
377
378         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
379         g_return_if_fail (edit_mode_id >= 0);
380         g_return_if_fail (description);
381         g_return_if_fail (button_label);
382         g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
383
384         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
385
386         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id));
387         g_return_if_fail (reg == NULL);
388
389         reg = edit_mode_register_new (description, button_label, tree_view, mode, action);
390         g_hash_table_insert (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id), (gpointer) reg);
391 }
392
393 void
394 modest_hildon2_window_set_edit_mode (ModestHildon2Window *self,
395                                      gint edit_mode_id)
396 {
397         ModestHildon2WindowPrivate *priv = NULL;
398         EditModeRegister *reg;
399         GtkTreeSelection *selection;
400
401         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
402         g_return_if_fail (edit_mode_id >= 0);
403
404         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
405         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, GINT_TO_POINTER (edit_mode_id));
406         g_return_if_fail (reg != NULL);
407
408         if (priv->edit_mode) {
409                 modest_hildon2_window_unset_edit_mode (self);
410         }
411
412         priv->edit_mode = TRUE;
413         priv->edit_command = edit_mode_id;
414
415         priv->current_edit_tree_view = reg->tree_view;
416         g_object_set (G_OBJECT (priv->current_edit_tree_view),
417                       "hildon-ui-mode", HILDON_UI_MODE_EDIT,
418                       NULL);
419
420         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->current_edit_tree_view));
421         gtk_tree_selection_set_mode (selection, reg->mode);
422         if (reg->mode == GTK_SELECTION_SINGLE || reg->mode == GTK_SELECTION_BROWSE) {
423                 GtkTreeModel *model;
424                 GtkTreeIter iter;
425
426                 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->current_edit_tree_view));
427                 if (gtk_tree_model_get_iter_first (model, &iter)) {
428                         gtk_tree_view_scroll_to_point (GTK_TREE_VIEW (priv->current_edit_tree_view), 0, 0);
429                         gtk_tree_selection_select_iter (selection, &iter);
430                 }
431         } else {
432                 gtk_tree_selection_unselect_all (selection);
433         }
434
435         priv->edit_toolbar = hildon_edit_toolbar_new ();
436         hildon_edit_toolbar_set_label (HILDON_EDIT_TOOLBAR (priv->edit_toolbar),
437                                        reg->description);
438         hildon_edit_toolbar_set_button_label (HILDON_EDIT_TOOLBAR (priv->edit_toolbar),
439                                               reg->button_label);
440         modest_window_pack_toolbar (MODEST_WINDOW (self), GTK_PACK_START,
441                                     priv->edit_toolbar);
442
443         g_signal_connect (G_OBJECT (priv->edit_toolbar), "button-clicked",
444                           G_CALLBACK (edit_toolbar_button_clicked), (gpointer) self);
445         g_signal_connect (G_OBJECT (priv->edit_toolbar), "arrow-clicked",
446                           G_CALLBACK (edit_toolbar_arrow_clicked), (gpointer) self);
447
448         gtk_widget_show (priv->edit_toolbar);
449         gtk_widget_queue_resize (priv->current_edit_tree_view);
450         gtk_window_fullscreen (GTK_WINDOW (self));
451
452         g_signal_emit (G_OBJECT (self), signals[EDIT_MODE_CHANGED_SIGNAL], 0,
453                        priv->edit_command, priv->edit_mode);
454 }
455
456 void 
457 modest_hildon2_window_unset_edit_mode (ModestHildon2Window *self)
458 {
459         ModestHildon2WindowPrivate *priv = NULL;
460
461         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
462         priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
463
464         if (priv->edit_toolbar) {
465                 gtk_widget_destroy (priv->edit_toolbar);
466                 priv->edit_toolbar = NULL;
467         }
468
469         if (priv->edit_mode) {
470                 priv->edit_mode = FALSE;
471                 if (priv->current_edit_tree_view) {
472                         g_object_set (G_OBJECT (priv->current_edit_tree_view), 
473                                       "hildon-ui-mode", HILDON_UI_MODE_NORMAL, 
474                                       NULL);
475                         gtk_widget_queue_resize (priv->current_edit_tree_view);
476                         priv->current_edit_tree_view = NULL;
477                 }
478                 gtk_window_unfullscreen (GTK_WINDOW (self));
479                 g_signal_emit (G_OBJECT (self), signals[EDIT_MODE_CHANGED_SIGNAL], 0,
480                                priv->edit_command, priv->edit_mode);
481                 priv->edit_command = MODEST_HILDON2_WINDOW_EDIT_MODE_NONE;
482         }
483 }
484
485 static EditModeRegister *
486 edit_mode_register_new (const gchar *description,
487                         const gchar *button_label,
488                         GtkTreeView *tree_view,
489                         GtkSelectionMode mode,
490                         ModestHildon2EditModeCallback action)
491 {
492         EditModeRegister *reg;
493
494         reg = g_slice_new (EditModeRegister);
495
496         reg->description = g_strdup (description);
497         reg->button_label = g_strdup (button_label);
498         reg->tree_view = g_object_ref (tree_view);
499         reg->mode = mode;
500         reg->action = action;
501
502         return reg;
503 }
504
505 static void 
506 edit_mode_register_destroy (gpointer data)
507 {
508         EditModeRegister *reg = (EditModeRegister *) data;
509
510         g_free (reg->description);
511         g_free (reg->button_label);
512         g_object_unref (reg->tree_view);
513
514         g_slice_free (EditModeRegister, reg);
515 }
516
517 static void
518 edit_toolbar_button_clicked (HildonEditToolbar *toolbar,
519                              ModestHildon2Window *self)
520 {
521         ModestHildon2WindowPrivate *priv = MODEST_HILDON2_WINDOW_GET_PRIVATE (self);
522         EditModeRegister *reg;
523
524         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
525
526         reg = (EditModeRegister *) g_hash_table_lookup (priv->edit_mode_registry, 
527                                                         GINT_TO_POINTER (priv->edit_command));
528
529         if (reg) {
530                 if ((reg->action == NULL) || reg->action (self))
531                         modest_hildon2_window_unset_edit_mode (self);
532         } else {
533                 modest_hildon2_window_unset_edit_mode (self);
534         }
535 }
536
537 static void
538 edit_toolbar_arrow_clicked (HildonEditToolbar *toolbar,
539                             ModestHildon2Window *self)
540 {
541         g_return_if_fail (MODEST_IS_HILDON2_WINDOW (self));
542
543         modest_hildon2_window_unset_edit_mode (self);
544 }
545