Auto-commit of loaddefs files.
[emacs.git] / src / gtkutil.h
blob43f2b237a68711a8e36d3a2908c8c5bafae7c1a7
1 /* Definitions and headers for GTK widgets.
3 Copyright (C) 2003-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 #ifndef GTKUTIL_H
21 #define GTKUTIL_H
24 #ifdef USE_GTK
26 #include <gtk/gtk.h>
27 #include "frame.h"
28 #include "xterm.h"
30 /* Minimum and maximum values used for GTK scroll bars */
32 #define XG_SB_MIN 1
33 #define XG_SB_MAX 10000000
34 #define XG_SB_RANGE (XG_SB_MAX-XG_SB_MIN)
36 /* Key for data that is valid for menus and scroll bars in a frame */
37 #define XG_FRAME_DATA "emacs_frame"
39 /* Key for data that menu items hold. */
40 #define XG_ITEM_DATA "emacs_menuitem"
42 /* This is a list node in a generic list implementation. */
43 typedef struct xg_list_node_
45 struct xg_list_node_ *prev;
46 struct xg_list_node_ *next;
47 } xg_list_node;
49 /* This structure is the callback data that is shared for menu items.
50 We need to keep it separate from the frame structure due to
51 detachable menus. The data in the frame structure is only valid while
52 the menu is popped up. This structure is kept around as long as
53 the menu is. */
54 typedef struct xg_menu_cb_data_
56 xg_list_node ptrs;
58 FRAME_PTR f;
59 Lisp_Object menu_bar_vector;
60 int menu_bar_items_used;
61 GCallback highlight_cb;
62 int ref_count;
63 } xg_menu_cb_data;
65 /* This structure holds callback information for each individual menu item. */
66 typedef struct xg_menu_item_cb_data_
68 xg_list_node ptrs;
70 gulong select_id;
71 Lisp_Object help;
72 gpointer call_data;
73 xg_menu_cb_data *cl_data;
75 } xg_menu_item_cb_data;
77 struct _widget_value;
79 extern struct _widget_value *malloc_widget_value (void);
80 extern void free_widget_value (struct _widget_value *);
82 extern bool xg_uses_old_file_dialog (void) ATTRIBUTE_CONST;
84 extern char *xg_get_file_name (FRAME_PTR f,
85 char *prompt,
86 char *default_filename,
87 bool mustmatch_p,
88 bool only_dir_p);
90 extern Lisp_Object xg_get_font (FRAME_PTR f, const char *);
92 extern GtkWidget *xg_create_widget (const char *type,
93 const char *name,
94 FRAME_PTR f,
95 struct _widget_value *val,
96 GCallback select_cb,
97 GCallback deactivate_cb,
98 GCallback highlight_cb);
100 extern void xg_modify_menubar_widgets (GtkWidget *menubar,
101 FRAME_PTR f,
102 struct _widget_value *val,
103 bool deep_p,
104 GCallback select_cb,
105 GCallback deactivate_cb,
106 GCallback highlight_cb);
108 extern void xg_update_frame_menubar (FRAME_PTR f);
110 extern bool xg_event_is_for_menubar (FRAME_PTR f, XEvent *event);
112 extern bool xg_have_tear_offs (void);
114 extern ptrdiff_t xg_get_scroll_id_for_window (Display *dpy, Window wid);
116 extern void xg_create_scroll_bar (FRAME_PTR f,
117 struct scroll_bar *bar,
118 GCallback scroll_callback,
119 GCallback end_callback,
120 const char *scroll_bar_name);
121 extern void xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id);
123 extern void xg_update_scrollbar_pos (FRAME_PTR f,
124 ptrdiff_t scrollbar_id,
125 int top,
126 int left,
127 int width,
128 int height);
130 extern void xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
131 int portion,
132 int position,
133 int whole);
134 extern bool xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event);
135 extern int xg_get_default_scrollbar_width (void);
137 extern void update_frame_tool_bar (FRAME_PTR f);
138 extern void free_frame_tool_bar (FRAME_PTR f);
139 extern void xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos);
141 extern void xg_frame_resized (FRAME_PTR f,
142 int pixelwidth,
143 int pixelheight);
144 extern void xg_frame_set_char_size (FRAME_PTR f, int cols, int rows);
145 extern GtkWidget * xg_win_to_widget (Display *dpy, Window wdesc);
147 extern void xg_display_open (char *display_name, Display **dpy);
148 extern void xg_display_close (Display *dpy);
149 extern GdkCursor * xg_create_default_cursor (Display *dpy);
151 extern bool xg_create_frame_widgets (FRAME_PTR f);
152 extern void xg_free_frame_widgets (FRAME_PTR f);
153 extern void xg_set_background_color (FRAME_PTR f, unsigned long bg);
154 extern bool xg_check_special_colors (struct frame *f,
155 const char *color_name,
156 XColor *color);
158 extern void xg_set_frame_icon (FRAME_PTR f,
159 Pixmap icon_pixmap,
160 Pixmap icon_mask);
162 extern bool xg_prepare_tooltip (FRAME_PTR f,
163 Lisp_Object string,
164 int *width,
165 int *height);
166 extern void xg_show_tooltip (FRAME_PTR f, int root_x, int root_y);
167 extern bool xg_hide_tooltip (FRAME_PTR f);
170 /* Mark all callback data that are Lisp_object:s during GC. */
171 extern void xg_mark_data (void);
173 /* Initialize GTK specific parts. */
174 extern void xg_initialize (void);
176 /* Setting scrollbar values invokes the callback. Use this variable
177 to indicate that the callback should do nothing. */
178 extern bool xg_ignore_gtk_scrollbar;
180 #endif /* USE_GTK */
181 #endif /* GTKUTIL_H */