2 * dialog.h -- common declarations for all dialog modules
4 * AUTHOR: Savio Lam (lam836@cs.cuhk.hk)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <sys/types.h>
34 * Colors in ncurses 1.9.9e do not work properly since foreground and
35 * background colors are OR'd rather than separately masked. This version
36 * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
37 * with standard curses. The simplest fix (to make this work with standard
38 * curses) uses the wbkgdset() function, not used in the original hack.
39 * Turn it off if we're building with 1.9.9e, since it just confuses things.
41 #if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
44 #define wbkgdset(w,p) /*nothing */
49 #define TR(params) _tracef params
54 #define BUF_SIZE (10*1024)
55 #define MIN(x,y) (x < y ? x : y)
56 #define MAX(x,y) (x > y ? x : y)
59 #define ACS_ULCORNER '+'
62 #define ACS_LLCORNER '+'
65 #define ACS_URCORNER '+'
68 #define ACS_LRCORNER '+'
83 #define ACS_UARROW '^'
86 #define ACS_DARROW 'v'
89 /* error return codes */
90 #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
96 chtype atr; /* Color attribute */
97 int fg; /* foreground */
98 int bg; /* background */
99 int hl; /* highlight this item */
103 const char *backtitle;
104 struct dialog_color screen;
105 struct dialog_color shadow;
106 struct dialog_color dialog;
107 struct dialog_color title;
108 struct dialog_color border;
109 struct dialog_color button_active;
110 struct dialog_color button_inactive;
111 struct dialog_color button_key_active;
112 struct dialog_color button_key_inactive;
113 struct dialog_color button_label_active;
114 struct dialog_color button_label_inactive;
115 struct dialog_color inputbox;
116 struct dialog_color inputbox_border;
117 struct dialog_color searchbox;
118 struct dialog_color searchbox_title;
119 struct dialog_color searchbox_border;
120 struct dialog_color position_indicator;
121 struct dialog_color menubox;
122 struct dialog_color menubox_border;
123 struct dialog_color item;
124 struct dialog_color item_selected;
125 struct dialog_color tag;
126 struct dialog_color tag_selected;
127 struct dialog_color tag_key;
128 struct dialog_color tag_key_selected;
129 struct dialog_color check;
130 struct dialog_color check_selected;
131 struct dialog_color uarrow;
132 struct dialog_color darrow;
138 extern struct dialog_info dlg;
139 extern char dialog_input_result[];
142 * Function prototypes
145 /* item list as used by checklist and menubox */
146 void item_reset(void);
147 void item_make(const char *fmt, ...);
148 void item_add_str(const char *fmt, ...);
149 void item_set_tag(char tag);
150 void item_set_data(void *p);
151 void item_set_selected(int val);
152 int item_activate_selected(void);
153 void *item_data(void);
156 /* item list manipulation for lxdialog use */
157 #define MAXITEMSTR 200
159 char str[MAXITEMSTR]; /* promtp displayed */
161 void *data; /* pointer to menu item - used by menubox+checklist */
162 int selected; /* Set to 1 by dialog_*() function if selected. */
165 /* list of lialog_items */
167 struct dialog_item node;
168 struct dialog_list *next;
171 extern struct dialog_list *item_cur;
172 extern struct dialog_list item_nil;
173 extern struct dialog_list *item_head;
175 int item_count(void);
176 void item_set(int n);
178 const char *item_str(void);
179 int item_is_selected(void);
180 int item_is_tag(char tag);
181 #define item_foreach() \
182 for (item_cur = item_head ? item_head: item_cur; \
183 item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
185 /* generic key handlers */
186 int on_key_esc(WINDOW *win);
187 int on_key_resize(void);
189 void init_dialog(const char *backtitle);
190 void reset_dialog(void);
191 void end_dialog(void);
192 void attr_clear(WINDOW * win, int height, int width, chtype attr);
193 void dialog_clear(void);
194 void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
195 void print_button(WINDOW * win, const char *label, int y, int x, int selected);
196 void print_title(WINDOW *dialog, const char *title, int width);
197 void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
199 void draw_shadow(WINDOW * win, int y, int x, int height, int width);
201 int first_alpha(const char *string, const char *exempt);
202 int dialog_yesno(const char *title, const char *prompt, int height, int width);
203 int dialog_msgbox(const char *title, const char *prompt, int height,
204 int width, int pause);
205 int dialog_textbox(const char *title, const char *file, int height, int width);
206 int dialog_menu(const char *title, const char *prompt,
207 const void *selected, int *s_scroll);
208 int dialog_checklist(const char *title, const char *prompt, int height,
209 int width, int list_height);
210 extern char dialog_input_result[];
211 int dialog_inputbox(const char *title, const char *prompt, int height,
212 int width, const char *init);
215 * This is the base for fictitious keys, which activate
218 * Mouse-generated keys are the following:
219 * -- the first 32 are used as numbers, in addition to '0'-'9'
220 * -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
221 * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
223 #define M_EVENT (KEY_MAX+1)