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