(tex-validate-buffer): Use distinct strings rather than
[bpt/emacs.git] / lwlib / lwlib.h
CommitLineData
07bf635f
RS
1#ifndef LWLIB_H
2#define LWLIB_H
3
4#include <X11/Intrinsic.h>
5
6/*
7** Widget values depend on the Widget type:
177c0ea7 8**
07bf635f
RS
9** widget: (name value key enabled data contents/selected)
10**
11** label: ("name" "string" NULL NULL NULL NULL)
12** button: ("name" "string" "key" T/F data <default-button-p>)
177c0ea7 13** button w/menu:
07bf635f
RS
14** ("name" "string" "key" T/F data (label|button|button w/menu...))
15** menubar: ("name" NULL NULL T/F data (button w/menu))
16** selectable thing:
17** ("name" "string" "key" T/F data T/F)
18** checkbox: selectable thing
19** radio: ("name" NULL NULL T/F data (selectable thing...))
20** strings: ("name" NULL NULL T/F data (selectable thing...))
21** text: ("name" "string" <ign> T/F data)
dfdcaf49 22** main: ("name")
07bf635f
RS
23*/
24
25typedef unsigned long LWLIB_ID;
26
27typedef enum _change_type
28{
29 NO_CHANGE = 0,
30 INVISIBLE_CHANGE = 1,
31 VISIBLE_CHANGE = 2,
32 STRUCTURAL_CHANGE = 3
33} change_type;
34
cedccd2e
GM
35enum button_type
36{
37 BUTTON_TYPE_NONE,
38 BUTTON_TYPE_TOGGLE,
39 BUTTON_TYPE_RADIO
40};
41
42/* Menu separator types. */
43
44enum menu_separator
45{
46 /* These values are Motif compatible. */
47 SEPARATOR_NO_LINE,
48 SEPARATOR_SINGLE_LINE,
49 SEPARATOR_DOUBLE_LINE,
50 SEPARATOR_SINGLE_DASHED_LINE,
51 SEPARATOR_DOUBLE_DASHED_LINE,
52 SEPARATOR_SHADOW_ETCHED_IN,
53 SEPARATOR_SHADOW_ETCHED_OUT,
54 SEPARATOR_SHADOW_ETCHED_IN_DASH,
55 SEPARATOR_SHADOW_ETCHED_OUT_DASH,
56
0591102a 57 /* The following are supported by Lucid menus. */
cedccd2e
GM
58 SEPARATOR_SHADOW_DOUBLE_ETCHED_IN,
59 SEPARATOR_SHADOW_DOUBLE_ETCHED_OUT,
60 SEPARATOR_SHADOW_DOUBLE_ETCHED_IN_DASH,
61 SEPARATOR_SHADOW_DOUBLE_ETCHED_OUT_DASH
62};
63
07bf635f
RS
64typedef struct _widget_value
65{
66 /* name of widget */
67 char* name;
68 /* value (meaning depend on widget type) */
69 char* value;
177c0ea7 70 /* keyboard equivalent. no implications for XtTranslations */
07bf635f 71 char* key;
0591102a
RS
72 /* Help string or nil if none.
73 GC finds this string through the frame's menu_bar_vector
74 or through menu_items. */
75 Lisp_Object help;
07bf635f
RS
76 /* true if enabled */
77 Boolean enabled;
78 /* true if selected */
79 Boolean selected;
80 /* true if was edited (maintained by get_value) */
81 Boolean edited;
cedccd2e
GM
82 /* The type of a button. */
83 enum button_type button_type;
07bf635f
RS
84 /* true if has changed (maintained by lw library) */
85 change_type change;
63e9d970
RS
86 /* true if this widget itself has changed,
87 but not counting the other widgets found in the `next' field. */
88 change_type this_one_change;
07bf635f
RS
89 /* Contents of the sub-widgets, also selected slot for checkbox */
90 struct _widget_value* contents;
91 /* data passed to callback */
92 XtPointer call_data;
93 /* next one in the list */
94 struct _widget_value* next;
95 /* slot for the toolkit dependent part. Always initialize to NULL. */
96 void* toolkit_data;
97 /* tell us if we should free the toolkit data slot when freeing the
98 widget_value itself. */
99 Boolean free_toolkit_data;
100
101 /* we resource the widget_value structures; this points to the next
102 one on the free list if this one has been deallocated.
103 */
104 struct _widget_value *free_list;
105} widget_value;
106
107
99570665
DL
108typedef void (*lw_callback) __P ((Widget w, LWLIB_ID id, void* data));
109
110void lw_register_widget __P ((char* type, char* name, LWLIB_ID id,
111 widget_value* val, lw_callback pre_activate_cb,
112 lw_callback selection_cb,
113 lw_callback post_activate_cb,
114 lw_callback highlight_cb));
115Widget lw_get_widget __P ((LWLIB_ID id, Widget parent, Boolean pop_up_p));
116Widget lw_make_widget __P ((LWLIB_ID id, Widget parent, Boolean pop_up_p));
117Widget lw_create_widget __P ((char* type, char* name, LWLIB_ID id,
118 widget_value* val, Widget parent, Boolean pop_up_p,
119 lw_callback pre_activate_cb,
120 lw_callback selection_cb,
121 lw_callback post_activate_cb,
122 lw_callback highlight_cb));
123LWLIB_ID lw_get_widget_id __P ((Widget w));
124int lw_modify_all_widgets __P ((LWLIB_ID id, widget_value* val, Boolean deep_p));
125void lw_destroy_widget __P ((Widget w));
126void lw_destroy_all_widgets __P ((LWLIB_ID id));
127void lw_destroy_everything __P ((void));
128void lw_destroy_all_pop_ups __P ((void));
129Widget lw_raise_all_pop_up_widgets __P ((void));
130widget_value* lw_get_all_values __P ((LWLIB_ID id));
131Boolean lw_get_some_values __P ((LWLIB_ID id, widget_value* val));
132void lw_pop_up_all_widgets __P ((LWLIB_ID id));
133void lw_pop_down_all_widgets __P ((LWLIB_ID id));
07bf635f 134widget_value *malloc_widget_value ();
99570665
DL
135void free_widget_value __P ((widget_value *));
136void lw_popup_menu __P ((Widget, XEvent *));
07bf635f
RS
137
138/* Toolkit independent way of focusing on a Widget at the Xt level. */
99570665 139void lw_set_keyboard_focus __P ((Widget parent, Widget w));
07bf635f
RS
140
141/* Silly Energize hack to invert the "sheet" button */
99570665 142void lw_show_busy __P ((Widget w, Boolean busy));
dfdcaf49
PR
143
144/* Silly hack to assist with Lucid/Athena geometry management. */
99570665 145void lw_refigure_widget __P ((Widget w, Boolean doit));
dfdcaf49
PR
146
147/* Toolkit independent way of determining if an event occurred on a
148 menubar. */
99570665 149Boolean lw_window_is_in_menubar __P ((Window win, Widget menubar_widget));
dfdcaf49
PR
150
151/* Manage resizing: TRUE permits resizing widget w; FALSE disallows it. */
99570665 152void lw_allow_resizing __P ((Widget w, Boolean flag));
07bf635f 153
11bcd7d4 154/* Set up the main window. */
99570665 155void lw_set_main_areas __P ((Widget parent,
11bcd7d4 156 Widget menubar,
99570665 157 Widget work_area));
11bcd7d4 158
cedccd2e
GM
159/* Value is non-zero if LABEL is a menu separator. If it is, *TYPE is
160 set to an appropriate enumerator of type enum menu_separator.
161 MOTIF_P non-zero means map separator types not supported by Motif
162 to similar ones that are supported. */
163
99570665
DL
164int lw_separator_p __P ((char *label, enum menu_separator *type,
165 int motif_p));
166
167void lwlib_bcopy __P ((char*, char*, int));
cedccd2e 168
07bf635f 169#endif /* LWLIB_H */
ab5796a9
MB
170
171/* arch-tag: 44d818d5-7eb2-4d87-acd7-b992bb0d5d20
172 (do not change this comment) */