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