[bpt/emacs.git] / oldXMenu / XMenu.h

/* Copyright    Massachusetts Institute of Technology    1985	*/

#include "copyright.h"


/*
 * XMenu:	MIT Project Athena, X Window system menu package
 *
 *	XMenu.h -	Include file for the MIT Project Athena
 *			XMenu X window system menu package.
 *
 *	Author:		Tony Della Fera, DEC
 *			August, 1984
 */

#ifndef _XMenu_h_
#define _XMenu_h_

#include <stdlib.h>
#include <X11/Xutil.h>
#include "X10.h"

#define FAILURE			-1
#define SUCCESS			1
#define POST_ERROR		-1
#define NO_SELECTION		-1

#define XM_FAILURE		-1
#define XM_SUCCESS		1
#define XM_NO_SELECT		2
#define XM_IA_SELECT		3

#define XME_CODE_COUNT		17

#define XME_NO_ERROR		0
#define XME_NOT_INIT		1
#define XME_ARG_BOUNDS		2
#define XME_P_NOT_FOUND		3
#define XME_S_NOT_FOUND		4
#define XME_STYLE_PARAM		5
#define XME_GRAB_MOUSE		6
#define XME_INTERP_LOC		7
#define XME_CALLOC		8
#define XME_CREATE_ASSOC	9
#define XME_STORE_BITMAP	10
#define XME_MAKE_TILES		11
#define XME_MAKE_PIXMAP		12
#define XME_CREATE_CURSOR	13
#define XME_OPEN_FONT		14
#define XME_CREATE_WINDOW	15
#define XME_CREATE_TRANSP	16

/*
 * XMenu error code and error list definitions.
 */
extern int _XMErrorCode;
extern char const *const _XMErrorList[];

/*
 * Define the XMWindow datatypes.
 *
 * An XMWindow is either an XMPane or an XMSelect.
 *
 * XMWindow is wrapper used to identify the constant window
 * information that makes up XMPane and XMSelect objects.
 *
 * An XMPane is a menu pane made up of one or more XMSelect and a label.
 *
 * An XMSelect is a menu selection object with a label and a data pointer.
 */
typedef enum _xmwintype {PANE, SELECTION, PL_HEADER, SL_HEADER, SEPARATOR} XMWType;

typedef struct _xmwindow {
    struct _xmwindow *next;	/* Next obj pointer (for emacs_insque). */
    struct _xmwindow *prev;	/* Prev obj pointer (for emacs_insque). */
    XMWType type;		/* Type of window. */
    Window window;		/* X Window Id. */
    int window_x;		/* Window upper left X coordinate. */
    int window_y;		/* Window upper left y coordinate. */
    int window_w;		/* Window width. */
    int window_h;		/* Window height. */
    int active;			/* Window active? */
    int activated;		/* Window activated? */
    int pad_l1;			/* ---- */
    char *pad_l2;		/* ---- */
    int pad_l3;			/* ---- */
    int pad_l4;			/* ---- */
    int pad_l5;			/* ---- */
    int pad_l6;			/* ---- */
    int pad_l7;			/* ---- */
    int pad_l8;			/* ---- */
    struct _xmwindow *pad_l9;	/* ---- */
    char *pad_l10;		/* ---- */
    struct _xmwindow *pad_l11;	/* ---- */
} XMWindow;

typedef struct _xmpane {
    struct _xmpane *next;	/* Next obj pointer (for emacs_insque). */
    struct _xmpane *prev;	/* Prev obj pointer (for emacs_insque). */
    XMWType type;		/* Type of window. */
    Window window;		/* X Window Id. */
    int window_x;		/* Window upper left X coordinate. */
    int window_y;		/* Window upper left y coordinate. */
    int window_w;		/* Window width. */
    int window_h;		/* Window height. */
    int active;			/* Window active? */
    int activated;		/* Window activated? */
    int serial;			/* -- Pane serial number. */
    char const *label;		/* -- Pane label. */
    int label_width;		/* -- Pane label width in pixels. */
    int label_length;		/* -- Pane label length in chars. */
    int label_x;		/* -- Pane label X offset. */
    int label_uy;		/* -- Pane label upper Y offset. */
    int label_ly;		/* -- Pane label lower Y offset. */
    int s_count;		/* -- Selections in this pane. */
    struct _xmselect *s_list;	/* -- Selection  window list. */
    char *pad_l10;		/* ---- */
    struct _xmwindow *pad_l11;	/* ---- */
} XMPane;

