2009-02-11 [colin] 3.7.0cvs58
[claws.git] / src / gtk / icon_legend.c
1 /*
2  * This file Copyright (C) 2005-2009 Paul Mangan <paul@claws-mail.org>
3  * and the Claws Mail 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 3 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, see <http://www.gnu.org/licenses/>.
17  * 
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #  include "config.h"
22 #endif
23
24 #include "defs.h"
25
26 #include <glib.h>
27 #include <glib/gi18n.h>
28 #include <gtk/gtk.h>
29 #include <gdk/gdkkeysyms.h>
30
31 #include "gtkutils.h"
32 #include "stock_pixmap.h"
33 #include "prefs_gtk.h"
34
35 #define ICONS 20
36
37 StockPixmap legend_icons[ICONS] = {
38         STOCK_PIXMAP_NEW,
39         STOCK_PIXMAP_UNREAD,
40         STOCK_PIXMAP_REPLIED, 
41         STOCK_PIXMAP_FORWARDED, 
42         STOCK_PIXMAP_IGNORETHREAD,
43         STOCK_PIXMAP_WATCHTHREAD,
44         STOCK_PIXMAP_SPAM,
45         STOCK_PIXMAP_CLIP,
46         STOCK_PIXMAP_GPG_SIGNED,
47         STOCK_PIXMAP_KEY,
48         STOCK_PIXMAP_CLIP_GPG_SIGNED,
49         STOCK_PIXMAP_CLIP_KEY,
50         STOCK_PIXMAP_MARK,
51         STOCK_PIXMAP_DELETED,
52         STOCK_PIXMAP_MOVED,
53         STOCK_PIXMAP_COPIED,
54         STOCK_PIXMAP_LOCKED,
55         STOCK_PIXMAP_DIR_OPEN, 
56         STOCK_PIXMAP_DIR_OPEN_HRM,
57         STOCK_PIXMAP_DIR_OPEN_MARK,
58 };
59
60 static gchar *legend_icon_desc[] = {
61 /* status column */
62         N_("New message"),
63         N_("Unread message"),
64         N_("Message has been replied to"),
65         N_("Message has been forwarded"),
66         N_("Message is in an ignored thread"),
67         N_("Message is in a watched thread"),
68         N_("Message is spam"),
69 /* attachment column */
70         N_("Message has attachment(s)"),
71         N_("Digitally signed message"),
72         N_("Encrypted message"),
73         N_("Message is signed and has attachment(s)"),
74         N_("Message is encrypted and has attachment(s)"),
75 /* mark column */
76         N_("Marked message"),
77         N_("Message is marked for deletion"),
78         N_("Message is marked for moving"),
79         N_("Message is marked for copying"),
80 /* locked column */
81         N_("Locked message"),
82 /* others */
83         N_("Folder (normal, opened)"),
84         N_("Folder with read messages hidden"),
85         N_("Folder contains marked messages"),
86 };
87
88 static struct LegendDialog {
89         GtkWidget *window;
90 } legend;
91
92 static void legend_create(void);
93 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event);
94 static void legend_close(void);
95
96 void legend_show(void)
97 {
98         if (!legend.window)
99                 legend_create();
100         else
101                 gtk_window_present(GTK_WINDOW(legend.window));
102 }
103
104 static void legend_create(void)
105 {
106         GtkWidget *window;
107         GtkWidget *vbox;
108         GtkWidget *confirm_area;
109         GtkWidget *close_button;
110         GtkWidget *hbox;
111         GtkWidget *label;
112         GtkWidget *icon_label;
113         GtkWidget *desc_label;
114         GtkWidget *scrolled_window;
115         GtkWidget *table;
116         gint i;
117
118         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "icon_legend");
119         gtk_window_set_title(GTK_WINDOW(window), _("Icon Legend"));
120         gtk_container_set_border_width(GTK_CONTAINER(window), 8);
121         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
122         gtk_widget_set_size_request(window, 360, 570);
123         g_signal_connect(G_OBJECT(window), "delete_event",
124                          G_CALLBACK(legend_close), NULL);
125         g_signal_connect(G_OBJECT(window), "key_press_event",
126                          G_CALLBACK(key_pressed), NULL);
127         gtk_widget_realize(window);
128
129         vbox = gtk_vbox_new(FALSE, 8);
130         gtk_container_add(GTK_CONTAINER(window), vbox);
131         gtk_container_set_border_width(GTK_CONTAINER(vbox), 2);
132
133         hbox = gtk_hbox_new(FALSE, 8);
134         gtk_widget_show(hbox);
135         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
136
137         label = gtk_label_new(_("<span weight=\"bold\">The following icons "
138                                 "are used to show the status of messages and "
139                                 "folders:</span>"));
140         gtk_label_set_use_markup(GTK_LABEL(label), TRUE);
141         gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
142         gtk_widget_show(label);
143         gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 0);
144
145         scrolled_window = gtk_scrolled_window_new (NULL, NULL);
146         gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scrolled_window),
147                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
148         gtk_box_pack_start(GTK_BOX(vbox), scrolled_window, TRUE, TRUE, 0);
149
150         table = gtk_table_new(ICONS, 2, FALSE);
151         gtk_container_set_border_width(GTK_CONTAINER(table), 8);
152         gtk_table_set_row_spacings(GTK_TABLE(table), 4);
153         gtk_table_set_col_spacings(GTK_TABLE(table), 8);
154
155         for (i = 0; i < ICONS; ++i) {
156                 icon_label = stock_pixmap_widget(window, legend_icons[i]);
157                 gtk_misc_set_alignment (GTK_MISC (icon_label), 0.5, 0.5);
158                 gtk_table_attach(GTK_TABLE(table), icon_label, 0, 1, i, i+1,
159                                 GTK_FILL, 0, 0, 0);
160
161                 desc_label = gtk_label_new(gettext(legend_icon_desc[i]));
162                 gtk_misc_set_alignment (GTK_MISC (desc_label), 0, 0.5);
163                 gtk_label_set_line_wrap(GTK_LABEL(desc_label), TRUE);
164                 gtk_table_attach(GTK_TABLE(table), desc_label, 1, 2, i, i+1,
165                                 GTK_FILL, 0, 0, 0);
166         }       
167
168         gtk_scrolled_window_add_with_viewport(GTK_SCROLLED_WINDOW(scrolled_window),
169                                               table);
170
171         gtkut_stock_button_set_create(&confirm_area, &close_button, GTK_STOCK_CLOSE,
172                                       NULL, NULL, NULL, NULL);
173         gtk_box_pack_end(GTK_BOX(vbox), confirm_area, FALSE, FALSE, 4);
174         gtk_widget_grab_default(close_button);
175         g_signal_connect_closure
176                 (G_OBJECT(close_button), "clicked",
177                  g_cclosure_new_swap(G_CALLBACK(legend_close),
178                                      window, NULL), FALSE);
179
180         gtk_widget_show_all(window);
181
182         legend.window = window;
183 }
184
185 static gboolean key_pressed(GtkWidget *widget, GdkEventKey *event)
186 {
187         if (event && event->keyval == GDK_Escape) {
188                 legend_close();
189         }
190         return FALSE;
191 }
192
193 static void legend_close(void)
194 {
195         gtk_widget_destroy(legend.window);
196         legend.window = NULL;
197 }