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