Minor clarifications.
[emacs.git] / src / gtkutil.c
blob67288cab33ff6b927245ad3714bb873a34102ffa
1 /* Functions for creating and updating GTK widgets.
2 Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA. */
21 #include "config.h"
23 #ifdef USE_GTK
24 #include <string.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include "lisp.h"
28 #include "xterm.h"
29 #include "blockinput.h"
30 #include "syssignal.h"
31 #include "window.h"
32 #include "atimer.h"
33 #include "gtkutil.h"
34 #include "termhooks.h"
35 #include "keyboard.h"
36 #include "charset.h"
37 #include "coding.h"
38 #include <gdk/gdkkeysyms.h>
41 #define FRAME_TOTAL_PIXEL_HEIGHT(f) \
42 (FRAME_PIXEL_HEIGHT (f) + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f))
44 /* Avoid "differ in sign" warnings */
45 #define SSDATA(x) ((char *) SDATA (x))
48 /***********************************************************************
49 Display handling functions
50 ***********************************************************************/
52 #ifdef HAVE_GTK_MULTIDISPLAY
54 /* Return the GdkDisplay that corresponds to the X display DPY. */
56 static GdkDisplay *
57 xg_get_gdk_display (dpy)
58 Display *dpy;
60 return gdk_x11_lookup_xdisplay (dpy);
63 /* When the GTK widget W is to be created on a display for F that
64 is not the default display, set the display for W.
65 W can be a GtkMenu or a GtkWindow widget. */
67 static void
68 xg_set_screen (w, f)
69 GtkWidget *w;
70 FRAME_PTR f;
72 if (FRAME_X_DISPLAY (f) != GDK_DISPLAY ())
74 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
75 GdkScreen *gscreen = gdk_display_get_default_screen (gdpy);
77 if (GTK_IS_MENU (w))
78 gtk_menu_set_screen (GTK_MENU (w), gscreen);
79 else
80 gtk_window_set_screen (GTK_WINDOW (w), gscreen);
85 #else /* not HAVE_GTK_MULTIDISPLAY */
87 /* Make some defines so we can use the GTK 2.2 functions when
88 compiling with GTK 2.0. */
90 #define xg_set_screen(w, f)
91 #define gdk_xid_table_lookup_for_display(dpy, w) gdk_xid_table_lookup (w)
92 #define gdk_pixmap_foreign_new_for_display(dpy, p) gdk_pixmap_foreign_new (p)
93 #define gdk_cursor_new_for_display(dpy, c) gdk_cursor_new (c)
94 #define gdk_x11_lookup_xdisplay(dpy) 0
95 #define GdkDisplay void
97 #endif /* not HAVE_GTK_MULTIDISPLAY */
99 /* Open a display named by DISPLAY_NAME. The display is returned in *DPY.
100 *DPY is set to NULL if the display can't be opened.
102 Returns non-zero if display could be opened, zero if display could not
103 be opened, and less than zero if the GTK version doesn't support
104 multipe displays. */
107 xg_display_open (display_name, dpy)
108 char *display_name;
109 Display **dpy;
111 #ifdef HAVE_GTK_MULTIDISPLAY
112 GdkDisplay *gdpy;
114 gdpy = gdk_display_open (display_name);
115 *dpy = gdpy ? GDK_DISPLAY_XDISPLAY (gdpy) : NULL;
117 return gdpy != NULL;
119 #else /* not HAVE_GTK_MULTIDISPLAY */
121 return -1;
122 #endif /* not HAVE_GTK_MULTIDISPLAY */
126 /* Close display DPY. */
128 void
129 xg_display_close (Display *dpy)
131 #ifdef HAVE_GTK_MULTIDISPLAY
132 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
134 /* GTK 2.2 has a bug that makes gdk_display_close crash (bug
135 http://bugzilla.gnome.org/show_bug.cgi?id=85715). This way
136 we can continue running, but there will be memory leaks. */
138 #if GTK_MAJOR_VERSION == 2 && GTK_MINOR_VERSION < 4
140 /* If this is the default display, we must change it before calling
141 dispose, otherwise it will crash. */
142 if (gdk_display_get_default () == gdpy)
144 struct x_display_info *dpyinfo;
145 Display *new_dpy = 0;
146 GdkDisplay *gdpy_new;
148 /* Find another display. */
149 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
150 if (dpyinfo->display != dpy)
152 new_dpy = dpyinfo->display;
153 break;
156 if (! new_dpy) return; /* Emacs will exit anyway. */
158 gdpy_new = gdk_x11_lookup_xdisplay (new_dpy);
159 gdk_display_manager_set_default_display (gdk_display_manager_get (),
160 gdpy_new);
163 g_object_run_dispose (G_OBJECT (gdpy));
165 #else
166 /* I hope this will be fixed in GTK 2.4. It is what bug 85715 says. */
167 gdk_display_close (gdpy);
168 #endif
169 #endif /* HAVE_GTK_MULTIDISPLAY */
173 /***********************************************************************
174 Utility functions
175 ***********************************************************************/
176 /* The timer for scroll bar repetition and menu bar timeouts.
177 NULL if no timer is started. */
178 static struct atimer *xg_timer;
181 /* The next two variables and functions are taken from lwlib. */
182 static widget_value *widget_value_free_list;
183 static int malloc_cpt;
185 /* Allocate a widget_value structure, either by taking one from the
186 widget_value_free_list or by malloc:ing a new one.
188 Return a pointer to the allocated structure. */
190 widget_value *
191 malloc_widget_value ()
193 widget_value *wv;
194 if (widget_value_free_list)
196 wv = widget_value_free_list;
197 widget_value_free_list = wv->free_list;
198 wv->free_list = 0;
200 else
202 wv = (widget_value *) malloc (sizeof (widget_value));
203 malloc_cpt++;
205 memset (wv, 0, sizeof (widget_value));
206 return wv;
209 /* This is analogous to free. It frees only what was allocated
210 by malloc_widget_value, and no substructures. */
212 void
213 free_widget_value (wv)
214 widget_value *wv;
216 if (wv->free_list)
217 abort ();
219 if (malloc_cpt > 25)
221 /* When the number of already allocated cells is too big,
222 We free it. */
223 free (wv);
224 malloc_cpt--;
226 else
228 wv->free_list = widget_value_free_list;
229 widget_value_free_list = wv;
234 /* Create and return the cursor to be used for popup menus and
235 scroll bars on display DPY. */
237 GdkCursor *
238 xg_create_default_cursor (dpy)
239 Display *dpy;
241 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (dpy);
242 return gdk_cursor_new_for_display (gdpy, GDK_LEFT_PTR);
245 /* Apply GMASK to GPIX and return a GdkPixbuf with an alpha channel. */
247 static GdkPixbuf *
248 xg_get_pixbuf_from_pix_and_mask (gpix, gmask, cmap)
249 GdkPixmap *gpix;
250 GdkPixmap *gmask;
251 GdkColormap *cmap;
253 int x, y, width, height, rowstride, mask_rowstride;
254 GdkPixbuf *icon_buf, *tmp_buf;
255 guchar *pixels;
256 guchar *mask_pixels;
258 gdk_drawable_get_size (gpix, &width, &height);
259 tmp_buf = gdk_pixbuf_get_from_drawable (NULL, gpix, cmap,
260 0, 0, 0, 0, width, height);
261 icon_buf = gdk_pixbuf_add_alpha (tmp_buf, FALSE, 0, 0, 0);
262 g_object_unref (G_OBJECT (tmp_buf));
264 if (gmask)
266 GdkPixbuf *mask_buf = gdk_pixbuf_get_from_drawable (NULL,
267 gmask,
268 NULL,
269 0, 0, 0, 0,
270 width, height);
271 guchar *pixels = gdk_pixbuf_get_pixels (icon_buf);
272 guchar *mask_pixels = gdk_pixbuf_get_pixels (mask_buf);
273 int rowstride = gdk_pixbuf_get_rowstride (icon_buf);
274 int mask_rowstride = gdk_pixbuf_get_rowstride (mask_buf);
275 int y;
277 for (y = 0; y < height; ++y)
279 guchar *iconptr, *maskptr;
280 int x;
282 iconptr = pixels + y * rowstride;
283 maskptr = mask_pixels + y * mask_rowstride;
285 for (x = 0; x < width; ++x)
287 /* In a bitmap, RGB is either 255/255/255 or 0/0/0. Checking
288 just R is sufficient. */
289 if (maskptr[0] == 0)
290 iconptr[3] = 0; /* 0, 1, 2 is R, G, B. 3 is alpha. */
292 iconptr += rowstride/width;
293 maskptr += mask_rowstride/width;
297 g_object_unref (G_OBJECT (mask_buf));
300 return icon_buf;
303 /* For the image defined in IMG, make and return a GtkImage. For displays with
304 8 planes or less we must make a GdkPixbuf and apply the mask manually.
305 Otherwise the highlightning and dimming the tool bar code in GTK does
306 will look bad. For display with more than 8 planes we just use the
307 pixmap and mask directly. For monochrome displays, GTK doesn't seem
308 able to use external pixmaps, it looks bad whatever we do.
309 The image is defined on the display where frame F is.
310 WIDGET is used to find the GdkColormap to use for the GdkPixbuf.
311 If OLD_WIDGET is NULL, a new widget is constructed and returned.
312 If OLD_WIDGET is not NULL, that widget is modified. */
314 static GtkWidget *
315 xg_get_image_for_pixmap (f, img, widget, old_widget)
316 FRAME_PTR f;
317 struct image *img;
318 GtkWidget *widget;
319 GtkImage *old_widget;
321 GdkPixmap *gpix;
322 GdkPixmap *gmask;
323 GdkDisplay *gdpy;
325 /* If we have a file, let GTK do all the image handling.
326 This seems to be the only way to make insensitive and activated icons
327 look good in all cases. */
328 Lisp_Object specified_file = Qnil;
329 Lisp_Object tail;
330 extern Lisp_Object QCfile;
332 for (tail = XCDR (img->spec);
333 NILP (specified_file) && CONSP (tail) && CONSP (XCDR (tail));
334 tail = XCDR (XCDR (tail)))
335 if (EQ (XCAR (tail), QCfile))
336 specified_file = XCAR (XCDR (tail));
338 if (STRINGP (specified_file))
340 Lisp_Object file = Qnil;
341 struct gcpro gcpro1;
342 GCPRO1 (file);
344 file = x_find_image_file (specified_file);
345 /* We already loaded the image once before calling this
346 function, so this should not fail. */
347 xassert (STRINGP (file) != 0);
349 if (! old_widget)
350 old_widget = GTK_IMAGE (gtk_image_new_from_file (SSDATA (file)));
351 else
352 gtk_image_set_from_file (old_widget, SSDATA (file));
354 UNGCPRO;
355 return GTK_WIDGET (old_widget);
358 /* No file, do the image handling ourselves. This will look very bad
359 on a monochrome display, and sometimes bad on all displays with
360 certain themes. */
362 gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
363 gpix = gdk_pixmap_foreign_new_for_display (gdpy, img->pixmap);
364 gmask = img->mask ? gdk_pixmap_foreign_new_for_display (gdpy, img->mask) : 0;
366 if (x_screen_planes (f) > 8 || x_screen_planes (f) == 1)
368 if (! old_widget)
369 old_widget = GTK_IMAGE (gtk_image_new_from_pixmap (gpix, gmask));
370 else
371 gtk_image_set_from_pixmap (old_widget, gpix, gmask);
373 else
376 /* This is a workaround to make icons look good on pseudo color
377 displays. Apparently GTK expects the images to have an alpha
378 channel. If they don't, insensitive and activated icons will
379 look bad. This workaround does not work on monochrome displays,
380 and is not needed on true color/static color displays (i.e.
381 16 bits and higher). */
382 GdkColormap *cmap = gtk_widget_get_colormap (widget);
383 GdkPixbuf *icon_buf = xg_get_pixbuf_from_pix_and_mask (gpix, gmask, cmap);
385 if (! old_widget)
386 old_widget = GTK_IMAGE (gtk_image_new_from_pixbuf (icon_buf));
387 else
388 gtk_image_set_from_pixbuf (old_widget, icon_buf);
390 g_object_unref (G_OBJECT (icon_buf));
393 g_object_unref (G_OBJECT (gpix));
394 if (gmask) g_object_unref (G_OBJECT (gmask));
396 return GTK_WIDGET (old_widget);
400 /* Set CURSOR on W and all widgets W contain. We must do like this
401 for scroll bars and menu because they create widgets internally,
402 and it is those widgets that are visible. */
404 static void
405 xg_set_cursor (w, cursor)
406 GtkWidget *w;
407 GdkCursor *cursor;
409 GList *children = gdk_window_peek_children (w->window);
411 gdk_window_set_cursor (w->window, cursor);
413 /* The scroll bar widget has more than one GDK window (had to look at
414 the source to figure this out), and there is no way to set cursor
415 on widgets in GTK. So we must set the cursor for all GDK windows.
416 Ditto for menus. */
418 for ( ; children; children = g_list_next (children))
419 gdk_window_set_cursor (GDK_WINDOW (children->data), cursor);
422 /* Timer function called when a timeout occurs for xg_timer.
423 This function processes all GTK events in a recursive event loop.
424 This is done because GTK timer events are not seen by Emacs event
425 detection, Emacs only looks for X events. When a scroll bar has the
426 pointer (detected by button press/release events below) an Emacs
427 timer is started, and this function can then check if the GTK timer
428 has expired by calling the GTK event loop.
429 Also, when a menu is active, it has a small timeout before it
430 pops down the sub menu under it. */
432 static void
433 xg_process_timeouts (timer)
434 struct atimer *timer;
436 BLOCK_INPUT;
437 /* Ideally we would like to just handle timer events, like the Xt version
438 of this does in xterm.c, but there is no such feature in GTK. */
439 while (gtk_events_pending ())
440 gtk_main_iteration ();
441 UNBLOCK_INPUT;
444 /* Start the xg_timer with an interval of 0.1 seconds, if not already started.
445 xg_process_timeouts is called when the timer expires. The timer
446 started is continuous, i.e. runs until xg_stop_timer is called. */
448 static void
449 xg_start_timer ()
451 if (! xg_timer)
453 EMACS_TIME interval;
454 EMACS_SET_SECS_USECS (interval, 0, 100000);
455 xg_timer = start_atimer (ATIMER_CONTINUOUS,
456 interval,
457 xg_process_timeouts,
462 /* Stop the xg_timer if started. */
464 static void
465 xg_stop_timer ()
467 if (xg_timer)
469 cancel_atimer (xg_timer);
470 xg_timer = 0;
474 /* Insert NODE into linked LIST. */
476 static void
477 xg_list_insert (xg_list_node *list, xg_list_node *node)
479 xg_list_node *list_start = list->next;
481 if (list_start) list_start->prev = node;
482 node->next = list_start;
483 node->prev = 0;
484 list->next = node;
487 /* Remove NODE from linked LIST. */
489 static void
490 xg_list_remove (xg_list_node *list, xg_list_node *node)
492 xg_list_node *list_start = list->next;
493 if (node == list_start)
495 list->next = node->next;
496 if (list->next) list->next->prev = 0;
498 else
500 node->prev->next = node->next;
501 if (node->next) node->next->prev = node->prev;
505 /* Allocate and return a utf8 version of STR. If STR is already
506 utf8 or NULL, just return STR.
507 If not, a new string is allocated and the caller must free the result
508 with g_free. */
510 static char *
511 get_utf8_string (str)
512 char *str;
514 char *utf8_str = str;
516 /* If not UTF-8, try current locale. */
517 if (str && !g_utf8_validate (str, -1, NULL))
518 utf8_str = g_locale_to_utf8 (str, -1, 0, 0, 0);
520 return utf8_str;
525 /***********************************************************************
526 General functions for creating widgets, resizing, events, e.t.c.
527 ***********************************************************************/
529 /* Make a geometry string and pass that to GTK. It seems this is the
530 only way to get geometry position right if the user explicitly
531 asked for a position when starting Emacs.
532 F is the frame we shall set geometry for. */
534 static void
535 xg_set_geometry (f)
536 FRAME_PTR f;
538 if (f->size_hint_flags & USPosition)
540 int left = f->left_pos;
541 int xneg = f->size_hint_flags & XNegative;
542 int top = f->top_pos;
543 int yneg = f->size_hint_flags & YNegative;
544 char geom_str[32];
546 if (xneg)
547 left = -left;
548 if (yneg)
549 top = -top;
551 sprintf (geom_str, "=%dx%d%c%d%c%d",
552 FRAME_PIXEL_WIDTH (f),
553 FRAME_TOTAL_PIXEL_HEIGHT (f),
554 (xneg ? '-' : '+'), left,
555 (yneg ? '-' : '+'), top);
557 if (!gtk_window_parse_geometry (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
558 geom_str))
559 fprintf (stderr, "Failed to parse: '%s'\n", geom_str);
560 } else if (f->size_hint_flags & PPosition) {
561 gtk_window_move (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
562 f->left_pos, f->top_pos);
567 /* Resize the outer window of frame F after chainging the height.
568 This happend when the menu bar or the tool bar is added or removed.
569 COLUMNS/ROWS is the size the edit area shall have after the resize. */
571 static void
572 xg_resize_outer_widget (f, columns, rows)
573 FRAME_PTR f;
574 int columns;
575 int rows;
577 /* If we are not mapped yet, set geometry once again, as window
578 height now have changed. */
579 if (! GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
580 xg_set_geometry (f);
582 xg_frame_set_char_size (f, columns, rows);
583 gdk_window_process_all_updates ();
586 /* Function to handle resize of our widgets. Since Emacs has some layouts
587 that does not fit well with GTK standard containers, we do most layout
588 manually.
589 F is the frame to resize.
590 PIXELWIDTH, PIXELHEIGHT is the new size in pixels. */
592 void
593 xg_resize_widgets (f, pixelwidth, pixelheight)
594 FRAME_PTR f;
595 int pixelwidth, pixelheight;
597 int mbheight = FRAME_MENUBAR_HEIGHT (f);
598 int tbheight = FRAME_TOOLBAR_HEIGHT (f);
599 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, (pixelheight
600 - mbheight - tbheight));
601 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
603 if (FRAME_GTK_WIDGET (f)
604 && (columns != FRAME_COLS (f)
605 || rows != FRAME_LINES (f)
606 || pixelwidth != FRAME_PIXEL_WIDTH (f)
607 || pixelheight != FRAME_PIXEL_HEIGHT (f)))
609 struct x_output *x = f->output_data.x;
610 GtkAllocation all;
612 all.y = mbheight + tbheight;
613 all.x = 0;
615 all.width = pixelwidth;
616 all.height = pixelheight - mbheight - tbheight;
618 gtk_widget_size_allocate (x->edit_widget, &all);
620 change_frame_size (f, rows, columns, 0, 1, 0);
621 SET_FRAME_GARBAGED (f);
622 cancel_mouse_face (f);
627 /* Update our widget size to be COLS/ROWS characters for frame F. */
629 void
630 xg_frame_set_char_size (f, cols, rows)
631 FRAME_PTR f;
632 int cols;
633 int rows;
635 int pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
636 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
637 int pixelwidth;
639 /* Take into account the size of the scroll bar. Always use the
640 number of columns occupied by the scroll bar here otherwise we
641 might end up with a frame width that is not a multiple of the
642 frame's character width which is bad for vertically split
643 windows. */
644 f->scroll_bar_actual_width
645 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
647 compute_fringe_widths (f, 0);
649 /* FRAME_TEXT_COLS_TO_PIXEL_WIDTH uses scroll_bar_actual_width, so call it
650 after calculating that value. */
651 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
653 /* Must resize our top level widget. Font size may have changed,
654 but not rows/cols. */
655 gtk_window_resize (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
656 pixelwidth, pixelheight);
657 xg_resize_widgets (f, pixelwidth, pixelheight);
658 x_wm_set_size_hint (f, 0, 0);
659 SET_FRAME_GARBAGED (f);
660 cancel_mouse_face (f);
663 /* Convert an X Window WSESC on display DPY to its corresponding GtkWidget.
664 Must be done like this, because GtkWidget:s can have "hidden"
665 X Window that aren't accessible.
667 Return 0 if no widget match WDESC. */
669 GtkWidget *
670 xg_win_to_widget (dpy, wdesc)
671 Display *dpy;
672 Window wdesc;
674 gpointer gdkwin;
675 GtkWidget *gwdesc = 0;
677 BLOCK_INPUT;
679 gdkwin = gdk_xid_table_lookup_for_display (gdk_x11_lookup_xdisplay (dpy),
680 wdesc);
681 if (gdkwin)
683 GdkEvent event;
684 event.any.window = gdkwin;
685 gwdesc = gtk_get_event_widget (&event);
688 UNBLOCK_INPUT;
689 return gwdesc;
692 /* Fill in the GdkColor C so that it represents PIXEL.
693 W is the widget that color will be used for. Used to find colormap. */
695 static void
696 xg_pix_to_gcolor (w, pixel, c)
697 GtkWidget *w;
698 unsigned long pixel;
699 GdkColor *c;
701 GdkColormap *map = gtk_widget_get_colormap (w);
702 gdk_colormap_query_color (map, pixel, c);
705 /* Create and set up the GTK widgets for frame F.
706 Return 0 if creation failed, non-zero otherwise. */
709 xg_create_frame_widgets (f)
710 FRAME_PTR f;
712 GtkWidget *wtop;
713 GtkWidget *wvbox;
714 GtkWidget *wfixed;
715 GdkColor bg;
716 GtkRcStyle *style;
717 int i;
718 char *title = 0;
720 BLOCK_INPUT;
722 wtop = gtk_window_new (GTK_WINDOW_TOPLEVEL);
723 xg_set_screen (wtop, f);
725 wvbox = gtk_vbox_new (FALSE, 0);
726 wfixed = gtk_fixed_new (); /* Must have this to place scroll bars */
728 if (! wtop || ! wvbox || ! wfixed)
730 if (wtop) gtk_widget_destroy (wtop);
731 if (wvbox) gtk_widget_destroy (wvbox);
732 if (wfixed) gtk_widget_destroy (wfixed);
734 UNBLOCK_INPUT;
735 return 0;
738 /* Use same names as the Xt port does. I.e. Emacs.pane.emacs by default */
739 gtk_widget_set_name (wtop, EMACS_CLASS);
740 gtk_widget_set_name (wvbox, "pane");
741 gtk_widget_set_name (wfixed, SSDATA (Vx_resource_name));
743 /* If this frame has a title or name, set it in the title bar. */
744 if (! NILP (f->title)) title = SSDATA (ENCODE_UTF_8 (f->title));
745 else if (! NILP (f->name)) title = SSDATA (ENCODE_UTF_8 (f->name));
747 if (title) gtk_window_set_title (GTK_WINDOW (wtop), title);
749 FRAME_GTK_OUTER_WIDGET (f) = wtop;
750 FRAME_GTK_WIDGET (f) = wfixed;
751 f->output_data.x->vbox_widget = wvbox;
753 gtk_fixed_set_has_window (GTK_FIXED (wfixed), TRUE);
755 gtk_widget_set_size_request (wfixed, FRAME_PIXEL_WIDTH (f),
756 FRAME_PIXEL_HEIGHT (f));
758 gtk_container_add (GTK_CONTAINER (wtop), wvbox);
759 gtk_box_pack_end (GTK_BOX (wvbox), wfixed, TRUE, TRUE, 0);
761 if (FRAME_EXTERNAL_TOOL_BAR (f))
762 update_frame_tool_bar (f);
764 /* The tool bar is created but first there are no items in it.
765 This causes it to be zero height. Later items are added, but then
766 the frame is already mapped, so there is a "jumping" resize.
767 This makes geometry handling difficult, for example -0-0 will end
768 up in the wrong place as tool bar height has not been taken into account.
769 So we cheat a bit by setting a height that is what it will have
770 later on when tool bar items are added. */
771 if (FRAME_EXTERNAL_TOOL_BAR (f) && f->n_tool_bar_items == 0)
772 FRAME_TOOLBAR_HEIGHT (f) = 38;
775 /* We don't want this widget double buffered, because we draw on it
776 with regular X drawing primitives, so from a GTK/GDK point of
777 view, the widget is totally blank. When an expose comes, this
778 will make the widget blank, and then Emacs redraws it. This flickers
779 a lot, so we turn off double buffering. */
780 gtk_widget_set_double_buffered (wfixed, FALSE);
782 /* GTK documents says use gtk_window_set_resizable. But then a user
783 can't shrink the window from its starting size. */
784 gtk_window_set_policy (GTK_WINDOW (wtop), TRUE, TRUE, TRUE);
785 gtk_window_set_wmclass (GTK_WINDOW (wtop),
786 SSDATA (Vx_resource_name),
787 SSDATA (Vx_resource_class));
789 /* Add callback to do nothing on WM_DELETE_WINDOW. The default in
790 GTK is to destroy the widget. We want Emacs to do that instead. */
791 g_signal_connect (G_OBJECT (wtop), "delete-event",
792 G_CALLBACK (gtk_true), 0);
794 /* Convert our geometry parameters into a geometry string
795 and specify it.
796 GTK will itself handle calculating the real position this way. */
797 xg_set_geometry (f);
799 gtk_widget_add_events (wfixed,
800 GDK_POINTER_MOTION_MASK
801 | GDK_EXPOSURE_MASK
802 | GDK_BUTTON_PRESS_MASK
803 | GDK_BUTTON_RELEASE_MASK
804 | GDK_KEY_PRESS_MASK
805 | GDK_ENTER_NOTIFY_MASK
806 | GDK_LEAVE_NOTIFY_MASK
807 | GDK_FOCUS_CHANGE_MASK
808 | GDK_STRUCTURE_MASK
809 | GDK_VISIBILITY_NOTIFY_MASK);
811 /* Must realize the windows so the X window gets created. It is used
812 by callers of this function. */
813 gtk_widget_realize (wfixed);
814 FRAME_X_WINDOW (f) = GTK_WIDGET_TO_X_WIN (wfixed);
816 /* Since GTK clears its window by filling with the background color,
817 we must keep X and GTK background in sync. */
818 xg_pix_to_gcolor (wfixed, f->output_data.x->background_pixel, &bg);
819 gtk_widget_modify_bg (wfixed, GTK_STATE_NORMAL, &bg);
821 /* Also, do not let any background pixmap to be set, this looks very
822 bad as Emacs overwrites the background pixmap with its own idea
823 of background color. */
824 style = gtk_widget_get_modifier_style (wfixed);
826 /* Must use g_strdup because gtk_widget_modify_style does g_free. */
827 style->bg_pixmap_name[GTK_STATE_NORMAL] = g_strdup ("<none>");
828 gtk_widget_modify_style (wfixed, style);
830 /* GTK does not set any border, and they look bad with GTK. */
831 f->border_width = 0;
832 f->internal_border_width = 0;
834 UNBLOCK_INPUT;
836 return 1;
839 /* Set the normal size hints for the window manager, for frame F.
840 FLAGS is the flags word to use--or 0 meaning preserve the flags
841 that the window now has.
842 If USER_POSITION is nonzero, we set the User Position
843 flag (this is useful when FLAGS is 0). */
845 void
846 x_wm_set_size_hint (f, flags, user_position)
847 FRAME_PTR f;
848 long flags;
849 int user_position;
851 if (FRAME_GTK_OUTER_WIDGET (f))
853 /* Must use GTK routines here, otherwise GTK resets the size hints
854 to its own defaults. */
855 GdkGeometry size_hints;
856 gint hint_flags = 0;
857 int base_width, base_height;
858 int min_rows = 0, min_cols = 0;
859 int win_gravity = f->win_gravity;
861 if (flags)
863 memset (&size_hints, 0, sizeof (size_hints));
864 f->output_data.x->size_hints = size_hints;
865 f->output_data.x->hint_flags = hint_flags;
867 else
868 flags = f->size_hint_flags;
870 size_hints = f->output_data.x->size_hints;
871 hint_flags = f->output_data.x->hint_flags;
873 hint_flags |= GDK_HINT_RESIZE_INC | GDK_HINT_MIN_SIZE;
874 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
875 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
877 hint_flags |= GDK_HINT_BASE_SIZE;
878 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
879 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0)
880 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
882 check_frame_size (f, &min_rows, &min_cols);
884 size_hints.base_width = base_width;
885 size_hints.base_height = base_height;
886 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
887 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
890 /* These currently have a one to one mapping with the X values, but I
891 don't think we should rely on that. */
892 hint_flags |= GDK_HINT_WIN_GRAVITY;
893 size_hints.win_gravity = 0;
894 if (win_gravity == NorthWestGravity)
895 size_hints.win_gravity = GDK_GRAVITY_NORTH_WEST;
896 else if (win_gravity == NorthGravity)
897 size_hints.win_gravity = GDK_GRAVITY_NORTH;
898 else if (win_gravity == NorthEastGravity)
899 size_hints.win_gravity = GDK_GRAVITY_NORTH_EAST;
900 else if (win_gravity == WestGravity)
901 size_hints.win_gravity = GDK_GRAVITY_WEST;
902 else if (win_gravity == CenterGravity)
903 size_hints.win_gravity = GDK_GRAVITY_CENTER;
904 else if (win_gravity == EastGravity)
905 size_hints.win_gravity = GDK_GRAVITY_EAST;
906 else if (win_gravity == SouthWestGravity)
907 size_hints.win_gravity = GDK_GRAVITY_SOUTH_WEST;
908 else if (win_gravity == SouthGravity)
909 size_hints.win_gravity = GDK_GRAVITY_SOUTH;
910 else if (win_gravity == SouthEastGravity)
911 size_hints.win_gravity = GDK_GRAVITY_SOUTH_EAST;
912 else if (win_gravity == StaticGravity)
913 size_hints.win_gravity = GDK_GRAVITY_STATIC;
915 if (flags & PPosition) hint_flags |= GDK_HINT_POS;
916 if (flags & USPosition) hint_flags |= GDK_HINT_USER_POS;
917 if (flags & USSize) hint_flags |= GDK_HINT_USER_SIZE;
919 if (user_position)
921 hint_flags &= ~GDK_HINT_POS;
922 hint_flags |= GDK_HINT_USER_POS;
925 BLOCK_INPUT;
927 gtk_window_set_geometry_hints (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)),
928 FRAME_GTK_OUTER_WIDGET (f),
929 &size_hints,
930 hint_flags);
932 f->output_data.x->size_hints = size_hints;
933 f->output_data.x->hint_flags = hint_flags;
934 UNBLOCK_INPUT;
938 /* Change background color of a frame.
939 Since GTK uses the background colour to clear the window, we must
940 keep the GTK and X colors in sync.
941 F is the frame to change,
942 BG is the pixel value to change to. */
944 void
945 xg_set_background_color (f, bg)
946 FRAME_PTR f;
947 unsigned long bg;
949 if (FRAME_GTK_WIDGET (f))
951 GdkColor gdk_bg;
953 BLOCK_INPUT;
954 xg_pix_to_gcolor (FRAME_GTK_WIDGET (f), bg, &gdk_bg);
955 gtk_widget_modify_bg (FRAME_GTK_WIDGET (f), GTK_STATE_NORMAL, &gdk_bg);
956 UNBLOCK_INPUT;
961 /* Set the frame icon to ICON_PIXMAP/MASK. This must be done with GTK
962 functions so GTK does not overwrite the icon. */
964 void
965 xg_set_frame_icon (f, icon_pixmap, icon_mask)
966 FRAME_PTR f;
967 Pixmap icon_pixmap;
968 Pixmap icon_mask;
970 GdkDisplay *gdpy = gdk_x11_lookup_xdisplay (FRAME_X_DISPLAY (f));
971 GdkPixmap *gpix = gdk_pixmap_foreign_new_for_display (gdpy, icon_pixmap);
972 GdkPixmap *gmask = gdk_pixmap_foreign_new_for_display (gdpy, icon_mask);
973 GdkPixbuf *gp = xg_get_pixbuf_from_pix_and_mask (gpix, gmask, NULL);
975 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)), gp);
980 /***********************************************************************
981 Dialog functions
982 ***********************************************************************/
983 /* Return the dialog title to use for a dialog of type KEY.
984 This is the encoding used by lwlib. We use the same for GTK. */
986 static char *
987 get_dialog_title (char key)
989 char *title = "";
991 switch (key) {
992 case 'E': case 'e':
993 title = "Error";
994 break;
996 case 'I': case 'i':
997 title = "Information";
998 break;
1000 case 'L': case 'l':
1001 title = "Prompt";
1002 break;
1004 case 'P': case 'p':
1005 title = "Prompt";
1006 break;
1008 case 'Q': case 'q':
1009 title = "Question";
1010 break;
1013 return title;
1016 /* Callback for dialogs that get WM_DELETE_WINDOW. We pop down
1017 the dialog, but return TRUE so the event does not propagate further
1018 in GTK. This prevents GTK from destroying the dialog widget automatically
1019 and we can always destrou the widget manually, regardles of how
1020 it was popped down (button press or WM_DELETE_WINDOW).
1021 W is the dialog widget.
1022 EVENT is the GdkEvent that represents WM_DELETE_WINDOW (not used).
1023 user_data is NULL (not used).
1025 Returns TRUE to end propagation of event. */
1027 static gboolean
1028 dialog_delete_callback (w, event, user_data)
1029 GtkWidget *w;
1030 GdkEvent *event;
1031 gpointer user_data;
1033 gtk_widget_unmap (w);
1034 return TRUE;
1037 /* Create a popup dialog window. See also xg_create_widget below.
1038 WV is a widget_value describing the dialog.
1039 SELECT_CB is the callback to use when a button has been pressed.
1040 DEACTIVATE_CB is the callback to use when the dialog pops down.
1042 Returns the GTK dialog widget. */
1044 static GtkWidget *
1045 create_dialog (wv, select_cb, deactivate_cb)
1046 widget_value *wv;
1047 GCallback select_cb;
1048 GCallback deactivate_cb;
1050 char *title = get_dialog_title (wv->name[0]);
1051 int total_buttons = wv->name[1] - '0';
1052 int right_buttons = wv->name[4] - '0';
1053 int left_buttons;
1054 int button_nr = 0;
1055 int button_spacing = 10;
1056 GtkWidget *wdialog = gtk_dialog_new ();
1057 widget_value *item;
1058 GtkBox *cur_box;
1059 GtkWidget *wvbox;
1060 GtkWidget *whbox_up;
1061 GtkWidget *whbox_down;
1063 /* If the number of buttons is greater than 4, make two rows of buttons
1064 instead. This looks better. */
1065 int make_two_rows = total_buttons > 4;
1067 if (right_buttons == 0) right_buttons = total_buttons/2;
1068 left_buttons = total_buttons - right_buttons;
1070 gtk_window_set_title (GTK_WINDOW (wdialog), title);
1071 gtk_widget_set_name (wdialog, "emacs-dialog");
1073 cur_box = GTK_BOX (GTK_DIALOG (wdialog)->action_area);
1075 if (make_two_rows)
1077 wvbox = gtk_vbox_new (TRUE, button_spacing);
1078 whbox_up = gtk_hbox_new (FALSE, 0);
1079 whbox_down = gtk_hbox_new (FALSE, 0);
1081 gtk_box_pack_start (cur_box, wvbox, FALSE, FALSE, 0);
1082 gtk_box_pack_start (GTK_BOX (wvbox), whbox_up, FALSE, FALSE, 0);
1083 gtk_box_pack_start (GTK_BOX (wvbox), whbox_down, FALSE, FALSE, 0);
1085 cur_box = GTK_BOX (whbox_up);
1088 g_signal_connect (G_OBJECT (wdialog), "delete-event",
1089 G_CALLBACK (dialog_delete_callback), 0);
1091 if (deactivate_cb)
1093 g_signal_connect (G_OBJECT (wdialog), "close", deactivate_cb, 0);
1094 g_signal_connect (G_OBJECT (wdialog), "response", deactivate_cb, 0);
1097 for (item = wv->contents; item; item = item->next)
1099 char *utf8_label = get_utf8_string (item->value);
1100 GtkWidget *w;
1101 GtkRequisition req;
1103 if (item->name && strcmp (item->name, "message") == 0)
1105 /* This is the text part of the dialog. */
1106 w = gtk_label_new (utf8_label);
1107 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (wdialog)->vbox),
1108 gtk_label_new (""),
1109 FALSE, FALSE, 0);
1110 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (wdialog)->vbox), w,
1111 TRUE, TRUE, 0);
1112 gtk_misc_set_alignment (GTK_MISC (w), 0.1, 0.5);
1114 /* Try to make dialog look better. Must realize first so
1115 the widget can calculate the size it needs. */
1116 gtk_widget_realize (w);
1117 gtk_widget_size_request (w, &req);
1118 gtk_box_set_spacing (GTK_BOX (GTK_DIALOG (wdialog)->vbox),
1119 req.height);
1120 if (item->value && strlen (item->value) > 0)
1121 button_spacing = 2*req.width/strlen (item->value);
1123 else
1125 /* This is one button to add to the dialog. */
1126 w = gtk_button_new_with_label (utf8_label);
1127 if (! item->enabled)
1128 gtk_widget_set_sensitive (w, FALSE);
1129 if (select_cb)
1130 g_signal_connect (G_OBJECT (w), "clicked",
1131 select_cb, item->call_data);
1133 gtk_box_pack_start (cur_box, w, TRUE, TRUE, button_spacing);
1134 if (++button_nr == left_buttons)
1136 if (make_two_rows)
1137 cur_box = GTK_BOX (whbox_down);
1138 else
1139 gtk_box_pack_start (cur_box,
1140 gtk_label_new (""),
1141 TRUE, TRUE,
1142 button_spacing);
1146 if (utf8_label && utf8_label != item->value)
1147 g_free (utf8_label);
1150 return wdialog;
1155 /***********************************************************************
1156 File dialog functions
1157 ***********************************************************************/
1158 /* Return non-zero if the old file selection dialog is being used.
1159 Return zero if not. */
1162 xg_uses_old_file_dialog ()
1164 #ifdef HAVE_GTK_FILE_BOTH
1165 extern int x_use_old_gtk_file_dialog;
1166 return x_use_old_gtk_file_dialog;
1167 #else /* ! HAVE_GTK_FILE_BOTH */
1169 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1170 return 1;
1171 #else
1172 return 0;
1173 #endif
1175 #endif /* ! HAVE_GTK_FILE_BOTH */
1179 /* Function that is called when the file dialog pops down.
1180 W is the dialog widget, RESPONSE is the response code.
1181 USER_DATA is what we passed in to g_signal_connect (pointer to int). */
1183 static void
1184 xg_file_response_cb (w,
1185 response,
1186 user_data)
1187 GtkDialog *w;
1188 gint response;
1189 gpointer user_data;
1191 int *ptr = (int *) user_data;
1192 *ptr = response;
1196 /* Destroy the dialog. This makes it pop down. */
1198 static Lisp_Object
1199 pop_down_file_dialog (arg)
1200 Lisp_Object arg;
1202 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1203 BLOCK_INPUT;
1204 gtk_widget_destroy (GTK_WIDGET (p->pointer));
1205 UNBLOCK_INPUT;
1206 return Qnil;
1209 typedef char * (*xg_get_file_func) P_ ((GtkWidget *));
1211 #ifdef HAVE_GTK_FILE_CHOOSER_DIALOG_NEW
1213 /* Return the selected file for file chooser dialog W.
1214 The returned string must be free:d. */
1216 static char *
1217 xg_get_file_name_from_chooser (w)
1218 GtkWidget *w;
1220 return gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (w));
1223 /* Callback called when the "Show hidden files" toggle is pressed.
1224 WIDGET is the toggle widget, DATA is the file chooser dialog. */
1226 static void
1227 xg_toggle_visibility_cb (widget, data)
1228 GtkWidget *widget;
1229 gpointer data;
1231 GtkFileChooser *dialog = GTK_FILE_CHOOSER (data);
1232 gboolean visible;
1233 g_object_get (G_OBJECT (dialog), "show-hidden", &visible, NULL);
1234 g_object_set (G_OBJECT (dialog), "show-hidden", !visible, NULL);
1238 /* Callback called when a property changes in a file chooser.
1239 GOBJECT is the file chooser dialog, ARG1 describes the property.
1240 USER_DATA is the toggle widget in the file chooser dialog.
1241 We use this to update the "Show hidden files" toggle when the user
1242 changes that property by right clicking in the file list. */
1244 static void
1245 xg_toggle_notify_cb (gobject, arg1, user_data)
1246 GObject *gobject;
1247 GParamSpec *arg1;
1248 gpointer user_data;
1250 extern int x_gtk_show_hidden_files;
1252 if (strcmp (arg1->name, "show-hidden") == 0)
1254 GtkFileChooser *dialog = GTK_FILE_CHOOSER (gobject);
1255 GtkWidget *wtoggle = GTK_WIDGET (user_data);
1256 gboolean visible, toggle_on;
1258 g_object_get (G_OBJECT (gobject), "show-hidden", &visible, NULL);
1259 toggle_on = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (wtoggle));
1261 if (!!visible != !!toggle_on)
1263 g_signal_handlers_block_by_func (G_OBJECT (wtoggle),
1264 G_CALLBACK (xg_toggle_visibility_cb),
1265 gobject);
1266 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), visible);
1267 g_signal_handlers_unblock_by_func
1268 (G_OBJECT (wtoggle),
1269 G_CALLBACK (xg_toggle_visibility_cb),
1270 gobject);
1272 x_gtk_show_hidden_files = visible;
1276 /* Read a file name from the user using a file chooser dialog.
1277 F is the current frame.
1278 PROMPT is a prompt to show to the user. May not be NULL.
1279 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1280 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1281 file. *FUNC is set to a function that can be used to retrieve the
1282 selected file name from the returned widget.
1284 Returns the created widget. */
1286 static GtkWidget *
1287 xg_get_file_with_chooser (f, prompt, default_filename,
1288 mustmatch_p, only_dir_p, func)
1289 FRAME_PTR f;
1290 char *prompt;
1291 char *default_filename;
1292 int mustmatch_p, only_dir_p;
1293 xg_get_file_func *func;
1295 char message[1024];
1297 GtkWidget *filewin, *wtoggle, *wbox, *wmessage;
1298 GtkWindow *gwin = GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f));
1299 GtkFileChooserAction action = (mustmatch_p ?
1300 GTK_FILE_CHOOSER_ACTION_OPEN :
1301 GTK_FILE_CHOOSER_ACTION_SAVE);
1302 extern int x_gtk_show_hidden_files;
1304 if (only_dir_p)
1305 action = GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER;
1307 filewin = gtk_file_chooser_dialog_new (prompt, gwin, action,
1308 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1309 (mustmatch_p || only_dir_p ?
1310 GTK_STOCK_OPEN : GTK_STOCK_OK),
1311 GTK_RESPONSE_OK,
1312 NULL);
1313 gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (filewin), TRUE);
1315 wbox = gtk_vbox_new (FALSE, 0);
1316 gtk_widget_show (wbox);
1317 wtoggle = gtk_check_button_new_with_label ("Show hidden files.");
1319 if (x_gtk_show_hidden_files)
1321 g_object_set (G_OBJECT (filewin), "show-hidden", TRUE, NULL);
1322 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (wtoggle), TRUE);
1324 gtk_widget_show (wtoggle);
1325 g_signal_connect (G_OBJECT (wtoggle), "clicked",
1326 G_CALLBACK (xg_toggle_visibility_cb), filewin);
1327 g_signal_connect (G_OBJECT (filewin), "notify",
1328 G_CALLBACK (xg_toggle_notify_cb), wtoggle);
1330 message[0] = '\0';
1331 if (action != GTK_FILE_CHOOSER_ACTION_SAVE)
1332 strcat (message, "\nType C-l to display a file name text entry box.\n");
1333 strcat (message, "\nIf you don't like this file selector, customize "
1334 "use-file-dialog\nto turn it off, or type C-x C-f to visit files.");
1336 wmessage = gtk_label_new (message);
1337 gtk_widget_show (wmessage);
1338 gtk_box_pack_start (GTK_BOX (wbox), wtoggle, FALSE, FALSE, 0);
1339 gtk_box_pack_start (GTK_BOX (wbox), wmessage, FALSE, FALSE, 0);
1340 gtk_file_chooser_set_extra_widget (GTK_FILE_CHOOSER (filewin), wbox);
1342 if (default_filename)
1344 Lisp_Object file;
1345 struct gcpro gcpro1;
1346 GCPRO1 (file);
1348 file = build_string (default_filename);
1350 /* File chooser does not understand ~/... in the file name. It must be
1351 an absolute name starting with /. */
1352 if (default_filename[0] != '/')
1353 file = Fexpand_file_name (file, Qnil);
1355 default_filename = SSDATA (file);
1356 if (Ffile_directory_p (file))
1357 gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (filewin),
1358 default_filename);
1359 else
1360 gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (filewin),
1361 default_filename);
1363 UNGCPRO;
1366 *func = xg_get_file_name_from_chooser;
1367 return filewin;
1369 #endif /* HAVE_GTK_FILE_CHOOSER_DIALOG_NEW */
1371 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1373 /* Return the selected file for file selector dialog W.
1374 The returned string must be free:d. */
1376 static char *
1377 xg_get_file_name_from_selector (w)
1378 GtkWidget *w;
1380 GtkFileSelection *filesel = GTK_FILE_SELECTION (w);
1381 return xstrdup ((char*) gtk_file_selection_get_filename (filesel));
1384 /* Create a file selection dialog.
1385 F is the current frame.
1386 PROMPT is a prompt to show to the user. May not be NULL.
1387 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1388 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1389 file. *FUNC is set to a function that can be used to retrieve the
1390 selected file name from the returned widget.
1392 Returns the created widget. */
1394 static GtkWidget *
1395 xg_get_file_with_selection (f, prompt, default_filename,
1396 mustmatch_p, only_dir_p, func)
1397 FRAME_PTR f;
1398 char *prompt;
1399 char *default_filename;
1400 int mustmatch_p, only_dir_p;
1401 xg_get_file_func *func;
1403 GtkWidget *filewin;
1404 GtkFileSelection *filesel;
1406 filewin = gtk_file_selection_new (prompt);
1407 filesel = GTK_FILE_SELECTION (filewin);
1409 if (default_filename)
1410 gtk_file_selection_set_filename (filesel, default_filename);
1412 if (mustmatch_p)
1414 /* The selection_entry part of filesel is not documented. */
1415 gtk_widget_set_sensitive (filesel->selection_entry, FALSE);
1416 gtk_file_selection_hide_fileop_buttons (filesel);
1419 *func = xg_get_file_name_from_selector;
1421 return filewin;
1423 #endif /* HAVE_GTK_FILE_SELECTION_NEW */
1425 /* Read a file name from the user using a file dialog, either the old
1426 file selection dialog, or the new file chooser dialog. Which to use
1427 depends on what the GTK version used has, and what the value of
1428 gtk-use-old-file-dialog.
1429 F is the current frame.
1430 PROMPT is a prompt to show to the user. May not be NULL.
1431 DEFAULT_FILENAME is a default selection to be displayed. May be NULL.
1432 If MUSTMATCH_P is non-zero, the returned file name must be an existing
1433 file.
1435 Returns a file name or NULL if no file was selected.
1436 The returned string must be freed by the caller. */
1438 char *
1439 xg_get_file_name (f, prompt, default_filename, mustmatch_p, only_dir_p)
1440 FRAME_PTR f;
1441 char *prompt;
1442 char *default_filename;
1443 int mustmatch_p, only_dir_p;
1445 GtkWidget *w = 0;
1446 int count = SPECPDL_INDEX ();
1447 char *fn = 0;
1448 int filesel_done = 0;
1449 xg_get_file_func func;
1451 #if defined (HAVE_GTK_AND_PTHREAD) && defined (__SIGRTMIN)
1452 /* I really don't know why this is needed, but without this the GLIBC add on
1453 library linuxthreads hangs when the Gnome file chooser backend creates
1454 threads. */
1455 sigblock (sigmask (__SIGRTMIN));
1456 #endif /* HAVE_GTK_AND_PTHREAD */
1458 #ifdef HAVE_GTK_FILE_BOTH
1460 if (xg_uses_old_file_dialog ())
1461 w = xg_get_file_with_selection (f, prompt, default_filename,
1462 mustmatch_p, only_dir_p, &func);
1463 else
1464 w = xg_get_file_with_chooser (f, prompt, default_filename,
1465 mustmatch_p, only_dir_p, &func);
1467 #else /* not HAVE_GTK_FILE_BOTH */
1469 #ifdef HAVE_GTK_FILE_SELECTION_NEW
1470 w = xg_get_file_with_selection (f, prompt, default_filename,
1471 mustmatch_p, only_dir_p, &func);
1472 #endif
1473 #ifdef HAVE_GTK_FILE_CHOOSER_DIALOG_NEW
1474 w = xg_get_file_with_chooser (f, prompt, default_filename,
1475 mustmatch_p, only_dir_p, &func);
1476 #endif
1478 #endif /* HAVE_GTK_FILE_BOTH */
1480 xg_set_screen (w, f);
1481 gtk_widget_set_name (w, "emacs-filedialog");
1482 gtk_window_set_transient_for (GTK_WINDOW (w),
1483 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
1484 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
1485 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
1487 g_signal_connect (G_OBJECT (w),
1488 "response",
1489 G_CALLBACK (xg_file_response_cb),
1490 &filesel_done);
1492 /* Don't destroy the widget if closed by the window manager close button. */
1493 g_signal_connect (G_OBJECT (w), "delete-event", G_CALLBACK (gtk_true), NULL);
1495 gtk_widget_show (w);
1497 record_unwind_protect (pop_down_file_dialog, make_save_value (w, 0));
1498 while (! filesel_done)
1500 x_menu_wait_for_event (0);
1501 gtk_main_iteration ();
1504 #if defined (HAVE_GTK_AND_PTHREAD) && defined (__SIGRTMIN)
1505 sigunblock (sigmask (__SIGRTMIN));
1506 #endif
1508 if (filesel_done == GTK_RESPONSE_OK)
1509 fn = (*func) (w);
1511 unbind_to (count, Qnil);
1513 return fn;
1517 /***********************************************************************
1518 Menu functions.
1519 ***********************************************************************/
1521 /* The name of menu items that can be used for citomization. Since GTK
1522 RC files are very crude and primitive, we have to set this on all
1523 menu item names so a user can easily cutomize menu items. */
1525 #define MENU_ITEM_NAME "emacs-menuitem"
1528 /* Linked list of all allocated struct xg_menu_cb_data. Used for marking
1529 during GC. The next member points to the items. */
1530 static xg_list_node xg_menu_cb_list;
1532 /* Linked list of all allocated struct xg_menu_item_cb_data. Used for marking
1533 during GC. The next member points to the items. */
1534 static xg_list_node xg_menu_item_cb_list;
1536 /* Allocate and initialize CL_DATA if NULL, otherwise increase ref_count.
1537 F is the frame CL_DATA will be initialized for.
1538 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1540 The menu bar and all sub menus under the menu bar in a frame
1541 share the same structure, hence the reference count.
1543 Returns CL_DATA if CL_DATA is not NULL, or a pointer to a newly
1544 allocated xg_menu_cb_data if CL_DATA is NULL. */
1546 static xg_menu_cb_data *
1547 make_cl_data (cl_data, f, highlight_cb)
1548 xg_menu_cb_data *cl_data;
1549 FRAME_PTR f;
1550 GCallback highlight_cb;
1552 if (! cl_data)
1554 cl_data = (xg_menu_cb_data*) xmalloc (sizeof (*cl_data));
1555 cl_data->f = f;
1556 cl_data->menu_bar_vector = f->menu_bar_vector;
1557 cl_data->menu_bar_items_used = f->menu_bar_items_used;
1558 cl_data->highlight_cb = highlight_cb;
1559 cl_data->ref_count = 0;
1561 xg_list_insert (&xg_menu_cb_list, &cl_data->ptrs);
1564 cl_data->ref_count++;
1566 return cl_data;
1569 /* Update CL_DATA with values from frame F and with HIGHLIGHT_CB.
1570 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1572 When the menu bar is updated, menu items may have been added and/or
1573 removed, so menu_bar_vector and menu_bar_items_used change. We must
1574 then update CL_DATA since it is used to determine which menu
1575 item that is invoked in the menu.
1576 HIGHLIGHT_CB could change, there is no check that the same
1577 function is given when modifying a menu bar as was given when
1578 creating the menu bar. */
1580 static void
1581 update_cl_data (cl_data, f, highlight_cb)
1582 xg_menu_cb_data *cl_data;
1583 FRAME_PTR f;
1584 GCallback highlight_cb;
1586 if (cl_data)
1588 cl_data->f = f;
1589 cl_data->menu_bar_vector = f->menu_bar_vector;
1590 cl_data->menu_bar_items_used = f->menu_bar_items_used;
1591 cl_data->highlight_cb = highlight_cb;
1595 /* Decrease reference count for CL_DATA.
1596 If reference count is zero, free CL_DATA. */
1598 static void
1599 unref_cl_data (cl_data)
1600 xg_menu_cb_data *cl_data;
1602 if (cl_data && cl_data->ref_count > 0)
1604 cl_data->ref_count--;
1605 if (cl_data->ref_count == 0)
1607 xg_list_remove (&xg_menu_cb_list, &cl_data->ptrs);
1608 xfree (cl_data);
1613 /* Function that marks all lisp data during GC. */
1615 void
1616 xg_mark_data ()
1618 xg_list_node *iter;
1620 for (iter = xg_menu_cb_list.next; iter; iter = iter->next)
1621 mark_object (((xg_menu_cb_data *) iter)->menu_bar_vector);
1623 for (iter = xg_menu_item_cb_list.next; iter; iter = iter->next)
1625 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data *) iter;
1627 if (! NILP (cb_data->help))
1628 mark_object (cb_data->help);
1633 /* Callback called when a menu item is destroyed. Used to free data.
1634 W is the widget that is being destroyed (not used).
1635 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W. */
1637 static void
1638 menuitem_destroy_callback (w, client_data)
1639 GtkWidget *w;
1640 gpointer client_data;
1642 if (client_data)
1644 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
1645 xg_list_remove (&xg_menu_item_cb_list, &data->ptrs);
1646 xfree (data);
1650 /* Callback called when the pointer enters/leaves a menu item.
1651 W is the menu item.
1652 EVENT is either an enter event or leave event.
1653 CLIENT_DATA points to the xg_menu_item_cb_data associated with the W.
1655 Returns FALSE to tell GTK to keep processing this event. */
1657 static gboolean
1658 menuitem_highlight_callback (w, event, client_data)
1659 GtkWidget *w;
1660 GdkEventCrossing *event;
1661 gpointer client_data;
1663 if (client_data)
1665 xg_menu_item_cb_data *data = (xg_menu_item_cb_data*) client_data;
1666 gpointer call_data = event->type == GDK_LEAVE_NOTIFY ? 0 : client_data;
1668 if (! NILP (data->help) && data->cl_data->highlight_cb)
1670 GtkCallback func = (GtkCallback) data->cl_data->highlight_cb;
1671 (*func) (w, call_data);
1675 return FALSE;
1678 /* Callback called when a menu is destroyed. Used to free data.
1679 W is the widget that is being destroyed (not used).
1680 CLIENT_DATA points to the xg_menu_cb_data associated with W. */
1682 static void
1683 menu_destroy_callback (w, client_data)
1684 GtkWidget *w;
1685 gpointer client_data;
1687 unref_cl_data ((xg_menu_cb_data*) client_data);
1690 /* Callback called when a menu does a grab or ungrab. That means the
1691 menu has been activated or deactivated.
1692 Used to start a timer so the small timeout the menus in GTK uses before
1693 popping down a menu is seen by Emacs (see xg_process_timeouts above).
1694 W is the widget that does the grab (not used).
1695 UNGRAB_P is TRUE if this is an ungrab, FALSE if it is a grab.
1696 CLIENT_DATA is NULL (not used). */
1698 static void
1699 menu_grab_callback (GtkWidget *widget,
1700 gboolean ungrab_p,
1701 gpointer client_data)
1703 /* Keep track of total number of grabs. */
1704 static int cnt;
1706 if (ungrab_p) cnt--;
1707 else cnt++;
1709 if (cnt > 0 && ! xg_timer) xg_start_timer ();
1710 else if (cnt == 0 && xg_timer) xg_stop_timer ();
1713 /* Make a GTK widget that contains both UTF8_LABEL and UTF8_KEY (both
1714 must be non-NULL) and can be inserted into a menu item.
1716 Returns the GtkHBox. */
1718 static GtkWidget *
1719 make_widget_for_menu_item (utf8_label, utf8_key)
1720 char *utf8_label;
1721 char *utf8_key;
1723 GtkWidget *wlbl;
1724 GtkWidget *wkey;
1725 GtkWidget *wbox;
1727 wbox = gtk_hbox_new (FALSE, 0);
1728 wlbl = gtk_label_new (utf8_label);
1729 wkey = gtk_label_new (utf8_key);
1731 gtk_misc_set_alignment (GTK_MISC (wlbl), 0.0, 0.5);
1732 gtk_misc_set_alignment (GTK_MISC (wkey), 0.0, 0.5);
1734 gtk_box_pack_start (GTK_BOX (wbox), wlbl, TRUE, TRUE, 0);
1735 gtk_box_pack_start (GTK_BOX (wbox), wkey, FALSE, FALSE, 0);
1737 gtk_widget_set_name (wlbl, MENU_ITEM_NAME);
1738 gtk_widget_set_name (wkey, MENU_ITEM_NAME);
1739 gtk_widget_set_name (wbox, MENU_ITEM_NAME);
1741 return wbox;
1744 /* Make and return a menu item widget with the key to the right.
1745 UTF8_LABEL is the text for the menu item (GTK uses UTF8 internally).
1746 UTF8_KEY is the text representing the key binding.
1747 ITEM is the widget_value describing the menu item.
1749 GROUP is an in/out parameter. If the menu item to be created is not
1750 part of any radio menu group, *GROUP contains NULL on entry and exit.
1751 If the menu item to be created is part of a radio menu group, on entry
1752 *GROUP contains the group to use, or NULL if this is the first item
1753 in the group. On exit, *GROUP contains the radio item group.
1755 Unfortunately, keys don't line up as nicely as in Motif,
1756 but the MacOS X version doesn't either, so I guess that is OK. */
1758 static GtkWidget *
1759 make_menu_item (utf8_label, utf8_key, item, group)
1760 char *utf8_label;
1761 char *utf8_key;
1762 widget_value *item;
1763 GSList **group;
1765 GtkWidget *w;
1766 GtkWidget *wtoadd = 0;
1768 /* It has been observed that some menu items have a NULL name field.
1769 This will lead to this function being called with a NULL utf8_label.
1770 GTK crashes on that so we set a blank label. Why there is a NULL
1771 name remains to be investigated. */
1772 if (! utf8_label) utf8_label = " ";
1774 if (utf8_key)
1775 wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
1777 if (item->button_type == BUTTON_TYPE_TOGGLE)
1779 *group = NULL;
1780 if (utf8_key) w = gtk_check_menu_item_new ();
1781 else w = gtk_check_menu_item_new_with_label (utf8_label);
1782 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), item->selected);
1784 else if (item->button_type == BUTTON_TYPE_RADIO)
1786 if (utf8_key) w = gtk_radio_menu_item_new (*group);
1787 else w = gtk_radio_menu_item_new_with_label (*group, utf8_label);
1788 *group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (w));
1789 if (item->selected)
1790 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), TRUE);
1792 else
1794 *group = NULL;
1795 if (utf8_key) w = gtk_menu_item_new ();
1796 else w = gtk_menu_item_new_with_label (utf8_label);
1799 if (wtoadd) gtk_container_add (GTK_CONTAINER (w), wtoadd);
1800 if (! item->enabled) gtk_widget_set_sensitive (w, FALSE);
1802 return w;
1805 /* Return non-zero if LABEL specifies a separator (GTK only has one
1806 separator type) */
1808 static int
1809 xg_separator_p (char *label)
1811 if (! label) return 0;
1812 else if (strlen (label) > 3
1813 && strncmp (label, "--", 2) == 0
1814 && label[2] != '-')
1816 static char* separator_names[] = {
1817 "space",
1818 "no-line",
1819 "single-line",
1820 "double-line",
1821 "single-dashed-line",
1822 "double-dashed-line",
1823 "shadow-etched-in",
1824 "shadow-etched-out",
1825 "shadow-etched-in-dash",
1826 "shadow-etched-out-dash",
1827 "shadow-double-etched-in",
1828 "shadow-double-etched-out",
1829 "shadow-double-etched-in-dash",
1830 "shadow-double-etched-out-dash",
1834 int i;
1836 label += 2;
1837 for (i = 0; separator_names[i]; ++i)
1838 if (strcmp (label, separator_names[i]) == 0)
1839 return 1;
1841 else
1843 /* Old-style separator, maybe. It's a separator if it contains
1844 only dashes. */
1845 while (*label == '-')
1846 ++label;
1847 if (*label == 0) return 1;
1850 return 0;
1853 static int xg_detached_menus;
1855 /* Returns non-zero if there are detached menus. */
1858 xg_have_tear_offs ()
1860 return xg_detached_menus > 0;
1863 /* Callback invoked when a detached menu window is removed. Here we
1864 decrease the xg_detached_menus count.
1865 WIDGET is the top level window that is removed (the parent of the menu).
1866 CLIENT_DATA is not used. */
1868 static void
1869 tearoff_remove (widget, client_data)
1870 GtkWidget *widget;
1871 gpointer client_data;
1873 if (xg_detached_menus > 0) --xg_detached_menus;
1876 /* Callback invoked when a menu is detached. It increases the
1877 xg_detached_menus count.
1878 WIDGET is the GtkTearoffMenuItem.
1879 CLIENT_DATA is not used. */
1881 static void
1882 tearoff_activate (widget, client_data)
1883 GtkWidget *widget;
1884 gpointer client_data;
1886 GtkWidget *menu = gtk_widget_get_parent (widget);
1887 if (gtk_menu_get_tearoff_state (GTK_MENU (menu)))
1889 ++xg_detached_menus;
1890 g_signal_connect (G_OBJECT (gtk_widget_get_toplevel (widget)),
1891 "destroy",
1892 G_CALLBACK (tearoff_remove), 0);
1897 /* Create a menu item widget, and connect the callbacks.
1898 ITEM decribes the menu item.
1899 F is the frame the created menu belongs to.
1900 SELECT_CB is the callback to use when a menu item is selected.
1901 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1902 CL_DATA points to the callback data to be used for this menu.
1903 GROUP is an in/out parameter. If the menu item to be created is not
1904 part of any radio menu group, *GROUP contains NULL on entry and exit.
1905 If the menu item to be created is part of a radio menu group, on entry
1906 *GROUP contains the group to use, or NULL if this is the first item
1907 in the group. On exit, *GROUP contains the radio item group.
1909 Returns the created GtkWidget. */
1911 static GtkWidget *
1912 xg_create_one_menuitem (item, f, select_cb, highlight_cb, cl_data, group)
1913 widget_value *item;
1914 FRAME_PTR f;
1915 GCallback select_cb;
1916 GCallback highlight_cb;
1917 xg_menu_cb_data *cl_data;
1918 GSList **group;
1920 char *utf8_label;
1921 char *utf8_key;
1922 GtkWidget *w;
1923 xg_menu_item_cb_data *cb_data;
1925 utf8_label = get_utf8_string (item->name);
1926 utf8_key = get_utf8_string (item->key);
1928 w = make_menu_item (utf8_label, utf8_key, item, group);
1930 if (utf8_label && utf8_label != item->name) g_free (utf8_label);
1931 if (utf8_key && utf8_key != item->key) g_free (utf8_key);
1933 cb_data = xmalloc (sizeof (xg_menu_item_cb_data));
1935 xg_list_insert (&xg_menu_item_cb_list, &cb_data->ptrs);
1937 cb_data->unhighlight_id = cb_data->highlight_id = cb_data->select_id = 0;
1938 cb_data->help = item->help;
1939 cb_data->cl_data = cl_data;
1940 cb_data->call_data = item->call_data;
1942 g_signal_connect (G_OBJECT (w),
1943 "destroy",
1944 G_CALLBACK (menuitem_destroy_callback),
1945 cb_data);
1947 /* Put cb_data in widget, so we can get at it when modifying menubar */
1948 g_object_set_data (G_OBJECT (w), XG_ITEM_DATA, cb_data);
1950 /* final item, not a submenu */
1951 if (item->call_data && ! item->contents)
1953 if (select_cb)
1954 cb_data->select_id
1955 = g_signal_connect (G_OBJECT (w), "activate", select_cb, cb_data);
1958 if (! NILP (item->help) && highlight_cb)
1960 /* We use enter/leave notify instead of select/deselect because
1961 select/deselect doesn't go well with detached menus. */
1962 cb_data->highlight_id
1963 = g_signal_connect (G_OBJECT (w),
1964 "enter-notify-event",
1965 G_CALLBACK (menuitem_highlight_callback),
1966 cb_data);
1967 cb_data->unhighlight_id
1968 = g_signal_connect (G_OBJECT (w),
1969 "leave-notify-event",
1970 G_CALLBACK (menuitem_highlight_callback),
1971 cb_data);
1974 return w;
1977 static GtkWidget *create_menus P_ ((widget_value *, FRAME_PTR, GCallback,
1978 GCallback, GCallback, int, int, int,
1979 GtkWidget *, xg_menu_cb_data *, char *));
1981 /* Create a full menu tree specified by DATA.
1982 F is the frame the created menu belongs to.
1983 SELECT_CB is the callback to use when a menu item is selected.
1984 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
1985 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
1986 POP_UP_P is non-zero if we shall create a popup menu.
1987 MENU_BAR_P is non-zero if we shall create a menu bar.
1988 ADD_TEAROFF_P is non-zero if we shall add a teroff menu item. Ignored
1989 if MENU_BAR_P is non-zero.
1990 TOPMENU is the topmost GtkWidget that others shall be placed under.
1991 It may be NULL, in that case we create the appropriate widget
1992 (menu bar or menu item depending on POP_UP_P and MENU_BAR_P)
1993 CL_DATA is the callback data we shall use for this menu, or NULL
1994 if we haven't set the first callback yet.
1995 NAME is the name to give to the top level menu if this function
1996 creates it. May be NULL to not set any name.
1998 Returns the top level GtkWidget. This is TOPLEVEL if TOPLEVEL is
1999 not NULL.
2001 This function calls itself to create submenus. */
2003 static GtkWidget *
2004 create_menus (data, f, select_cb, deactivate_cb, highlight_cb,
2005 pop_up_p, menu_bar_p, add_tearoff_p, topmenu, cl_data, name)
2006 widget_value *data;
2007 FRAME_PTR f;
2008 GCallback select_cb;
2009 GCallback deactivate_cb;
2010 GCallback highlight_cb;
2011 int pop_up_p;
2012 int menu_bar_p;
2013 int add_tearoff_p;
2014 GtkWidget *topmenu;
2015 xg_menu_cb_data *cl_data;
2016 char *name;
2018 widget_value *item;
2019 GtkWidget *wmenu = topmenu;
2020 GSList *group = NULL;
2022 if (! topmenu)
2024 if (! menu_bar_p)
2026 wmenu = gtk_menu_new ();
2027 xg_set_screen (wmenu, f);
2029 else wmenu = gtk_menu_bar_new ();
2031 /* Put cl_data on the top menu for easier access. */
2032 cl_data = make_cl_data (cl_data, f, highlight_cb);
2033 g_object_set_data (G_OBJECT (wmenu), XG_FRAME_DATA, (gpointer)cl_data);
2034 g_signal_connect (G_OBJECT (wmenu), "destroy",
2035 G_CALLBACK (menu_destroy_callback), cl_data);
2037 if (name)
2038 gtk_widget_set_name (wmenu, name);
2040 if (deactivate_cb)
2041 g_signal_connect (G_OBJECT (wmenu),
2042 "selection-done", deactivate_cb, 0);
2044 g_signal_connect (G_OBJECT (wmenu),
2045 "grab-notify", G_CALLBACK (menu_grab_callback), 0);
2048 if (! menu_bar_p && add_tearoff_p)
2050 GtkWidget *tearoff = gtk_tearoff_menu_item_new ();
2051 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), tearoff);
2053 g_signal_connect (G_OBJECT (tearoff), "activate",
2054 G_CALLBACK (tearoff_activate), 0);
2057 for (item = data; item; item = item->next)
2059 GtkWidget *w;
2061 if (pop_up_p && !item->contents && !item->call_data
2062 && !xg_separator_p (item->name))
2064 char *utf8_label;
2065 /* A title for a popup. We do the same as GTK does when
2066 creating titles, but it does not look good. */
2067 group = NULL;
2068 utf8_label = get_utf8_string (item->name);
2070 gtk_menu_set_title (GTK_MENU (wmenu), utf8_label);
2071 w = gtk_menu_item_new_with_label (utf8_label);
2072 gtk_widget_set_sensitive (w, FALSE);
2073 if (utf8_label && utf8_label != item->name) g_free (utf8_label);
2075 else if (xg_separator_p (item->name))
2077 group = NULL;
2078 /* GTK only have one separator type. */
2079 w = gtk_separator_menu_item_new ();
2081 else
2083 w = xg_create_one_menuitem (item,
2085 item->contents ? 0 : select_cb,
2086 highlight_cb,
2087 cl_data,
2088 &group);
2090 if (item->contents)
2092 GtkWidget *submenu = create_menus (item->contents,
2094 select_cb,
2095 deactivate_cb,
2096 highlight_cb,
2099 add_tearoff_p,
2101 cl_data,
2103 gtk_menu_item_set_submenu (GTK_MENU_ITEM (w), submenu);
2107 gtk_menu_shell_append (GTK_MENU_SHELL (wmenu), w);
2108 gtk_widget_set_name (w, MENU_ITEM_NAME);
2111 return wmenu;
2114 /* Create a menubar, popup menu or dialog, depending on the TYPE argument.
2115 TYPE can be "menubar", "popup" for popup menu, or "dialog" for a dialog
2116 with some text and buttons.
2117 F is the frame the created item belongs to.
2118 NAME is the name to use for the top widget.
2119 VAL is a widget_value structure describing items to be created.
2120 SELECT_CB is the callback to use when a menu item is selected or
2121 a dialog button is pressed.
2122 DEACTIVATE_CB is the callback to use when an item is deactivated.
2123 For a menu, when a sub menu is not shown anymore, for a dialog it is
2124 called when the dialog is popped down.
2125 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2127 Returns the widget created. */
2129 GtkWidget *
2130 xg_create_widget (type, name, f, val,
2131 select_cb, deactivate_cb, highlight_cb)
2132 char *type;
2133 char *name;
2134 FRAME_PTR f;
2135 widget_value *val;
2136 GCallback select_cb;
2137 GCallback deactivate_cb;
2138 GCallback highlight_cb;
2140 GtkWidget *w = 0;
2141 int menu_bar_p = strcmp (type, "menubar") == 0;
2142 int pop_up_p = strcmp (type, "popup") == 0;
2144 if (strcmp (type, "dialog") == 0)
2146 w = create_dialog (val, select_cb, deactivate_cb);
2147 xg_set_screen (w, f);
2148 gtk_window_set_transient_for (GTK_WINDOW (w),
2149 GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
2150 gtk_window_set_destroy_with_parent (GTK_WINDOW (w), TRUE);
2151 gtk_widget_set_name (w, "emacs-dialog");
2152 gtk_window_set_modal (GTK_WINDOW (w), TRUE);
2154 else if (menu_bar_p || pop_up_p)
2156 w = create_menus (val->contents,
2158 select_cb,
2159 deactivate_cb,
2160 highlight_cb,
2161 pop_up_p,
2162 menu_bar_p,
2163 menu_bar_p,
2166 name);
2168 /* Set the cursor to an arrow for popup menus when they are mapped.
2169 This is done by default for menu bar menus. */
2170 if (pop_up_p)
2172 /* Must realize so the GdkWindow inside the widget is created. */
2173 gtk_widget_realize (w);
2174 xg_set_cursor (w, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
2177 else
2179 fprintf (stderr, "bad type in xg_create_widget: %s, doing nothing\n",
2180 type);
2183 return w;
2186 /* Return the label for menu item WITEM. */
2188 static const char *
2189 xg_get_menu_item_label (witem)
2190 GtkMenuItem *witem;
2192 GtkLabel *wlabel = GTK_LABEL (gtk_bin_get_child (GTK_BIN (witem)));
2193 return gtk_label_get_label (wlabel);
2196 /* Return non-zero if the menu item WITEM has the text LABEL. */
2198 static int
2199 xg_item_label_same_p (witem, label)
2200 GtkMenuItem *witem;
2201 char *label;
2203 int is_same = 0;
2204 char *utf8_label = get_utf8_string (label);
2205 const char *old_label = witem ? xg_get_menu_item_label (witem) : 0;
2207 if (! old_label && ! utf8_label)
2208 is_same = 1;
2209 else if (old_label && utf8_label)
2210 is_same = strcmp (utf8_label, old_label) == 0;
2212 if (utf8_label && utf8_label != label) g_free (utf8_label);
2214 return is_same;
2217 /* Destroy widgets in LIST. */
2219 static void
2220 xg_destroy_widgets (list)
2221 GList *list;
2223 GList *iter;
2225 for (iter = list; iter; iter = g_list_next (iter))
2227 GtkWidget *w = GTK_WIDGET (iter->data);
2229 /* Destroying the widget will remove it from the container it is in. */
2230 gtk_widget_destroy (w);
2234 /* Update the top level names in MENUBAR (i.e. not submenus).
2235 F is the frame the menu bar belongs to.
2236 *LIST is a list with the current menu bar names (menu item widgets).
2237 ITER is the item within *LIST that shall be updated.
2238 POS is the numerical position, starting at 0, of ITER in *LIST.
2239 VAL describes what the menu bar shall look like after the update.
2240 SELECT_CB is the callback to use when a menu item is selected.
2241 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2242 CL_DATA points to the callback data to be used for this menu bar.
2244 This function calls itself to walk through the menu bar names. */
2246 static void
2247 xg_update_menubar (menubar, f, list, iter, pos, val,
2248 select_cb, highlight_cb, cl_data)
2249 GtkWidget *menubar;
2250 FRAME_PTR f;
2251 GList **list;
2252 GList *iter;
2253 int pos;
2254 widget_value *val;
2255 GCallback select_cb;
2256 GCallback highlight_cb;
2257 xg_menu_cb_data *cl_data;
2259 if (! iter && ! val)
2260 return;
2261 else if (iter && ! val)
2263 /* Item(s) have been removed. Remove all remaining items. */
2264 xg_destroy_widgets (iter);
2266 /* All updated. */
2267 val = 0;
2268 iter = 0;
2270 else if (! iter && val)
2272 /* Item(s) added. Add all new items in one call. */
2273 create_menus (val, f, select_cb, 0, highlight_cb,
2274 0, 1, 0, menubar, cl_data, 0);
2276 /* All updated. */
2277 val = 0;
2278 iter = 0;
2280 /* Below this neither iter or val is NULL */
2281 else if (xg_item_label_same_p (GTK_MENU_ITEM (iter->data), val->name))
2283 /* This item is still the same, check next item. */
2284 val = val->next;
2285 iter = g_list_next (iter);
2286 ++pos;
2288 else /* This item is changed. */
2290 GtkMenuItem *witem = GTK_MENU_ITEM (iter->data);
2291 GtkMenuItem *witem2 = 0;
2292 int val_in_menubar = 0;
2293 int iter_in_new_menubar = 0;
2294 GList *iter2;
2295 widget_value *cur;
2297 /* See if the changed entry (val) is present later in the menu bar */
2298 for (iter2 = iter;
2299 iter2 && ! val_in_menubar;
2300 iter2 = g_list_next (iter2))
2302 witem2 = GTK_MENU_ITEM (iter2->data);
2303 val_in_menubar = xg_item_label_same_p (witem2, val->name);
2306 /* See if the current entry (iter) is present later in the
2307 specification for the new menu bar. */
2308 for (cur = val; cur && ! iter_in_new_menubar; cur = cur->next)
2309 iter_in_new_menubar = xg_item_label_same_p (witem, cur->name);
2311 if (val_in_menubar && ! iter_in_new_menubar)
2313 int nr = pos;
2315 /* This corresponds to:
2316 Current: A B C
2317 New: A C
2318 Remove B. */
2320 gtk_widget_ref (GTK_WIDGET (witem));
2321 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem));
2322 gtk_widget_destroy (GTK_WIDGET (witem));
2324 /* Must get new list since the old changed. */
2325 g_list_free (*list);
2326 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2327 while (nr-- > 0) iter = g_list_next (iter);
2329 else if (! val_in_menubar && ! iter_in_new_menubar)
2331 /* This corresponds to:
2332 Current: A B C
2333 New: A X C
2334 Rename B to X. This might seem to be a strange thing to do,
2335 since if there is a menu under B it will be totally wrong for X.
2336 But consider editing a C file. Then there is a C-mode menu
2337 (corresponds to B above).
2338 If then doing C-x C-f the minibuf menu (X above) replaces the
2339 C-mode menu. When returning from the minibuffer, we get
2340 back the C-mode menu. Thus we do:
2341 Rename B to X (C-mode to minibuf menu)
2342 Rename X to B (minibuf to C-mode menu).
2343 If the X menu hasn't been invoked, the menu under B
2344 is up to date when leaving the minibuffer. */
2345 GtkLabel *wlabel = GTK_LABEL (gtk_bin_get_child (GTK_BIN (witem)));
2346 char *utf8_label = get_utf8_string (val->name);
2347 GtkWidget *submenu = gtk_menu_item_get_submenu (witem);
2349 gtk_label_set_text (wlabel, utf8_label);
2351 /* If this item has a submenu that has been detached, change
2352 the title in the WM decorations also. */
2353 if (submenu && gtk_menu_get_tearoff_state (GTK_MENU (submenu)))
2354 /* Set the title of the detached window. */
2355 gtk_menu_set_title (GTK_MENU (submenu), utf8_label);
2357 iter = g_list_next (iter);
2358 val = val->next;
2359 ++pos;
2361 else if (! val_in_menubar && iter_in_new_menubar)
2363 /* This corresponds to:
2364 Current: A B C
2365 New: A X B C
2366 Insert X. */
2368 int nr = pos;
2369 GList *group = 0;
2370 GtkWidget *w = xg_create_one_menuitem (val,
2372 select_cb,
2373 highlight_cb,
2374 cl_data,
2375 &group);
2377 gtk_widget_set_name (w, MENU_ITEM_NAME);
2378 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar), w, pos);
2380 g_list_free (*list);
2381 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2382 while (nr-- > 0) iter = g_list_next (iter);
2383 iter = g_list_next (iter);
2384 val = val->next;
2385 ++pos;
2387 else /* if (val_in_menubar && iter_in_new_menubar) */
2389 int nr = pos;
2390 /* This corresponds to:
2391 Current: A B C
2392 New: A C B
2393 Move C before B */
2395 gtk_widget_ref (GTK_WIDGET (witem2));
2396 gtk_container_remove (GTK_CONTAINER (menubar), GTK_WIDGET (witem2));
2397 gtk_menu_shell_insert (GTK_MENU_SHELL (menubar),
2398 GTK_WIDGET (witem2), pos);
2399 gtk_widget_unref (GTK_WIDGET (witem2));
2401 g_list_free (*list);
2402 *list = iter = gtk_container_get_children (GTK_CONTAINER (menubar));
2403 while (nr-- > 0) iter = g_list_next (iter);
2404 val = val->next;
2405 ++pos;
2409 /* Update the rest of the menu bar. */
2410 xg_update_menubar (menubar, f, list, iter, pos, val,
2411 select_cb, highlight_cb, cl_data);
2414 /* Update the menu item W so it corresponds to VAL.
2415 SELECT_CB is the callback to use when a menu item is selected.
2416 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2417 CL_DATA is the data to set in the widget for menu invokation. */
2419 static void
2420 xg_update_menu_item (val, w, select_cb, highlight_cb, cl_data)
2421 widget_value *val;
2422 GtkWidget *w;
2423 GCallback select_cb;
2424 GCallback highlight_cb;
2425 xg_menu_cb_data *cl_data;
2427 GtkWidget *wchild;
2428 GtkLabel *wlbl = 0;
2429 GtkLabel *wkey = 0;
2430 char *utf8_label;
2431 char *utf8_key;
2432 const char *old_label = 0;
2433 const char *old_key = 0;
2434 xg_menu_item_cb_data *cb_data;
2436 wchild = gtk_bin_get_child (GTK_BIN (w));
2437 utf8_label = get_utf8_string (val->name);
2438 utf8_key = get_utf8_string (val->key);
2440 /* See if W is a menu item with a key. See make_menu_item above. */
2441 if (GTK_IS_HBOX (wchild))
2443 GList *list = gtk_container_get_children (GTK_CONTAINER (wchild));
2445 wlbl = GTK_LABEL (list->data);
2446 wkey = GTK_LABEL (list->next->data);
2447 g_list_free (list);
2449 if (! utf8_key)
2451 /* Remove the key and keep just the label. */
2452 gtk_widget_ref (GTK_WIDGET (wlbl));
2453 gtk_container_remove (GTK_CONTAINER (w), wchild);
2454 gtk_container_add (GTK_CONTAINER (w), GTK_WIDGET (wlbl));
2455 wkey = 0;
2459 else /* Just a label. */
2461 wlbl = GTK_LABEL (wchild);
2463 /* Check if there is now a key. */
2464 if (utf8_key)
2466 GtkWidget *wtoadd = make_widget_for_menu_item (utf8_label, utf8_key);
2467 GList *list = gtk_container_get_children (GTK_CONTAINER (wtoadd));
2469 wlbl = GTK_LABEL (list->data);
2470 wkey = GTK_LABEL (list->next->data);
2471 g_list_free (list);
2473 gtk_container_remove (GTK_CONTAINER (w), wchild);
2474 gtk_container_add (GTK_CONTAINER (w), wtoadd);
2479 if (wkey) old_key = gtk_label_get_label (wkey);
2480 if (wlbl) old_label = gtk_label_get_label (wlbl);
2482 if (wkey && utf8_key && (! old_key || strcmp (utf8_key, old_key) != 0))
2483 gtk_label_set_text (wkey, utf8_key);
2485 if (! old_label || strcmp (utf8_label, old_label) != 0)
2486 gtk_label_set_text (wlbl, utf8_label);
2488 if (utf8_key && utf8_key != val->key) g_free (utf8_key);
2489 if (utf8_label && utf8_label != val->name) g_free (utf8_label);
2491 if (! val->enabled && GTK_WIDGET_SENSITIVE (w))
2492 gtk_widget_set_sensitive (w, FALSE);
2493 else if (val->enabled && ! GTK_WIDGET_SENSITIVE (w))
2494 gtk_widget_set_sensitive (w, TRUE);
2496 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (w),
2497 XG_ITEM_DATA);
2498 if (cb_data)
2500 cb_data->call_data = val->call_data;
2501 cb_data->help = val->help;
2502 cb_data->cl_data = cl_data;
2504 /* We assume the callback functions don't change. */
2505 if (val->call_data && ! val->contents)
2507 /* This item shall have a select callback. */
2508 if (! cb_data->select_id)
2509 cb_data->select_id
2510 = g_signal_connect (G_OBJECT (w), "activate",
2511 select_cb, cb_data);
2513 else if (cb_data->select_id)
2515 g_signal_handler_disconnect (w, cb_data->select_id);
2516 cb_data->select_id = 0;
2519 if (NILP (cb_data->help))
2521 /* Shall not have help. Remove if any existed previously. */
2522 if (cb_data->highlight_id)
2524 g_signal_handler_disconnect (G_OBJECT (w),
2525 cb_data->highlight_id);
2526 cb_data->highlight_id = 0;
2528 if (cb_data->unhighlight_id)
2530 g_signal_handler_disconnect (G_OBJECT (w),
2531 cb_data->unhighlight_id);
2532 cb_data->unhighlight_id = 0;
2535 else if (! cb_data->highlight_id && highlight_cb)
2537 /* Have help now, but didn't previously. Add callback. */
2538 cb_data->highlight_id
2539 = g_signal_connect (G_OBJECT (w),
2540 "enter-notify-event",
2541 G_CALLBACK (menuitem_highlight_callback),
2542 cb_data);
2543 cb_data->unhighlight_id
2544 = g_signal_connect (G_OBJECT (w),
2545 "leave-notify-event",
2546 G_CALLBACK (menuitem_highlight_callback),
2547 cb_data);
2552 /* Update the toggle menu item W so it corresponds to VAL. */
2554 static void
2555 xg_update_toggle_item (val, w)
2556 widget_value *val;
2557 GtkWidget *w;
2559 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
2562 /* Update the radio menu item W so it corresponds to VAL. */
2564 static void
2565 xg_update_radio_item (val, w)
2566 widget_value *val;
2567 GtkWidget *w;
2569 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (w), val->selected);
2572 /* Update the sub menu SUBMENU and all its children so it corresponds to VAL.
2573 SUBMENU may be NULL, in that case a new menu is created.
2574 F is the frame the menu bar belongs to.
2575 VAL describes the contents of the menu bar.
2576 SELECT_CB is the callback to use when a menu item is selected.
2577 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2578 HIGHLIGHT_CB is the callback to call when entering/leaving menu items.
2579 CL_DATA is the call back data to use for any newly created items.
2581 Returns the updated submenu widget, that is SUBMENU unless SUBMENU
2582 was NULL. */
2584 static GtkWidget *
2585 xg_update_submenu (submenu, f, val,
2586 select_cb, deactivate_cb, highlight_cb, cl_data)
2587 GtkWidget *submenu;
2588 FRAME_PTR f;
2589 widget_value *val;
2590 GCallback select_cb;
2591 GCallback deactivate_cb;
2592 GCallback highlight_cb;
2593 xg_menu_cb_data *cl_data;
2595 GtkWidget *newsub = submenu;
2596 GList *list = 0;
2597 GList *iter;
2598 widget_value *cur;
2599 int has_tearoff_p = 0;
2600 GList *first_radio = 0;
2602 if (submenu)
2603 list = gtk_container_get_children (GTK_CONTAINER (submenu));
2605 for (cur = val, iter = list;
2606 cur && iter;
2607 iter = g_list_next (iter), cur = cur->next)
2609 GtkWidget *w = GTK_WIDGET (iter->data);
2611 /* Skip tearoff items, they have no counterpart in val. */
2612 if (GTK_IS_TEAROFF_MENU_ITEM (w))
2614 has_tearoff_p = 1;
2615 iter = g_list_next (iter);
2616 if (iter) w = GTK_WIDGET (iter->data);
2617 else break;
2620 /* Remember first radio button in a group. If we get a mismatch in
2621 a radio group we must rebuild the whole group so that the connections
2622 in GTK becomes correct. */
2623 if (cur->button_type == BUTTON_TYPE_RADIO && ! first_radio)
2624 first_radio = iter;
2625 else if (cur->button_type != BUTTON_TYPE_RADIO
2626 && ! GTK_IS_RADIO_MENU_ITEM (w))
2627 first_radio = 0;
2629 if (GTK_IS_SEPARATOR_MENU_ITEM (w))
2631 if (! xg_separator_p (cur->name))
2632 break;
2634 else if (GTK_IS_CHECK_MENU_ITEM (w))
2636 if (cur->button_type != BUTTON_TYPE_TOGGLE)
2637 break;
2638 xg_update_toggle_item (cur, w);
2639 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
2641 else if (GTK_IS_RADIO_MENU_ITEM (w))
2643 if (cur->button_type != BUTTON_TYPE_RADIO)
2644 break;
2645 xg_update_radio_item (cur, w);
2646 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
2648 else if (GTK_IS_MENU_ITEM (w))
2650 GtkMenuItem *witem = GTK_MENU_ITEM (w);
2651 GtkWidget *sub;
2653 if (cur->button_type != BUTTON_TYPE_NONE ||
2654 xg_separator_p (cur->name))
2655 break;
2657 xg_update_menu_item (cur, w, select_cb, highlight_cb, cl_data);
2659 sub = gtk_menu_item_get_submenu (witem);
2660 if (sub && ! cur->contents)
2662 /* Not a submenu anymore. */
2663 gtk_widget_ref (sub);
2664 gtk_menu_item_remove_submenu (witem);
2665 gtk_widget_destroy (sub);
2667 else if (cur->contents)
2669 GtkWidget *nsub;
2671 nsub = xg_update_submenu (sub, f, cur->contents,
2672 select_cb, deactivate_cb,
2673 highlight_cb, cl_data);
2675 /* If this item just became a submenu, we must set it. */
2676 if (nsub != sub)
2677 gtk_menu_item_set_submenu (witem, nsub);
2680 else
2682 /* Structural difference. Remove everything from here and down
2683 in SUBMENU. */
2684 break;
2688 /* Remove widgets from first structual change. */
2689 if (iter)
2691 /* If we are adding new menu items below, we must remove from
2692 first radio button so that radio groups become correct. */
2693 if (cur && first_radio) xg_destroy_widgets (first_radio);
2694 else xg_destroy_widgets (iter);
2697 if (cur)
2699 /* More items added. Create them. */
2700 newsub = create_menus (cur,
2702 select_cb,
2703 deactivate_cb,
2704 highlight_cb,
2707 ! has_tearoff_p,
2708 submenu,
2709 cl_data,
2713 if (list) g_list_free (list);
2715 return newsub;
2718 /* Update the MENUBAR.
2719 F is the frame the menu bar belongs to.
2720 VAL describes the contents of the menu bar.
2721 If DEEP_P is non-zero, rebuild all but the top level menu names in
2722 the MENUBAR. If DEEP_P is zero, just rebuild the names in the menubar.
2723 SELECT_CB is the callback to use when a menu item is selected.
2724 DEACTIVATE_CB is the callback to use when a sub menu is not shown anymore.
2725 HIGHLIGHT_CB is the callback to call when entering/leaving menu items. */
2727 void
2728 xg_modify_menubar_widgets (menubar, f, val, deep_p,
2729 select_cb, deactivate_cb, highlight_cb)
2730 GtkWidget *menubar;
2731 FRAME_PTR f;
2732 widget_value *val;
2733 int deep_p;
2734 GCallback select_cb;
2735 GCallback deactivate_cb;
2736 GCallback highlight_cb;
2738 xg_menu_cb_data *cl_data;
2739 GList *list = gtk_container_get_children (GTK_CONTAINER (menubar));
2741 if (! list) return;
2743 cl_data = (xg_menu_cb_data*) g_object_get_data (G_OBJECT (menubar),
2744 XG_FRAME_DATA);
2746 xg_update_menubar (menubar, f, &list, list, 0, val->contents,
2747 select_cb, highlight_cb, cl_data);
2749 if (deep_p)
2751 widget_value *cur;
2753 /* Update all sub menus.
2754 We must keep the submenus (GTK menu item widgets) since the
2755 X Window in the XEvent that activates the menu are those widgets. */
2757 /* Update cl_data, menu_item things in F may have changed. */
2758 update_cl_data (cl_data, f, highlight_cb);
2760 for (cur = val->contents; cur; cur = cur->next)
2762 GList *iter;
2763 GtkWidget *sub = 0;
2764 GtkWidget *newsub;
2765 GtkMenuItem *witem;
2767 /* Find sub menu that corresponds to val and update it. */
2768 for (iter = list ; iter; iter = g_list_next (iter))
2770 witem = GTK_MENU_ITEM (iter->data);
2771 if (xg_item_label_same_p (witem, cur->name))
2773 sub = gtk_menu_item_get_submenu (witem);
2774 break;
2778 newsub = xg_update_submenu (sub,
2780 cur->contents,
2781 select_cb,
2782 deactivate_cb,
2783 highlight_cb,
2784 cl_data);
2785 /* sub may still be NULL. If we just updated non deep and added
2786 a new menu bar item, it has no sub menu yet. So we set the
2787 newly created sub menu under witem. */
2788 if (newsub != sub)
2790 xg_set_screen (newsub, f);
2791 gtk_menu_item_set_submenu (witem, newsub);
2796 g_list_free (list);
2797 gtk_widget_show_all (menubar);
2800 /* Recompute all the widgets of frame F, when the menu bar has been
2801 changed. Value is non-zero if widgets were updated. */
2804 xg_update_frame_menubar (f)
2805 FRAME_PTR f;
2807 struct x_output *x = f->output_data.x;
2808 GtkRequisition req;
2810 if (!x->menubar_widget || GTK_WIDGET_MAPPED (x->menubar_widget))
2811 return 0;
2813 BLOCK_INPUT;
2815 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->menubar_widget,
2816 FALSE, FALSE, 0);
2817 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->menubar_widget, 0);
2819 gtk_widget_show_all (x->menubar_widget);
2820 gtk_widget_size_request (x->menubar_widget, &req);
2822 FRAME_MENUBAR_HEIGHT (f) = req.height;
2824 /* The height has changed, resize outer widget and set columns
2825 rows to what we had before adding the menu bar. */
2826 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
2828 SET_FRAME_GARBAGED (f);
2829 UNBLOCK_INPUT;
2831 return 1;
2834 /* Get rid of the menu bar of frame F, and free its storage.
2835 This is used when deleting a frame, and when turning off the menu bar. */
2837 void
2838 free_frame_menubar (f)
2839 FRAME_PTR f;
2841 struct x_output *x = f->output_data.x;
2843 if (x->menubar_widget)
2845 BLOCK_INPUT;
2847 gtk_container_remove (GTK_CONTAINER (x->vbox_widget), x->menubar_widget);
2848 /* The menubar and its children shall be deleted when removed from
2849 the container. */
2850 x->menubar_widget = 0;
2851 FRAME_MENUBAR_HEIGHT (f) = 0;
2853 /* The height has changed, resize outer widget and set columns
2854 rows to what we had before removing the menu bar. */
2855 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
2857 SET_FRAME_GARBAGED (f);
2858 UNBLOCK_INPUT;
2864 /***********************************************************************
2865 Scroll bar functions
2866 ***********************************************************************/
2869 /* Setting scroll bar values invokes the callback. Use this variable
2870 to indicate that callback should do nothing. */
2872 int xg_ignore_gtk_scrollbar;
2874 /* SET_SCROLL_BAR_X_WINDOW assumes the second argument fits in
2875 32 bits. But we want to store pointers, and they may be larger
2876 than 32 bits. Keep a mapping from integer index to widget pointers
2877 to get around the 32 bit limitation. */
2879 static struct
2881 GtkWidget **widgets;
2882 int max_size;
2883 int used;
2884 } id_to_widget;
2886 /* Grow this much every time we need to allocate more */
2888 #define ID_TO_WIDGET_INCR 32
2890 /* Store the widget pointer W in id_to_widget and return the integer index. */
2892 static int
2893 xg_store_widget_in_map (w)
2894 GtkWidget *w;
2896 int i;
2898 if (id_to_widget.max_size == id_to_widget.used)
2900 int new_size = id_to_widget.max_size + ID_TO_WIDGET_INCR;
2902 id_to_widget.widgets = xrealloc (id_to_widget.widgets,
2903 sizeof (GtkWidget *)*new_size);
2905 for (i = id_to_widget.max_size; i < new_size; ++i)
2906 id_to_widget.widgets[i] = 0;
2907 id_to_widget.max_size = new_size;
2910 /* Just loop over the array and find a free place. After all,
2911 how many scroll bars are we creating? Should be a small number.
2912 The check above guarantees we will find a free place. */
2913 for (i = 0; i < id_to_widget.max_size; ++i)
2915 if (! id_to_widget.widgets[i])
2917 id_to_widget.widgets[i] = w;
2918 ++id_to_widget.used;
2920 return i;
2924 /* Should never end up here */
2925 abort ();
2928 /* Remove pointer at IDX from id_to_widget.
2929 Called when scroll bar is destroyed. */
2931 static void
2932 xg_remove_widget_from_map (idx)
2933 int idx;
2935 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
2937 id_to_widget.widgets[idx] = 0;
2938 --id_to_widget.used;
2942 /* Get the widget pointer at IDX from id_to_widget. */
2944 static GtkWidget *
2945 xg_get_widget_from_map (idx)
2946 int idx;
2948 if (idx < id_to_widget.max_size && id_to_widget.widgets[idx] != 0)
2949 return id_to_widget.widgets[idx];
2951 return 0;
2954 /* Return the scrollbar id for X Window WID on display DPY.
2955 Return -1 if WID not in id_to_widget. */
2958 xg_get_scroll_id_for_window (dpy, wid)
2959 Display *dpy;
2960 Window wid;
2962 int idx;
2963 GtkWidget *w;
2965 w = xg_win_to_widget (dpy, wid);
2967 if (w)
2969 for (idx = 0; idx < id_to_widget.max_size; ++idx)
2970 if (id_to_widget.widgets[idx] == w)
2971 return idx;
2974 return -1;
2977 /* Callback invoked when scroll bar WIDGET is destroyed.
2978 DATA is the index into id_to_widget for WIDGET.
2979 We free pointer to last scroll bar values here and remove the index. */
2981 static void
2982 xg_gtk_scroll_destroy (widget, data)
2983 GtkWidget *widget;
2984 gpointer data;
2986 gpointer p;
2987 int id = (int) (EMACS_INT) data; /* The EMACS_INT cast avoids a warning. */
2989 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
2990 if (p) xfree (p);
2991 xg_remove_widget_from_map (id);
2994 /* Callback for button press/release events. Used to start timer so that
2995 the scroll bar repetition timer in GTK gets handeled.
2996 Also, sets bar->dragging to Qnil when dragging (button release) is done.
2997 WIDGET is the scroll bar widget the event is for (not used).
2998 EVENT contains the event.
2999 USER_DATA points to the struct scrollbar structure.
3001 Returns FALSE to tell GTK that it shall continue propagate the event
3002 to widgets. */
3004 static gboolean
3005 scroll_bar_button_cb (widget, event, user_data)
3006 GtkWidget *widget;
3007 GdkEventButton *event;
3008 gpointer user_data;
3010 if (event->type == GDK_BUTTON_PRESS && ! xg_timer)
3011 xg_start_timer ();
3012 else if (event->type == GDK_BUTTON_RELEASE)
3014 struct scroll_bar *bar = (struct scroll_bar *) user_data;
3015 if (xg_timer) xg_stop_timer ();
3016 bar->dragging = Qnil;
3019 return FALSE;
3022 /* Create a scroll bar widget for frame F. Store the scroll bar
3023 in BAR.
3024 SCROLL_CALLBACK is the callback to invoke when the value of the
3025 bar changes.
3026 SCROLL_BAR_NAME is the name we use for the scroll bar. Can be used
3027 to set resources for the widget. */
3029 void
3030 xg_create_scroll_bar (f, bar, scroll_callback, scroll_bar_name)
3031 FRAME_PTR f;
3032 struct scroll_bar *bar;
3033 GCallback scroll_callback;
3034 char *scroll_bar_name;
3036 GtkWidget *wscroll;
3037 GtkWidget *webox;
3038 GtkObject *vadj;
3039 int scroll_id;
3041 /* Page, step increment values are not so important here, they
3042 will be corrected in x_set_toolkit_scroll_bar_thumb. */
3043 vadj = gtk_adjustment_new (XG_SB_MIN, XG_SB_MIN, XG_SB_MAX,
3044 0.1, 0.1, 0.1);
3046 wscroll = gtk_vscrollbar_new (GTK_ADJUSTMENT (vadj));
3047 webox = gtk_event_box_new ();
3048 gtk_widget_set_name (wscroll, scroll_bar_name);
3049 gtk_range_set_update_policy (GTK_RANGE (wscroll), GTK_UPDATE_CONTINUOUS);
3051 scroll_id = xg_store_widget_in_map (wscroll);
3053 g_signal_connect (G_OBJECT (wscroll),
3054 "value-changed",
3055 scroll_callback,
3056 (gpointer) bar);
3057 /* The EMACS_INT cast avoids a warning. */
3058 g_signal_connect (G_OBJECT (wscroll),
3059 "destroy",
3060 G_CALLBACK (xg_gtk_scroll_destroy),
3061 (gpointer) (EMACS_INT) scroll_id);
3063 /* Connect to button press and button release to detect if any scroll bar
3064 has the pointer. */
3065 g_signal_connect (G_OBJECT (wscroll),
3066 "button-press-event",
3067 G_CALLBACK (scroll_bar_button_cb),
3068 (gpointer) bar);
3069 g_signal_connect (G_OBJECT (wscroll),
3070 "button-release-event",
3071 G_CALLBACK (scroll_bar_button_cb),
3072 (gpointer) bar);
3074 /* The scroll bar widget does not draw on a window of its own. Instead
3075 it draws on the parent window, in this case the edit widget. So
3076 whenever the edit widget is cleared, the scroll bar needs to redraw
3077 also, which causes flicker. Put an event box between the edit widget
3078 and the scroll bar, so the scroll bar instead draws itself on the
3079 event box window. */
3080 gtk_fixed_put (GTK_FIXED (f->output_data.x->edit_widget), webox, -1, -1);
3081 gtk_container_add (GTK_CONTAINER (webox), wscroll);
3084 /* Set the cursor to an arrow. */
3085 xg_set_cursor (webox, FRAME_X_DISPLAY_INFO (f)->xg_cursor);
3087 SET_SCROLL_BAR_X_WINDOW (bar, scroll_id);
3090 /* Make the scroll bar represented by SCROLLBAR_ID visible. */
3092 void
3093 xg_show_scroll_bar (scrollbar_id)
3094 int scrollbar_id;
3096 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3097 if (w)
3098 gtk_widget_show_all (gtk_widget_get_parent (w));
3101 /* Remove the scroll bar represented by SCROLLBAR_ID from the frame F. */
3103 void
3104 xg_remove_scroll_bar (f, scrollbar_id)
3105 FRAME_PTR f;
3106 int scrollbar_id;
3108 GtkWidget *w = xg_get_widget_from_map (scrollbar_id);
3109 if (w)
3111 GtkWidget *wparent = gtk_widget_get_parent (w);
3112 gtk_widget_destroy (w);
3113 gtk_widget_destroy (wparent);
3114 SET_FRAME_GARBAGED (f);
3118 /* Update the position of the vertical scroll bar represented by SCROLLBAR_ID
3119 in frame F.
3120 TOP/LEFT are the new pixel positions where the bar shall appear.
3121 WIDTH, HEIGHT is the size in pixels the bar shall have. */
3123 void
3124 xg_update_scrollbar_pos (f, scrollbar_id, top, left, width, height)
3125 FRAME_PTR f;
3126 int scrollbar_id;
3127 int top;
3128 int left;
3129 int width;
3130 int height;
3133 GtkWidget *wscroll = xg_get_widget_from_map (scrollbar_id);
3135 if (wscroll)
3137 GtkWidget *wfixed = f->output_data.x->edit_widget;
3138 GtkWidget *wparent = gtk_widget_get_parent (wscroll);
3140 /* Move and resize to new values. */
3141 gtk_fixed_move (GTK_FIXED (wfixed), wparent, left, top);
3142 gtk_widget_set_size_request (wscroll, width, height);
3143 gtk_widget_queue_draw (wparent);
3144 gdk_window_process_all_updates ();
3145 /* GTK does not redraw until the main loop is entered again, but
3146 if there are no X events pending we will not enter it. So we sync
3147 here to get some events. */
3148 x_sync (f);
3149 SET_FRAME_GARBAGED (f);
3150 cancel_mouse_face (f);
3154 /* Set the thumb size and position of scroll bar BAR. We are currently
3155 displaying PORTION out of a whole WHOLE, and our position POSITION. */
3157 void
3158 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
3159 struct scroll_bar *bar;
3160 int portion, position, whole;
3162 GtkWidget *wscroll = xg_get_widget_from_map (SCROLL_BAR_X_WINDOW (bar));
3164 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3166 if (wscroll && NILP (bar->dragging))
3168 GtkAdjustment *adj;
3169 gdouble shown;
3170 gdouble top;
3171 int size, value;
3172 int new_step;
3173 int changed = 0;
3175 adj = gtk_range_get_adjustment (GTK_RANGE (wscroll));
3177 /* We do the same as for MOTIF in xterm.c, assume 30 chars per line
3178 rather than the real portion value. This makes the thumb less likely
3179 to resize and that looks better. */
3180 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
3181 /* When the thumb is at the bottom, position == whole.
3182 So we need to increase `whole' to make space for the thumb. */
3183 whole += portion;
3185 if (whole <= 0)
3186 top = 0, shown = 1;
3187 else
3189 top = (gdouble) position / whole;
3190 shown = (gdouble) portion / whole;
3193 size = shown * XG_SB_RANGE;
3194 size = min (size, XG_SB_RANGE);
3195 size = max (size, 1);
3197 value = top * XG_SB_RANGE;
3198 value = min (value, XG_SB_MAX - size);
3199 value = max (value, XG_SB_MIN);
3201 /* Assume all lines are of equal size. */
3202 new_step = size / max (1, FRAME_LINES (f));
3204 if ((int) adj->page_size != size
3205 || (int) adj->step_increment != new_step)
3207 adj->page_size = size;
3208 adj->step_increment = new_step;
3209 /* Assume a page increment is about 95% of the page size */
3210 adj->page_increment = (int) (0.95*adj->page_size);
3211 changed = 1;
3214 if (changed || (int) gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3216 GtkWidget *wfixed = f->output_data.x->edit_widget;
3218 BLOCK_INPUT;
3220 /* gtk_range_set_value invokes the callback. Set
3221 ignore_gtk_scrollbar to make the callback do nothing */
3222 xg_ignore_gtk_scrollbar = 1;
3224 if ((int) gtk_range_get_value (GTK_RANGE (wscroll)) != value)
3225 gtk_range_set_value (GTK_RANGE (wscroll), (gdouble)value);
3226 else if (changed)
3227 gtk_adjustment_changed (adj);
3229 xg_ignore_gtk_scrollbar = 0;
3231 UNBLOCK_INPUT;
3237 /***********************************************************************
3238 Tool bar functions
3239 ***********************************************************************/
3240 /* The key for the data we put in the GtkImage widgets. The data is
3241 the image used by Emacs. We use this to see if we need to update
3242 the GtkImage with a new image. */
3243 #define XG_TOOL_BAR_IMAGE_DATA "emacs-tool-bar-image"
3245 /* Callback function invoked when a tool bar item is pressed.
3246 W is the button widget in the tool bar that got pressed,
3247 CLIENT_DATA is an integer that is the index of the button in the
3248 tool bar. 0 is the first button. */
3250 static void
3251 xg_tool_bar_callback (w, client_data)
3252 GtkWidget *w;
3253 gpointer client_data;
3255 /* The EMACS_INT cast avoids a warning. */
3256 int idx = (int) (EMACS_INT) client_data;
3257 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3258 Lisp_Object key, frame;
3259 struct input_event event;
3260 EVENT_INIT (event);
3262 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3263 return;
3265 idx *= TOOL_BAR_ITEM_NSLOTS;
3267 key = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_KEY);
3268 XSETFRAME (frame, f);
3269 event.kind = TOOL_BAR_EVENT;
3270 event.frame_or_window = frame;
3271 event.arg = frame;
3272 kbd_buffer_store_event (&event);
3274 event.kind = TOOL_BAR_EVENT;
3275 event.frame_or_window = frame;
3276 event.arg = key;
3277 event.modifiers = 0; /* These are not available. */
3278 kbd_buffer_store_event (&event);
3281 /* This callback is called when a tool bar is detached. We must set
3282 the height of the tool bar to zero when this happens so frame sizes
3283 are correctly calculated.
3284 WBOX is the handle box widget that enables detach/attach of the tool bar.
3285 W is the tool bar widget.
3286 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
3288 static void
3289 xg_tool_bar_detach_callback (wbox, w, client_data)
3290 GtkHandleBox *wbox;
3291 GtkWidget *w;
3292 gpointer client_data;
3294 FRAME_PTR f = (FRAME_PTR) client_data;
3296 if (f)
3298 FRAME_X_OUTPUT (f)->toolbar_detached = 1;
3300 /* When detaching a tool bar, not everything dissapear. There are
3301 a few pixels left that are used to drop the tool bar back into
3302 place. */
3303 FRAME_TOOLBAR_HEIGHT (f) = 2;
3305 /* The height has changed, resize outer widget and set columns
3306 rows to what we had before detaching the tool bar. */
3307 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
3311 /* This callback is called when a tool bar is reattached. We must set
3312 the height of the tool bar when this happens so frame sizes
3313 are correctly calculated.
3314 WBOX is the handle box widget that enables detach/attach of the tool bar.
3315 W is the tool bar widget.
3316 CLIENT_DATA is a pointer to the frame the tool bar belongs to. */
3318 static void
3319 xg_tool_bar_attach_callback (wbox, w, client_data)
3320 GtkHandleBox *wbox;
3321 GtkWidget *w;
3322 gpointer client_data;
3324 FRAME_PTR f = (FRAME_PTR) client_data;
3326 if (f)
3328 GtkRequisition req;
3330 FRAME_X_OUTPUT (f)->toolbar_detached = 0;
3332 gtk_widget_size_request (w, &req);
3333 FRAME_TOOLBAR_HEIGHT (f) = req.height;
3335 /* The height has changed, resize outer widget and set columns
3336 rows to what we had before attaching the tool bar. */
3337 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
3341 /* This callback is called when the mouse enters or leaves a tool bar item.
3342 It is used for displaying and hiding the help text.
3343 W is the tool bar item, a button.
3344 EVENT is either an enter event or leave event.
3345 CLIENT_DATA is an integer that is the index of the button in the
3346 tool bar. 0 is the first button.
3348 Returns FALSE to tell GTK to keep processing this event. */
3350 static gboolean
3351 xg_tool_bar_help_callback (w, event, client_data)
3352 GtkWidget *w;
3353 GdkEventCrossing *event;
3354 gpointer client_data;
3356 /* The EMACS_INT cast avoids a warning. */
3357 int idx = (int) (EMACS_INT) client_data;
3358 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (w), XG_FRAME_DATA);
3359 Lisp_Object help, frame;
3361 if (! GTK_IS_BUTTON (w))
3362 return FALSE;
3364 if (! f || ! f->n_tool_bar_items || NILP (f->tool_bar_items))
3365 return FALSE;
3367 if (event->type == GDK_ENTER_NOTIFY)
3369 idx *= TOOL_BAR_ITEM_NSLOTS;
3370 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_HELP);
3372 if (NILP (help))
3373 help = AREF (f->tool_bar_items, idx + TOOL_BAR_ITEM_CAPTION);
3375 else
3376 help = Qnil;
3378 XSETFRAME (frame, f);
3379 kbd_buffer_store_help_event (frame, help);
3381 return FALSE;
3385 /* This callback is called when a tool bar item shall be redrawn.
3386 It modifies the expose event so that the GtkImage widget redraws the
3387 whole image. This to overcome a bug that makes GtkImage draw the image
3388 in the wrong place when it tries to redraw just a part of the image.
3389 W is the GtkImage to be redrawn.
3390 EVENT is the expose event for W.
3391 CLIENT_DATA is unused.
3393 Returns FALSE to tell GTK to keep processing this event. */
3395 static gboolean
3396 xg_tool_bar_item_expose_callback (w, event, client_data)
3397 GtkWidget *w;
3398 GdkEventExpose *event;
3399 gpointer client_data;
3401 gint width, height;
3403 gdk_drawable_get_size (event->window, &width, &height);
3405 event->area.x -= width > event->area.width ? width-event->area.width : 0;
3406 event->area.y -= height > event->area.height ? height-event->area.height : 0;
3408 event->area.x = max (0, event->area.x);
3409 event->area.y = max (0, event->area.y);
3411 event->area.width = max (width, event->area.width);
3412 event->area.height = max (height, event->area.height);
3414 return FALSE;
3417 /* This callback is called when a tool bar shall be redrawn.
3418 We need to update the tool bar from here in case the image cache
3419 has deleted the pixmaps used in the tool bar.
3420 W is the GtkToolbar to be redrawn.
3421 EVENT is the expose event for W.
3422 CLIENT_DATA is pointing to the frame for this tool bar.
3424 Returns FALSE to tell GTK to keep processing this event. */
3426 static gboolean
3427 xg_tool_bar_expose_callback (w, event, client_data)
3428 GtkWidget *w;
3429 GdkEventExpose *event;
3430 gpointer client_data;
3432 update_frame_tool_bar ((FRAME_PTR) client_data);
3433 return FALSE;
3436 /* Create a tool bar for frame F. */
3438 static void
3439 xg_create_tool_bar (f)
3440 FRAME_PTR f;
3442 struct x_output *x = f->output_data.x;
3443 GtkRequisition req;
3444 int vbox_pos = x->menubar_widget ? 1 : 0;
3446 x->toolbar_widget = gtk_toolbar_new ();
3447 x->handlebox_widget = gtk_handle_box_new ();
3448 x->toolbar_detached = 0;
3450 gtk_container_add (GTK_CONTAINER (x->handlebox_widget),
3451 x->toolbar_widget);
3453 gtk_box_pack_start (GTK_BOX (x->vbox_widget), x->handlebox_widget,
3454 FALSE, FALSE, 0);
3456 gtk_box_reorder_child (GTK_BOX (x->vbox_widget), x->handlebox_widget,
3457 vbox_pos);
3459 gtk_widget_set_name (x->toolbar_widget, "emacs-toolbar");
3461 /* We only have icons, so override any user setting. We could
3462 use the caption property of the toolbar item (see update_frame_tool_bar
3463 below), but some of those strings are long, making the toolbar so
3464 long it does not fit on the screen. The GtkToolbar widget makes every
3465 item equal size, so the longest caption determine the size of every
3466 tool bar item. I think the creators of the GtkToolbar widget
3467 counted on 4 or 5 character long strings. */
3468 gtk_toolbar_set_style (GTK_TOOLBAR (x->toolbar_widget), GTK_TOOLBAR_ICONS);
3469 gtk_toolbar_set_orientation (GTK_TOOLBAR (x->toolbar_widget),
3470 GTK_ORIENTATION_HORIZONTAL);
3472 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-detached",
3473 G_CALLBACK (xg_tool_bar_detach_callback), f);
3474 g_signal_connect (G_OBJECT (x->handlebox_widget), "child-attached",
3475 G_CALLBACK (xg_tool_bar_attach_callback), f);
3476 g_signal_connect (G_OBJECT (x->toolbar_widget),
3477 "expose-event",
3478 G_CALLBACK (xg_tool_bar_expose_callback),
3481 gtk_widget_show_all (x->handlebox_widget);
3483 gtk_widget_size_request (x->toolbar_widget, &req);
3484 FRAME_TOOLBAR_HEIGHT (f) = req.height;
3486 /* The height has changed, resize outer widget and set columns
3487 rows to what we had before adding the tool bar. */
3488 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
3490 SET_FRAME_GARBAGED (f);
3493 /* Update the tool bar for frame F. Add new buttons and remove old. */
3495 void
3496 update_frame_tool_bar (f)
3497 FRAME_PTR f;
3499 int i;
3500 GtkRequisition old_req, new_req;
3501 GList *icon_list;
3502 GList *iter;
3503 struct x_output *x = f->output_data.x;
3504 int hmargin, vmargin;
3506 if (! FRAME_GTK_WIDGET (f))
3507 return;
3509 BLOCK_INPUT;
3511 if (INTEGERP (Vtool_bar_button_margin)
3512 && XINT (Vtool_bar_button_margin) > 0)
3514 hmargin = XFASTINT (Vtool_bar_button_margin);
3515 vmargin = XFASTINT (Vtool_bar_button_margin);
3517 else if (CONSP (Vtool_bar_button_margin))
3519 if (INTEGERP (XCAR (Vtool_bar_button_margin))
3520 && XINT (XCAR (Vtool_bar_button_margin)) > 0)
3521 hmargin = XFASTINT (XCAR (Vtool_bar_button_margin));
3523 if (INTEGERP (XCDR (Vtool_bar_button_margin))
3524 && XINT (XCDR (Vtool_bar_button_margin)) > 0)
3525 vmargin = XFASTINT (XCDR (Vtool_bar_button_margin));
3528 /* The natural size (i.e. when GTK uses 0 as margin) looks best,
3529 so take DEFAULT_TOOL_BAR_BUTTON_MARGIN to mean "default for GTK",
3530 i.e. zero. This means that margins less than
3531 DEFAULT_TOOL_BAR_BUTTON_MARGIN has no effect. */
3532 hmargin = max (0, hmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
3533 vmargin = max (0, vmargin - DEFAULT_TOOL_BAR_BUTTON_MARGIN);
3535 if (! x->toolbar_widget)
3536 xg_create_tool_bar (f);
3538 gtk_widget_size_request (x->toolbar_widget, &old_req);
3540 icon_list = gtk_container_get_children (GTK_CONTAINER (x->toolbar_widget));
3541 iter = icon_list;
3543 for (i = 0; i < f->n_tool_bar_items; ++i)
3545 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
3547 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
3548 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
3549 int idx;
3550 int img_id;
3551 struct image *img;
3552 Lisp_Object image;
3553 GtkWidget *wicon = iter ? GTK_WIDGET (iter->data) : 0;
3555 if (iter) iter = g_list_next (iter);
3557 /* If image is a vector, choose the image according to the
3558 button state. */
3559 image = PROP (TOOL_BAR_ITEM_IMAGES);
3560 if (VECTORP (image))
3562 if (enabled_p)
3563 idx = (selected_p
3564 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
3565 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
3566 else
3567 idx = (selected_p
3568 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
3569 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
3571 xassert (ASIZE (image) >= idx);
3572 image = AREF (image, idx);
3574 else
3575 idx = -1;
3577 /* Ignore invalid image specifications. */
3578 if (!valid_image_p (image))
3580 if (wicon) gtk_widget_hide (wicon);
3581 continue;
3584 img_id = lookup_image (f, image);
3585 img = IMAGE_FROM_ID (f, img_id);
3586 prepare_image_for_display (f, img);
3588 if (img->load_failed_p || img->pixmap == None)
3590 if (wicon) gtk_widget_hide (wicon);
3591 continue;
3594 if (! wicon)
3596 GtkWidget *w = xg_get_image_for_pixmap (f, img, x->widget, NULL);
3597 GtkToolItem *ti = gtk_tool_button_new (w, "");
3599 gtk_misc_set_padding (GTK_MISC (w), hmargin, vmargin);
3601 gtk_toolbar_insert (GTK_TOOLBAR (x->toolbar_widget),
3604 /* The EMACS_INT cast avoids a warning. */
3605 g_signal_connect (GTK_WIDGET (ti), "clicked",
3606 GTK_SIGNAL_FUNC (xg_tool_bar_callback),
3607 (gpointer) (EMACS_INT) i);
3609 gtk_widget_show (GTK_WIDGET (ti));
3610 gtk_widget_show (GTK_WIDGET (w));
3612 /* Save the image so we can see if an update is needed when
3613 this function is called again. */
3614 g_object_set_data (G_OBJECT (w), XG_TOOL_BAR_IMAGE_DATA,
3615 (gpointer)img->pixmap);
3617 g_object_set_data (G_OBJECT (ti), XG_FRAME_DATA, (gpointer)f);
3619 /* Catch expose events to overcome an annoying redraw bug, see
3620 comment for xg_tool_bar_item_expose_callback. */
3621 g_signal_connect (G_OBJECT (ti),
3622 "expose-event",
3623 G_CALLBACK (xg_tool_bar_item_expose_callback),
3626 gtk_widget_set_sensitive (GTK_WIDGET (ti), enabled_p);
3627 gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (ti), FALSE);
3629 while (! GTK_IS_BUTTON (w))
3630 w = gtk_widget_get_parent (w);
3632 g_object_set_data (G_OBJECT (w), XG_FRAME_DATA, (gpointer)f);
3634 /* Use enter/leave notify to show help. We use the events
3635 rather than the GtkButton specific signals "enter" and
3636 "leave", so we can have only one callback. The event
3637 will tell us what kind of event it is. */
3638 /* The EMACS_INT cast avoids a warning. */
3639 g_signal_connect (G_OBJECT (w),
3640 "enter-notify-event",
3641 G_CALLBACK (xg_tool_bar_help_callback),
3642 (gpointer) (EMACS_INT) i);
3643 g_signal_connect (G_OBJECT (w),
3644 "leave-notify-event",
3645 G_CALLBACK (xg_tool_bar_help_callback),
3646 (gpointer) (EMACS_INT) i);
3648 else
3650 /* The child of the tool bar is a button. Inside that button
3651 is a vbox. Inside that vbox is the GtkImage. */
3652 GtkWidget *wvbox = gtk_bin_get_child (GTK_BIN (wicon));
3653 GList *chlist = gtk_container_get_children (GTK_CONTAINER (wvbox));
3654 GtkImage *wimage = GTK_IMAGE (chlist->data);
3655 Pixmap old_img = (Pixmap)g_object_get_data (G_OBJECT (wimage),
3656 XG_TOOL_BAR_IMAGE_DATA);
3657 g_list_free (chlist);
3659 gtk_misc_set_padding (GTK_MISC (wimage), hmargin, vmargin);
3661 if (old_img != img->pixmap)
3662 (void) xg_get_image_for_pixmap (f, img, x->widget, wimage);
3664 g_object_set_data (G_OBJECT (wimage), XG_TOOL_BAR_IMAGE_DATA,
3665 (gpointer)img->pixmap);
3667 gtk_widget_set_sensitive (wicon, enabled_p);
3668 gtk_widget_show (wicon);
3671 #undef PROP
3674 /* Remove buttons not longer needed. We just hide them so they
3675 can be reused later on. */
3676 while (iter)
3678 GtkWidget *w = GTK_WIDGET (iter->data);
3679 gtk_widget_hide (w);
3680 iter = g_list_next (iter);
3683 gtk_widget_size_request (x->toolbar_widget, &new_req);
3684 if (old_req.height != new_req.height
3685 && ! FRAME_X_OUTPUT (f)->toolbar_detached)
3687 FRAME_TOOLBAR_HEIGHT (f) = new_req.height;
3688 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
3691 if (icon_list) g_list_free (icon_list);
3693 UNBLOCK_INPUT;
3696 /* Deallocate all resources for the tool bar on frame F.
3697 Remove the tool bar. */
3699 void
3700 free_frame_tool_bar (f)
3701 FRAME_PTR f;
3703 struct x_output *x = f->output_data.x;
3705 if (x->toolbar_widget)
3707 BLOCK_INPUT;
3708 gtk_container_remove (GTK_CONTAINER (x->vbox_widget),
3709 x->handlebox_widget);
3710 x->toolbar_widget = 0;
3711 x->handlebox_widget = 0;
3712 FRAME_TOOLBAR_HEIGHT (f) = 0;
3714 /* The height has changed, resize outer widget and set columns
3715 rows to what we had before removing the tool bar. */
3716 xg_resize_outer_widget (f, FRAME_COLS (f), FRAME_LINES (f));
3718 SET_FRAME_GARBAGED (f);
3719 UNBLOCK_INPUT;
3725 /***********************************************************************
3726 Initializing
3727 ***********************************************************************/
3728 void
3729 xg_initialize ()
3731 GtkBindingSet *binding_set;
3733 xg_ignore_gtk_scrollbar = 0;
3734 xg_detached_menus = 0;
3735 xg_menu_cb_list.prev = xg_menu_cb_list.next =
3736 xg_menu_item_cb_list.prev = xg_menu_item_cb_list.next = 0;
3738 id_to_widget.max_size = id_to_widget.used = 0;
3739 id_to_widget.widgets = 0;
3741 /* Remove F10 as a menu accelerator, it does not mix well with Emacs key
3742 bindings. It doesn't seem to be any way to remove properties,
3743 so we set it to VoidSymbol which in X means "no key". */
3744 gtk_settings_set_string_property (gtk_settings_get_default (),
3745 "gtk-menu-bar-accel",
3746 "VoidSymbol",
3747 EMACS_CLASS);
3749 /* Make GTK text input widgets use Emacs style keybindings. This is
3750 Emacs after all. */
3751 gtk_settings_set_string_property (gtk_settings_get_default (),
3752 "gtk-key-theme-name",
3753 "Emacs",
3754 EMACS_CLASS);
3756 /* Make dialogs close on C-g. Since file dialog inherits from
3757 dialog, this works for them also. */
3758 binding_set = gtk_binding_set_by_class (gtk_type_class (GTK_TYPE_DIALOG));
3759 gtk_binding_entry_add_signal (binding_set, GDK_g, GDK_CONTROL_MASK,
3760 "close", 0);
3762 /* Make menus close on C-g. */
3763 binding_set = gtk_binding_set_by_class (gtk_type_class (GTK_TYPE_MENU_SHELL));
3764 gtk_binding_entry_add_signal (binding_set, GDK_g, GDK_CONTROL_MASK,
3765 "cancel", 0);
3768 #endif /* USE_GTK */
3770 /* arch-tag: fe7104da-bc1e-4aba-9bd1-f349c528f7e3
3771 (do not change this comment) */