src/gtkutil.h

/* Definitions and headers for GTK widgets.
   Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
     Free Software Foundation, Inc.

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
the Free Software Foundation, either version 3 of the License, or
(at your option) 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.  If not, see <http://www.gnu.org/licenses/>.  */

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

#define XG_SB_MIN 1
#define XG_SB_MAX 10000000
#define XG_SB_RANGE (XG_SB_MAX-XG_SB_MIN)

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

  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;

} 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 */
  Lisp_Object   lname;
  char		*name;
  /* value (meaning depend on widget type) */
  char		*value;
  /* keyboard equivalent. no implications for XtTranslations */
  Lisp_Object   lkey;
  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;

#ifdef HAVE_GTK_FILE_BOTH
extern int use_old_gtk_file_dialog;
#endif

extern widget_value *malloc_widget_value P_ ((void));
extern void free_widget_value P_ ((widget_value *));

extern int xg_uses_old_file_dialog P_ ((void));

extern char *xg_get_file_name P_ ((FRAME_PTR f,
                                   char *prompt,
                                   char *default_filename,
                                   int mustmatch_p,
                                   int only_dir_p));

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

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

extern int xg_have_tear_offs P_ ((void));

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

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,
                                         int height));

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

extern void xg_frame_resized P_ ((FRAME_PTR f,
                                  int pixelwidth,
                                  int pixelheight));
extern void xg_frame_set_char_size P_ ((FRAME_PTR f, int cols, int rows));
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));

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

extern void xg_set_frame_icon P_ ((FRAME_PTR f,
                                   Pixmap icon_pixmap,
                                   Pixmap icon_mask));

/* Mark all callback data that are Lisp_object:s during GC.  */
extern void xg_mark_data P_ ((void));

/* Initialize GTK specific parts.  */
extern void xg_initialize P_ ((void));

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

/* arch-tag: 0757f3dc-00c7-4cee-9e4c-282cf1d34c72
   (do not change this comment) */
Commit	Line	Data
	1	/* Definitions and headers for GTK widgets.
	2	Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008
	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 in a frame */
	36	#define XG_FRAME_DATA "emacs_frame"
	37
	38	/* Key for data that is the last scrollbar value */
	39	#define XG_LAST_SB_DATA "emacs_last_sb_value"
	40
	41	/* Key for data that menu items hold. */
	42	#define XG_ITEM_DATA "emacs_menuitem"
	43
	44
	45	/* Button types in menus. */
	46	enum button_type
	47	{
	48	BUTTON_TYPE_NONE,
	49	BUTTON_TYPE_TOGGLE,
	50	BUTTON_TYPE_RADIO
	51	};
	52
	53	/* This is a list node in a generic list implementation. */
	54	typedef struct xg_list_node_
	55	{
	56	struct xg_list_node_ *prev;
	57	struct xg_list_node_ *next;
	58	} xg_list_node;
	59
	60	/* This structure is the callback data that is shared for menu items.
	61	We need to keep it separate from the frame structure due to
	62	detachable menus. The data in the frame structure is only valid while
	63	the menu is popped up. This structure is kept around as long as
	64	the menu is. */
	65	typedef struct xg_menu_cb_data_
	66	{
	67	xg_list_node ptrs;
	68
	69	FRAME_PTR f;
	70	Lisp_Object menu_bar_vector;
	71	int menu_bar_items_used;
	72	GCallback highlight_cb;
	73	int ref_count;
	74	} xg_menu_cb_data;
	75
	76	/* This structure holds callback information for each individual menu item. */
	77	typedef struct xg_menu_item_cb_data_
	78	{
	79	xg_list_node ptrs;
	80
	81	gulong select_id;
	82	Lisp_Object help;
	83	gpointer call_data;
	84	xg_menu_cb_data *cl_data;
	85
	86	} xg_menu_item_cb_data;
	87
	88
	89	/* Used to specify menus and dialogs.
	90	This is an adaption from lwlib for Gtk so we can use more of the same
	91	code as lwlib in xmenu.c. */
	92	typedef struct _widget_value
	93	{
	94	/* name of widget */
	95	Lisp_Object lname;
	96	char *name;
	97	/* value (meaning depend on widget type) */
	98	char *value;
	99	/* keyboard equivalent. no implications for XtTranslations */
	100	Lisp_Object lkey;
	101	char *key;
	102	/* Help string or nil if none.
	103	GC finds this string through the frame's menu_bar_vector
	104	or through menu_items. */
	105	Lisp_Object help;
	106	/* true if enabled */
	107	gint enabled;
	108	/* true if selected */
	109	gint selected;
	110	/* The type of a button. */
	111	enum button_type button_type;
	112	/* Contents of the sub-widgets, also selected slot for checkbox */
	113	struct _widget_value *contents;
	114	/* data passed to callback */
	115	gpointer call_data;
	116	/* next one in the list */
	117	struct _widget_value *next;
	118
	119	/* we resource the widget_value structures; this points to the next
	120	one on the free list if this one has been deallocated.
	121	*/
	122	struct _widget_value *free_list;
	123	} widget_value;
	124
	125	#ifdef HAVE_GTK_FILE_BOTH
	126	extern int use_old_gtk_file_dialog;
	127	#endif
	128
	129	extern widget_value *malloc_widget_value P_ ((void));
	130	extern void free_widget_value P_ ((widget_value *));
	131
	132	extern int xg_uses_old_file_dialog P_ ((void));
	133
	134	extern char *xg_get_file_name P_ ((FRAME_PTR f,
	135	char *prompt,
	136	char *default_filename,
	137	int mustmatch_p,
	138	int only_dir_p));
	139
	140	extern char xg_get_font_name P_ ((FRAME_PTR f, char ));
	141
	142	extern GtkWidget xg_create_widget P_ ((char type,
	143	char *name,
	144	FRAME_PTR f,
	145	widget_value *val,
	146	GCallback select_cb,
	147	GCallback deactivate_cb,
	148	GCallback hightlight_cb));
	149
	150	extern void xg_modify_menubar_widgets P_ ((GtkWidget *menubar,
	151	FRAME_PTR f,
	152	widget_value *val,
	153	int deep_p,
	154	GCallback select_cb,
	155	GCallback deactivate_cb,
	156	GCallback hightlight_cb));
	157
	158	extern int xg_update_frame_menubar P_ ((FRAME_PTR f));
	159
	160	extern int xg_have_tear_offs P_ ((void));
	161
	162	extern int xg_get_scroll_id_for_window P_ ((Display *dpy, Window wid));
	163
	164	extern void xg_create_scroll_bar P_ ((FRAME_PTR f,
	165	struct scroll_bar *bar,
	166	GCallback scroll_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
	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) */