gtkutil.h 7.33 KB
Newer Older
Jan Djärv's avatar
Jan Djärv committed
1
/* Definitions and headers for GTK widgets.
Glenn Morris's avatar
Glenn Morris committed
2
   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
3
     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 28 29 30

#ifndef GTKUTIL_H
#define GTKUTIL_H


#ifdef USE_GTK

#include <gtk/gtk.h>
#include "frame.h"

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

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

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

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

/* Button types in menus.  */
enum button_type
{
  BUTTON_TYPE_NONE,
  BUTTON_TYPE_TOGGLE,
  BUTTON_TYPE_RADIO
};

/* 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;
64

Jan Djärv's avatar
Jan Djärv committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
  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;
81

Jan Djärv's avatar
Jan Djärv committed
82 83 84 85 86 87 88 89 90
} xg_menu_item_cb_data;


/* Used to specify menus and dialogs.
   This is an adaption from lwlib for Gtk so we can use more of the same
   code as lwlib in xmenu.c.  */
typedef struct _widget_value
{
  /* name of widget */
91
  Lisp_Object   lname;
Jan Djärv's avatar
Jan Djärv committed
92 93 94
  char		*name;
  /* value (meaning depend on widget type) */
  char		*value;
95
  /* keyboard equivalent. no implications for XtTranslations */
96
  Lisp_Object   lkey;
Jan Djärv's avatar
Jan Djärv committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
  char		*key;
  /* Help string or nil if none.
     GC finds this string through the frame's menu_bar_vector
     or through menu_items.  */
  Lisp_Object	help;
  /* true if enabled */
  gint	        enabled;
  /* true if selected */
  gint	selected;
  /* The type of a button.  */
  enum button_type button_type;
  /* Contents of the sub-widgets, also selected slot for checkbox */
  struct _widget_value	*contents;
  /* data passed to callback */
  gpointer	call_data;
  /* next one in the list */
  struct _widget_value	*next;

  /* we resource the widget_value structures; this points to the next
     one on the free list if this one has been deallocated.
   */
  struct _widget_value *free_list;
} widget_value;

121
#ifdef HAVE_GTK_FILE_SELECTION_NEW
122 123 124
extern int use_old_gtk_file_dialog;
#endif

Jan Djärv's avatar
Jan Djärv committed
125
extern widget_value *malloc_widget_value P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
126 127
extern void free_widget_value P_ ((widget_value *));

128 129
extern int xg_uses_old_file_dialog P_ ((void));

Jan Djärv's avatar
Jan Djärv committed
130 131 132
extern char *xg_get_file_name P_ ((FRAME_PTR f,
                                   char *prompt,
                                   char *default_filename,
133 134
                                   int mustmatch_p,
                                   int only_dir_p));
Jan Djärv's avatar
Jan Djärv committed
135

136 137
extern char *xg_get_font_name P_ ((FRAME_PTR f, char *));

Jan Djärv's avatar
Jan Djärv committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
extern GtkWidget *xg_create_widget P_ ((char *type,
                                        char *name,
                                        FRAME_PTR f,
                                        widget_value *val,
                                        GCallback select_cb,
                                        GCallback deactivate_cb,
                                        GCallback hightlight_cb));

extern void xg_modify_menubar_widgets P_ ((GtkWidget *menubar,
                                           FRAME_PTR f,
                                           widget_value *val,
                                           int deep_p,
                                           GCallback select_cb,
                                           GCallback deactivate_cb,
                                           GCallback hightlight_cb));

extern int xg_update_frame_menubar P_ ((FRAME_PTR f));

156
extern int xg_have_tear_offs P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
157

158
extern int xg_get_scroll_id_for_window P_ ((Display *dpy, Window wid));
159

Jan Djärv's avatar
Jan Djärv committed
160 161 162
extern void xg_create_scroll_bar P_ ((FRAME_PTR f,
                                      struct scroll_bar *bar,
                                      GCallback scroll_callback,
163
                                      GCallback end_callback,
Jan Djärv's avatar
Jan Djärv committed
164 165 166 167 168 169 170 171
                                      char *scroll_bar_name));
extern void xg_remove_scroll_bar P_ ((FRAME_PTR f, int scrollbar_id));

extern void xg_update_scrollbar_pos P_ ((FRAME_PTR f,
                                         int scrollbar_id,
                                         int top,
                                         int left,
                                         int width,
172
                                         int height));
Jan Djärv's avatar
Jan Djärv committed
173 174 175 176 177

extern void xg_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *bar,
                                                 int portion,
                                                 int position,
                                                 int whole));
Jan Djärv's avatar
Jan Djärv committed
178
extern int xg_event_is_for_scrollbar P_ ((FRAME_PTR f, XEvent *event));
Jan Djärv's avatar
Jan Djärv committed
179 180 181 182

extern void update_frame_tool_bar P_ ((FRAME_PTR f));
extern void free_frame_tool_bar P_ ((FRAME_PTR f));

183 184 185
extern void xg_frame_resized P_ ((FRAME_PTR f,
                                  int pixelwidth,
                                  int pixelheight));
Jan Djärv's avatar
Jan Djärv committed
186
extern void xg_frame_set_char_size P_ ((FRAME_PTR f, int cols, int rows));
187 188
extern GtkWidget * xg_win_to_widget P_ ((Display *dpy, Window wdesc));

189
extern void xg_display_open P_ ((char *display_name, Display **dpy));
190 191 192
extern void xg_display_close P_ ((Display *dpy));
extern GdkCursor * xg_create_default_cursor P_ ((Display *dpy));

Jan Djärv's avatar
Jan Djärv committed
193 194 195 196 197 198
extern int xg_create_frame_widgets P_ ((FRAME_PTR f));
extern void x_wm_set_size_hint P_ ((FRAME_PTR f,
                                    long flags,
                                    int user_position));
extern void xg_set_background_color P_ ((FRAME_PTR f, unsigned long bg));

199 200 201
extern void xg_set_frame_icon P_ ((FRAME_PTR f,
                                   Pixmap icon_pixmap,
                                   Pixmap icon_mask));
202

Jan Djärv's avatar
Jan Djärv committed
203
/* Mark all callback data that are Lisp_object:s during GC.  */
Jan Djärv's avatar
Jan Djärv committed
204
extern void xg_mark_data P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
205 206

/* Initialize GTK specific parts.  */
Jan Djärv's avatar
Jan Djärv committed
207
extern void xg_initialize P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
208 209 210 211 212 213 214

/* 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 */
Miles Bader's avatar
Miles Bader committed
215 216 217

/* arch-tag: 0757f3dc-00c7-4cee-9e4c-282cf1d34c72
   (do not change this comment) */