1 #ifndef INCLUDED_lwlib_h_
2 #define INCLUDED_lwlib_h_
4 #include <X11/Intrinsic.h>
6 #if defined (LWLIB_MENUBARS_LUCID) || defined (LWLIB_MENUBARS_MOTIF) || defined (LWLIB_MENUBARS_ATHENA)
9 #if defined (LWLIB_SCROLLBARS_LUCID) || defined (LWLIB_SCROLLBARS_MOTIF) || defined (LWLIB_SCROLLBARS_ATHENA)
10 #define NEED_SCROLLBARS
12 #if defined (LWLIB_DIALOGS_LUCID) || defined (LWLIB_DIALOGS_MOTIF) || defined (LWLIB_DIALOGS_ATHENA)
17 ** Widget values depend on the Widget type:
19 ** widget: (name value key enabled data contents/selected)
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)
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)
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.
43 typedef unsigned long LWLIB_ID;
45 typedef enum _change_type
53 typedef enum _widget_value_type
66 typedef enum _scroll_action
68 SCROLLBAR_LINE_UP = 0,
69 SCROLLBAR_LINE_DOWN = 1,
70 SCROLLBAR_PAGE_UP = 2,
71 SCROLLBAR_PAGE_DOWN = 3,
78 typedef struct _scroll_event
85 typedef struct _scrollbar_values
96 int scrollbar_width, scrollbar_height;
97 int scrollbar_x, scrollbar_y;
100 typedef struct _widget_args
102 /* some things are only possible at creation time. args are applied
103 to widgets at creation time. */
106 /* Copying args is impossible so we make the caller give us heap allocated
107 args and free them when on-one wants them any more. */
111 typedef struct _widget_value
113 /* This slot is only partially utilized right now. */
114 widget_value_type type;
118 /* value (meaning BOGUSLY depend on widget type) */
120 /* keyboard equivalent. no implications for XtTranslations */
122 /* accelerator key. For XEmacs, this should be a Lisp_Object holding a
123 char or symbol suitable for passing to event_matches_key_specifier_p.
124 Outside of emacs, this can be anything: an X KeySym is a good idea.
125 lwlib provides support functions for keyboard traversal of menus. Actual
126 implementation of those accelerators is up to the application.
129 /* true if enabled */
131 /* true if selected */
133 /* true if was edited (maintained by get_value) */
135 /* true if has changed (maintained by lw library) */
137 /* Contents of the sub-widgets, also selected slot for checkbox */
138 struct _widget_value* contents;
139 /* data passed to callback */
141 /* next one in the list */
142 struct _widget_value* next;
143 /* slot for the toolkit dependent part. Always initialize to NULL. */
145 /* tell us if we should free the toolkit data slot when freeing the
146 widget_value itself. */
147 Boolean free_toolkit_data;
149 /* data defining a scrollbar; only valid if type == "scrollbar" */
150 scrollbar_values *scrollbar_data;
152 /* A reference counted arg structure. */
153 struct _widget_args *args;
154 /* we resource the widget_value structures; this points to the next
155 one on the free list if this one has been deallocated. */
156 struct _widget_value *free_list;
161 typedef void (*lw_callback) (Widget w, LWLIB_ID id, XtPointer data);
164 /* maybe this should go into a generic lwmenu.h */
166 extern int lw_menu_active;
168 #if defined (LWLIB_MENUBARS_LUCID)
170 #define lw_set_menu xlw_set_menu
171 #define lw_push_menu xlw_push_menu
172 #define lw_pop_menu xlw_pop_menu
173 #define lw_set_item xlw_set_item
174 #define lw_map_menu xlw_map_menu
175 #define lw_display_menu xlw_display_menu
176 #define lw_kill_menus xlw_kill_menus
177 #define lw_get_entries xlw_get_entries
178 #define lw_menu_level xlw_menu_level
179 #else /* LWLIB_MENUBARS_LUCID */
180 /* do this for the other toolkits too */
181 #endif /* LWLIB_MENUBARS_LUCID */
183 #if defined (LWLIB_TABS_LUCID)
187 void lw_register_widget (const char* type, const char* name, LWLIB_ID id,
188 widget_value* val, lw_callback pre_activate_cb,
189 lw_callback selection_cb,
190 lw_callback post_activate_cb);
191 Widget lw_get_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
192 Widget lw_make_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
193 Widget lw_create_widget (const char* type, const char* name, LWLIB_ID id,
194 widget_value* val, Widget parent, Boolean pop_up_p,
195 lw_callback pre_activate_cb,
196 lw_callback selection_cb,
197 lw_callback post_activate_cb);
198 LWLIB_ID lw_get_widget_id (Widget w);
199 int lw_map_widget_values (LWLIB_ID id, int (*mapfunc) (widget_value *value,
202 void lw_modify_all_widgets (LWLIB_ID id, widget_value* val, Boolean deep_p);
203 void lw_destroy_widget (Widget w);
204 void lw_destroy_all_widgets (LWLIB_ID id);
205 void lw_destroy_everything (void);
206 void lw_destroy_all_pop_ups (void);
207 Widget lw_raise_all_pop_up_widgets (void);
208 widget_value* lw_get_all_values (LWLIB_ID id);
209 Boolean lw_get_some_values (LWLIB_ID id, widget_value* val);
210 void lw_pop_up_all_widgets (LWLIB_ID id);
211 void lw_pop_down_all_widgets (LWLIB_ID id);
212 void lw_add_value_args_to_args (widget_value* wv, ArgList addto, int* offset);
213 void lw_add_widget_value_arg (widget_value* wv, String name, XtArgVal value);
214 void lw_copy_widget_value_args (widget_value* copy, widget_value* val);
216 widget_value *malloc_widget_value (void);
217 void free_widget_value (widget_value *);
218 void free_widget_value_tree (widget_value *wv);
219 widget_value *replace_widget_value_tree (widget_value*, widget_value*);
221 void lw_popup_menu (Widget, XEvent *);
223 /* Toolkit independent way of focusing on a Widget at the Xt level. */
224 void lw_set_keyboard_focus (Widget parent, Widget w);
226 /* Silly Energize hack to invert the "sheet" button */
227 void lw_show_busy (Widget w, Boolean busy);
229 #endif /* INCLUDED_lwlib_h_ */