MenuShell menu button work:
[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 static void modest_shell_window_finalize     (GObject *obj);
45
46 static gboolean on_zoom_minus_plus_not_implemented (ModestWindow *window);
47 static void modest_shell_window_show_progress (ModestWindow *window,
48                                                  gboolean show);
49 static void modest_shell_window_show_toolbar (ModestWindow *self,
50                                                  gboolean show_toolbar);
51 static void modest_shell_window_add_toolbar (ModestWindow *self,
52                                                GtkToolbar *toolbar);
53 static void modest_shell_window_add_to_menu (ModestWindow *window,
54                                                const gchar *label,
55                                                const gchar *accelerator,
56                                                ModestWindowMenuCallback callback,
57                                                ModestDimmingCallback dimming_callback);
58 static void modest_shell_window_add_item_to_menu (ModestWindow *window,
59                                                     GtkWidget *item,
60                                                     ModestDimmingCallback dimming_callback);
61 static void modest_shell_window_set_title (ModestWindow *self,
62                                              const gchar *title);
63
64 typedef struct _ModestShellWindowPrivate ModestShellWindowPrivate;
65 struct _ModestShellWindowPrivate {
66
67         GtkWidget *shell;
68         ModestDimmingRulesGroup *app_menu_dimming_group;
69         GtkAccelGroup *accel_group;
70
71         GtkWidget *menu;
72         gchar *title;
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
118         parent_class            = g_type_class_peek_parent (klass);
119         gobject_class->dispose  = modest_shell_window_dispose;
120         gobject_class->finalize  = modest_shell_window_finalize;
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_finalize (GObject *obj)
157 {
158         ModestShellWindowPrivate *priv;
159
160         priv = MODEST_SHELL_WINDOW_GET_PRIVATE(obj);
161
162         if (priv->title)
163                 g_free (priv->title);
164
165         G_OBJECT_CLASS(parent_class)->finalize (obj);
166 }
167
168 static void
169 modest_shell_window_instance_init (GTypeInstance *instance, gpointer g_class)
170 {
171         ModestShellWindow *self = NULL; 
172         ModestWindowPrivate *parent_priv = NULL;
173         ModestShellWindowPrivate *priv = NULL;
174
175         self = (ModestShellWindow *) instance;
176         parent_priv = MODEST_WINDOW_GET_PRIVATE (self);
177         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
178
179         priv->title = NULL;
180
181         priv->accel_group = gtk_accel_group_new ();
182
183         priv->app_menu_dimming_group = modest_dimming_rules_group_new (MODEST_DIMMING_RULES_MENU, FALSE);
184         gtk_window_add_accel_group (GTK_WINDOW (self), priv->accel_group);
185
186         priv->menu = gtk_menu_new ();
187
188         modest_ui_dimming_manager_insert_rules_group (parent_priv->ui_dimming_manager, 
189                                                       priv->app_menu_dimming_group);
190
191         /* Dont't restore settings here, 
192          * because it requires a gtk_widget_show(), 
193          * and we don't want to do that until later,
194          * so that the UI is not visible for non-menu D-Bus activation.
195          */
196 }
197
198 static gboolean
199 on_zoom_minus_plus_not_implemented (ModestWindow *window)
200 {
201         g_return_val_if_fail (MODEST_IS_SHELL_WINDOW (window), FALSE);
202
203         modest_platform_information_banner (NULL, NULL, _CS("ckct_ib_cannot_zoom_here"));
204         return FALSE;
205 }
206 void 
207 modest_shell_window_add_item_to_menu (ModestWindow *self,
208                                         GtkWidget *button,
209                                         ModestDimmingCallback dimming_callback)
210 {
211         ModestShellWindowPrivate *priv;
212
213         g_return_if_fail (MODEST_IS_SHELL_WINDOW(self));
214         g_return_if_fail (GTK_IS_BUTTON (button));
215         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
216
217         modest_ui_dimming_manager_set_widget_dimming_mode (GTK_WIDGET (button),
218                                                            MODEST_UI_DIMMING_MODE_HIDE);
219
220         if (dimming_callback)
221                 modest_dimming_rules_group_add_widget_rule (priv->app_menu_dimming_group,
222                                                             GTK_WIDGET (button),
223                                                             (GCallback) dimming_callback,
224                                                             MODEST_WINDOW (self));
225         if (priv->menu) {
226                 gtk_menu_shell_append (GTK_MENU_SHELL (priv->menu), button);
227         } else {
228                 gtk_widget_destroy (button);
229         }
230
231         gtk_widget_show (GTK_WIDGET (button));
232 }
233
234 static void
235 modest_shell_window_add_to_menu (ModestWindow *self,
236                                    const gchar *label,
237                                    const gchar *accelerator,
238                                    ModestWindowMenuCallback callback,
239                                    ModestDimmingCallback dimming_callback)
240 {
241         ModestShellWindowPrivate *priv = NULL;
242         GtkWidget *menu_item;
243
244         g_return_if_fail (MODEST_IS_SHELL_WINDOW(self));
245         g_return_if_fail (label && label[0] != '\0');
246         g_return_if_fail (callback != NULL);
247
248         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
249
250         menu_item = gtk_menu_item_new_with_label (label);
251         g_signal_connect_after (G_OBJECT (menu_item), "activate-item",
252                                 G_CALLBACK (callback), (gpointer) self);
253
254         if (accelerator != NULL) {
255                 guint accel_key;
256                 GdkModifierType accel_mods;
257
258                 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
259                 gtk_widget_add_accelerator (menu_item, "clicked", priv->accel_group,
260                                             accel_key, accel_mods, 0);
261         }
262
263         if (priv->menu) {
264                 gtk_menu_shell_append (GTK_MENU_SHELL (priv->menu), menu_item);
265         } else {
266                 gtk_widget_destroy (menu_item);
267         }
268 }
269
270 static void
271 modest_shell_window_show_toolbar (ModestWindow *self,
272                                     gboolean show_toolbar)
273 {
274         /* Empty implementation: Hildon 2.2 implementation
275          * doesn't switch toolbar visibility */
276 }
277
278 static void
279 modest_shell_window_add_toolbar (ModestWindow *self,
280                                  GtkToolbar *toolbar)
281 {
282         gtk_box_pack_end (GTK_BOX (self), GTK_WIDGET (toolbar), FALSE, FALSE, 0);
283 }
284
285 static void
286 modest_shell_window_set_title (ModestWindow *self,
287                                const gchar *title)
288 {
289         ModestShellWindowPrivate *priv = NULL;
290
291         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
292         if (priv->title)
293                 g_free (priv->title);
294         priv->title = g_strdup (title);
295         if (priv->shell) {
296                 modest_shell_set_title (MODEST_SHELL (priv->shell),
297                                         MODEST_WINDOW (self),
298                                         title);
299         }
300 }
301
302 static void
303 modest_shell_window_show_progress (ModestWindow *self,
304                                      gboolean show)
305 {
306         ModestShellWindowPrivate *priv = NULL;
307
308         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
309         modest_shell_show_progress (MODEST_SHELL (priv->shell),
310                                     self,
311                                     show);
312 }
313
314 void
315 modest_shell_window_set_shell (ModestShellWindow *self,
316                                ModestShell *shell)
317 {
318         ModestShellWindowPrivate *priv = NULL;
319
320         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
321
322         if (priv->shell) {
323                 modest_shell_delete_window (MODEST_SHELL (shell), MODEST_WINDOW (self));
324                 g_object_unref (priv->shell);
325         }
326
327         priv->shell = g_object_ref (shell);
328         modest_shell_set_title (MODEST_SHELL (priv->shell),
329                                 MODEST_WINDOW (self),
330                                 priv->title);
331 }
332
333 GtkWidget *
334 modest_shell_window_get_menu (ModestShellWindow *self)
335 {
336         ModestShellWindowPrivate *priv = NULL;
337
338         priv = MODEST_SHELL_WINDOW_GET_PRIVATE (self);
339
340         return priv->menu;
341 }