1 /* Copyright (c) 2008, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #include <modest-header-window.h>
31 #include <modest-osso-state-saving.h>
33 #include <hildon/hildon-pannable-area.h>
34 #include <modest-window-mgr.h>
35 #include <modest-signal-mgr.h>
36 #include <modest-runtime.h>
37 #include <modest-platform.h>
38 #include <modest-maemo-utils.h>
39 #include <modest-icon-names.h>
40 #include <modest-ui-constants.h>
41 #include <modest-account-mgr.h>
42 #include <modest-account-mgr-helpers.h>
43 #include <modest-defs.h>
44 #include <modest-widget-memory.h>
45 #include <modest-ui-actions.h>
46 #include <modest-platform.h>
47 #include <modest-text-utils.h>
48 #include <hildon/hildon-button.h>
49 #include <hildon/hildon-program.h>
50 #include <hildon/hildon-banner.h>
53 CONTENTS_STATE_NONE = 0,
54 CONTENTS_STATE_EMPTY = 1,
55 CONTENTS_STATE_HEADERS = 2
58 typedef struct _ModestHeaderWindowPrivate ModestHeaderWindowPrivate;
59 struct _ModestHeaderWindowPrivate {
61 GtkWidget *header_view;
62 GtkWidget *empty_view;
63 GtkWidget *contents_view;
64 GtkWidget *new_message_button;
66 ContentsState contents_state;
71 GtkWidget *updating_banner;
72 guint updating_banner_timeout;
78 osso_display_state_t display_state;
80 #define MODEST_HEADER_WINDOW_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
81 MODEST_TYPE_HEADER_WINDOW, \
82 ModestHeaderWindowPrivate))
84 /* 'private'/'protected' functions */
85 static void modest_header_window_class_init (ModestHeaderWindowClass *klass);
86 static void modest_header_window_init (ModestHeaderWindow *obj);
87 static void modest_header_window_finalize (GObject *obj);
89 static void connect_signals (ModestHeaderWindow *self);
90 static void modest_header_window_disconnect_signals (ModestWindow *self);
92 static gboolean on_zoom_minus_plus_not_implemented (ModestWindow *window);
93 static void add_to_menu (ModestHeaderWindow *self,
97 static void setup_menu (ModestHeaderWindow *self);
98 static GtkWidget *create_empty_view (void);
99 static GtkWidget *create_header_view (TnyFolder *folder);
101 static void update_view (ModestHeaderWindow *self,
102 TnyFolderChange *change);
103 static void set_contents_state (ModestHeaderWindow *window,
104 ContentsState state);
106 static void on_msg_count_changed (ModestHeaderView *header_view,
108 TnyFolderChange *change,
109 ModestHeaderWindow *header_window);
110 static void on_header_activated (ModestHeaderView *header_view,
113 ModestHeaderWindow *header_window);
114 static void on_updating_msg_list (ModestHeaderView *header_view,
120 static GtkWindowClass *parent_class = NULL;
122 #define EMPTYVIEW_XALIGN 0.5
123 #define EMPTYVIEW_YALIGN 0.0
124 #define EMPTYVIEW_XSPACE 1.0
125 #define EMPTYVIEW_YSPACE 0.0
129 /************************************************************************/
132 modest_header_window_get_type (void)
134 static GType my_type = 0;
136 static const GTypeInfo my_info = {
137 sizeof(ModestHeaderWindowClass),
138 NULL, /* base init */
139 NULL, /* base finalize */
140 (GClassInitFunc) modest_header_window_class_init,
141 NULL, /* class finalize */
142 NULL, /* class data */
143 sizeof(ModestHeaderWindow),
145 (GInstanceInitFunc) modest_header_window_init,
148 my_type = g_type_register_static (MODEST_TYPE_WINDOW,
149 "ModestHeaderWindow",
156 modest_header_window_class_init (ModestHeaderWindowClass *klass)
158 GObjectClass *gobject_class;
159 gobject_class = (GObjectClass*) klass;
160 ModestWindowClass *modest_window_class = (ModestWindowClass *) klass;
162 parent_class = g_type_class_peek_parent (klass);
163 gobject_class->finalize = modest_header_window_finalize;
165 g_type_class_add_private (gobject_class, sizeof(ModestHeaderWindowPrivate));
167 modest_window_class->zoom_minus_func = on_zoom_minus_plus_not_implemented;
168 modest_window_class->zoom_plus_func = on_zoom_minus_plus_not_implemented;
169 modest_window_class->disconnect_signals_func = modest_header_window_disconnect_signals;
173 modest_header_window_init (ModestHeaderWindow *obj)
175 ModestHeaderWindowPrivate *priv;
177 priv = MODEST_HEADER_WINDOW_GET_PRIVATE(obj);
179 priv->sighandlers = NULL;
180 priv->display_state = OSSO_DISPLAY_ON;
182 priv->header_view = NULL;
183 priv->empty_view = NULL;
184 priv->contents_view = NULL;
185 priv->contents_state = CONTENTS_STATE_NONE;
187 priv->updating_banner = NULL;
188 priv->updating_banner_timeout = 0;
190 modest_window_mgr_register_help_id (modest_runtime_get_window_mgr(),
192 "applications_email_headerview");
196 modest_header_window_finalize (GObject *obj)
198 ModestHeaderWindowPrivate *priv;
200 priv = MODEST_HEADER_WINDOW_GET_PRIVATE(obj);
202 g_object_unref (priv->header_view);
203 g_object_unref (priv->empty_view);
204 g_object_unref (priv->folder);
206 /* Sanity check: shouldn't be needed, the window mgr should
207 call this function before */
208 modest_header_window_disconnect_signals (MODEST_WINDOW (obj));
210 if (priv->updating_banner_timeout > 0) {
211 g_source_remove (priv->updating_banner_timeout);
212 priv->updating_banner_timeout = 0;
214 if (priv->updating_banner) {
215 gtk_widget_destroy (priv->updating_banner);
216 priv->updating_banner = NULL;
219 G_OBJECT_CLASS(parent_class)->finalize (obj);
223 modest_header_window_disconnect_signals (ModestWindow *self)
225 ModestHeaderWindowPrivate *priv;
226 priv = MODEST_HEADER_WINDOW_GET_PRIVATE(self);
228 modest_signal_mgr_disconnect_all_and_destroy (priv->sighandlers);
229 priv->sighandlers = NULL;
233 connect_signals (ModestHeaderWindow *self)
235 ModestHeaderWindowPrivate *priv;
237 priv = MODEST_HEADER_WINDOW_GET_PRIVATE(self);
242 modest_signal_mgr_connect (priv->sighandlers,G_OBJECT(priv->header_view),
244 G_CALLBACK(on_msg_count_changed), self);
246 modest_signal_mgr_connect (priv->sighandlers, G_OBJECT (priv->header_view),
248 G_CALLBACK (on_header_activated), self);
250 modest_signal_mgr_connect (priv->sighandlers,
251 G_OBJECT (priv->header_view),
253 G_CALLBACK (on_updating_msg_list),
256 /* TODO: connect header view activate */
258 /* new message button */
260 g_signal_connect (G_OBJECT (priv->new_message_button), "clicked",
261 G_CALLBACK (modest_ui_actions_on_new_msg), (gpointer) self);
265 /* we don't register this in sighandlers, as it should be run after disconnecting all signals,
266 * in destroy stage */
272 osso_display_event_cb (osso_display_state_t state,
275 ModestHeaderWindowPrivate *priv = MODEST_HEADER_WINDOW_GET_PRIVATE (data);
277 priv->display_state = state;
279 /* Stop blinking if the screen becomes on */
280 if (priv->display_state == OSSO_DISPLAY_ON)
281 modest_platform_remove_new_mail_notifications (TRUE);
285 create_header_view (TnyFolder *folder)
287 GtkWidget *header_view;
289 header_view = modest_header_view_new (NULL, MODEST_HEADER_VIEW_STYLE_TWOLINES);
290 modest_header_view_set_folder (MODEST_HEADER_VIEW (header_view), folder,
292 modest_widget_memory_restore (modest_runtime_get_conf (), G_OBJECT(header_view),
293 MODEST_CONF_HEADER_VIEW_KEY);
299 create_empty_view (void)
301 GtkLabel *label = NULL;
302 GtkWidget *align = NULL;
304 align = gtk_alignment_new(EMPTYVIEW_XALIGN, EMPTYVIEW_YALIGN, EMPTYVIEW_XSPACE, EMPTYVIEW_YSPACE);
305 label = GTK_LABEL(gtk_label_new (_("mcen_ia_nomessages")));
306 gtk_label_set_justify (label, GTK_JUSTIFY_CENTER);
307 gtk_container_add (GTK_CONTAINER (align), GTK_WIDGET(label));
309 return GTK_WIDGET(align);
314 modest_header_window_new (TnyFolder *folder)
316 ModestHeaderWindow *self = NULL;
317 ModestHeaderWindowPrivate *priv = NULL;
319 GdkPixbuf *window_icon;
322 self = MODEST_HEADER_WINDOW(g_object_new(MODEST_TYPE_HEADER_WINDOW, NULL));
323 priv = MODEST_HEADER_WINDOW_GET_PRIVATE(self);
325 priv->folder = g_object_ref (folder);
327 pannable = hildon_pannable_area_new ();
329 priv->header_view = create_header_view (folder);
330 priv->empty_view = create_empty_view ();
331 g_object_ref (priv->header_view);
332 g_object_ref (priv->empty_view);
333 priv->contents_view = gtk_vbox_new (FALSE, 0);
334 priv->new_message_button = hildon_button_new (MODEST_EDITABLE_SIZE,
335 HILDON_BUTTON_ARRANGEMENT_HORIZONTAL);
336 hildon_button_set_title (HILDON_BUTTON (priv->new_message_button), _("mcen_me_viewer_newemail"));
337 hildon_button_set_image (HILDON_BUTTON (priv->new_message_button),
338 gtk_image_new_from_stock (MODEST_STOCK_NEW_MAIL, GTK_ICON_SIZE_DIALOG));
339 hildon_button_set_title_alignment (HILDON_BUTTON (priv->new_message_button), 0.0, 0.5);
340 hildon_button_set_image_alignment (HILDON_BUTTON (priv->new_message_button), 0.0, 0.5);
341 hildon_button_set_alignment (HILDON_BUTTON (priv->new_message_button), 0.0, 0.5, 1.0, 0.0);
342 hildon_button_set_image_position (HILDON_BUTTON (priv->new_message_button), GTK_POS_LEFT);
346 gtk_box_pack_start (GTK_BOX (priv->contents_view), priv->new_message_button, FALSE, FALSE, 0);
347 hildon_pannable_area_add_with_viewport (HILDON_PANNABLE_AREA (pannable), priv->contents_view);
348 gtk_container_add (GTK_CONTAINER (self), pannable);
350 gtk_widget_show (priv->contents_view);
351 gtk_widget_show (pannable);
352 gtk_widget_show (priv->new_message_button);
354 connect_signals (MODEST_HEADER_WINDOW (self));
356 update_view (self, NULL);
358 /* Load previous osso state, for instance if we are being restored from
360 modest_osso_load_state ();
362 /* Get device name */
363 modest_maemo_utils_get_device_name ();
365 app = hildon_program_get_instance ();
366 hildon_program_add_window (app, HILDON_WINDOW (self));
368 /* Set window icon */
369 window_icon = modest_platform_get_icon (MODEST_APP_ICON, MODEST_ICON_SIZE_BIG);
371 gtk_window_set_icon (GTK_WINDOW (self), window_icon);
372 g_object_unref (window_icon);
375 /* Listen for changes in the screen, we don't want to show a
376 led pattern when the display is on for example */
377 osso_hw_set_display_event_cb (modest_maemo_utils_get_osso_context (),
378 osso_display_event_cb,
381 /* Dont't restore settings here,
382 * because it requires a gtk_widget_show(),
383 * and we don't want to do that until later,
384 * so that the UI is not visible for non-menu D-Bus activation.
387 return MODEST_WINDOW(self);
391 on_zoom_minus_plus_not_implemented (ModestWindow *window)
393 g_return_val_if_fail (MODEST_IS_HEADER_WINDOW (window), FALSE);
395 hildon_banner_show_information (NULL, NULL, dgettext("hildon-common-strings", "ckct_ib_cannot_zoom_here"));
401 modest_header_window_screen_is_on (ModestHeaderWindow *self)
403 ModestHeaderWindowPrivate *priv = NULL;
405 g_return_val_if_fail (MODEST_IS_HEADER_WINDOW(self), FALSE);
407 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (self);
409 return (priv->display_state == OSSO_DISPLAY_ON) ? TRUE : FALSE;
413 modest_header_window_get_header_view (ModestHeaderWindow *self)
415 ModestHeaderWindowPrivate *priv = NULL;
417 g_return_val_if_fail (MODEST_IS_HEADER_WINDOW(self), FALSE);
419 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (self);
421 return MODEST_HEADER_VIEW (priv->header_view);
424 static void add_to_menu (ModestHeaderWindow *self,
431 button = gtk_button_new_with_label (label);
432 g_signal_connect_after (G_OBJECT (button), "clicked",
433 callback, (gpointer) self);
434 hildon_app_menu_append (menu, GTK_BUTTON (button));
437 static void setup_menu (ModestHeaderWindow *self)
439 ModestHeaderWindowPrivate *priv = NULL;
442 g_return_if_fail (MODEST_IS_HEADER_WINDOW(self));
444 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (self);
446 app_menu = hildon_app_menu_new ();
448 add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_viewer_newemail"),
449 G_CALLBACK (modest_ui_actions_on_new_msg));
450 add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_sendandreceive"),
451 G_CALLBACK (modest_ui_actions_on_send_receive));
452 add_to_menu (self, HILDON_APP_MENU (app_menu), _("mcen_me_inbox_messagedetails"),
453 G_CALLBACK (modest_ui_actions_on_details));
455 hildon_stackable_window_set_main_menu (HILDON_STACKABLE_WINDOW (self),
456 HILDON_APP_MENU (app_menu));
460 update_view (ModestHeaderWindow *self,
461 TnyFolderChange *change)
463 ModestHeaderWindowPrivate *priv = NULL;
464 gboolean refilter = FALSE;
465 gboolean folder_empty = FALSE;
466 gboolean all_marked_as_deleted = FALSE;
468 g_return_if_fail (MODEST_IS_HEADER_WINDOW(self));
469 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (self);
470 g_return_if_fail (priv->folder);
472 if (change != NULL) {
473 TnyFolderChangeChanged changed;
475 changed = tny_folder_change_get_changed (change);
476 /* If something changes */
477 if ((changed) & TNY_FOLDER_CHANGE_CHANGED_ALL_COUNT)
478 folder_empty = (((guint) tny_folder_change_get_new_all_count (change)) == 0);
480 folder_empty = (((guint) tny_folder_get_all_count (TNY_FOLDER (priv->folder))) == 0);
482 if ((changed) & TNY_FOLDER_CHANGE_CHANGED_EXPUNGED_HEADERS)
485 folder_empty = (((guint) tny_folder_get_all_count (TNY_FOLDER (priv->folder))) == 0);
488 /* Check if all messages are marked to be deleted */
489 all_marked_as_deleted = modest_header_view_is_empty (MODEST_HEADER_VIEW (priv->header_view));
490 folder_empty = folder_empty || all_marked_as_deleted;
492 /* Set style of headers view */
493 set_contents_state (self, folder_empty?CONTENTS_STATE_EMPTY:CONTENTS_STATE_HEADERS);
496 modest_header_view_refilter (MODEST_HEADER_VIEW (priv->header_view));
500 set_contents_state (ModestHeaderWindow *self,
503 ModestHeaderWindowPrivate *priv = NULL;
505 g_return_if_fail (MODEST_IS_HEADER_WINDOW(self));
506 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (self);
508 if (priv->contents_state == state)
511 /* Remove from container the old content */
512 switch (priv->contents_state) {
513 case CONTENTS_STATE_EMPTY:
514 gtk_container_remove (GTK_CONTAINER (priv->contents_view), priv->empty_view);
516 case CONTENTS_STATE_HEADERS:
517 gtk_container_remove (GTK_CONTAINER (priv->contents_view), priv->header_view);
519 case CONTENTS_STATE_NONE:
523 /* Add the new content */
525 case CONTENTS_STATE_EMPTY:
526 gtk_box_pack_start (GTK_BOX (priv->contents_view), priv->empty_view, TRUE, TRUE, 0);
527 gtk_widget_show (priv->empty_view);
529 case CONTENTS_STATE_HEADERS:
530 gtk_box_pack_start (GTK_BOX (priv->contents_view), priv->header_view, TRUE, TRUE, 0);
531 gtk_widget_show (priv->header_view);
533 case CONTENTS_STATE_NONE:
536 priv->contents_state = state;
541 on_msg_count_changed (ModestHeaderView *header_view,
543 TnyFolderChange *change,
544 ModestHeaderWindow *header_window)
546 g_return_if_fail (MODEST_IS_HEADER_WINDOW (header_window));
548 update_view (MODEST_HEADER_WINDOW (header_window), change);
552 on_header_activated (ModestHeaderView *header_view,
555 ModestHeaderWindow *header_window)
557 modest_ui_actions_on_header_activated (header_view, header, path, MODEST_WINDOW (header_window));
561 updating_banner_destroyed (gpointer data,
562 GObject *where_the_object_was)
564 ModestHeaderWindowPrivate *priv = NULL;
566 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (data);
568 priv->updating_banner = NULL;
572 show_updating_banner (gpointer user_data)
574 ModestHeaderWindowPrivate *priv = NULL;
576 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (user_data);
578 if (priv->updating_banner == NULL) {
580 /* We're outside the main lock */
581 gdk_threads_enter ();
582 priv->updating_banner =
583 modest_platform_animation_banner (GTK_WIDGET (user_data), NULL,
584 _CS ("ckdg_pb_updating"));
586 /* We need this because banners in Maemo could be
587 destroyed by dialogs so we need to properly update
588 our reference to it */
589 g_object_weak_ref (G_OBJECT (priv->updating_banner),
590 updating_banner_destroyed,
592 gdk_threads_leave ();
596 priv->updating_banner_timeout = 0;
601 * We use this function to show/hide a progress banner showing
602 * "Updating" while the header view is being filled. We're not showing
603 * it unless the update takes more than 2 seconds
605 * If starting = TRUE then the refresh is starting, otherwise it means
606 * that is has just finished
609 on_updating_msg_list (ModestHeaderView *header_view,
613 ModestHeaderWindowPrivate *priv = NULL;
615 priv = MODEST_HEADER_WINDOW_GET_PRIVATE (user_data);
617 /* Remove old timeout */
618 if (priv->updating_banner_timeout > 0) {
619 g_source_remove (priv->updating_banner_timeout);
620 priv->updating_banner_timeout = 0;
623 /* Create a new timeout */
625 priv->updating_banner_timeout =
626 g_timeout_add (2000, show_updating_banner, user_data);
628 /* Remove the banner if exists */
629 if (priv->updating_banner) {
630 gtk_widget_destroy (priv->updating_banner);
631 priv->updating_banner = NULL;