revise label colouring, add filter action for label colouring, fix filtering issues
[claws.git] / src / labelcolors.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 2001 Hiroyuki Yamamoto & The Sylpheed Claws Team
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 /* (alfons) - based on a contribution by Satoshi Nagayasu; revised for colorful 
21  * menu and more Sylpheed integration. The idea to put the code in a separate
22  * file is just that it make it easier to allow "user changeable" label colors.
23  */
24
25 #include "defs.h"
26 #include "intl.h"
27
28 #include <glib.h>
29 #include <gdk/gdkx.h>
30 #include <gtk/gtkwidget.h>
31 #include <gtk/gtkpixmap.h>
32 #include <gtk/gtkmenu.h>
33 #include <gtk/gtkcheckmenuitem.h>
34 #include <gtk/gtklabel.h>
35 #include <gtk/gtkmenuitem.h>
36 #include <gtk/gtkalignment.h>
37 #include <gtk/gtkhbox.h>
38 #include <gtk/gtkwindow.h>
39
40
41 #include "labelcolors.h"
42 #include "gtkutils.h"
43 #include "utils.h"
44
45 static gchar *labels[] = {
46         N_("Orange"),
47         N_("Red") ,
48         N_("Pink"),
49         N_("Sky blue"),
50         N_("Blue"),
51         N_("Green"),
52         N_("Brown")
53 };
54
55 typedef enum LabelColorChangeFlags_ {
56         LCCF_COLOR = 1 << 0,
57         LCCF_LABEL = 1 << 1,
58         LCCF_ALL   = LCCF_COLOR | LCCF_LABEL
59 } LabelColorChangeFlags;
60
61 /* XXX: if you add colors, make sure you also check the procmsg.h. color indices
62  * are stored as 3 bits; that explains the max. of 7 colors */
63 static struct 
64 {
65         LabelColorChangeFlags   changed; 
66         GdkColor                color;
67
68         /* XXX: note that the label member is supposed to be dynamically 
69          * allocated and fffreed */
70         gchar                   *label;
71         GtkPixmap               *pixmap;
72 }
73 label_colors[] = 
74 {
75         { LCCF_ALL, { 0, 0xffff, (0x99 << 8), 0x0 },            NULL, NULL },
76         { LCCF_ALL, { 0, 0xffff, 0, 0 },                        NULL, NULL },
77         { LCCF_ALL, { 0, 0xffff, (0x66 << 8), 0xffff },         NULL, NULL },
78         { LCCF_ALL, { 0, 0x0, (0xcc << 8), 0xffff },            NULL, NULL },
79         { LCCF_ALL, { 0, 0x0, 0x0, 0xffff },                    NULL, NULL },
80         { LCCF_ALL, { 0, 0x0, 0x99 << 8, 0x0 },                 NULL, NULL },
81         { LCCF_ALL, { 0, 0x66 << 8, 0x33 << 8, 0x33 << 8 },     NULL, NULL }
82 };
83
84 #define LABEL_COLORS_ELEMS (sizeof label_colors / sizeof label_colors[0])
85
86 #define G_RETURN_VAL_IF_INVALID_COLOR(color, val) \
87         g_return_val_if_fail((color) >= 0 && (color) < LABEL_COLORS_ELEMS, (val))
88
89 static void labelcolors_recreate        (gint);
90 static void labelcolors_recreate_label  (gint);
91
92 gint labelcolors_get_color_count(void)
93 {
94         return LABEL_COLORS_ELEMS;
95 }
96
97 GdkColor labelcolors_get_color(gint color_index)
98 {
99         GdkColor invalid = { 0 };
100
101         G_RETURN_VAL_IF_INVALID_COLOR(color_index, invalid);
102
103         return label_colors[color_index].color;
104 }
105
106 gchar *labelcolors_get_color_text(gint color_index)
107 {
108         G_RETURN_VAL_IF_INVALID_COLOR(color_index, NULL);
109
110         labelcolors_recreate_label(color_index);
111         return label_colors[color_index].label;
112 }
113
114 GtkPixmap *labelcolors_create_color_pixmap(GdkColor color)
115 {
116         const char *FMT = "+      c #%2.2X%2.2X%2.2X";
117         char buf[40];
118         
119         /* black frame of 1 pixel */
120         char * dummy_xpm[] = {
121                 "16 16 3 1",
122                 "       c None",
123                 ".      c #000000",
124                 "+      c #000000",
125                 "................",
126                 ".++++++++++++++.",
127                 ".++++++++++++++.",
128                 ".++++++++++++++.",
129                 ".++++++++++++++.",
130                 ".++++++++++++++.",
131                 ".++++++++++++++.",
132                 ".++++++++++++++.",
133                 ".++++++++++++++.",
134                 ".++++++++++++++.",
135                 ".++++++++++++++.",
136                 ".++++++++++++++.",
137                 ".++++++++++++++.",
138                 ".++++++++++++++.",
139                 ".++++++++++++++.",
140                 "................"
141         };
142
143         GdkBitmap *xpmmask;
144         GdkPixmap *xpm;
145         GtkPixmap *pixmap;
146
147         /* put correct color in xpm data */
148         sprintf(buf, FMT, color.red >> 8, color.green >> 8, color.blue >> 8);
149         dummy_xpm[3] = buf;                             
150
151         /* XXX: passing NULL as GdkWindow* seems to be possible */
152         xpm = gdk_pixmap_create_from_xpm_d(GDK_ROOT_PARENT(), &xpmmask, NULL, (gchar **) &dummy_xpm);
153         if (xpm == NULL)
154                 debug_print("*** NO XPM\n");
155         pixmap = GTK_PIXMAP(gtk_pixmap_new(xpm, xpmmask)); 
156
157         
158         g_return_val_if_fail(pixmap, NULL);
159
160         gdk_pixmap_unref(xpm);
161         gdk_bitmap_unref(xpmmask);
162         return pixmap;
163 }
164
165 /* XXX: this function to check if menus with colors and labels should
166  * be recreated */
167 gboolean labelcolors_changed(void)
168 {
169         gint n;
170         for (n = 0; n < LABEL_COLORS_ELEMS; n++) {
171                 if (label_colors[n].changed) 
172                         return TRUE;
173         }
174         return FALSE;
175 }
176
177 /* XXX: labelcolors_recreate_XXX are there to make sure everything
178  * is initialized ok, without having to call a global _xxx_init_
179  * function */
180 static void labelcolors_recreate_color(gint color)
181 {
182         GtkPixmap *pixmap;
183         
184         if (!(label_colors[color].changed & LCCF_COLOR))
185                 return;
186         
187         pixmap = GTK_PIXMAP(labelcolors_create_color_pixmap(label_colors[color].color));
188         g_return_if_fail(pixmap);
189         
190         if (label_colors[color].pixmap)
191                 gtk_widget_destroy(GTK_WIDGET(label_colors[color].pixmap));
192                 
193         label_colors[color].pixmap = pixmap;            
194         label_colors[color].changed &= ~LCCF_COLOR;
195 }
196
197 static void labelcolors_recreate_label(gint color)
198 {
199         if (!label_colors[color].changed & LCCF_LABEL)
200                 return;
201
202         if (label_colors[color].label == NULL) 
203                 label_colors[color].label = g_strdup(labels[color]);
204         
205         label_colors[color].changed &= ~LCCF_LABEL;
206 }
207
208 /* XXX: call this function everytime when you're doing important
209  * stuff with the label_colors[] array */
210 static void labelcolors_recreate(gint color)
211 {
212         labelcolors_recreate_label(color);
213         labelcolors_recreate_color(color);
214 }
215
216 static void labelcolors_recreate_all(void)
217 {
218         gint n;
219         for ( n = 0; n < LABEL_COLORS_ELEMS; n++) 
220                 labelcolors_recreate(n);
221 }
222
223 /* labelcolors_create_check_color_menu_item() - creates a color
224  * menu item with a check box */
225 GtkWidget *labelcolors_create_check_color_menu_item(gint color_index)
226 {
227         GtkWidget *label; 
228         GtkWidget *hbox; 
229         GtkWidget *align; 
230         GtkWidget *pixmap; 
231         GtkWidget *item;
232
233         G_RETURN_VAL_IF_INVALID_COLOR(color_index, NULL);
234
235         item  = gtk_check_menu_item_new();
236
237         labelcolors_recreate(color_index);
238
239         /* XXX: gnome-core::panel::menu.c is a great example of
240          * how to create pixmap menus */
241         label = gtk_label_new(label_colors[color_index].label);
242         
243         gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.5);
244         gtk_widget_show(label);
245         hbox = gtk_hbox_new(FALSE, 0);
246         gtk_widget_show(hbox);
247         gtk_container_add(GTK_CONTAINER(item), hbox);
248
249         align = gtk_alignment_new(0.5, 0.5, 0.0, 0.0);
250         gtk_widget_show(align);
251         gtk_container_set_border_width(GTK_CONTAINER(align), 1);
252
253         gtk_container_add(GTK_CONTAINER(align), GTK_WIDGET(label_colors[color_index].pixmap));
254         gtk_widget_show(GTK_WIDGET(label_colors[color_index].pixmap));
255         gtk_widget_set_usize(align, 16, 16);
256
257         gtk_box_pack_start(GTK_BOX(hbox), align, FALSE, FALSE, 0);
258         gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 4);
259
260         return item;
261 }
262
263 /* labelcolors_create_color_menu() - creates a color menu without 
264  * checkitems, probably for use in combo items */
265 GtkWidget *labelcolors_create_color_menu(void)
266 {
267         GtkWidget *label; 
268         GtkWidget *hbox; 
269         GtkWidget *align; 
270         GtkWidget *pixmap; 
271         GtkWidget *item;
272         GtkWidget *menu;
273         gint i;
274
275         labelcolors_recreate_all();
276
277         /* create the menu items. each item has its color code attached */
278         menu = gtk_menu_new();
279         gtk_object_set_data(GTK_OBJECT(menu), "label_color_menu", menu);
280
281         item = gtk_menu_item_new_with_label(_("None"));
282         gtk_menu_append(GTK_MENU(menu), item);
283         gtk_object_set_data(GTK_OBJECT(item), "color", GUINT_TO_POINTER(0));
284         gtk_widget_show(item);
285         
286         /* and the color items */
287         for (i = 0; i < LABEL_COLORS_ELEMS; i++) {
288                 GtkPixmap *pixmap = labelcolors_create_color_pixmap(label_colors[i].color);
289
290                 item  = gtk_menu_item_new();
291                 gtk_object_set_data(GTK_OBJECT(item), "color", GUINT_TO_POINTER(i + 1));
292
293                 label = gtk_label_new(label_colors[i].label);
294                 
295                 gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.5);
296                 gtk_widget_show(label);
297                 hbox = gtk_hbox_new(FALSE, 0);
298                 gtk_widget_show(hbox);
299                 gtk_container_add(GTK_CONTAINER(item), hbox);
300
301                 align = gtk_alignment_new(0.5, 0.5, 0.0, 0.0);
302                 gtk_widget_show(align);
303                 gtk_container_set_border_width(GTK_CONTAINER(align), 1);
304
305                 gtk_container_add(GTK_CONTAINER(align), GTK_WIDGET(pixmap));
306                 gtk_widget_show(GTK_WIDGET(pixmap));
307                 gtk_widget_set_usize(align, 16, 16);
308
309                 gtk_box_pack_start(GTK_BOX(hbox), align, FALSE, FALSE, 0);
310                 gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 4);
311                 
312                 gtk_menu_append(GTK_MENU(menu), item);
313                 gtk_widget_show(item);
314         }
315         
316         gtk_widget_show(menu);
317
318         return menu;
319 }
320
321 guint labelcolors_get_color_menu_active_item(GtkWidget *menu)
322 {
323         GtkWidget *menuitem;
324         guint      color;
325         
326         g_return_val_if_fail( gtk_object_get_data(GTK_OBJECT(menu), "label_color_menu"), 0);
327         menuitem = gtk_menu_get_active(GTK_MENU(menu));
328         color = GPOINTER_TO_UINT( gtk_object_get_data(GTK_OBJECT(menuitem), "color") );
329         return color;
330 }
331
332