0dcf04ad6246a0389cf646b1951b9716c5753fda
[modest] / src / widgets / modest-toolbar.c
1 /* Copyright (c) 2006, 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 <glib/gi18n.h>
31 #include "modest-toolbar.h"
32
33 /* 'private'/'protected' functions */
34 static void modest_toolbar_class_init (ModestToolbarClass *klass);
35 static void modest_toolbar_init       (ModestToolbar *obj);
36 static void modest_toolbar_finalize   (GObject *obj);
37
38 static void on_toolbutton_clicked (GtkToolButton *button, ModestToolbar *self);
39
40 /* list my signals  */
41 enum {
42         BUTTON_CLICKED_SIGNAL,
43         LAST_SIGNAL
44 };
45
46 typedef struct _ModestToolbarPrivate ModestToolbarPrivate;
47 struct _ModestToolbarPrivate {
48         GtkTooltips     *tooltips;
49
50 };
51 #define MODEST_TOOLBAR_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
52                                             MODEST_TYPE_TOOLBAR, \
53                                             ModestToolbarPrivate))
54 /* globals */
55 static GtkToolbarClass *parent_class = NULL;
56
57 static guint signals[LAST_SIGNAL] = {0};
58
59 GType
60 modest_toolbar_get_type (void)
61 {
62         static GType my_type = 0;
63         if (!my_type) {
64                 static const GTypeInfo my_info = {
65                         sizeof(ModestToolbarClass),
66                         NULL,           /* base init */
67                         NULL,           /* base finalize */
68                         (GClassInitFunc) modest_toolbar_class_init,
69                         NULL,           /* class finalize */
70                         NULL,           /* class data */
71                         sizeof(ModestToolbar),
72                         1,              /* n_preallocs */
73                         (GInstanceInitFunc) modest_toolbar_init,
74                         NULL
75                 };
76                 my_type = g_type_register_static (GTK_TYPE_TOOLBAR,
77                                                   "ModestToolbar",
78                                                   &my_info, 0);
79         }
80         return my_type;
81 }
82
83 static void
84 modest_toolbar_class_init (ModestToolbarClass *klass)
85 {
86         GObjectClass *gobject_class;
87         gobject_class = (GObjectClass*) klass;
88
89         parent_class            = g_type_class_peek_parent (klass);
90         gobject_class->finalize = modest_toolbar_finalize;
91
92         g_type_class_add_private (gobject_class, sizeof(ModestToolbarPrivate));
93
94         signals[BUTTON_CLICKED_SIGNAL] = 
95                 g_signal_new ("button_clicked",
96                               G_TYPE_FROM_CLASS (gobject_class),
97                               G_SIGNAL_RUN_FIRST,
98                               G_STRUCT_OFFSET (ModestToolbarClass, button_clicked),
99                               NULL, NULL,
100                               g_cclosure_marshal_VOID__INT,
101                               G_TYPE_NONE, 1, G_TYPE_INT);
102 }
103
104 static void
105 modest_toolbar_init (ModestToolbar *obj)
106 {
107         ModestToolbarPrivate *priv;
108         priv = MODEST_TOOLBAR_GET_PRIVATE(obj);
109
110         priv->tooltips = NULL;
111         
112 }
113
114 static void
115 modest_toolbar_finalize (GObject *obj)
116 {
117         G_OBJECT_CLASS(parent_class)->finalize (obj);
118 }
119
120
121 /* don't free icon_name/label/tooltip, they're static */ 
122 static gboolean
123 data_for_button_id (ModestToolbarButton button_id,
124                     gchar **icon_name, gchar **label, gchar **tooltip)
125 {
126         switch (button_id) {
127         case MODEST_TOOLBAR_BUTTON_MAIL_SEND:
128                 *label     = _("Send");
129                 *tooltip   = _("Send the current email message");
130                 *icon_name = MODEST_TOOLBAR_ICON_MAIL_SEND;
131                 break;
132         case MODEST_TOOLBAR_BUTTON_NEW_MAIL:
133                 *label     = _("New mail");
134                 *tooltip   = _("Compose a new email message");
135                 *icon_name = MODEST_TOOLBAR_ICON_NEW_MAIL;
136                 break;
137         case MODEST_TOOLBAR_BUTTON_SEND_RECEIVE:
138                 *label     = _("Send/Receive");
139                 *tooltip   = _("Send and receive messages");
140                 *icon_name = MODEST_TOOLBAR_ICON_SEND_RECEIVE;
141                 break;
142         case MODEST_TOOLBAR_BUTTON_REPLY:
143                 *label     = _("Reply");
144                 *tooltip   = _("Reply to the selected email message");
145                 *icon_name = MODEST_TOOLBAR_ICON_REPLY;
146                 break;
147         case MODEST_TOOLBAR_BUTTON_REPLY_ALL:
148                 *label    = _("Reply all");
149                 *tooltip   = _("Reply to all people the selected email was sent to");
150                 *icon_name = MODEST_TOOLBAR_ICON_REPLY_ALL;
151                 break;
152         case MODEST_TOOLBAR_BUTTON_FORWARD:
153                 *label     = _("Forward");
154                 *tooltip   = _("Forward the selected email");
155                 *icon_name = MODEST_TOOLBAR_ICON_FORWARD;
156                 break;
157         case MODEST_TOOLBAR_BUTTON_DELETE:
158                 *label     = _("Delete");
159                 *tooltip   = _("Delete the selected email message(s)");
160                 *icon_name = MODEST_TOOLBAR_ICON_DELETE;
161                 break;
162         case MODEST_TOOLBAR_BUTTON_NEXT:
163                 *label     = _("Next");
164                 *tooltip   = _("Move to the next message");
165                 *icon_name = MODEST_TOOLBAR_ICON_NEXT;
166                 break;
167         case MODEST_TOOLBAR_BUTTON_PREV:
168                 *label    = _("Previous");
169                 *tooltip   = _("Move to the previous message");
170                 *icon_name = MODEST_TOOLBAR_ICON_PREV;  
171                 break;
172         case MODEST_TOOLBAR_BUTTON_STOP:
173                 *label    = _("Stop");
174                 *tooltip  = _("Stop whatever"); 
175                 *icon_name = MODEST_TOOLBAR_ICON_STOP;
176                 break;
177         default:
178                 g_printerr ("modest: not a valid button id: %d\n", 
179                             button_id);
180                 return FALSE;
181         }
182         return TRUE;
183 }
184
185
186 static gboolean 
187 modest_toolbar_set_buttons (ModestToolbar *self, const GSList *buttons)
188 {
189         const GSList *cursor;
190         ModestToolbarPrivate *priv;
191
192         priv = MODEST_TOOLBAR_GET_PRIVATE(self);
193         
194         priv->tooltips = gtk_tooltips_new ();
195         gtk_tooltips_enable (priv->tooltips);
196         gtk_toolbar_set_tooltips (GTK_TOOLBAR(self), TRUE);
197
198         cursor = buttons;
199         while (cursor) {
200                 ModestToolbarButton button_id =
201                         (ModestToolbarButton) GPOINTER_TO_INT(cursor->data);
202                 
203                 if (button_id == MODEST_TOOLBAR_SEPARATOR)
204                         gtk_toolbar_insert (GTK_TOOLBAR(self), 
205                                             gtk_separator_tool_item_new(), -1);
206                 else {
207                         gchar *icon_name, *label, *tooltip; /* don't free these */
208                         if (!data_for_button_id (button_id, &icon_name, &label, &tooltip))
209                                 g_printerr ("modest: error getting data for toolbar button %d\n",
210                                             button_id);
211                         else {
212                                 GtkWidget *icon = NULL;
213                                 GtkToolItem *button = NULL;
214                                 GdkPixbuf *pixbuf = NULL;
215                                 
216                                 pixbuf = modest_icon_factory_get_icon_at_size (icon_name, 24, 24);
217                                 if (pixbuf)
218                                         icon   = gtk_image_new_from_pixbuf ((GdkPixbuf*)pixbuf);
219                                 button = gtk_tool_button_new (icon, label);
220                                 g_object_set_data (G_OBJECT(button), "button_id",
221                                                    GINT_TO_POINTER(button_id));
222                                 g_signal_connect (G_OBJECT(button), "clicked", 
223                                                   G_CALLBACK(on_toolbutton_clicked), self);
224
225                                 gtk_tooltips_set_tip (priv->tooltips, GTK_WIDGET(button),
226                                                       tooltip, NULL);
227                                 gtk_widget_show_all (GTK_WIDGET(button));
228                                 gtk_toolbar_insert (GTK_TOOLBAR(self), button, -1);
229                         }
230                 }
231                 cursor = cursor->next;
232         }
233         
234         return TRUE; /* FIXME */   
235 }       
236
237
238 ModestToolbar*
239 modest_toolbar_new (const GSList *buttons)
240 {
241         GObject *obj;
242
243         obj = g_object_new(MODEST_TYPE_TOOLBAR, NULL);
244         modest_toolbar_set_buttons (MODEST_TOOLBAR(obj), buttons);
245         
246         return MODEST_TOOLBAR(obj);
247 }
248
249 static void
250 on_toolbutton_clicked (GtkToolButton *button, ModestToolbar *self)
251 {
252         gint button_id = GPOINTER_TO_INT(
253                 g_object_get_data(G_OBJECT(button), "button_id"));
254
255         g_signal_emit (G_OBJECT(self), signals[BUTTON_CLICKED_SIGNAL],
256                        0, button_id);
257 }
258
259