annotate lwlib/lwlib.h @ 78:c7528f8e288d r20-0b34

Import from CVS: tag r20-0b34
author cvs
date Mon, 13 Aug 2007 09:05:42 +0200
parents 376386a54a3c
children 2d532a89d707
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 #ifndef LWLIB_H
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 #define LWLIB_H
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 #include <X11/Intrinsic.h>
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 /* To eliminate use of `const' in the lwlib sources, define CONST_IS_LOSING. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 #undef CONST
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 #ifdef CONST_IS_LOSING
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 # define CONST
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 #else
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 # define CONST const
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 #if defined (MENUBARS_LUCID) || defined (MENUBARS_MOTIF) || defined (MENUBARS_ATHENA)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 #define NEED_MENUBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 #if defined (SCROLLBARS_LUCID) || defined (SCROLLBARS_MOTIF) || defined (SCROLLBARS_ATHENA)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 #define NEED_SCROLLBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 #if defined (DIALOGS_LUCID) || defined (DIALOGS_MOTIF) || defined (DIALOGS_ATHENA)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 #define NEED_DIALOGS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 /*
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 ** Widget values depend on the Widget type:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 **
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 ** widget: (name value key enabled data contents/selected)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 **
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 ** label: ("name" "string" NULL NULL NULL NULL)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 ** BUTTON: ("name" "string" "key" T/F data <default-button-p>)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 ** CASCADE (button w/menu):
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 ** ("name" "string" "key" T/F data (label|button|button w/menu...))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 ** INCREMENTAL (button w/menu construction callback):
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 ** ("name" "string" NULL T/F <opaque pointer>)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 ** menubar: ("name" NULL NULL T/F data (button w/menu))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 ** scrollbar:("name" NULL NULL T/F NULL NULL)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 ** selectable thing:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 ** ("name" "string" "key" T/F data T/F)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 ** checkbox: selectable thing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 ** radio: ("name" NULL NULL T/F data (selectable thing...))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 ** strings: ("name" NULL NULL T/F data (selectable thing...))
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 ** TEXT: ("name" "string" <ign> T/F data)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 **
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 ** Note that the above is EXTREMELY bogus. The "type" of the various entities
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 ** that a widget_value structure can represent is implicit in the contents of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 ** half a dozen slots, instead of there simply being a type field. This
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 ** should all be rethunk. I've added a type field, but for now it's only used
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 ** by the new xlwmenu code.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 typedef unsigned long LWLIB_ID;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 typedef enum _change_type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 NO_CHANGE = 0,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 INVISIBLE_CHANGE = 1,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 VISIBLE_CHANGE = 2,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 STRUCTURAL_CHANGE = 3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 } change_type;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 typedef enum _widget_value_type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 UNSPECIFIED_TYPE = 0,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 BUTTON_TYPE = 1,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 TOGGLE_TYPE = 2,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 RADIO_TYPE = 3,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 TEXT_TYPE = 4,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 SEPARATOR_TYPE = 5,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 CASCADE_TYPE = 6,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 PUSHRIGHT_TYPE = 7,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 INCREMENTAL_TYPE = 8
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 } widget_value_type;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 typedef enum _scroll_action
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 SCROLLBAR_LINE_UP = 0,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 SCROLLBAR_LINE_DOWN = 1,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 SCROLLBAR_PAGE_UP = 2,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 SCROLLBAR_PAGE_DOWN = 3,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 SCROLLBAR_DRAG = 4,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 SCROLLBAR_CHANGE = 5,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 SCROLLBAR_TOP = 6,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 SCROLLBAR_BOTTOM = 7
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 } scroll_action;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 typedef struct _scroll_event
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 scroll_action action;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 int slider_value;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 Time time;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 } scroll_event;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 typedef struct _scrollbar_values
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 int line_increment;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 int page_increment;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 int minimum;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 int maximum;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 int slider_size;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 int slider_position;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 int scrollbar_width, scrollbar_height;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 int scrollbar_x, scrollbar_y;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 } scrollbar_values;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 typedef struct _widget_value
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 {
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 /* This slot is only partially utilized right now. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 widget_value_type type;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 /* name of widget */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 char* name;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 /* value (meaning BOGUSLY depend on widget type) */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 char* value;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117 /* keyboard equivalent. no implications for XtTranslations */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 char* key;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 /* true if enabled */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 Boolean enabled;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 /* true if selected */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122 Boolean selected;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 /* true if was edited (maintained by get_value) */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124 Boolean edited;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 /* true if has changed (maintained by lw library) */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 change_type change;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 /* Contents of the sub-widgets, also selected slot for checkbox */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 struct _widget_value* contents;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 /* data passed to callback */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 XtPointer call_data;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 /* next one in the list */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132 struct _widget_value* next;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 /* slot for the toolkit dependent part. Always initialize to NULL. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 void* toolkit_data;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 /* tell us if we should free the toolkit data slot when freeing the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136 widget_value itself. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 Boolean free_toolkit_data;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 /* data defining a scrollbar; only valid if type == "scrollbar" */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 scrollbar_values *scrollbar_data;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 /* we resource the widget_value structures; this points to the next
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 one on the free list if this one has been deallocated.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 struct _widget_value *free_list;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 } widget_value;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 typedef void (*lw_callback) (Widget w, LWLIB_ID id, XtPointer data);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 void lw_register_widget (CONST char* type, CONST char* name, LWLIB_ID id,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 widget_value* val, lw_callback pre_activate_cb,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 lw_callback selection_cb,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 lw_callback post_activate_cb);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 Widget lw_get_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156 Widget lw_make_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 Widget lw_create_widget (CONST char* type, CONST char* name, LWLIB_ID id,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 widget_value* val, Widget parent, Boolean pop_up_p,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 lw_callback pre_activate_cb,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 lw_callback selection_cb,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161 lw_callback post_activate_cb);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 LWLIB_ID lw_get_widget_id (Widget w);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163 int lw_map_widget_values (LWLIB_ID id, int (*mapfunc) (widget_value *value,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 void *closure),
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165 void *closure);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 void lw_modify_all_widgets (LWLIB_ID id, widget_value* val, Boolean deep_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 void lw_destroy_widget (Widget w);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 void lw_destroy_all_widgets (LWLIB_ID id);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 void lw_destroy_everything (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170 void lw_destroy_all_pop_ups (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 Widget lw_raise_all_pop_up_widgets (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 widget_value* lw_get_all_values (LWLIB_ID id);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173 Boolean lw_get_some_values (LWLIB_ID id, widget_value* val);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
174 void lw_pop_up_all_widgets (LWLIB_ID id);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
175 void lw_pop_down_all_widgets (LWLIB_ID id);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
176
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
177 widget_value *malloc_widget_value (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178 void free_widget_value (widget_value *);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 widget_value *replace_widget_value_tree (widget_value*, widget_value*);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
180
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 void lw_popup_menu (Widget, XEvent *);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183 /* Toolkit independent way of focusing on a Widget at the Xt level. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 void lw_set_keyboard_focus (Widget parent, Widget w);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
186 /* Silly Energize hack to invert the "sheet" button */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
187 void lw_show_busy (Widget w, Boolean busy);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
188
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 #endif /* LWLIB_H */