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