src/gtkutil.h

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