Contents in release-21-2 at 1999-06-30-19.
[chise/xemacs-chise.git-] / src / gui.h
1 /* Generic GUI code. (menubars, scrollbars, toolbars, dialogs)
2    Copyright (C) 1995 Board of Trustees, University of Illinois.
3    Copyright (C) 1995, 1996 Ben Wing.
4    Copyright (C) 1995 Sun Microsystems, Inc.
5
6 This file is part of XEmacs.
7
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
11 later version.
12
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
16 for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING.  If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA.  */
22
23 /* Synched up with: Not in FSF. */
24
25 /* Written by kkm on 12/24/97 */
26
27 #ifndef _XEMACS_GUI_H_
28 #define _XEMACS_GUI_H_
29
30 int separator_string_p (CONST char *s);
31 void get_gui_callback (Lisp_Object, Lisp_Object *, Lisp_Object *);
32
33 extern int popup_up_p;
34
35 /************************************************************************/
36 /*                      Image Instance Object                           */
37 /************************************************************************/
38
39 DECLARE_LRECORD (gui_item, struct Lisp_Gui_Item);
40 #define XGUI_ITEM(x) \
41   XRECORD (x, gui_item, struct Lisp_Gui_Item)
42 #define XSETGUI_ITEM(x, p) XSETRECORD (x, p, gui_item)
43 #define GUI_ITEMP(x) RECORDP (x, gui_item)
44 #define GC_GUI_ITEMP(x) GC_RECORDP (x, gui_item)
45 #define CHECK_GUI_ITEM(x) CHECK_RECORD (x, gui_item)
46 #define CONCHECK_GUI_ITEM(x) CONCHECK_RECORD (x, gui_item)
47
48 /* This structure describes gui button,
49    menu item or submenu properties */
50 struct Lisp_Gui_Item
51 {
52   struct lcrecord_header header;
53   Lisp_Object name;             /* String */
54   Lisp_Object callback;         /* Symbol or form */
55   Lisp_Object suffix;           /* String */
56   Lisp_Object active;           /* Form */
57   Lisp_Object included;         /* Form */
58   Lisp_Object config;           /* Anything EQable */
59   Lisp_Object filter;           /* Form */
60   Lisp_Object style;            /* Symbol */
61   Lisp_Object selected;         /* Form */
62   Lisp_Object keys;             /* String */
63   Lisp_Object accelerator;      /* Char or Symbol  */
64 };
65
66 extern Lisp_Object Q_accelerator, Q_active, Q_config, Q_filter, Q_included;
67 extern Lisp_Object Q_keys, Q_selected, Q_suffix, Qradio, Qtoggle;
68 extern Lisp_Object Q_key_sequence, Q_label, Q_callback;
69
70 void gui_item_add_keyval_pair (Lisp_Object,
71                                Lisp_Object key, Lisp_Object val,
72                                Error_behavior errb);
73 Lisp_Object gui_parse_item_keywords (Lisp_Object item);
74 Lisp_Object gui_parse_item_keywords_no_errors (Lisp_Object item);
75 int  gui_item_active_p (Lisp_Object);
76 int  gui_item_selected_p (Lisp_Object);
77 int  gui_item_included_p (Lisp_Object, Lisp_Object into);
78 Lisp_Object gui_item_accelerator (Lisp_Object gui_item);
79 Lisp_Object gui_name_accelerator (Lisp_Object name);
80 int  gui_item_id_hash (Lisp_Object, Lisp_Object gui_item, int);
81 unsigned int gui_item_display_flush_left  (Lisp_Object pgui_item,
82                                            char* buf, Bytecount buf_len);
83 unsigned int gui_item_display_flush_right (Lisp_Object gui_item,
84                                            char* buf, Bytecount buf_len);
85
86 Lisp_Object allocate_gui_item ();
87 void gui_item_init (Lisp_Object gui_item);
88
89 /* this is mswindows biased but reasonably safe I think */
90 #define GUI_ITEM_ID_SLOTS 8
91 #define GUI_ITEM_ID_MIN(s) (s * 0x2000)
92 #define GUI_ITEM_ID_MAX(s) (0x1FFF + GUI_ITEM_ID_MIN (s))
93 #define GUI_ITEM_ID_BITS(x,s) (((x) & 0x1FFF) + GUI_ITEM_ID_MIN (s))
94
95 #define MAX_MENUITEM_LENGTH 128
96
97 #endif /* _XEMACS_GUI_H_ */