gtkutil.h 6.47 KB
Newer Older
Jan Djärv's avatar
Jan Djärv committed
1
/* Definitions and headers for GTK widgets.
2

3
Copyright (C) 2003-2012  Free Software Foundation, Inc.
Jan Djärv's avatar
Jan Djärv committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jan Djärv's avatar
Jan Djärv committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jan Djärv's avatar
Jan Djärv committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jan Djärv's avatar
Jan Djärv committed
19 20 21 22 23 24 25 26 27

#ifndef GTKUTIL_H
#define GTKUTIL_H


#ifdef USE_GTK

#include <gtk/gtk.h>
#include "frame.h"
28
#include "xterm.h"
Jan Djärv's avatar
Jan Djärv committed
29 30 31

/* Minimum and maximum values used for GTK scroll bars  */

32
#define XG_SB_MIN 1
Jan Djärv's avatar
Jan Djärv committed
33
#define XG_SB_MAX 10000000
34
#define XG_SB_RANGE (XG_SB_MAX-XG_SB_MIN)
Jan Djärv's avatar
Jan Djärv committed
35

36
/* Key for data that is valid for menus and scroll bars in a frame  */
Jan Djärv's avatar
Jan Djärv committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
#define XG_FRAME_DATA "emacs_frame"

/* Key for data that menu items hold.  */
#define XG_ITEM_DATA "emacs_menuitem"

/* This is a list node in a generic list implementation.  */
typedef struct xg_list_node_
{
  struct xg_list_node_ *prev;
  struct xg_list_node_ *next;
} xg_list_node;

/* This structure is the callback data that is shared for menu items.
   We need to keep it separate from the frame structure due to
   detachable menus.  The data in the frame structure is only valid while
   the menu is popped up.  This structure is kept around as long as
   the menu is.  */
typedef struct xg_menu_cb_data_
{
  xg_list_node  ptrs;
57

Jan Djärv's avatar
Jan Djärv committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  FRAME_PTR     f;
  Lisp_Object   menu_bar_vector;
  int           menu_bar_items_used;
  GCallback     highlight_cb;
  int           ref_count;
} xg_menu_cb_data;

/* This structure holds callback information for each individual menu item.  */
typedef struct xg_menu_item_cb_data_
{
  xg_list_node  ptrs;

  gulong        select_id;
  Lisp_Object   help;
  gpointer	call_data;
  xg_menu_cb_data *cl_data;
74

Jan Djärv's avatar
Jan Djärv committed
75 76
} xg_menu_item_cb_data;

77
struct _widget_value;
78

79 80
extern struct _widget_value *malloc_widget_value (void);
extern void free_widget_value (struct _widget_value *);
Jan D's avatar
Jan D committed
81

Dmitry Antipov's avatar
Dmitry Antipov committed
82
extern int xg_uses_old_file_dialog (void) ATTRIBUTE_CONST;
Jan D's avatar
Jan D committed
83 84 85 86 87 88 89

extern char *xg_get_file_name (FRAME_PTR f,
                               char *prompt,
                               char *default_filename,
                               int mustmatch_p,
                               int only_dir_p);

90
extern Lisp_Object xg_get_font (FRAME_PTR f, const char *);
Jan D's avatar
Jan D committed
91

92 93
extern GtkWidget *xg_create_widget (const char *type,
                                    const char *name,
Jan D's avatar
Jan D committed
94
                                    FRAME_PTR f,
95
                                    struct _widget_value *val,
Jan D's avatar
Jan D committed
96 97
                                    GCallback select_cb,
                                    GCallback deactivate_cb,
Paul Eggert's avatar
Paul Eggert committed
98
                                    GCallback highlight_cb);
Jan D's avatar
Jan D committed
99 100 101

extern void xg_modify_menubar_widgets (GtkWidget *menubar,
                                       FRAME_PTR f,
102
                                       struct _widget_value *val,
Jan D's avatar
Jan D committed
103 104 105
                                       int deep_p,
                                       GCallback select_cb,
                                       GCallback deactivate_cb,
Paul Eggert's avatar
Paul Eggert committed
106
                                       GCallback highlight_cb);
