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