2005-01-29 [paul] 1.0.0cvs23.2
[claws.git] / src / stock_pixmap.c
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2001 Hiroyuki Yamamoto
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 #include "defs.h"
21 #include <glib.h>
22 #include <gtk/gtkwidget.h>
23 #include <gtk/gtkimage.h>
24 #include <string.h>
25 #include <dirent.h>
26
27 #include "stock_pixmap.h"
28 #include "gtkutils.h"
29 #include "utils.h"
30 #include "prefs_common.h"
31
32 #include "pixmaps/address.xpm"
33 #include "pixmaps/book.xpm"
34 #include "pixmaps/category.xpm"
35 #include "pixmaps/checkbox_off.xpm"
36 #include "pixmaps/checkbox_on.xpm"
37 #include "pixmaps/clip.xpm"
38 #include "pixmaps/clipkey.xpm"
39 #include "pixmaps/complete.xpm"
40 #include "pixmaps/continue.xpm"
41 #include "pixmaps/deleted.xpm"
42 #include "pixmaps/dir_close.xpm"
43 #include "pixmaps/dir_open.xpm"
44 #include "pixmaps/dir_open_hrm.xpm"
45 #include "pixmaps/error.xpm"
46 #include "pixmaps/forwarded.xpm"
47 #include "pixmaps/group.xpm"
48 #include "pixmaps/inbox.xpm"
49 #include "pixmaps/inbox_hrm.xpm"
50 #include "pixmaps/interface.xpm"
51 #include "pixmaps/jpilot.xpm"
52 #include "pixmaps/key.xpm"
53 #include "pixmaps/ldap.xpm"
54 #include "pixmaps/linewrap.xpm"
55 #include "pixmaps/linewrapcurrent.xpm"
56 #include "pixmaps/mark.xpm"
57 #include "pixmaps/locked.xpm"
58 #include "pixmaps/new.xpm"
59 #include "pixmaps/outbox.xpm"
60 #include "pixmaps/outbox_hrm.xpm"
61 #include "pixmaps/replied.xpm"
62 #include "pixmaps/close.xpm"
63 #include "pixmaps/down_arrow.xpm"
64 #include "pixmaps/up_arrow.xpm"
65 #include "pixmaps/exec.xpm"
66 #include "pixmaps/mail.xpm"
67 #include "pixmaps/mail_attach.xpm"
68 #include "pixmaps/mail_compose.xpm"
69 #include "pixmaps/mail_forward.xpm"
70 #include "pixmaps/mail_receive.xpm"
71 #include "pixmaps/mail_receive_all.xpm"
72 #include "pixmaps/mail_reply.xpm"
73 #include "pixmaps/mail_reply_to_all.xpm"
74 #include "pixmaps/mail_reply_to_author.xpm"
75 #include "pixmaps/mail_send.xpm"
76 #include "pixmaps/mail_send_queue.xpm"
77 #include "pixmaps/news_compose.xpm"
78 #include "pixmaps/paste.xpm"
79 #include "pixmaps/preferences.xpm"
80 #include "pixmaps/properties.xpm"
81 #include "pixmaps/sylpheed_icon.xpm"
82 #include "pixmaps/sylpheed_logo.xpm"
83 #include "pixmaps/address_book.xpm"
84 #include "pixmaps/trash.xpm"
85 #include "pixmaps/trash_hrm.xpm"
86 #include "pixmaps/unread.xpm"
87 #include "pixmaps/read.xpm"
88 #include "pixmaps/vcard.xpm"
89 #include "pixmaps/ignorethread.xpm"
90 #include "pixmaps/online.xpm"
91 #include "pixmaps/offline.xpm"
92 #include "pixmaps/notice_warn.xpm"
93 #include "pixmaps/notice_error.xpm"
94 #include "pixmaps/notice_note.xpm"
95 #include "pixmaps/quicksearch.xpm"
96 #include "pixmaps/gpg_signed.xpm"
97 #include "pixmaps/drafts_close.xpm"
98 #include "pixmaps/drafts_open.xpm"
99 #include "pixmaps/mime_text_plain.xpm"
100 #include "pixmaps/mime_text_html.xpm"
101 #include "pixmaps/mime_application.xpm"
102 #include "pixmaps/mime_image.xpm"
103 #include "pixmaps/mime_audio.xpm"
104 #include "pixmaps/mime_text_enriched.xpm"
105 #include "pixmaps/mime_unknown.xpm"
106 #include "pixmaps/privacy_signed.xpm"
107 #include "pixmaps/privacy_passed.xpm"
108 #include "pixmaps/privacy_failed.xpm"
109 #include "pixmaps/privacy_unknown.xpm"
110 #include "pixmaps/privacy_expired.xpm"
111 #include "pixmaps/privacy_warn.xpm"                 
112 #include "pixmaps/privacy_emblem_encrypted.xpm"
113 #include "pixmaps/privacy_emblem_signed.xpm"
114 #include "pixmaps/privacy_emblem_passed.xpm"
115 #include "pixmaps/privacy_emblem_failed.xpm"
116 #include "pixmaps/privacy_emblem_warn.xpm"
117 #include "pixmaps/mime_message.xpm"                  
118 #include "pixmaps/address_search.xpm"
119 #include "pixmaps/check_spelling.xpm"
120
121 typedef struct _StockPixmapData StockPixmapData;
122
123 struct _StockPixmapData
124 {
125         gchar **data;
126         GdkPixmap *pixmap;
127         GdkBitmap *mask;
128         gchar *file;
129         gchar *icon_path;
130         GdkPixbuf *pixbuf;
131 };
132
133 typedef struct _OverlayData OverlayData;
134
135 struct _OverlayData
136 {
137         GdkPixmap *base_pixmap;
138         GdkBitmap *base_mask;
139         GdkPixmap *overlay_pixmap;
140         GdkBitmap *overlay_mask;
141         guint base_height;
142         guint base_width;
143         guint overlay_height;
144         guint overlay_width;
145         OverlayPosition position;
146         gint border_x;
147         gint border_y;
148 };
149
150 static void stock_pixmap_find_themes_in_dir(GList **list, const gchar *dirname);
151
152 static StockPixmapData pixmaps[] =
153 {
154         {address_xpm                            , NULL, NULL, "address", NULL},
155         {address_book_xpm                       , NULL, NULL, "address_book", NULL},
156         {address_search_xpm                     , NULL, NULL, "address_search", NULL},
157         {book_xpm                               , NULL, NULL, "book", NULL},
158         {category_xpm                           , NULL, NULL, "category", NULL},
159         {checkbox_off_xpm                       , NULL, NULL, "checkbox_off", NULL},
160         {checkbox_on_xpm                        , NULL, NULL, "checkbox_on", NULL},
161         {check_spelling_xpm                     , NULL, NULL, "check_spelling", NULL},
162         {clip_xpm                               , NULL, NULL, "clip", NULL},
163         {clipkey_xpm                            , NULL, NULL, "clipkey", NULL},
164         {close_xpm                              , NULL, NULL, "close", NULL},
165         {complete_xpm                           , NULL, NULL, "complete", NULL},
166         {continue_xpm                           , NULL, NULL, "continue", NULL},
167         {deleted_xpm                            , NULL, NULL, "deleted", NULL},
168         {dir_close_xpm                          , NULL, NULL, "dir_close", NULL},
169         {dir_close_xpm                          , NULL, NULL, "dir_close_hrm", NULL},
170         {dir_open_xpm                           , NULL, NULL, "dir_open", NULL},
171         {dir_open_hrm_xpm                       , NULL, NULL, "dir_open_hrm", NULL},
172         {down_arrow_xpm                         , NULL, NULL, "down_arrow", NULL},
173         {up_arrow_xpm                           , NULL, NULL, "up_arrow", NULL},
174         {mail_compose_xpm                       , NULL, NULL, "edit_extern", NULL},
175         {error_xpm                              , NULL, NULL, "error", NULL},
176         {exec_xpm                               , NULL, NULL, "exec", NULL},
177         {forwarded_xpm                          , NULL, NULL, "forwarded", NULL},
178         {group_xpm                              , NULL, NULL, "group", NULL},
179         {ignorethread_xpm                       , NULL, NULL, "ignorethread", NULL},
180         {inbox_xpm                              , NULL, NULL, "inbox_close", NULL},
181         {inbox_hrm_xpm                          , NULL, NULL, "inbox_close_hrm", NULL},
182         {inbox_xpm                              , NULL, NULL, "inbox_open", NULL},
183         {inbox_hrm_xpm                          , NULL, NULL, "inbox_open_hrm", NULL},
184         {paste_xpm                              , NULL, NULL, "insert_file", NULL},
185         {interface_xpm                          , NULL, NULL, "interface", NULL},
186         {jpilot_xpm                             , NULL, NULL, "jpilot", NULL},
187         {key_xpm                                , NULL, NULL, "key", NULL},
188         {ldap_xpm                               , NULL, NULL, "ldap", NULL},
189         {linewrapcurrent_xpm                    , NULL, NULL, "linewrapcurrent", NULL},
190         {linewrap_xpm                           , NULL, NULL, "linewrap", NULL},
191         {locked_xpm                             , NULL, NULL, "locked", NULL},
192         {mail_xpm                               , NULL, NULL, "mail", NULL},
193         {mail_attach_xpm                        , NULL, NULL, "mail_attach", NULL},
194         {mail_compose_xpm                       , NULL, NULL, "mail_compose", NULL},
195         {mail_forward_xpm                       , NULL, NULL, "mail_forward", NULL},
196         {mail_receive_xpm                       , NULL, NULL, "mail_receive", NULL},
197         {mail_receive_all_xpm                   , NULL, NULL, "mail_receive_all", NULL},
198         {mail_reply_xpm                         , NULL, NULL, "mail_reply", NULL},
199         {mail_reply_to_all_xpm                  , NULL, NULL, "mail_reply_to_all", NULL},
200         {mail_reply_to_author_xpm               , NULL, NULL, "mail_reply_to_author", NULL},
201         {mail_send_xpm                          , NULL, NULL, "mail_send", NULL},
202         {mail_send_queue_xpm                    , NULL, NULL, "mail_send_queue", NULL},
203         {mail_xpm                               , NULL, NULL, "mail_sign", NULL},
204         {mark_xpm                               , NULL, NULL, "mark", NULL},
205         {new_xpm                                , NULL, NULL, "new", NULL},
206         {news_compose_xpm                       , NULL, NULL, "news_compose", NULL},
207         {outbox_xpm                             , NULL, NULL, "outbox_close", NULL},
208         {outbox_hrm_xpm                         , NULL, NULL, "outbox_close_hrm", NULL},
209         {outbox_xpm                             , NULL, NULL, "outbox_open", NULL},
210         {outbox_hrm_xpm                         , NULL, NULL, "outbox_open_hrm", NULL},
211         {replied_xpm                            , NULL, NULL, "replied", NULL},
212         {paste_xpm                              , NULL, NULL, "paste", NULL},
213         {preferences_xpm                        , NULL, NULL, "preferences", NULL},
214         {properties_xpm                         , NULL, NULL, "properties", NULL},
215         {outbox_xpm                             , NULL, NULL, "queue_close", NULL},
216         {outbox_hrm_xpm                         , NULL, NULL, "queue_close_hrm", NULL},
217         {outbox_xpm                             , NULL, NULL, "queue_open", NULL},
218         {outbox_hrm_xpm                         , NULL, NULL, "queue_open_hrm", NULL},
219         {trash_xpm                              , NULL, NULL, "trash_open", NULL},
220         {trash_hrm_xpm                          , NULL, NULL, "trash_open_hrm", NULL},
221         {trash_xpm                              , NULL, NULL, "trash_close", NULL},
222         {trash_hrm_xpm                          , NULL, NULL, "trash_close_hrm", NULL},
223         {unread_xpm                             , NULL, NULL, "unread", NULL},
224         {vcard_xpm                              , NULL, NULL, "vcard", NULL},
225         {online_xpm                             , NULL, NULL, "online", NULL},
226         {offline_xpm                            , NULL, NULL, "offline", NULL},
227         {notice_warn_xpm                        , NULL, NULL, "notice_warn",  NULL},
228         {notice_error_xpm                       , NULL, NULL, "notice_error",  NULL},
229         {notice_note_xpm                        , NULL, NULL, "notice_note",  NULL},
230         {quicksearch_xpm                        , NULL, NULL, "quicksearch",  NULL},
231         {gpg_signed_xpm                         , NULL, NULL, "gpg_signed", NULL},
232         {drafts_close_xpm                       , NULL, NULL, "drafts_close", NULL},
233         {drafts_open_xpm                        , NULL, NULL, "drafts_open", NULL},
234         {mime_text_plain_xpm                    , NULL, NULL, "mime_text_plain", NULL},
235         {mime_text_html_xpm                     , NULL, NULL, "mime_text_html", NULL},
236         {mime_application_xpm                   , NULL, NULL, "mime_application", NULL},
237         {mime_image_xpm                         , NULL, NULL, "mime_image", NULL},
238         {mime_audio_xpm                         , NULL, NULL, "mime_audio", NULL},
239         {mime_text_enriched_xpm                 , NULL, NULL, "mime_text_enriched", NULL},
240         {mime_unknown_xpm                       , NULL, NULL, "mime_unknown", NULL},    
241         {privacy_signed_xpm                     , NULL, NULL, "privacy_signed", NULL},
242         {privacy_passed_xpm                     , NULL, NULL, "privacy_passed", NULL},
243         {privacy_failed_xpm                     , NULL, NULL, "privacy_failed", NULL},  
244         {privacy_unknown_xpm                    , NULL, NULL, "privacy_unknown", NULL},
245         {privacy_expired_xpm                    , NULL, NULL, "privacy_expired", NULL},
246         {privacy_warn_xpm                       , NULL, NULL, "privacy_warn", NULL},
247         {privacy_emblem_encrypted_xpm           , NULL, NULL, "privacy_emblem_encrypted", NULL},
248         {privacy_emblem_signed_xpm              , NULL, NULL, "privacy_emblem_signed", NULL},
249         {privacy_emblem_passed_xpm              , NULL, NULL, "privacy_emblem_passed", NULL},
250         {privacy_emblem_failed_xpm              , NULL, NULL, "privacy_emblem_failed", NULL},   
251         {privacy_emblem_warn_xpm                , NULL, NULL, "privacy_emblem_warn", NULL},
252         {mime_message_xpm                       , NULL, NULL, "mime_message", NULL},
253         {sylpheed_icon_xpm                      , NULL, NULL, "sylpheed_icon", NULL},
254         {read_xpm                               , NULL, NULL, "read", NULL},
255         {sylpheed_logo_xpm                      , NULL, NULL, "sylpheed_logo", NULL},
256 };
257
258 /* return newly constructed GtkPixmap from GdkPixmap */
259 GtkWidget *stock_pixmap_widget(GtkWidget *window, StockPixmap icon)
260 {
261         GdkPixmap *pixmap;
262         GdkBitmap *mask;
263
264         g_return_val_if_fail(window != NULL, NULL);
265         g_return_val_if_fail(icon >= 0 && icon < N_STOCK_PIXMAPS, NULL);
266
267         if (stock_pixmap_gdk(window, icon, &pixmap, &mask) != -1)
268                 return gtk_image_new_from_pixmap(pixmap, mask);
269         
270         return NULL;
271 }
272
273 /*!
274  *\brief        
275  */
276 gint stock_pixbuf_gdk(GtkWidget *window, StockPixmap icon, GdkPixbuf **pixbuf)
277 {
278         StockPixmapData *pix_d;
279
280         g_return_val_if_fail(window != NULL, -1);
281         g_return_val_if_fail(icon >= 0 && icon < N_STOCK_PIXMAPS, -1);
282
283         if (pixbuf) 
284                 *pixbuf = NULL;
285
286         pix_d = &pixmaps[icon];
287
288         if (!pix_d->pixbuf || (strcmp2(pix_d->icon_path, prefs_common.pixmap_theme_path) != 0)) {
289                 GdkPixbuf *pix = NULL;
290         
291                 if (strcmp(prefs_common.pixmap_theme_path, DEFAULT_PIXMAP_THEME) != 0) {
292                         if (is_dir_exist(prefs_common.pixmap_theme_path)) {
293                                 char *icon_file_name; 
294                                 
295                                 icon_file_name = g_strconcat(prefs_common.pixmap_theme_path,
296                                                              G_DIR_SEPARATOR_S,
297                                                              pix_d->file,
298                                                              ".xpm",
299                                                              NULL);
300                                 if (is_file_exist(icon_file_name)) {
301                                         GError *err = NULL;
302                                         pix = gdk_pixbuf_new_from_file(icon_file_name, &err);   
303                                         if (err) g_error_free(err);
304                                 }                                       
305                                 if (pix) {
306                                         if (pix_d->icon_path != NULL) g_free(pix_d->icon_path);
307                                         pix_d->icon_path = g_strdup(prefs_common.pixmap_theme_path);
308                                 }
309                                 g_free(icon_file_name);
310                         } else {
311                                 /* even the path does not exist (deleted between two sessions), so
312                                 set the preferences to the internal theme */
313                                 prefs_common.pixmap_theme_path = g_strdup(DEFAULT_PIXMAP_THEME);
314                         }
315                 }
316                 pix_d->pixbuf = pix;
317         }
318
319         if (!pix_d->pixbuf) {
320                 pix_d->pixbuf = gdk_pixbuf_new_from_xpm_data((const gchar **) pix_d->data);
321                 if (pix_d->pixbuf) {
322                         if (pix_d->icon_path != NULL) g_free(pix_d->icon_path);
323                         pix_d->icon_path = g_strdup(DEFAULT_PIXMAP_THEME);      
324                 }
325         }
326
327         g_return_val_if_fail(pix_d->pixbuf != NULL, -1);
328
329         if (pixbuf)
330                 *pixbuf = pix_d->pixbuf;
331
332         /* pixbuf should have one ref outstanding */            
333
334         return 0;
335 }
336
337 /* create GdkPixmap if it has not created yet */
338 gint stock_pixmap_gdk(GtkWidget *window, StockPixmap icon,
339                       GdkPixmap **pixmap, GdkBitmap **mask)
340 {
341         StockPixmapData *pix_d;
342
343         if (pixmap) *pixmap = NULL;
344         if (mask)   *mask   = NULL;
345
346         g_return_val_if_fail(window != NULL, -1);
347         g_return_val_if_fail(icon >= 0 && icon < N_STOCK_PIXMAPS, -1);
348
349         pix_d = &pixmaps[icon];
350
351         if (!pix_d->pixmap || (strcmp2(pix_d->icon_path, prefs_common.pixmap_theme_path) != 0)) {
352                 GdkPixmap *pix = NULL;
353         
354                 if (strcmp(prefs_common.pixmap_theme_path, DEFAULT_PIXMAP_THEME) != 0) {
355                         if ( is_dir_exist(prefs_common.pixmap_theme_path) ) {
356                                 char *icon_file_name; 
357                                 
358                                 icon_file_name = g_strconcat(prefs_common.pixmap_theme_path,
359                                                              G_DIR_SEPARATOR_S,
360                                                              pix_d->file,
361                                                              ".xpm",
362                                                              NULL);
363                                 if (is_file_exist(icon_file_name))
364                                         PIXMAP_CREATE_FROM_FILE(window, pix, pix_d->mask, icon_file_name);
365                                 if (pix) {
366                                         if (pix_d->icon_path != NULL) g_free(pix_d->icon_path);
367                                         pix_d->icon_path = g_strdup(prefs_common.pixmap_theme_path);
368                                 }
369                                 g_free(icon_file_name);
370                         } else {
371                                 /* even the path does not exist (deleted between two sessions), so
372                                 set the preferences to the internal theme */
373                                 prefs_common.pixmap_theme_path = g_strdup(DEFAULT_PIXMAP_THEME);
374                         }
375                 }
376                 pix_d->pixmap = pix;
377         }
378
379         if (!pix_d->pixmap) {
380                 PIXMAP_CREATE(window, pix_d->pixmap, pix_d->mask, pix_d->data);
381                 if (pix_d->pixmap) {
382                         if (pix_d->icon_path != NULL) g_free(pix_d->icon_path);
383                         pix_d->icon_path = g_strdup(DEFAULT_PIXMAP_THEME);      
384                 }
385         }
386
387         g_return_val_if_fail(pix_d->pixmap != NULL, -1);
388         
389         if (pixmap) 
390                 *pixmap = pix_d->pixmap;
391         if (mask)   
392                 *mask   = pix_d->mask;
393
394         return 0;
395 }
396
397 static void stock_pixmap_find_themes_in_dir(GList **list, const gchar *dirname)
398 {
399         struct dirent *d;
400         DIR *dp;
401         
402         if ((dp = opendir(dirname)) == NULL) {
403                 debug_print("dir %s not found, skipping theme scan", dirname);
404                 return;
405         }
406         
407         while ((d = readdir(dp)) != NULL) {
408                 gchar *entry;
409                 gchar *fullentry;
410
411                 entry     = d->d_name;
412                 fullentry = g_strconcat(dirname, G_DIR_SEPARATOR_S, entry, NULL);
413                 
414                 if (strcmp(entry, ".") != 0 && strcmp(entry, "..") != 0 && is_dir_exist(fullentry)) {
415                         gchar *filetoexist;
416                         int i;
417                         
418                         for (i = 0; i < N_STOCK_PIXMAPS; i++) {
419                                 filetoexist = g_strconcat(fullentry, G_DIR_SEPARATOR_S, pixmaps[i].file, ".xpm", NULL);
420                                 if (is_file_exist(filetoexist)) {
421                                         *list = g_list_append(*list, fullentry);
422                                         break;
423                                 }
424                         }
425                         g_free(filetoexist);
426                         if (i == N_STOCK_PIXMAPS) 
427                                 g_free(fullentry);
428                 } else 
429                         g_free(fullentry);
430         }
431         closedir(dp);
432 }
433
434 GList *stock_pixmap_themes_list_new(void)
435 {
436         gchar *defaulttheme;
437         gchar *userthemes;
438         gchar *systemthemes;
439         GList *list = NULL;
440         
441         defaulttheme = g_strdup(DEFAULT_PIXMAP_THEME);
442         userthemes   = g_strconcat(get_home_dir(), G_DIR_SEPARATOR_S,
443                                    RC_DIR, G_DIR_SEPARATOR_S, 
444                                    PIXMAP_THEME_DIR, NULL);
445         systemthemes = g_strconcat(PACKAGE_DATA_DIR, G_DIR_SEPARATOR_S,
446                                    PIXMAP_THEME_DIR, NULL);
447
448         list = g_list_append(list, defaulttheme);
449         
450         stock_pixmap_find_themes_in_dir(&list, userthemes);
451         stock_pixmap_find_themes_in_dir(&list, systemthemes);
452
453         g_free(userthemes);
454         g_free(systemthemes);
455         return list;
456 }
457
458 void stock_pixmap_themes_list_free(GList *list)
459 {
460         GList *ptr;
461
462         for (ptr = g_list_first(list); ptr != NULL; ptr = g_list_next(ptr)) 
463                 if (ptr->data)
464                         g_free(ptr->data);
465         g_list_free(list);              
466 }
467
468 gchar *stock_pixmap_get_name (StockPixmap icon)
469 {
470         g_return_val_if_fail(icon >= 0 && icon < N_STOCK_PIXMAPS, NULL);
471         
472         return pixmaps[icon].file;
473
474 }
475
476 StockPixmap stock_pixmap_get_icon (gchar *file)
477 {
478         gint i;
479         
480         for (i = 0; i < N_STOCK_PIXMAPS; i++) {
481                 if (strcmp (pixmaps[i].file, file) == 0)
482                         return i;
483         }
484         return -1;
485 }
486
487 static gboolean pixmap_with_overlay_expose_event_cb(GtkWidget *widget, GdkEventExpose *expose,
488                                                     OverlayData *data) 
489 {
490         GdkDrawable *drawable = widget->window; 
491         GdkGC *gc_pix;
492         gint left = 0;
493         gint top = 0;
494
495         g_return_val_if_fail(data->base_pixmap != NULL, FALSE);
496         g_return_val_if_fail(data->base_mask != NULL, FALSE);
497
498         gc_pix = gdk_gc_new((GdkWindow *)drawable);
499                                                  
500         gdk_window_clear_area (drawable, expose->area.x, expose->area.y,
501                                expose->area.width, expose->area.height);
502
503         gdk_gc_set_tile(gc_pix, data->base_pixmap);
504         gdk_gc_set_ts_origin(gc_pix, data->border_x, data->border_y);
505         gdk_gc_set_clip_mask(gc_pix, data->base_mask);
506         gdk_gc_set_clip_origin(gc_pix, data->border_x, data->border_y);
507         gdk_gc_set_fill(gc_pix, GDK_TILED);
508
509         gdk_draw_rectangle(drawable, gc_pix, TRUE, data->border_x, data->border_y, 
510                            data->base_width, data->base_height);
511
512         if (data->position != OVERLAY_NONE) {
513                 g_return_val_if_fail(data->overlay_pixmap != NULL, FALSE);
514                 g_return_val_if_fail(data->overlay_mask != NULL, FALSE);
515
516                 gdk_gc_set_tile(gc_pix, data->overlay_pixmap);
517                 gdk_gc_set_clip_mask(gc_pix, data->overlay_mask);
518
519                 switch (data->position) {
520                         case OVERLAY_TOP_LEFT:
521                         case OVERLAY_MID_LEFT:
522                         case OVERLAY_BOTTOM_LEFT:
523                                 left = 0;
524                                 break;
525
526                         case OVERLAY_TOP_CENTER:
527                         case OVERLAY_MID_CENTER:
528                         case OVERLAY_BOTTOM_CENTER:
529                                 left = (data->base_width + data->border_x * 2  - data->overlay_width)/2;
530                                 break;
531
532                         case OVERLAY_TOP_RIGHT:
533                         case OVERLAY_MID_RIGHT:
534                         case OVERLAY_BOTTOM_RIGHT:
535                                 left = data->base_width + data->border_x * 2 - data->overlay_width;
536                                 break;
537
538                         default:
539                                 break;
540                 }
541                 switch (data->position) {
542                         case OVERLAY_TOP_LEFT:
543                         case OVERLAY_TOP_CENTER:
544                         case OVERLAY_TOP_RIGHT:
545                                 top = 0;
546                                 break;
547
548                         case OVERLAY_MID_LEFT:
549                         case OVERLAY_MID_CENTER:
550                         case OVERLAY_MID_RIGHT:
551                                 top = (data->base_height + data->border_y * 2  - data->overlay_height)/2;
552                                 break;
553                                         
554                         case OVERLAY_BOTTOM_LEFT:
555                         case OVERLAY_BOTTOM_CENTER:
556                         case OVERLAY_BOTTOM_RIGHT:
557                                 top = data->base_height + data->border_y * 2 - data->overlay_height;
558                                 break;
559
560                         default:
561                                 break;
562                 }
563
564                 gdk_gc_set_ts_origin(gc_pix, left, top);
565                 gdk_gc_set_clip_origin(gc_pix, left, top);
566                 gdk_gc_set_fill(gc_pix, GDK_TILED);
567                 gdk_draw_rectangle(drawable, gc_pix, TRUE, left, top, 
568                                    data->overlay_width, data->overlay_height);
569         }
570         gdk_gc_destroy(gc_pix);
571         
572         return TRUE;
573 }
574
575 static void pixmap_with_overlay_destroy_cb(GtkObject *object, OverlayData *data) 
576 {
577         g_object_unref(data->base_pixmap);
578         g_object_unref(data->base_mask);
579         if (data->position != OVERLAY_NONE) {
580                 g_object_unref(data->overlay_pixmap);
581                 g_object_unref(data->overlay_mask);
582         }
583         g_free(data);
584 }
585
586 /**
587  * \brief Get a widget showing one icon with another overlaid on top of it.
588  *
589  * The base icon is always centralised, the other icon can be positioned.
590  * The overlay icon is ignored if pos=OVERLAY_NONE is used
591  *
592  * \param window   top-level window widget
593  * \param icon     the base icon
594  * \param overlay  the icon to overlay
595  * \param pos      how to align the overlay widget, or OVERLAY_NONE for no overlay
596  * \param border_x size of the border around the base icon (left and right)
597  * \param border_y size of the border around the base icon (top and bottom)
598  */
599 GtkWidget *stock_pixmap_widget_with_overlay(GtkWidget *window, StockPixmap icon,
600                                             StockPixmap overlay, OverlayPosition pos,
601                                             gint border_x, gint border_y)
602 {
603         GdkPixmap *stock_pixmap;
604         GdkBitmap *stock_mask;
605         GtkWidget *widget;
606         GtkWidget *stock_wid;
607         OverlayData *data;
608         
609         data = g_new0(OverlayData, 1);
610
611         stock_wid = stock_pixmap_widget(window, icon);
612         gtk_image_get_pixmap(GTK_IMAGE(stock_wid), &stock_pixmap, &stock_mask);
613         g_object_ref(stock_pixmap);
614         g_object_ref(stock_mask);
615         data->base_pixmap = stock_pixmap;
616         data->base_mask   = stock_mask;
617         data->base_height = stock_wid->requisition.height;
618         data->base_width  = stock_wid->requisition.width;
619         gtk_widget_destroy(stock_wid);
620
621         if (pos == OVERLAY_NONE) {
622                 data->overlay_pixmap = NULL;
623                 data->overlay_mask   = NULL;
624         } else {
625                 stock_wid = stock_pixmap_widget(window, overlay);
626                 gtk_image_get_pixmap(GTK_IMAGE(stock_wid), &stock_pixmap, &stock_mask);
627                 g_object_ref(stock_pixmap);
628                 g_object_ref(stock_mask);
629                 data->overlay_pixmap = stock_pixmap;
630                 data->overlay_mask   = stock_mask;
631                 data->overlay_height = stock_wid->requisition.height;
632                 data->overlay_width  = stock_wid->requisition.width;
633
634                 gtk_widget_destroy(stock_wid);
635         }
636         
637         data->position = pos;
638         data->border_x = border_x;
639         data->border_y = border_y;
640
641         widget = gtk_drawing_area_new();
642         gtk_drawing_area_size(GTK_DRAWING_AREA(widget), data->base_width + border_x * 2, 
643                               data->base_height + border_y * 2);
644         g_signal_connect(G_OBJECT(widget), "expose_event", 
645                          G_CALLBACK(pixmap_with_overlay_expose_event_cb), data);
646         g_signal_connect(G_OBJECT(widget), "destroy",
647                          G_CALLBACK(pixmap_with_overlay_destroy_cb), data);
648         return widget;
649
650 }