typedef struct _xmselect {
    struct _xmselect *next;	/* Next obj pointer (for emacs_insque). */
    struct _xmselect *prev;	/* Prev obj pointer (for emacs_insque). */
    XMWType type;		/* Type of window. */
    Window window;		/* X Window Id. */
    Window parent;		/* X Window id of parent window. */
    int window_x;		/* Window upper left X coordinate. */
    int window_y;		/* Window upper left y coordinate. */
    int window_w;		/* Window width. */
    int window_h;		/* Window height. */
    int active;			/* Window active? */
    int activated;		/* Window activated? */
    int serial;			/* -- Selection serial number. */
    char *label;		/* -- Selection label. */
    int label_width;		/* -- Selection label width in pixels. */
    int label_length;		/* -- Selection label length in chars. */
    int label_x;		/* -- Selection label X offset. */
    int label_y;		/* -- Selection label Y offset. */
    int pad_l7;			/* ---- */
    int pad_l8;			/* ---- */
    struct _xmwindow *pad_l9;	/* ---- */
    char *data;			/* -- Selection data pointer. */
    struct _xmpane *parent_p;	/* -- Selection parent pane structure. */
    char const *help_string;	/* Help string or null.  */
} XMSelect;


/*
 * Define the XMStyle datatype.
 *
 * Menu presentation style information.
 *
 */
typedef enum _xmstyle {
    LEFT,			/* Left oriented object. */
    RIGHT,			/* Right oriented object. */
    CENTER			/* Center oriented object. */
} XMStyle;


/*
 * Define the XMMode datatype.
 *
 * Menu presentation mode information.
 *
 */
typedef enum _xmmode {
    BOX,			/* BOXed graphic rendition. */
    INVERT			/* INVERTed graphic rendition. */
} XMMode;


/*
 * Define the XMenu datatype.
 *
 * All dimensions are in pixels unless otherwise noted.
 */
typedef struct _xmenu {
    /* -------------------- Menu data -------------------- */
    XMStyle menu_style;		/* Menu display style. */
    XMMode menu_mode;		/* Menu display mode. */
    int freeze;			/* Freeze server mode? */
    int aeq;			/* Asynchronous Event Queuing mode? */
    int recompute;		/* Recompute menu dependencies? */
    Window parent;		/* Menu's parent window. */
    int width;			/* Overall menu width. */
    int height;			/* Overall menu height. */
    int x_pos;			/* Overall menu origin. */
    int y_pos;			/* Overall menu origin. */
    Cursor mouse_cursor;	/* Mouse cursor raster. */
    XAssocTable *assoc_tab;	/* XMWindow association table. */
    XMPane *p_list;		/* List of XMPanes. */
    /* -------------------- Pane window data -------------------- */
    XMStyle p_style;		/* Pane display style. */
    int p_events;		/* Pane window X events. */
    XFontStruct *p_fnt_info;	/* Flag font info structure. */
    GC pane_GC;			/* Pane graphics context. */
    int p_fnt_pad;		/* Fixed flag font padding in pixels. */
    double p_spread;		/* Pane spread in flag height fractions. */
    int p_bdr_width;		/* Pane border width. */
    int flag_height;		/* Flag height. */
    int p_width;		/* Menu pane width. */
    int p_height;		/* Menu pane height. */
    int p_x_off;		/* Pane window X offset. */
    int p_y_off;		/* Pane window Y offset. */
    int p_count;		/* Number of panes per menu. */
    /* -------------------- Selection window data -------------------- */
    XMStyle s_style;		/* Selection display style. */
    int s_events;		/* Selection window X events. */
    XFontStruct *s_fnt_info;	/* Body font info structure. */
    int s_fnt_pad;		/* Fixed body font padding in pixels. */
    double s_spread;		/* Select spread in line height fractions. */
    int s_bdr_width;		/* Select border width. */
    int s_width;		/* Selection window width. */
    int s_height;		/* Selection window height. */
    int s_x_off;		/* Selection window X offset. */
    int s_y_off;		/* Selection window Y offset. */
    int s_count;		/* Maximum number of selections per pane. */
    GC normal_select_GC;	/* GC used for inactive selections. */
    GC inverse_select_GC;	/* GC used for active (current) selection. */
    GC inact_GC;		/* GC used for inactive selections and */
				/* panes headers. */
    /* -------------------- Color data -------------------- */
    unsigned long p_bdr_color;	/* Color of pane border pixmap. */
    unsigned long s_bdr_color;	/* Color of selection border pixmap. */
    unsigned long p_frg_color;	/* Color of pane foreground pixmap. */
    unsigned long s_frg_color;	/* Color of selection pixmap. */
    unsigned long bkgnd_color;	/* Color of menu background pixmap. */
    /* -------------------- Pixmap data -------------------- */
    Pixmap p_bdr_pixmap;	/* Pane border pixmap. */
    Pixmap s_bdr_pixmap;	/* Selection border pixmap. */
    Pixmap p_frg_pixmap;	/* Pane foreground pixmap. */
    Pixmap s_frg_pixmap;	/* Selection foreground pixmap. */
    Pixmap bkgnd_pixmap;	/* Menu background pixmap. */
    Pixmap inact_pixmap;	/* Menu inactive pixmap. */
} XMenu;

