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