XEmacs 21.2.36 "Notos"
[chise/xemacs-chise.git.1] / 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 INCLUDED_gui_h_
28 #define INCLUDED_gui_h_
29
30 int separator_string_p (const Bufbyte *s);
31 void get_gui_callback (Lisp_Object, Lisp_Object *, Lisp_Object *);
32 int gui_item_equal_sans_selected (Lisp_Object obj1, Lisp_Object obj2, int depth);
33
34 extern int popup_up_p;
35
36 /************************************************************************/
37 /*                      Image Instance Object                           */
38 /************************************************************************/
39
40 /* This structure describes gui button,
41    menu item or submenu properties */
42 struct Lisp_Gui_Item
43 {
44   struct lcrecord_header header;
45   Lisp_Object name;             /* String */
46   Lisp_Object callback;         /* Symbol or form */
47   Lisp_Object callback_ex;      /* Form taking context arguments */
48   Lisp_Object suffix;           /* String */
49   Lisp_Object active;           /* Form */
50   Lisp_Object included;         /* Form */
51   Lisp_Object config;           /* Anything EQable */
52   Lisp_Object filter;           /* Form */
53   Lisp_Object style;            /* Symbol */
54   Lisp_Object selected;         /* Form */
55   Lisp_Object keys;             /* String */
56   Lisp_Object accelerator;      /* Char or Symbol  */
57   Lisp_Object value;            /* Anything you like */
58 };
59
60 DECLARE_LRECORD (gui_item, Lisp_Gui_Item);
61 #define XGUI_ITEM(x) XRECORD (x, gui_item, Lisp_Gui_Item)
62 #define XSETGUI_ITEM(x, p) XSETRECORD (x, p, gui_item)
63 #define GUI_ITEMP(x) RECORDP (x, gui_item)
64 #define CHECK_GUI_ITEM(x) CHECK_RECORD (x, gui_item)
65 #define CONCHECK_GUI_ITEM(x) CONCHECK_RECORD (x, gui_item)
66
67 void gui_item_add_keyval_pair (Lisp_Object,
68                                Lisp_Object key, Lisp_Object val,
69                                Error_behavior errb);
70 Lisp_Object gui_parse_item_keywords (Lisp_Object item);
71 Lisp_Object gui_parse_item_keywords_no_errors (Lisp_Object item);
72 void gui_add_item_keywords_to_plist (Lisp_Object plist, Lisp_Object gui_item);
73 int  gui_item_active_p (Lisp_Object);
74 int  gui_item_selected_p (Lisp_Object);
75 Lisp_Object gui_item_list_find_selected (Lisp_Object gui_item_list);
76 int  gui_item_included_p (Lisp_Object, Lisp_Object into);
77 Lisp_Object gui_item_accelerator (Lisp_Object gui_item);
78 Lisp_Object gui_name_accelerator (Lisp_Object name);
79 int  gui_item_id_hash (Lisp_Object, Lisp_Object gui_item, int);
80 unsigned int gui_item_display_flush_left  (Lisp_Object pgui_item,
81                                            char* buf, Bytecount buf_len);
82 unsigned int gui_item_display_flush_right (Lisp_Object gui_item,
83                                            char* buf, Bytecount buf_len);
84
85 Lisp_Object allocate_gui_item (void);
86 void gui_item_init (Lisp_Object gui_item);
87 Lisp_Object parse_gui_item_tree_children (Lisp_Object list);
88 Lisp_Object copy_gui_item_tree (Lisp_Object arg);
89
90 extern Lisp_Object Qmenu_no_selection_hook, Qdelete_dialog_box_hook;
91
92 /* this is mswindows biased but reasonably safe I think */
93 #define GUI_ITEM_ID_SLOTS 8
94 #define GUI_ITEM_ID_MIN(s) (s * 0x2000)
95 #define GUI_ITEM_ID_MAX(s) (0x1FFF + GUI_ITEM_ID_MIN (s))
96 #define GUI_ITEM_ID_BITS(x,s) (((x) & 0x1FFF) + GUI_ITEM_ID_MIN (s))
97
98 #define MAX_MENUITEM_LENGTH 128
99
100 #endif /* INCLUDED_gui_h_ */