typedef void (*Wait_func)(void*);

/*
 * XMenu library routine declarations.
 */
XMenu *XMenuCreate(Display *display, Window parent, char const *def_env);
int XMenuAddPane(Display *display, XMenu *menu, char const *label, int active);
int XMenuAddSelection(Display *display, XMenu *menu, int p_num, char *data, char *label, int active, char const *help);
int XMenuInsertPane(XMenu *menu, int p_num, char *label, int active);
int XMenuInsertSelection(XMenu *menu, int p_num, int s_num, char *data, char *label, int active);
int XMenuFindPane(XMenu *menu, char *label);
int XMenuFindSelection(XMenu *menu, int p_num, char *label);
int XMenuChangePane(XMenu *menu, int p_num, char *label);
int XMenuChangeSelection(Display *display, XMenu *menu, int p_num, int s_num, char *data, int data_sw, char *label, int label_sw);
int XMenuSetPane(XMenu *menu, int p_num, int active);
int XMenuSetSelection(XMenu *menu, int p_num, int s_num, int active);
int XMenuRecompute(Display *display, XMenu *menu);
void XMenuEventHandler(int (*handler) (XEvent *));
int XMenuLocate(Display *display, XMenu *menu, int p_num, int s_num, int x_pos, int y_pos, int *ul_x, int *ul_y, int *width, int *height);
void XMenuSetFreeze(XMenu *menu, int freeze);
void XMenuActivateSetWaitFunction(Wait_func func, void *data);
int XMenuActivate(Display *display, XMenu *menu, int *p_num, int *s_num, int x_pos, int y_pos, unsigned int event_mask, char **data, void (*help_callback) (char const *, int, int));
char *XMenuPost(Display *display, XMenu *menu, int *p_num, int *s_num, int x_pos, int y_pos, int event_mask);
int XMenuDeletePane(Display *display, XMenu *menu, int p_num);
int XMenuDeleteSelection(Display *display, XMenu *menu, int p_num, int s_num);
void XMenuDestroy(Display *display, XMenu *menu);
char const *XMenuError(void);
void XMenuSetAEQ(XMenu *menu, int aeq);

#endif
/* Don't add after this point. */
Commit	Line	Data
2cd3138f GM	1	/* Copyright Massachusetts Institute of Technology 1985 */
2cd3138f GM	2
e745ede7 DL	3	#include "copyright.h"
e745ede7 DL	4
e745ede7 DL	5
	6	/*
	7	* XMenu: MIT Project Athena, X Window system menu package
	8	*
	9	* XMenu.h - Include file for the MIT Project Athena
	10	* XMenu X window system menu package.
177c0ea7	11	*
e745ede7 DL	12	* Author: Tony Della Fera, DEC
	13	* August, 1984
	14	*/
	15
	16	#ifndef _XMenu_h_
	17	#define _XMenu_h_
	18
