2 * $Id: treeview.c,v 1.24 2013/09/02 17:13:33 tom Exp $
4 * treeview.c -- implements the treeview dialog
6 * Copyright 2012,2013 Thomas E. Dickey
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License, version 2.1
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this program; if not, write to
19 * Free Software Foundation, Inc.
20 * 51 Franklin St., Fifth Floor
21 * Boston, MA 02110, USA.
28 #define MIN_HIGH (1 + (5 * MARGIN))
31 /* the outer-window */
40 /* the inner-window */
42 DIALOG_LISTITEM *items;
49 * Print list item. The 'selected' parameter is true if 'choice' is the
50 * current item. That one is colored differently from the other items.
53 print_item(ALL_DATA * data,
54 DIALOG_LISTITEM * item,
60 WINDOW *win = data->list;
61 chtype save = dlg_get_attrs(win);
64 int climit = (getmaxx(win) - data->check_x + 1);
65 const char *show = (dialog_vars.no_items
69 /* Clear 'residue' of last item */
70 (void) wattrset(win, menubox_attr);
71 (void) wmove(win, choice, 0);
72 for (i = 0; i < data->use_width; i++)
73 (void) waddch(win, ' ');
75 (void) wmove(win, choice, data->check_x);
76 (void) wattrset(win, selected ? check_selected_attr : check_attr);
78 data->is_check ? "[%c]" : "(%c)",
80 (void) wattrset(win, menubox_attr);
82 (void) wattrset(win, selected ? item_selected_attr : item_attr);
83 for (i = 0; i < depths; ++i) {
85 (void) wmove(win, choice, data->item_x + INDENT * i);
86 (void) waddch(win, ACS_VLINE);
87 for (j = INDENT - 1; j > 0; --j)
88 (void) waddch(win, ' ');
90 (void) wmove(win, choice, data->item_x + INDENT * depths);
92 dlg_print_listitem(win, show, climit, first, selected);
95 dlg_item_help(item->help);
97 (void) wattrset(win, save);
101 print_list(ALL_DATA * data,
109 getyx(data->dialog, cur_y, cur_x);
111 for (i = 0; i < max_choice; i++) {
113 &data->items[scrollamt + i],
115 data->depths[scrollamt + i],
118 (void) wnoutrefresh(data->list);
120 dlg_draw_scrollbar(data->dialog,
123 (long) (scrollamt + max_choice),
124 (long) (data->item_no),
125 data->box_x + data->check_x,
126 data->box_x + data->use_width,
128 data->box_y + data->use_height + 1,
129 menubox_border2_attr,
130 menubox_border_attr);
132 (void) wmove(data->dialog, cur_y, cur_x);
136 check_hotkey(DIALOG_LISTITEM * items, int choice)
140 if (dlg_match_char(dlg_last_getc(),
143 : items[choice].name))) {
150 * This is an alternate interface to 'treeview' which allows the application
151 * to read the list item states back directly without putting them in the
155 dlg_treeview(const char *title,
161 DIALOG_LISTITEM * items,
168 static DLG_KEYS_BINDING binding[] = {
171 DLG_KEYS_DATA( DLGK_FIELD_NEXT, KEY_RIGHT ),
172 DLG_KEYS_DATA( DLGK_FIELD_NEXT, TAB ),
173 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_BTAB ),
174 DLG_KEYS_DATA( DLGK_FIELD_PREV, KEY_LEFT ),
175 DLG_KEYS_DATA( DLGK_ITEM_FIRST, KEY_HOME ),
176 DLG_KEYS_DATA( DLGK_ITEM_LAST, KEY_END ),
177 DLG_KEYS_DATA( DLGK_ITEM_LAST, KEY_LL ),
178 DLG_KEYS_DATA( DLGK_ITEM_NEXT, '+' ),
179 DLG_KEYS_DATA( DLGK_ITEM_NEXT, KEY_DOWN ),
180 DLG_KEYS_DATA( DLGK_ITEM_NEXT, CHR_NEXT ),
181 DLG_KEYS_DATA( DLGK_ITEM_PREV, '-' ),
182 DLG_KEYS_DATA( DLGK_ITEM_PREV, KEY_UP ),
183 DLG_KEYS_DATA( DLGK_ITEM_PREV, CHR_PREVIOUS ),
184 DLG_KEYS_DATA( DLGK_PAGE_NEXT, KEY_NPAGE ),
185 DLG_KEYS_DATA( DLGK_PAGE_NEXT, DLGK_MOUSE(KEY_NPAGE) ),
186 DLG_KEYS_DATA( DLGK_PAGE_PREV, KEY_PPAGE ),
187 DLG_KEYS_DATA( DLGK_PAGE_PREV, DLGK_MOUSE(KEY_PPAGE) ),
193 int old_height = height;
194 int old_width = width;
197 int i, j, key2, found, x, y, cur_y, box_x, box_y;
199 int button = dialog_state.visit_items ? -1 : dlg_default_button();
200 int choice = dlg_default_listitem(items);
205 int use_width, name_width, text_width, tree_width;
206 int result = DLG_EXIT_UNKNOWN;
208 WINDOW *dialog, *list;
209 char *prompt = dlg_strclone(cprompt);
210 const char **buttons = dlg_ok_labels();
211 const char *widget_name;
213 /* we need at least two states */
214 if (states == 0 || strlen(states) < 2)
216 num_states = (int) strlen(states);
218 memset(&all, 0, sizeof(all));
220 all.item_no = item_no;
225 dlg_tab_correct_str(prompt);
228 * If this is a radiobutton list, ensure that no more than one item is
229 * selected initially. Allow none to be selected, since some users may
230 * wish to provide this flavor.
232 if (flag == FLAG_RADIO) {
235 for (i = 0; i < item_no; i++) {
236 if (items[i].state) {
247 widget_name = "treeview";
252 use_height = list_height;
253 use_width = dlg_calc_list_width(item_no, items) + 10;
254 use_width = MAX(26, use_width);
255 if (use_height == 0) {
256 /* calculate height without items (4) */
257 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH, use_width);
258 dlg_calc_listh(&height, &use_height, item_no);
260 dlg_auto_size(title, prompt, &height, &width, MIN_HIGH + use_height, use_width);
262 dlg_button_layout(buttons, &width);
263 dlg_print_size(height, width);
264 dlg_ctl_size(height, width);
266 x = dlg_box_x_ordinate(width);
267 y = dlg_box_y_ordinate(height);
269 dialog = dlg_new_window(height, width, y, x);
270 dlg_register_window(dialog, widget_name, binding);
271 dlg_register_buttons(dialog, widget_name, buttons);
273 dlg_mouse_setbase(x, y);
275 dlg_draw_box2(dialog, 0, 0, height, width, dialog_attr, border_attr, border2_attr);
276 dlg_draw_bottom_box2(dialog, border_attr, border2_attr, dialog_attr);
277 dlg_draw_title(dialog, title);
279 (void) wattrset(dialog, dialog_attr);
280 dlg_print_autowrap(dialog, prompt, height, width);
282 all.use_width = width - 4;
283 cur_y = getcury(dialog);
285 box_x = (width - all.use_width) / 2 - 1;
288 * After displaying the prompt, we know how much space we really have.
289 * Limit the list to avoid overwriting the ok-button.
291 if (use_height + MIN_HIGH > height - cur_y)
292 use_height = height - MIN_HIGH - cur_y;
296 max_choice = MIN(use_height, item_no);
298 /* create new window for the list */
299 list = dlg_sub_window(dialog, use_height, all.use_width,
300 y + box_y + 1, x + box_x + 1);
302 /* draw a box around the list items */
303 dlg_draw_box(dialog, box_y, box_x,
304 use_height + 2 * MARGIN,
305 all.use_width + 2 * MARGIN,
306 menubox_border_attr, menubox_border2_attr);
311 /* Find length of longest item to center treeview */
312 for (i = 0; i < item_no; i++) {
313 tree_width = MAX(tree_width, INDENT * depths[i]);
314 text_width = MAX(text_width, dlg_count_columns(items[i].text));
315 name_width = MAX(name_width, dlg_count_columns(items[i].name));
317 if (dialog_vars.no_tags && !dialog_vars.no_items) {
318 tree_width += text_width;
319 } else if (dialog_vars.no_items) {
320 tree_width += name_width;
322 tree_width += (text_width + name_width);
325 use_width = (all.use_width - 4);
326 tree_width = MIN(tree_width, all.use_width);
328 all.check_x = (use_width - tree_width) / 2;
329 all.item_x = ((dialog_vars.no_tags
331 : (dialog_vars.no_items
336 /* ensure we are scrolled to show the current choice */
337 if (choice >= (max_choice + scrollamt)) {
338 scrollamt = choice - max_choice + 1;
339 choice = max_choice - 1;
342 /* register the new window, along with its borders */
343 dlg_mouse_mkbigregion(box_y + 1, box_x,
344 use_height, all.use_width + 2,
345 KEY_MAX, 1, 1, 1 /* by lines */ );
350 all.use_height = use_height;
352 print_list(&all, choice, scrollamt, max_choice);
354 dlg_draw_buttons(dialog, height - 2, 0, buttons, button, FALSE, width);
356 dlg_trace_win(dialog);
357 while (result == DLG_EXIT_UNKNOWN) {
358 if (button < 0) /* --visit-items */
359 wmove(dialog, box_y + choice + 1, box_x + all.check_x + 2);
361 key = dlg_mouse_wgetch(dialog, &fkey);
362 if (dlg_result_key(key, fkey, &result))
365 was_mouse = (fkey && is_DLGK_MOUSE(key));
369 if (was_mouse && (key >= KEY_MAX)) {
371 if (i < max_choice) {
372 choice = (key - KEY_MAX);
373 print_list(&all, choice, scrollamt, max_choice);
375 key = ' '; /* force the selected item to toggle */
381 } else if (was_mouse && key >= KEY_MIN) {
382 key = dlg_lookup_key(dialog, key, &fkey);
386 * A space toggles the item status.
389 int current = scrollamt + choice;
390 int next = items[current].state + 1;
392 if (next >= num_states)
395 if (flag == FLAG_CHECK) { /* checklist? */
396 items[current].state = next;
398 for (i = 0; i < item_no; i++) {
403 if (items[current].state) {
404 items[current].state = next ? next : 1;
406 items[current].state = 1;
409 print_list(&all, choice, scrollamt, max_choice);
410 continue; /* wait for another key press */
414 * Check if key pressed matches first character of any item tag in
415 * list. If there is more than one match, we will cycle through
416 * each one as the same key is pressed repeatedly.
420 if (button < 0 || !dialog_state.visit_items) {
421 for (j = scrollamt + choice + 1; j < item_no; j++) {
422 if (check_hotkey(items, j)) {
429 for (j = 0; j <= scrollamt + choice; j++) {
430 if (check_hotkey(items, j)) {
439 } else if ((j = dlg_char_to_button(key, buttons)) >= 0) {
447 * A single digit (1-9) positions the selection to that line in the
453 && (key - '1' < max_choice)) {
462 case DLGK_ITEM_FIRST:
466 i = item_no - 1 - scrollamt;
471 else if (scrollamt != 0)
472 i = -MIN(scrollamt, max_choice);
477 i = MIN(choice + max_choice, item_no - scrollamt - 1);
481 if (choice == 0 && scrollamt == 0)
486 if (scrollamt + choice >= item_no - 1)
498 if (i < 0 || i >= max_choice) {
503 choice = max_choice - 1;
504 scrollamt += (i - max_choice + 1);
506 print_list(&all, choice, scrollamt, max_choice);
509 print_list(&all, choice, scrollamt, max_choice);
512 continue; /* wait for another key press */
518 result = dlg_enter_buttoncode(button);
520 case DLGK_FIELD_PREV:
521 button = dlg_prev_button(buttons, button);
522 dlg_draw_buttons(dialog, height - 2, 0, buttons, button,
525 case DLGK_FIELD_NEXT:
526 button = dlg_next_button(buttons, button);
527 dlg_draw_buttons(dialog, height - 2, 0, buttons, button,
537 dlg_del_window(dialog);
539 dlg_mouse_free_regions();
544 if ((key2 = dlg_ok_buttoncode(key)) >= 0) {
556 dlg_del_window(dialog);
557 dlg_mouse_free_regions();
559 *current_item = (scrollamt + choice);
564 * Display a set of items as a tree.
567 dialog_treeview(const char *title,
578 DIALOG_LISTITEM *listitems;
580 bool show_status = FALSE;
584 listitems = dlg_calloc(DIALOG_LISTITEM, (size_t) item_no + 1);
585 assert_ptr(listitems, "dialog_treeview");
587 depths = dlg_calloc(int, (size_t) item_no + 1);
588 assert_ptr(depths, "dialog_treeview");
590 for (i = j = 0; i < item_no; ++i) {
591 listitems[i].name = items[j++];
592 listitems[i].text = (dialog_vars.no_items
595 listitems[i].state = !dlg_strcmp(items[j++], "on");
596 depths[i] = atoi(items[j++]);
597 listitems[i].help = ((dialog_vars.item_help)
601 dlg_align_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no);
603 result = dlg_treeview(title,
616 case DLG_EXIT_OK: /* FALLTHRU */
621 dlg_add_help_listitem(&result, &help_result, &listitems[current]);
622 if ((show_status = dialog_vars.help_status)) {
623 if (dialog_vars.separate_output) {
624 dlg_add_string(help_result);
627 dlg_add_quoted(help_result);
630 dlg_add_string(help_result);
636 for (i = 0; i < item_no; i++) {
637 if (listitems[i].state) {
638 if (dialog_vars.separate_output) {
639 dlg_add_string(listitems[i].name);
642 if (dlg_need_separator())
644 if (flag == FLAG_CHECK)
645 dlg_add_quoted(listitems[i].name);
647 dlg_add_string(listitems[i].name);
651 dlg_add_last_key(-1);
654 dlg_free_columns(&listitems[0].text, (int) sizeof(DIALOG_LISTITEM), item_no);