Jan D's avatar
Jan D committed
107 108 109

extern int xg_update_frame_menubar (FRAME_PTR f);

110 111
extern int xg_event_is_for_menubar (FRAME_PTR f, XEvent *event);

Jan D's avatar
Jan D committed
112 113
extern int xg_have_tear_offs (void);

114
extern ptrdiff_t xg_get_scroll_id_for_window (Display *dpy, Window wid);
Jan D's avatar
Jan D committed
115 116 117 118 119

extern void xg_create_scroll_bar (FRAME_PTR f,
                                  struct scroll_bar *bar,
                                  GCallback scroll_callback,
                                  GCallback end_callback,
120
                                  const char *scroll_bar_name);
121
extern void xg_remove_scroll_bar (FRAME_PTR f, ptrdiff_t scrollbar_id);
Jan D's avatar
Jan D committed
122 123

extern void xg_update_scrollbar_pos (FRAME_PTR f,
124
                                     ptrdiff_t scrollbar_id,
Jan D's avatar
Jan D committed
125 126 127 128 129 130 131 132 133 134
                                     int top,
                                     int left,
                                     int width,
                                     int height);

extern void xg_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar,
                                             int portion,
                                             int position,
                                             int whole);
extern int xg_event_is_for_scrollbar (FRAME_PTR f, XEvent *event);
135
extern int xg_get_default_scrollbar_width (void);
Jan D's avatar
Jan D committed
136 137 138

extern void update_frame_tool_bar (FRAME_PTR f);
extern void free_frame_tool_bar (FRAME_PTR f);
139
extern int xg_change_toolbar_position (FRAME_PTR f, Lisp_Object pos);
Jan D's avatar
Jan D committed
140 141 142 143 144 145 146 147 148 149 150 151

extern void xg_frame_resized (FRAME_PTR f,
                              int pixelwidth,
                              int pixelheight);
extern void xg_frame_set_char_size (FRAME_PTR f, int cols, int rows);
extern GtkWidget * xg_win_to_widget (Display *dpy, Window wdesc);

extern void xg_display_open (char *display_name, Display **dpy);
extern void xg_display_close (Display *dpy);
extern GdkCursor * xg_create_default_cursor (Display *dpy);

extern int xg_create_frame_widgets (FRAME_PTR f);
152
extern void xg_free_frame_widgets (FRAME_PTR f);
Jan D's avatar
Jan D committed
153 154 155 156
extern void x_wm_set_size_hint (FRAME_PTR f,
                                long flags,
                                int user_position);
extern void xg_set_background_color (FRAME_PTR f, unsigned long bg);
157 158 159
extern int xg_check_special_colors (struct frame *f,
                                    const char *color_name,
                                    XColor *color);
Jan D's avatar
Jan D committed
160 161 162 163

extern void xg_set_frame_icon (FRAME_PTR f,
                               Pixmap icon_pixmap,
                               Pixmap icon_mask);
164

165 166 167 168 169 170 171 172
extern int xg_prepare_tooltip (FRAME_PTR f,
                               Lisp_Object string,
                               int *width,
                               int *height);
extern void xg_show_tooltip (FRAME_PTR f, int root_x, int root_y);
extern int xg_hide_tooltip (FRAME_PTR f);


Jan Djärv's avatar
Jan Djärv committed
173
/* Mark all callback data that are Lisp_object:s during GC.  */
Jan D's avatar
Jan D committed
174
extern void xg_mark_data (void);
Jan Djärv's avatar
Jan Djärv committed
175 176

/* Initialize GTK specific parts.  */
Jan D's avatar
Jan D committed
177
extern void xg_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
178 179 180 181 182 183 184

/* Setting scrollbar values invokes the callback.  Use this variable
   to indicate that the callback should do nothing.  */
extern int xg_ignore_gtk_scrollbar;

#endif /* USE_GTK */
#endif /* GTKUTIL_H */