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>
32 # define gettext(Msgid) ((const char *) (Msgid))
41 * Colors in ncurses 1.9.9e do not work properly since foreground and
42 * background colors are OR'd rather than separately masked. This version
43 * of dialog was hacked to work with ncurses 1.9.9e, making it incompatible
44 * with standard curses. The simplest fix (to make this work with standard
45 * curses) uses the wbkgdset() function, not used in the original hack.
46 * Turn it off if we're building with 1.9.9e, since it just confuses things.
48 #if defined(NCURSES_VERSION) && defined(_NEED_WRAP) && !defined(GCC_PRINTFLIKE)
51 #define wbkgdset(w,p) /*nothing */
56 #define TR(params) _tracef params
61 #define BUF_SIZE (10*1024)
62 #define MIN(x,y) (x < y ? x : y)
63 #define MAX(x,y) (x > y ? x : y)
66 #define ACS_ULCORNER '+'
69 #define ACS_LLCORNER '+'
72 #define ACS_URCORNER '+'
75 #define ACS_LRCORNER '+'
90 #define ACS_UARROW '^'
93 #define ACS_DARROW 'v'
96 /* error return codes */
97 #define ERRDISPLAYTOOSMALL (KEY_MAX + 1)
102 struct dialog_color {
103 chtype atr; /* Color attribute */
104 int fg; /* foreground */
105 int bg; /* background */
106 int hl; /* highlight this item */
109 struct subtitle_list {
110 struct subtitle_list *next;
115 const char *backtitle;
116 struct subtitle_list *subtitles;
117 struct dialog_color screen;
118 struct dialog_color shadow;
119 struct dialog_color dialog;
120 struct dialog_color title;
121 struct dialog_color border;
122 struct dialog_color button_active;
123 struct dialog_color button_inactive;
124 struct dialog_color button_key_active;
125 struct dialog_color button_key_inactive;
126 struct dialog_color button_label_active;
127 struct dialog_color button_label_inactive;
128 struct dialog_color inputbox;
129 struct dialog_color inputbox_border;
130 struct dialog_color searchbox;
131 struct dialog_color searchbox_title;
132 struct dialog_color searchbox_border;
133 struct dialog_color position_indicator;
134 struct dialog_color menubox;
135 struct dialog_color menubox_border;
136 struct dialog_color item;
137 struct dialog_color item_selected;
138 struct dialog_color tag;
139 struct dialog_color tag_selected;
140 struct dialog_color tag_key;
141 struct dialog_color tag_key_selected;
142 struct dialog_color check;
143 struct dialog_color check_selected;
144 struct dialog_color uarrow;
145 struct dialog_color darrow;
151 extern struct dialog_info dlg;
152 extern char dialog_input_result[];
153 extern int saved_x, saved_y; /* Needed in signal handler in mconf.c */
156 * Function prototypes
159 /* item list as used by checklist and menubox */
160 void item_reset(void);
161 void item_make(const char *fmt, ...);
162 void item_add_str(const char *fmt, ...);
163 void item_set_tag(char tag);
164 void item_set_data(void *p);
165 void item_set_selected(int val);
166 int item_activate_selected(void);
167 void *item_data(void);
170 /* item list manipulation for lxdialog use */
171 #define MAXITEMSTR 200
173 char str[MAXITEMSTR]; /* promtp displayed */
175 void *data; /* pointer to menu item - used by menubox+checklist */
176 int selected; /* Set to 1 by dialog_*() function if selected. */
179 /* list of lialog_items */
181 struct dialog_item node;
182 struct dialog_list *next;
185 extern struct dialog_list *item_cur;
186 extern struct dialog_list item_nil;
187 extern struct dialog_list *item_head;
189 int item_count(void);
190 void item_set(int n);
192 const char *item_str(void);
193 int item_is_selected(void);
194 int item_is_tag(char tag);
195 #define item_foreach() \
196 for (item_cur = item_head ? item_head: item_cur; \
197 item_cur && (item_cur != &item_nil); item_cur = item_cur->next)
199 /* generic key handlers */
200 int on_key_esc(WINDOW *win);
201 int on_key_resize(void);
203 int init_dialog(const char *backtitle);
204 void set_dialog_backtitle(const char *backtitle);
205 void set_dialog_subtitles(struct subtitle_list *subtitles);
206 void end_dialog(int x, int y);
207 void attr_clear(WINDOW * win, int height, int width, chtype attr);
208 void dialog_clear(void);
209 void print_autowrap(WINDOW * win, const char *prompt, int width, int y, int x);
210 void print_button(WINDOW * win, const char *label, int y, int x, int selected);
211 void print_title(WINDOW *dialog, const char *title, int width);
212 void draw_box(WINDOW * win, int y, int x, int height, int width, chtype box,
214 void draw_shadow(WINDOW * win, int y, int x, int height, int width);
216 int first_alpha(const char *string, const char *exempt);
217 int dialog_yesno(const char *title, const char *prompt, int height, int width);
218 int dialog_msgbox(const char *title, const char *prompt, int height,
219 int width, int pause);
222 typedef void (*update_text_fn)(char *buf, size_t start, size_t end, void
224 int dialog_textbox(const char *title, char *tbuf, int initial_height,
225 int initial_width, int *keys, int *_vscroll, int *_hscroll,
226 update_text_fn update_text, void *data);
227 int dialog_menu(const char *title, const char *prompt,
228 const void *selected, int *s_scroll);
229 int dialog_checklist(const char *title, const char *prompt, int height,
230 int width, int list_height);
231 int dialog_inputbox(const char *title, const char *prompt, int height,
232 int width, const char *init);
235 * This is the base for fictitious keys, which activate
238 * Mouse-generated keys are the following:
239 * -- the first 32 are used as numbers, in addition to '0'-'9'
240 * -- the lowercase are used to signal mouse-enter events (M_EVENT + 'o')
241 * -- uppercase chars are used to invoke the button (M_EVENT + 'O')
243 #define M_EVENT (KEY_MAX+1)