src/gtkutil.h

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