ababf900	19	#include <stdlib.h>
e745ede7 DL	20	#include <X11/Xutil.h>
	21	#include "X10.h"
	22
	23	#define FAILURE -1
	24	#define SUCCESS 1
	25	#define POST_ERROR -1
	26	#define NO_SELECTION -1
	27
	28	#define XM_FAILURE -1
	29	#define XM_SUCCESS 1
	30	#define XM_NO_SELECT 2
	31	#define XM_IA_SELECT 3
	32
	33	#define XME_CODE_COUNT 17
	34
	35	#define XME_NO_ERROR 0
	36	#define XME_NOT_INIT 1
	37	#define XME_ARG_BOUNDS 2
	38	#define XME_P_NOT_FOUND 3
	39	#define XME_S_NOT_FOUND 4
	40	#define XME_STYLE_PARAM 5
	41	#define XME_GRAB_MOUSE 6
	42	#define XME_INTERP_LOC 7
	43	#define XME_CALLOC 8
	44	#define XME_CREATE_ASSOC 9
	45	#define XME_STORE_BITMAP 10
	46	#define XME_MAKE_TILES 11
	47	#define XME_MAKE_PIXMAP 12
	48	#define XME_CREATE_CURSOR 13
	49	#define XME_OPEN_FONT 14
	50	#define XME_CREATE_WINDOW 15
	51	#define XME_CREATE_TRANSP 16
	52
	53	/*
	54	* XMenu error code and error list definitions.
	55	*/
	56	extern int _XMErrorCode;
55660072	57	extern char const *const _XMErrorList[];
e745ede7 DL	58
	59	/*
	60	* Define the XMWindow datatypes.
	61	*
	62	* An XMWindow is either an XMPane or an XMSelect.
	63	*
	64	* XMWindow is wrapper used to identify the constant window
	65	* information that makes up XMPane and XMSelect objects.
	66	*
	67	* An XMPane is a menu pane made up of one or more XMSelect and a label.
	68	*
	69	* An XMSelect is a menu selection object with a label and a data pointer.
	70	*/
	71	typedef enum _xmwintype {PANE, SELECTION, PL_HEADER, SL_HEADER, SEPARATOR} XMWType;
	72
	73	typedef struct _xmwindow {
	74	struct _xmwindow next; / Next obj pointer (for emacs_insque). */
	75	struct _xmwindow prev; / Prev obj pointer (for emacs_insque). */
	76	XMWType type; /* Type of window. */
	77	Window window; /* X Window Id. */
	78	int window_x; /* Window upper left X coordinate. */
	79	int window_y; /* Window upper left y coordinate. */
	80	int window_w; /* Window width. */
	81	int window_h; /* Window height. */
	82	int active; /* Window active? */
	83	int activated; /* Window activated? */
	84	int pad_l1; /* ---- */
	85	char pad_l2; / ---- */
	86	int pad_l3; /* ---- */
	87	int pad_l4; /* ---- */
	88	int pad_l5; /* ---- */
	89	int pad_l6; /* ---- */
	90	int pad_l7; /* ---- */
	91	int pad_l8; /* ---- */
	92	struct _xmwindow pad_l9; / ---- */
	93	char pad_l10; / ---- */
	94	struct _xmwindow pad_l11; / ---- */
	95	} XMWindow;
	96
	97	typedef struct _xmpane {
	98	struct _xmpane next; / Next obj pointer (for emacs_insque). */
	99	struct _xmpane prev; / Prev obj pointer (for emacs_insque). */
	100	XMWType type; /* Type of window. */
	101	Window window; /* X Window Id. */
	102	int window_x; /* Window upper left X coordinate. */
	103	int window_y; /* Window upper left y coordinate. */
	104	int window_w; /* Window width. */
	105	int window_h; /* Window height. */
	106	int active; /* Window active? */
	107	int activated; /* Window activated? */
	108	int serial; /* -- Pane serial number. */
55660072	109	char const label; / -- Pane label. */
e745ede7 DL	110	int label_width; /* -- Pane label width in pixels. */
	111	int label_length; /* -- Pane label length in chars. */
	112	int label_x; /* -- Pane label X offset. */
	113	int label_uy; /* -- Pane label upper Y offset. */
	114	int label_ly; /* -- Pane label lower Y offset. */
	115	int s_count; /* -- Selections in this pane. */
	116	struct _xmselect s_list; / -- Selection window list. */
	117	char pad_l10; / ---- */
	118	struct _xmwindow pad_l11; / ---- */
	119	} XMPane;
	120
	121	typedef struct _xmselect {
	122	struct _xmselect next; / Next obj pointer (for emacs_insque). */
	123	struct _xmselect prev; / Prev obj pointer (for emacs_insque). */
	124	XMWType type; /* Type of window. */
	125	Window window; /* X Window Id. */
	126	Window parent; /* X Window id of parent window. */
	127	int window_x; /* Window upper left X coordinate. */
	128	int window_y; /* Window upper left y coordinate. */
	129	int window_w; /* Window width. */
	130	int window_h; /* Window height. */
	131	int active; /* Window active? */
	132	int activated; /* Window activated? */
	133	int serial; /* -- Selection serial number. */
	134	char label; / -- Selection label. */
	135	int label_width; /* -- Selection label width in pixels. */
	136	int label_length; /* -- Selection label length in chars. */
	137	int label_x; /* -- Selection label X offset. */
	138	int label_y; /* -- Selection label Y offset. */
	139	int pad_l7; /* ---- */
	140	int pad_l8; /* ---- */
	141	struct _xmwindow pad_l9; / ---- */
	142	char data; / -- Selection data pointer. */
	143	struct _xmpane parent_p; / -- Selection parent pane structure. */
55660072	144	char const help_string; / Help string or null. */
e745ede7 DL	145	} XMSelect;
	146
	147
	148	/*
	149	* Define the XMStyle datatype.
	150	*
	151	* Menu presentation style information.
	152	*
	153	*/
	154	typedef enum _xmstyle {
fa463103 PE	155	LEFT, /* Left oriented object. */
fa463103 PE	156	RIGHT, /* Right oriented object. */
e745ede7 DL	157	CENTER /* Center oriented object. */
	158	} XMStyle;
	159
	160
	161	/*
	162	* Define the XMMode datatype.
	163	*
	164	* Menu presentation mode information.
	165	*
	166	*/
	167	typedef enum _xmmode {
	168	BOX, /* BOXed graphic rendition. */
	169	INVERT /* INVERTed graphic rendition. */
	170	} XMMode;
	171
	172
