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 3
   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
     Free Software Foundation, Inc.
Jan Djärv's avatar
Jan Djärv committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jan Djärv's avatar
Jan Djärv committed
21 22 23 24 25 26 27 28 29 30 31 32

#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  */

33
#define XG_SB_MIN 1
Jan Djärv's avatar
Jan Djärv committed
34
#define XG_SB_MAX 10000000
35
#define XG_SB_RANGE (XG_SB_MAX-XG_SB_MIN)
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 64 65 66 67 68 69

/* Key for data that is valid for menus in a frame  */
#define XG_FRAME_DATA "emacs_frame"

/* Key for data that is the last scrollbar value  */
#define XG_LAST_SB_DATA "emacs_last_sb_value"

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

Jan Djärv's avatar
Jan Djärv committed
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
  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;
87

Jan Djärv's avatar
Jan Djärv committed
88 89 90 91 92 93 94 95 96
} 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 */
97
  Lisp_Object   lname;
Jan Djärv's avatar
Jan Djärv committed
98 99 100
  char		*name;
  /* value (meaning depend on widget type) */
  char		*value;
101
  /* keyboard equivalent. no implications for XtTranslations */
102
  Lisp_Object   lkey;
Jan Djärv's avatar
Jan Djärv committed
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
  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;

127 128 129 130
#ifdef HAVE_GTK_FILE_BOTH
extern int use_old_gtk_file_dialog;
#endif

Jan Djärv's avatar
Jan Djärv committed
131
extern widget_value *malloc_widget_value P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
132 133
extern void free_widget_value P_ ((widget_value *));

134 135
extern int xg_uses_old_file_dialog P_ ((void));

Jan Djärv's avatar
Jan Djärv committed
136 137 138
extern char *xg_get_file_name P_ ((FRAME_PTR f,
                                   char *prompt,
                                   char *default_filename,
139 140
                                   int mustmatch_p,
                                   int only_dir_p));
Jan Djärv's avatar
Jan Djärv committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159

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));

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

162
extern int xg_get_scroll_id_for_window P_ ((Display *dpy, Window wid));
163

Jan Djärv's avatar
Jan Djärv committed
164 165 166 167 168 169 170 171 172 173 174 175
extern void xg_create_scroll_bar P_ ((FRAME_PTR f,
                                      struct scroll_bar *bar,
                                      GCallback scroll_callback,
                                      char *scroll_bar_name));
extern void xg_show_scroll_bar P_ ((int scrollbar_id));
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,
176
                                         int height));
Jan Djärv's avatar
Jan Djärv committed
177 178 179 180 181 182 183 184 185 186

extern void xg_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *bar,
                                                 int portion,
                                                 int position,
                                                 int whole));


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

187 188 189
extern void xg_frame_resized P_ ((FRAME_PTR f,
                                  int pixelwidth,
                                  int pixelheight));
Jan Djärv's avatar
Jan Djärv committed
190
extern void xg_frame_set_char_size P_ ((FRAME_PTR f, int cols, int rows));
191 192 193 194 195 196
extern GtkWidget * xg_win_to_widget P_ ((Display *dpy, Window wdesc));

extern int xg_display_open P_ ((char *display_name, Display **dpy));
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
197 198 199 200 201 202
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));

203 204 205
extern void xg_set_frame_icon P_ ((FRAME_PTR f,
                                   Pixmap icon_pixmap,
                                   Pixmap icon_mask));
206

Jan Djärv's avatar
Jan Djärv committed
207
/* Mark all callback data that are Lisp_object:s during GC.  */
Jan Djärv's avatar
Jan Djärv committed
208
extern void xg_mark_data P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
209 210

/* Initialize GTK specific parts.  */
Jan Djärv's avatar
Jan Djärv committed
211
extern void xg_initialize P_ ((void));
Jan Djärv's avatar
Jan Djärv committed
212 213 214 215 216 217 218

/* 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
219 220 221

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