(C6-2A23): Unify U-0002F82F; add `<-same' for JX1-2E71.
[chise/xemacs-chise.git.1] / lwlib / lwlib.h
1 #ifndef INCLUDED_lwlib_h_
2 #define INCLUDED_lwlib_h_
3
4 #include <X11/Intrinsic.h>
5
6 #if defined (LWLIB_MENUBARS_LUCID) || defined (LWLIB_MENUBARS_MOTIF) || defined (LWLIB_MENUBARS_ATHENA)
7 #define NEED_MENUBARS
8 #endif
9 #if defined (LWLIB_SCROLLBARS_LUCID) || defined (LWLIB_SCROLLBARS_MOTIF) || defined (LWLIB_SCROLLBARS_ATHENA)
10 #define NEED_SCROLLBARS
11 #endif
12 #if defined (LWLIB_DIALOGS_LUCID) || defined (LWLIB_DIALOGS_MOTIF) || defined (LWLIB_DIALOGS_ATHENA)
13 #define NEED_DIALOGS
14 #endif
15
16 /*
17 ** Widget values depend on the Widget type:
18 **
19 ** widget:   (name    value   key enabled data contents/selected)
20 **
21 ** label:    ("name" "string" NULL  NULL NULL NULL)
22 ** BUTTON:   ("name" "string" "key" T/F  data <default-button-p>)
23 ** CASCADE (button w/menu):
24 **           ("name" "string" "key" T/F  data (label|button|button w/menu...))
25 ** INCREMENTAL (button w/menu construction callback):
26 **           ("name" "string" NULL  T/F  <opaque pointer>)
27 ** menubar:  ("name" NULL     NULL  T/F  data (button w/menu))
28 ** scrollbar:("name" NULL     NULL  T/F  NULL NULL)
29 ** selectable thing:
30 **           ("name" "string" "key" T/F  data T/F)
31 ** checkbox: selectable thing
32 ** radio:    ("name" NULL     NULL  T/F  data (selectable thing...))
33 ** strings:  ("name" NULL     NULL  T/F  data (selectable thing...))
34 ** TEXT:     ("name" "string" <ign> T/F  data)
35 **
36 ** Note that the above is EXTREMELY bogus.  The "type" of the various entities
37 ** that a widget_value structure can represent is implicit in the contents of
38 ** half a dozen slots, instead of there simply being a type field.  This
39 ** should all be rethunk.  I've added a type field, but for now it's only used
40 ** by the new xlwmenu code.
41 */
42
43 typedef unsigned long LWLIB_ID;
44
45 typedef enum _change_type
46 {
47   NO_CHANGE = 0,
48   INVISIBLE_CHANGE = 1,
49   VISIBLE_CHANGE = 2,
50   STRUCTURAL_CHANGE = 3
51 } change_type;
52
53 typedef enum _widget_value_type
54 {
55   UNSPECIFIED_TYPE = 0,
56   BUTTON_TYPE = 1,
57   TOGGLE_TYPE = 2,
58   RADIO_TYPE = 3,
59   TEXT_TYPE = 4,
60   SEPARATOR_TYPE = 5,
61   CASCADE_TYPE = 6,
62   PUSHRIGHT_TYPE = 7,
63   INCREMENTAL_TYPE = 8
64 } widget_value_type;
65
66 typedef enum _scroll_action
67 {
68   SCROLLBAR_LINE_UP = 0,
69   SCROLLBAR_LINE_DOWN = 1,
70   SCROLLBAR_PAGE_UP = 2,
71   SCROLLBAR_PAGE_DOWN = 3,
72   SCROLLBAR_DRAG = 4,
73   SCROLLBAR_CHANGE = 5,
74   SCROLLBAR_TOP = 6,
75   SCROLLBAR_BOTTOM = 7
76 } scroll_action;
77
78 typedef struct _scroll_event
79 {
80   scroll_action action;
81   int slider_value;
82   Time time;
83 } scroll_event;
84
85 typedef struct _scrollbar_values
86 {
87   int line_increment;
88   int page_increment;
89
90   int minimum;
91   int maximum;
92
93   int slider_size;
94   int slider_position;
95
96   int scrollbar_width, scrollbar_height;
97   int scrollbar_x, scrollbar_y;
98 } scrollbar_values;
99
100 typedef struct _widget_args
101 {
102   /* some things are only possible at creation time. args are applied
103      to widgets at creation time.  */
104   ArgList args;
105   int   nargs;
106   /* Copying args is impossible so we make the caller give us heap allocated
107      args and free them when no one wants them any more. */
108   int   ref_count;
109   /* Since we are reference counting we need to be able to determine
110      when something has changed. */
111   Boolean       args_changed;
112 } widget_args;
113
114 typedef struct _widget_value
115 {
116   /* This slot is only partially utilized right now. */
117   widget_value_type type;
118
119   /* name of widget */
120   char*         name;
121   /* value (meaning BOGUSLY depends on widget type) */
122   char*         value;
123   /* keyboard equivalent. no implications for XtTranslations */
124   char*         key;
125   /* accelerator key.  For XEmacs, this should be a Lisp_Object holding a
126      char or symbol suitable for passing to event_matches_key_specifier_p.
127      Outside of emacs, this can be anything: an X KeySym is a good idea.
128      lwlib provides support functions for keyboard traversal of menus.  Actual
129      implementation of those accelerators is up to the application.
130      */
131   XtPointer     accel;
132   /* true if enabled */
133   Boolean       enabled;
134   /* true if selected */
135   Boolean       selected;
136   /* true if was edited (maintained by get_value) */
137   Boolean       edited;
138   /* true if has changed (maintained by lw library) */
139   change_type   change;
140   /* Contents of sub-widgets, also selected slot for checkbox */
141   struct _widget_value* contents;
142   /* data passed to callback */
143   XtPointer     call_data;
144   /* next in the list of siblings */
145   struct _widget_value* next;
146   /* slot for the toolkit dependent part.  Always initialize to NULL. */
147   void* toolkit_data;
148   /* tell us if we should free the toolkit data slot when freeing the
149      widget_value itself. */
150   Boolean free_toolkit_data;
151
152   /* data defining a scrollbar; only valid if type == "scrollbar" */
153   scrollbar_values *scrollbar_data;
154
155   /* A reference counted arg structure. */
156   struct _widget_args *args;
157   /* we resource the widget_value structures; this points to the next
158      one on the free list if this one has been deallocated.  */
159   struct _widget_value *free_list;
160
161 } widget_value;
162
163
164 typedef void (*lw_callback) (Widget w, LWLIB_ID id, XtPointer data);
165
166 /* menu stuff */
167 /* maybe this should go into a generic lwmenu.h */
168
169 extern int lw_menu_active;
170
171 #if defined (LWLIB_MENUBARS_LUCID)
172 #include "xlwmenu.h"
173 #define lw_set_menu xlw_set_menu
174 #define lw_push_menu xlw_push_menu
175 #define lw_pop_menu xlw_pop_menu
176 #define lw_set_item xlw_set_item
177 #define lw_map_menu xlw_map_menu
178 #define lw_display_menu xlw_display_menu
179 #define lw_kill_menus xlw_kill_menus
180 #define lw_get_entries xlw_get_entries
181 #define lw_menu_level xlw_menu_level
182 #else /* LWLIB_MENUBARS_LUCID */
183 /* do this for the other toolkits too */
184 #endif /* LWLIB_MENUBARS_LUCID */
185
186 #if defined (LWLIB_TABS_LUCID)
187 #include "xlwtabs.h"
188 #endif
189
190 void  lw_register_widget (const char* type, const char* name, LWLIB_ID id,
191                           widget_value* val, lw_callback pre_activate_cb,
192                           lw_callback selection_cb,
193                           lw_callback post_activate_cb);
194 Widget lw_get_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
195 Widget lw_make_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
196 Widget lw_create_widget (const char* type, const char* name, LWLIB_ID id,
197                          widget_value* val, Widget parent, Boolean pop_up_p,
198                          lw_callback pre_activate_cb,
199                          lw_callback selection_cb,
200                          lw_callback post_activate_cb);
201 LWLIB_ID lw_get_widget_id (Widget w);
202 int lw_map_widget_values (LWLIB_ID id, int (*mapfunc) (widget_value *value,
203                                                        void *closure),
204                           void *closure);
205 void lw_modify_all_widgets (LWLIB_ID id, widget_value* val, Boolean deep_p);
206 void lw_destroy_widget (Widget w);
207 void lw_destroy_all_widgets (LWLIB_ID id);
208 void lw_destroy_everything (void);
209 void lw_destroy_all_pop_ups (void);
210 Widget lw_raise_all_pop_up_widgets (void);
211 widget_value* lw_get_all_values (LWLIB_ID id);
212 Boolean lw_get_some_values (LWLIB_ID id, widget_value* val);
213 void lw_pop_up_all_widgets (LWLIB_ID id);
214 void lw_pop_down_all_widgets (LWLIB_ID id);
215 void lw_add_value_args_to_args (widget_value* wv, ArgList addto, int* offset);
216 void lw_add_widget_value_arg (widget_value* wv, String name, XtArgVal value);
217 XtArgVal lw_get_value_arg (widget_value* wv, String name);
218 void lw_copy_widget_value_args (widget_value* copy, widget_value* val);
219 widget_value * copy_widget_value_tree (widget_value *val, change_type change);
220
221 widget_value *malloc_widget_value (void);
222 void free_widget_value (widget_value *);
223 void free_widget_value_tree (widget_value *wv);
224 widget_value *replace_widget_value_tree (widget_value*, widget_value*);
225
226 void lw_popup_menu (Widget, XEvent *);
227
228 /* Toolkit independent way of focusing on a Widget at the Xt level. */
229 void lw_set_keyboard_focus (Widget parent, Widget w);
230
231  /* Silly Energize hack to invert the "sheet" button */
232 void lw_show_busy (Widget w, Boolean busy);
233
234 void lw_remove_accelerator_spec (char *val);
235
236 #endif /* INCLUDED_lwlib_h_ */