1 #ifndef INCLUDED_lwlib_h_
2 #define INCLUDED_lwlib_h_
6 #include <X11/Intrinsic.h>
8 /* To eliminate use of `const' in the lwlib sources, define CONST_IS_LOSING. */
15 #if defined (LWLIB_MENUBARS_LUCID) || defined (LWLIB_MENUBARS_MOTIF) || defined (LWLIB_MENUBARS_ATHENA)
18 #if defined (LWLIB_SCROLLBARS_LUCID) || defined (LWLIB_SCROLLBARS_MOTIF) || defined (LWLIB_SCROLLBARS_ATHENA)
19 #define NEED_SCROLLBARS
21 #if defined (LWLIB_DIALOGS_LUCID) || defined (LWLIB_DIALOGS_MOTIF) || defined (LWLIB_DIALOGS_ATHENA)
26 ** Widget values depend on the Widget type:
28 ** widget: (name value key enabled data contents/selected)
30 ** label: ("name" "string" NULL NULL NULL NULL)
31 ** BUTTON: ("name" "string" "key" T/F data <default-button-p>)
32 ** CASCADE (button w/menu):
33 ** ("name" "string" "key" T/F data (label|button|button w/menu...))
34 ** INCREMENTAL (button w/menu construction callback):
35 ** ("name" "string" NULL T/F <opaque pointer>)
36 ** menubar: ("name" NULL NULL T/F data (button w/menu))
37 ** scrollbar:("name" NULL NULL T/F NULL NULL)
39 ** ("name" "string" "key" T/F data T/F)
40 ** checkbox: selectable thing
41 ** radio: ("name" NULL NULL T/F data (selectable thing...))
42 ** strings: ("name" NULL NULL T/F data (selectable thing...))
43 ** TEXT: ("name" "string" <ign> T/F data)
45 ** Note that the above is EXTREMELY bogus. The "type" of the various entities
46 ** that a widget_value structure can represent is implicit in the contents of
47 ** half a dozen slots, instead of there simply being a type field. This
48 ** should all be rethunk. I've added a type field, but for now it's only used
49 ** by the new xlwmenu code.
52 typedef unsigned long LWLIB_ID;
54 typedef enum _change_type
62 typedef enum _widget_value_type
75 typedef enum _scroll_action
77 SCROLLBAR_LINE_UP = 0,
78 SCROLLBAR_LINE_DOWN = 1,
79 SCROLLBAR_PAGE_UP = 2,
80 SCROLLBAR_PAGE_DOWN = 3,
87 typedef struct _scroll_event
94 typedef struct _scrollbar_values
105 int scrollbar_width, scrollbar_height;
106 int scrollbar_x, scrollbar_y;
109 typedef struct _widget_args
111 /* some things are only possible at creation time. args are applied
112 to widgets at creation time. */
115 /* Copying args is impossible so we make the caller give us heap allocated
116 args and free them when on-one wants them any more. */
120 typedef struct _widget_value
122 /* This slot is only partially utilized right now. */
123 widget_value_type type;
127 /* value (meaning BOGUSLY depend on widget type) */
129 /* keyboard equivalent. no implications for XtTranslations */
131 /* accelerator key. For XEmacs, this should be a Lisp_Object holding a
132 char or symbol suitable for passing to event_matches_key_specifier_p.
133 Outside of emacs, this can be anything: an X KeySym is a good idea.
134 lwlib provides support functions for keyboard traversal of menus. Actual
135 implementation of those accelerators is up to the application.
138 /* true if enabled */
140 /* true if selected */
142 /* true if was edited (maintained by get_value) */
144 /* true if has changed (maintained by lw library) */
146 /* Contents of the sub-widgets, also selected slot for checkbox */
147 struct _widget_value* contents;
148 /* data passed to callback */
150 /* next one in the list */
151 struct _widget_value* next;
152 /* slot for the toolkit dependent part. Always initialize to NULL. */
154 /* tell us if we should free the toolkit data slot when freeing the
155 widget_value itself. */
156 Boolean free_toolkit_data;
158 /* data defining a scrollbar; only valid if type == "scrollbar" */
159 scrollbar_values *scrollbar_data;
161 /* A reference counted arg structure. */
162 struct _widget_args *args;
163 /* we resource the widget_value structures; this points to the next
164 one on the free list if this one has been deallocated. */
165 struct _widget_value *free_list;
170 typedef void (*lw_callback) (Widget w, LWLIB_ID id, XtPointer data);
173 /* maybe this should go into a generic lwmenu.h */
175 extern int lw_menu_active;
177 #if defined (LWLIB_MENUBARS_LUCID)
179 #define lw_set_menu xlw_set_menu
180 #define lw_push_menu xlw_push_menu
181 #define lw_pop_menu xlw_pop_menu
182 #define lw_set_item xlw_set_item
183 #define lw_map_menu xlw_map_menu
184 #define lw_display_menu xlw_display_menu
185 #define lw_kill_menus xlw_kill_menus
186 #define lw_get_entries xlw_get_entries
187 #define lw_menu_level xlw_menu_level
188 #else /* LWLIB_MENUBARS_LUCID */
189 /* do this for the other toolkits too */
190 #endif /* LWLIB_MENUBARS_LUCID */
192 #if defined (LWLIB_TABS_LUCID)
196 void lw_register_widget (CONST char* type, CONST char* name, LWLIB_ID id,
197 widget_value* val, lw_callback pre_activate_cb,
198 lw_callback selection_cb,
199 lw_callback post_activate_cb);
200 Widget lw_get_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
201 Widget lw_make_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
202 Widget lw_create_widget (CONST char* type, CONST char* name, LWLIB_ID id,
203 widget_value* val, Widget parent, Boolean pop_up_p,
204 lw_callback pre_activate_cb,
205 lw_callback selection_cb,
206 lw_callback post_activate_cb);
207 LWLIB_ID lw_get_widget_id (Widget w);
208 int lw_map_widget_values (LWLIB_ID id, int (*mapfunc) (widget_value *value,
211 void lw_modify_all_widgets (LWLIB_ID id, widget_value* val, Boolean deep_p);
212 void lw_destroy_widget (Widget w);
213 void lw_destroy_all_widgets (LWLIB_ID id);
214 void lw_destroy_everything (void);
215 void lw_destroy_all_pop_ups (void);
216 Widget lw_raise_all_pop_up_widgets (void);
217 widget_value* lw_get_all_values (LWLIB_ID id);
218 Boolean lw_get_some_values (LWLIB_ID id, widget_value* val);
219 void lw_pop_up_all_widgets (LWLIB_ID id);
220 void lw_pop_down_all_widgets (LWLIB_ID id);
221 void lw_add_value_args_to_args (widget_value* wv, ArgList addto, int* offset);
222 void lw_add_widget_value_arg (widget_value* wv, String name, XtArgVal value);
223 void lw_copy_widget_value_args (widget_value* copy, widget_value* val);
225 widget_value *malloc_widget_value (void);
226 void free_widget_value (widget_value *);
227 void free_widget_value_tree (widget_value *wv);
228 widget_value *replace_widget_value_tree (widget_value*, widget_value*);
230 void lw_popup_menu (Widget, XEvent *);
232 /* Toolkit independent way of focusing on a Widget at the Xt level. */
233 void lw_set_keyboard_focus (Widget parent, Widget w);
235 /* Silly Energize hack to invert the "sheet" button */
236 void lw_show_busy (Widget w, Boolean busy);
238 #endif /* INCLUDED_lwlib_h_ */