annotate src/gui.h @ 353:3b3709405255 r21-1-6

Import from CVS: tag r21-1-6
author cvs
date Mon, 13 Aug 2007 10:55:33 +0200
parents 19dcec799385
children cc15677e0335
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
231
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
1 /* Generic GUI code. (menubars, scrollbars, toolbars, dialogs)
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
2 Copyright (C) 1995 Board of Trustees, University of Illinois.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
3 Copyright (C) 1995, 1996 Ben Wing.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
4 Copyright (C) 1995 Sun Microsystems, Inc.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
5
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
6 This file is part of XEmacs.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
7
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
8 XEmacs is free software; you can redistribute it and/or modify it
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
10 Free Software Foundation; either version 2, or (at your option) any
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
11 later version.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
12
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
16 for more details.
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
17
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
19 along with XEmacs; see the file COPYING. If not, write to
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
21 Boston, MA 02111-1307, USA. */
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
22
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
23 /* Synched up with: Not in FSF. */
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
24
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
25 /* Written by kkm on 12/24/97 */
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
26
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
27 #ifndef _XEMACS_GUI_H_
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
28 #define _XEMACS_GUI_H_
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
29
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
30 #ifdef HAVE_POPUPS
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
31 int separator_string_p (CONST char *s);
288
e11d67e05968 Import from CVS: tag r21-0b42
cvs
parents: 286
diff changeset
32 void get_gui_callback (Lisp_Object, Lisp_Object *, Lisp_Object *);
286
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 272
diff changeset
33
231
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
34 extern int popup_up_p;
251
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
35
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
36 /* This structure describes gui button,
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
37 menu item or submenu properties */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
38 struct gui_item
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
39 {
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
40 Lisp_Object name; /* String */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
41 Lisp_Object callback; /* Symbol or form */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
42 Lisp_Object suffix; /* String */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
43 Lisp_Object active; /* Form */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
44 Lisp_Object included; /* Form */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
45 Lisp_Object config; /* Anything EQable */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
46 Lisp_Object filter; /* Form */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
47 Lisp_Object style; /* Symbol */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
48 Lisp_Object selected; /* Form */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
49 Lisp_Object keys; /* String */
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
50 };
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
51 #define GUI_ITEM_LAST_GCPROED keys
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
52 #define GUI_ITEM_GCPRO_COUNT \
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
53 (slot_offset(struct gui_item, GUI_ITEM_LAST_GCPROED) / sizeof(Lisp_Object) + 1)
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
54
269
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
55 /*
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
56 * gui_item is a struct containing a bunch of Lisp_Object
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
57 * members. We need to GC-protect all the member slots.
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
58 * Rather than build a long chain of individual gcpro structs
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
59 * that protect the slots individually, we protect all the
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
60 * member slots by pretending the struct is an array. ANSI C
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
61 * requires this hack to work, ugly though it is.
269
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
62 */
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
63 #define GCPRO_GUI_ITEM(pgui_item) \
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
64 do { \
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
65 Lisp_Object *gui_item_array = (Lisp_Object *) pgui_item; \
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
66 GCPRO1 (gui_item_array[0]); \
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
67 gcpro1.nvars = GUI_ITEM_GCPRO_COUNT; \
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
68 } while (0);
b2472a1930f2 Import from CVS: tag r20-5b33
cvs
parents: 251
diff changeset
69
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
70 extern Lisp_Object Q_accelerator, Q_active, Q_config, Q_filter, Q_included;
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
71 extern Lisp_Object Q_keys, Q_selected, Q_suffix, Qradio, Qtoggle;
321
19dcec799385 Import from CVS: tag r21-0-58
cvs
parents: 288
diff changeset
72 extern Lisp_Object Q_key_sequence, Q_label;
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
73
251
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
74 void gui_item_init (struct gui_item *pgui_item);
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
75 void gui_item_add_keyval_pair (struct gui_item *pgui_item,
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
76 Lisp_Object key, Lisp_Object val);
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
77 void gui_parse_item_keywords (Lisp_Object item, struct gui_item *pgui_item);
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
78 int gui_item_active_p (CONST struct gui_item *pgui_item);
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
79 int gui_item_included_p (CONST struct gui_item *pgui_item, Lisp_Object into);
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
80 unsigned int gui_item_display_flush_left (CONST struct gui_item *pgui_item,
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
81 char* buf, Bytecount buf_len);
251
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
82 unsigned int gui_item_display_flush_right (CONST struct gui_item *pgui_item,
272
c5d627a313b1 Import from CVS: tag r21-0b34
cvs
parents: 269
diff changeset
83 char* buf, Bytecount buf_len);
251
677f6a0ee643 Import from CVS: tag r20-5b24
cvs
parents: 231
diff changeset
84
231
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
85 #endif /* HAVE_POPUPS */
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
86
557eaa0339bf Import from CVS: tag r20-5b14
cvs
parents:
diff changeset
87 #endif /* _XEMACS_GUI_H_ */