src/gtkutil.h

   1 /* Definitions and headers for GTK widgets.
   2    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
   3      Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #ifndef GTKUTIL_H
  21 #define GTKUTIL_H
  22
  23
  24 #ifdef USE_GTK
  25
  26 #include <gtk/gtk.h>
  27 #include "frame.h"
  28
  29 /* Minimum and maximum values used for GTK scroll bars  */
  30
  31 #define XG_SB_MIN 1
  32 #define XG_SB_MAX 10000000
  33 #define XG_SB_RANGE (XG_SB_MAX-XG_SB_MIN)
  34
  35 /* Key for data that is valid for menus and scroll bars in a frame  */
  36 #define XG_FRAME_DATA "emacs_frame"
  37
  38 /* Key for data that menu items hold.  */
  39 #define XG_ITEM_DATA "emacs_menuitem"
  40
  41
  42 /* Button types in menus.  */
  43 enum button_type
  44 {
  45   BUTTON_TYPE_NONE,
  46   BUTTON_TYPE_TOGGLE,
  47   BUTTON_TYPE_RADIO
  48 };
  49
  50 /* This is a list node in a generic list implementation.  */
  51 typedef struct xg_list_node_
  52 {
  53   struct xg_list_node_ *prev;
  54   struct xg_list_node_ *next;
  55 } xg_list_node;
  56
  57 /* This structure is the callback data that is shared for menu items.
  58    We need to keep it separate from the frame structure due to
  59    detachable menus.  The data in the frame structure is only valid while
  60    the menu is popped up.  This structure is kept around as long as
  61    the menu is.  */
  62 typedef struct xg_menu_cb_data_
  63 {
  64   xg_list_node  ptrs;
  65
  66   FRAME_PTR     f;
  67   Lisp_Object   menu_bar_vector;
  68   int           menu_bar_items_used;
  69   GCallback     highlight_cb;
  70   int           ref_count;
  71 } xg_menu_cb_data;
  72
  73 /* This structure holds callback information for each individual menu item.  */
  74 typedef struct xg_menu_item_cb_data_
  75 {
  76   xg_list_node  ptrs;
  77
  78   gulong        select_id;
  79   Lisp_Object   help;
  80   gpointer      call_data;
  81   xg_menu_cb_data *cl_data;
  82
  83 } xg_menu_item_cb_data;
  84
  85
  86 /* Used to specify menus and dialogs.
  87    This is an adaption from lwlib for Gtk so we can use more of the same
  88    code as lwlib in xmenu.c.  */
  89 typedef struct _widget_value
  90 {
  91   /* name of widget */
  92   Lisp_Object   lname;
  93   char          *name;
  94   /* value (meaning depend on widget type) */
  95   char          *value;
  96   /* keyboard equivalent. no implications for XtTranslations */
  97   Lisp_Object   lkey;
  98   char          *key;
  99   /* Help string or nil if none.
 100      GC finds this string through the frame's menu_bar_vector
 101      or through menu_items.  */
 102   Lisp_Object   help;
 103   /* true if enabled */
 104   gint          enabled;
 105   /* true if selected */
 106   gint  selected;
 107   /* The type of a button.  */
 108   enum button_type button_type;
 109   /* Contents of the sub-widgets, also selected slot for checkbox */
 110   struct _widget_value  *contents;
 111   /* data passed to callback */
 112   gpointer      call_data;
 113   /* next one in the list */
 114   struct _widget_value  *next;
 115
 116   /* we resource the widget_value structures; this points to the next
 117      one on the free list if this one has been deallocated.
 118    */
 119   struct _widget_value *free_list;
 120 } widget_value;
 121
 122 #ifdef HAVE_GTK_FILE_BOTH
 123 extern int use_old_gtk_file_dialog;
 124 #endif
 125
 126 extern widget_value *malloc_widget_value P_ ((void));
 127 extern void free_widget_value P_ ((widget_value *));
 128
 129 extern int xg_uses_old_file_dialog P_ ((void));
 130
 131 extern char *xg_get_file_name P_ ((FRAME_PTR f,
 132                                    char *prompt,
 133                                    char *default_filename,
 134                                    int mustmatch_p,
 135                                    int only_dir_p));
 136
 137 extern char *xg_get_font_name P_ ((FRAME_PTR f, char *));
 138
 139 extern GtkWidget *xg_create_widget P_ ((char *type,
 140                                         char *name,
 141                                         FRAME_PTR f,
 142                                         widget_value *val,
 143                                         GCallback select_cb,
 144                                         GCallback deactivate_cb,
 145                                         GCallback hightlight_cb));
 146
 147 extern void xg_modify_menubar_widgets P_ ((GtkWidget *menubar,
 148                                            FRAME_PTR f,
 149                                            widget_value *val,
 150                                            int deep_p,
 151                                            GCallback select_cb,
 152                                            GCallback deactivate_cb,
 153                                            GCallback hightlight_cb));
 154
 155 extern int xg_update_frame_menubar P_ ((FRAME_PTR f));
 156
 157 extern int xg_event_is_for_menubar P_ ((FRAME_PTR f, XEvent *event));
 158
 159 extern int xg_have_tear_offs P_ ((void));
 160
 161 extern int xg_get_scroll_id_for_window P_ ((Display *dpy, Window wid));
 162
 163 extern void xg_create_scroll_bar P_ ((FRAME_PTR f,
 164                                       struct scroll_bar *bar,
 165                                       GCallback scroll_callback,
 166                                       GCallback end_callback,
 167                                       char *scroll_bar_name));
 168 extern void xg_show_scroll_bar P_ ((int scrollbar_id));
 169 extern void xg_remove_scroll_bar P_ ((FRAME_PTR f, int scrollbar_id));
 170
 171 extern void xg_update_scrollbar_pos P_ ((FRAME_PTR f,
 172                                          int scrollbar_id,
 173                                          int top,
 174                                          int left,
 175                                          int width,
 176                                          int height));
 177
 178 extern void xg_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *bar,
 179                                                  int portion,
 180                                                  int position,
 181                                                  int whole));
 182 extern int xg_event_is_for_scrollbar P_ ((FRAME_PTR f, XEvent *event));
 183
 184 extern void update_frame_tool_bar P_ ((FRAME_PTR f));
 185 extern void free_frame_tool_bar P_ ((FRAME_PTR f));
 186
 187 extern void xg_frame_resized P_ ((FRAME_PTR f,
 188                                   int pixelwidth,
 189                                   int pixelheight));
 190 extern void xg_frame_set_char_size P_ ((FRAME_PTR f, int cols, int rows));
 191 extern GtkWidget * xg_win_to_widget P_ ((Display *dpy, Window wdesc));
 192
 193 extern int xg_display_open P_ ((char *display_name, Display **dpy));
 194 extern void xg_display_close P_ ((Display *dpy));
 195 extern GdkCursor * xg_create_default_cursor P_ ((Display *dpy));
 196
 197 extern int xg_create_frame_widgets P_ ((FRAME_PTR f));
 198 extern void x_wm_set_size_hint P_ ((FRAME_PTR f,
 199                                     long flags,
 200                                     int user_position));
 201 extern void xg_set_background_color P_ ((FRAME_PTR f, unsigned long bg));
 202
 203 extern void xg_set_frame_icon P_ ((FRAME_PTR f,
 204                                    Pixmap icon_pixmap,
 205                                    Pixmap icon_mask));
 206
 207 /* Mark all callback data that are Lisp_object:s during GC.  */
 208 extern void xg_mark_data P_ ((void));
 209
 210 /* Initialize GTK specific parts.  */
 211 extern void xg_initialize P_ ((void));
 212
 213 /* Setting scrollbar values invokes the callback.  Use this variable
 214    to indicate that the callback should do nothing.  */
 215 extern int xg_ignore_gtk_scrollbar;
 216
 217 #endif /* USE_GTK */
 218 #endif /* GTKUTIL_H */
 219
 220 /* arch-tag: 0757f3dc-00c7-4cee-9e4c-282cf1d34c72
 221    (do not change this comment) */