177c0ea7 JB	173	/*
177c0ea7 JB	174	* Define the XMenu datatype.
e745ede7 DL	175	*
	176	* All dimensions are in pixels unless otherwise noted.
	177	*/
	178	typedef struct _xmenu {
	179	/* -------------------- Menu data -------------------- */
	180	XMStyle menu_style; /* Menu display style. */
	181	XMMode menu_mode; /* Menu display mode. */
	182	int freeze; /* Freeze server mode? */
	183	int aeq; /* Asynchronous Event Queuing mode? */
	184	int recompute; /* Recompute menu dependencies? */
	185	Window parent; /* Menu's parent window. */
	186	int width; /* Overall menu width. */
	187	int height; /* Overall menu height. */
09e80d9f	188	int x_pos; /* Overall menu origin. */
e745ede7 DL	189	int y_pos; /* Overall menu origin. */
	190	Cursor mouse_cursor; /* Mouse cursor raster. */
	191	XAssocTable assoc_tab; / XMWindow association table. */
	192	XMPane p_list; / List of XMPanes. */
	193	/* -------------------- Pane window data -------------------- */
	194	XMStyle p_style; /* Pane display style. */
	195	int p_events; /* Pane window X events. */
	196	XFontStruct p_fnt_info; / Flag font info structure. */
	197	GC pane_GC; /* Pane graphics context. */
	198	int p_fnt_pad; /* Fixed flag font padding in pixels. */
	199	double p_spread; /* Pane spread in flag height fractions. */
	200	int p_bdr_width; /* Pane border width. */
	201	int flag_height; /* Flag height. */
	202	int p_width; /* Menu pane width. */
	203	int p_height; /* Menu pane height. */
	204	int p_x_off; /* Pane window X offset. */
	205	int p_y_off; /* Pane window Y offset. */
	206	int p_count; /* Number of panes per menu. */
	207	/* -------------------- Selection window data -------------------- */
	208	XMStyle s_style; /* Selection display style. */
	209	int s_events; /* Selection window X events. */
	210	XFontStruct s_fnt_info; / Body font info structure. */
	211	int s_fnt_pad; /* Fixed body font padding in pixels. */
	212	double s_spread; /* Select spread in line height fractions. */
	213	int s_bdr_width; /* Select border width. */
	214	int s_width; /* Selection window width. */
	215	int s_height; /* Selection window height. */
	216	int s_x_off; /* Selection window X offset. */
	217	int s_y_off; /* Selection window Y offset. */
	218	int s_count; /* Maximum number of selections per pane. */
	219	GC normal_select_GC; /* GC used for inactive selections. */
177c0ea7	220	GC inverse_select_GC; /* GC used for active (current) selection. */
e745ede7 DL	221	GC inact_GC; /* GC used for inactive selections and */
	222	/* panes headers. */
	223	/* -------------------- Color data -------------------- */
	224	unsigned long p_bdr_color; /* Color of pane border pixmap. */
	225	unsigned long s_bdr_color; /* Color of selection border pixmap. */
	226	unsigned long p_frg_color; /* Color of pane foreground pixmap. */
	227	unsigned long s_frg_color; /* Color of selection pixmap. */
	228	unsigned long bkgnd_color; /* Color of menu background pixmap. */
	229	/* -------------------- Pixmap data -------------------- */
	230	Pixmap p_bdr_pixmap; /* Pane border pixmap. */
	231	Pixmap s_bdr_pixmap; /* Selection border pixmap. */
	232	Pixmap p_frg_pixmap; /* Pane foreground pixmap. */
	233	Pixmap s_frg_pixmap; /* Selection foreground pixmap. */
	234	Pixmap bkgnd_pixmap; /* Menu background pixmap. */
	235	Pixmap inact_pixmap; /* Menu inactive pixmap. */
	236	} XMenu;
	237
