3148611ffa2d84790f18755153a8463393cbead2
[modest] / src / gtk / modest-shell-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 <modest-platform.h>
31 #include "modest-marshal.h"
32 #include <modest-defs.h>
33 #include <modest-ui-dimming-rules.h>
34 #include <modest-ui-dimming-manager.h>
35 #include <modest-window-priv.h>
36 #include <modest-shell-window.h>
37 #include <modest-ui-actions.h>
38 #include "modest-text-utils.h"
39
40 /* 'private'/'protected' functions */
41 static void modest_shell_window_class_init  (gpointer klass, gpointer class_data);
42 static void modest_shell_window_instance_init (GTypeInstance *instance, gpointer g_class);
43 static void modest_shell_window_dispose     (GObject *obj);
44
45 static gboolean on_zoom_minus_plus_not_implemented (ModestWindow *window);
46 static void modest_shell_window_show_progress (ModestWindow *window,
47                                                  gboolean show);
48 static void setup_menu (ModestShellWindow *self);
49
50 static void modest_shell_window_show_toolbar (ModestWindow *self,
51                                                  gboolean show_toolbar);
52 static void modest_shell_window_add_toolbar (ModestWindow *self,
53                                                GtkToolbar *toolbar);
54 static void modest_shell_window_add_to_menu (ModestWindow *window,
55                                                const gchar *label,
56                                                const gchar *accelerator,
57                                                ModestWindowMenuCallback callback,
58                                                ModestDimmingCallback dimming_callback);
59 static void modest_shell_window_add_item_to_menu (ModestWindow *window,
60                                                     GtkWidget *item,
61                                                     ModestDimmingCallback dimming_callback);
62 static void modest_shell_window_set_title (ModestWindow *self,
63                                              const gchar *title);
64
65 typedef struct _ModestShellWindowPrivate ModestShellWindowPrivate;
66 struct _ModestShellWindowPrivate {
67
68         GtkWidget *shell;
69         ModestDimmingRulesGroup *app_menu_dimming_group;
70         GtkAccelGroup *accel_group;
71
72         GtkWidget *menu;
73
74 };
75 #define MODEST_SHELL_WINDOW_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE((o), \
76                                                                             MODEST_TYPE_SHELL_WINDOW, \
77                                                                             ModestShellWindowPrivate))
78
79 /* globals */
80 static GtkWindowClass *parent_class = NULL;
81
82 /* uncomment the following if you have defined any signals */
83 static guint signals[LAST_SIGNAL] = {0};
84
85 /************************************************************************/
86
87 GType
88 modest_shell_window_get_type (void)
89 {
90         static GType my_type = 0;
91         if (!my_type) {
92                 static const GTypeInfo my_info = {
93                         sizeof(ModestShellWindowClass),
94                         NULL,           /* base init */
95                         NULL,           /* base finalize */
96                         (GClassInitFunc) modest_shell_window_class_init,
97                         NULL,           /* class finalize */
98                         NULL,           /* class data */
99                         sizeof(ModestShellWindow),
100                         1,              /* n_preallocs */
101                         (GInstanceInitFunc) modest_shell_window_instance_init,
102                         NULL
103                 };
104                 my_type = g_type_register_static (MODEST_TYPE_WINDOW,
105                                                   "ModestShellWindow",
106                                                   &my_info, 0);
107         }
108         return my_type;
109 }
110
111 static void
112 modest_shell_window_class_init (gpointer klass, gpointer class_data)
113 {
114         GObjectClass *gobject_class;
115         gobject_class = (GObjectClass*) klass;
116         ModestWindowClass *modest_window_class = (ModestWindowClass *) klass;
117         HildonWindowClass *hildon_window_class = (HildonWindowClass *) klass;
118
119         parent_class            = g_type_class_peek_parent (klass);
120         gobject_class->dispose  = modest_shell_window_dispose;
121
122         g_type_class_add_private (gobject_class, sizeof(ModestShellWindowPrivate));
123         
124         modest_window_class->zoom_minus_func = on_zoom_minus_plus_not_implemented;
125         modest_window_class->zoom_plus_func = on_zoom_minus_plus_not_implemented;
126         modest_window_class->show_toolbar_func = modest_shell_window_show_toolbar;
127         modest_window_class->add_toolbar_func = modest_shell_window_add_toolbar;
128         modest_window_class->add_to_menu_func = modest_shell_window_add_to_menu;
129         modest_window_class->add_item_to_menu_func = modest_shell_window_add_item_to_menu;
130         modest_window_class->set_title_func = modest_shell_window_set_title;
131         modest_window_class->show_progress_func = modest_shell_window_show_progress;
132
133 }
134
135 static void
136 modest_shell_window_dispose (GObject *obj)
137 {
138         ModestShellWindowPrivate *priv;
139
140         priv = MODEST_SHELL_WINDOW_GET_PRIVATE(obj);
141
142         if (priv->app_menu_dimming_group) {
143                 g_object_unref (priv->app_menu_dimming_group);
144                 priv->app_menu_dimming_group = NULL;
145         }
146
147         if (priv->menu) {
148                 gtk_widget_destroy (priv->menu);
149                 priv->menu = NULL;
150         }
151
152         G_OBJECT_CLASS(parent_class)->dispose (obj);
153 }
154
155 static void
156 modest_shell_window_instance_init (GTypeInstance *instance, gpointer g_class)
157 {
158         ModestShellWindow *self = NULL; 
159         ModestWindowPrivate *parent_priv = NULL;
160         ModestShellWindowPrivate *priv = NULL;
161
162         self = (ModestShellWindow *) instance;
163         parent_priv = MODEST_WINDOW_GET_PRIVATE (self);
164         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
165
166         priv->accel_group = gtk_accel_group_new ();
167
168         priv->app_menu_dimming_group = modest_dimming_rules_group_new (MODEST_DIMMING_RULES_MENU, FALSE);
169         gtk_window_add_accel_group (GTK_WINDOW (self), priv->accel_group);
170
171         priv->menu = gtk_menu_new ();
172
173         modest_ui_dimming_manager_insert_rules_group (parent_priv->ui_dimming_manager, 
174                                                       priv->app_menu_dimming_group);
175
176         /* Dont't restore settings here, 
177          * because it requires a gtk_widget_show(), 
178          * and we don't want to do that until later,
179          * so that the UI is not visible for non-menu D-Bus activation.
180          */
181 }
182
183 static gboolean
184 on_zoom_minus_plus_not_implemented (ModestWindow *window)
185 {
186         g_return_val_if_fail (MODEST_IS_SHELL_WINDOW (window), FALSE);
187
188         modest_platform_information_banner (NULL, NULL, _CS("ckct_ib_cannot_zoom_here"));
189         return FALSE;
190 }
191 void 
192 modest_shell_window_add_item_to_menu (ModestWindow *self,
193                                         GtkWidget *button,
194                                         ModestDimmingCallback dimming_callback)
195 {
196         ModestShellWindowPrivate *priv;
197         GtkWidget *menu;
198
199         g_return_if_fail (MODEST_IS_SHELL_WINDOW(self));
200         g_return_if_fail (GTK_IS_BUTTON (button));
201         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
202
203         modest_ui_dimming_manager_set_widget_dimming_mode (GTK_WIDGET (button),
204                                                            MODEST_UI_DIMMING_MODE_HIDE);
205
206         if (dimming_callback)
207                 modest_dimming_rules_group_add_widget_rule (priv->app_menu_dimming_group,
208                                                             GTK_WIDGET (button),
209                                                             (GCallback) dimming_callback,
210                                                             MODEST_WINDOW (self));
211         if (priv->menu) {
212                 gtk_menu_shell_append (GTK_MENU_SHELL (priv->menu), button);
213         } else {
214                 gtk_widget_destroy (button);
215         }
216
217         gtk_widget_show (GTK_WIDGET (button));
218 }
219
220 static void
221 modest_shell_window_add_to_menu (ModestWindow *self,
222                                    const gchar *label,
223                                    const gchar *accelerator,
224                                    ModestWindowMenuCallback callback,
225                                    ModestDimmingCallback dimming_callback)
226 {
227         ModestShellWindowPrivate *priv = NULL;
228         GtkWidget *menu_item;
229         GtkWidget *menu;
230
231         g_return_if_fail (MODEST_IS_SHELL_WINDOW(self));
232         g_return_if_fail (label && label[0] != '\0');
233         g_return_if_fail (callback != NULL);
234
235         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
236
237         menu_item = gtk_menu_item_new_with_label (label);
238         g_signal_connect_after (G_OBJECT (button), "activate-item",
239                                 G_CALLBACK (callback), (gpointer) self);
240
241         if (accelerator != NULL) {
242                 guint accel_key;
243                 GdkModifierType accel_mods;
244
245                 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
246                 gtk_widget_add_accelerator (menu_item, "clicked", priv->accel_group,
247                                             accel_key, accel_mods, 0);
248         }
249
250         if (priv->menu) {
251                 gtk_menu_shell_append (GTK_MENU (priv->menu), menu_item);
252         } else {
253                 gtk_widget_destroy (menu_item);
254         }
255 }
256
257 static void
258 modest_shell_window_show_toolbar (ModestWindow *self,
259                                     gboolean show_toolbar)
260 {
261         /* Empty implementation: Hildon 2.2 implementation
262          * doesn't switch toolbar visibility */
263 }
264
265 static void
266 modest_shell_window_add_toolbar (ModestWindow *self,
267                                    GtkToolbar *toolbar)
268 {
269         gtk_box_pack_end (GTK_BOX (self), toolbar, FALSE, FALSE, 0);
270 }
271
272 static void
273 modest_shell_window_set_title (ModestWindow *self,
274                                const gchar *title)
275 {
276         ModestShellWindowPrivate *priv = NULL;
277
278         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
279         modest_shell_set_title (MODEST_SHELL (priv->shell),
280                                 MODEST_WINDOW (self),
281                                 title);
282 }
283
284 static void
285 modest_shell_window_show_progress (ModestWindow *self,
286                                      gboolean show)
287 {
288         modest_shell_show_progress (MODEST_SHELL (priv->shell),
289                                     self,
290                                     show);
291 }
292
293 void
294 modest_shell_window_set_shell (ModestShellWindow *self,
295                                ModestShell *shell)
296 {
297         ModestShellWindowPrivate *priv = NULL;
298
299         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
300
301         if (priv->shell) {
302                 modest_shell_delete_window (MODEST_SHELL (shell), MODEST_WINDOW (self));
303                 g_object_unref (priv->shell);
304         }
305
306         priv->shell = g_object_ref (shell);
307 }
308
309 GtkWidget *
310 modest_shell_window_get_menu (ModestShellWindow *self)
311 {
312         ModestShellWindowPrivate *priv = NULL;
313
314         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
315
316         return priv->menu;
317 }