b782e2d7 DN	238	typedef void (Wait_func)(void);
b782e2d7 DN	239
e745ede7 DL	240	/*
	241	* XMenu library routine declarations.
	242	*/
55660072 PE	243	XMenu XMenuCreate(Display display, Window parent, char const *def_env);
	244	int XMenuAddPane(Display display, XMenu menu, char const *label, int active);
	245	int XMenuAddSelection(Display display, XMenu menu, int p_num, char data, char label, int active, char const *help);
	246	int XMenuInsertPane(XMenu menu, int p_num, char label, int active);
	247	int XMenuInsertSelection(XMenu menu, int p_num, int s_num, char data, char *label, int active);
	248	int XMenuFindPane(XMenu menu, char label);
	249	int XMenuFindSelection(XMenu menu, int p_num, char label);
	250	int XMenuChangePane(XMenu menu, int p_num, char label);
	251	int XMenuChangeSelection(Display display, XMenu menu, int p_num, int s_num, char data, int data_sw, char label, int label_sw);
	252	int XMenuSetPane(XMenu *menu, int p_num, int active);
	253	int XMenuSetSelection(XMenu *menu, int p_num, int s_num, int active);
	254	int XMenuRecompute(Display display, XMenu menu);
	255	void XMenuEventHandler(int (handler) (XEvent ));
	256	int XMenuLocate(Display display, XMenu menu, int p_num, int s_num, int x_pos, int y_pos, int ul_x, int ul_y, int width, int height);
	257	void XMenuSetFreeze(XMenu *menu, int freeze);
b782e2d7	258	void XMenuActivateSetWaitFunction(Wait_func func, void *data);
55660072 PE	259	int XMenuActivate(Display display, XMenu menu, int p_num, int s_num, int x_pos, int y_pos, unsigned int event_mask, char *data, void (help_callback) (char const *, int, int));
	260	char XMenuPost(Display display, XMenu menu, int p_num, int *s_num, int x_pos, int y_pos, int event_mask);
	261	int XMenuDeletePane(Display display, XMenu menu, int p_num);
	262	int XMenuDeleteSelection(Display display, XMenu menu, int p_num, int s_num);
	263	void XMenuDestroy(Display display, XMenu menu);
	264	char const *XMenuError(void);
	265	void XMenuSetAEQ(XMenu *menu, int aeq);
e745ede7 DL	266
	267	#endif
	268	/* Don't add after this point. */