Lines Matching +full:int +full:- +full:array +full:- +full:variable +full:- +full:length +full:- +full:and +full:- +full:constrained +full:- +full:values
3 .\" Copyright 2005-2020,2021 Thomas E. Dickey
5 .\" This program is free software; you can redistribute it and/or modify
52 dialog \- widgets and utilities for the \*p program
54 .B cc [ flag ... ] file ... \-l\*l [ library ... ]
58 .B cc $(\*p\-config \-\-cflags) file ... $(\*p\-config \-\-libs) ]
83 "Hello, in dialog\-format",
104 Colors and video attributes are categorized and associated with
108 to the combined color and attribute table \fBdlg_color_table[]\fP.
110 The \fB\*p\fP application passes its command-line parameters
112 Some of those parameters are single values,
113 but some of the widgets accept data as an array of values.
114 Those include checklist/radiobox, menubox and formbox.
115 When the \fB\-\-item\-help\fP option is given, an extra column
117 The USE_ITEM_HELP(), CHECKBOX_TAGS, MENUBOX_TAGS and FORMBOX_TAGS
128 \fIDIALOG_STATE\fP, \fIDIALOG_VARS\fP and \fIDIALOG_COLORS\fP.
130 \fBdialog_state\fP, \fBdialog_vars\fP and \fBdlg_color_table\fP
139 .\" ---------------------------------------------------------------------------
143 .\" ---------------------------------------------------------------------------
148 .\" ---------------------------------------------------------------------------
153 .\" ---------------------------------------------------------------------------
155 This corresponds to the command-line option "\fB\-\-aspect\-ratio\fP".
158 sizing (specifying 0 for height and width).
161 .\" ---------------------------------------------------------------------------
167 .\" ---------------------------------------------------------------------------
172 .\" ---------------------------------------------------------------------------
175 closed, the list is transferred to this variable.
177 .\" ---------------------------------------------------------------------------
183 .\" ---------------------------------------------------------------------------
185 This corresponds to the command-line option "\fB\-\-no\-mouse\fP".
186 If true, \fB\*p\fP will not initialize (and enable) the mouse in
188 .\" ---------------------------------------------------------------------------
191 which the application and library functions may write text results.
196 e.g., by using the "\fB\-\-stdout\fP" option.
197 .\" ---------------------------------------------------------------------------
205 .\" ---------------------------------------------------------------------------
211 "\fB\-\-input\-fd\fP" option.
213 a pipe (standard input) and at the same time read
218 The adjusted pipe stream value is stored in this variable.
219 .\" ---------------------------------------------------------------------------
221 The text-formatting functions use this for the number of rows used for
224 It is used by \fB\*l\fP for the command-line options
225 "\fB\-\-print\-text\-size\fP" and
226 "\fB\-\-print\-text\-only\fP".
227 .\" ---------------------------------------------------------------------------
229 This is set in \fIinit_dialog\fP and
233 .\" ---------------------------------------------------------------------------
238 unless that happens to not be a terminal (and if \fIinit_dialog\fP can
240 .\" ---------------------------------------------------------------------------
242 The text-formatting functions use this for the number of columns used for
245 It is used by \fB\*l\fP for the command-line options
246 "\fB\-\-print\-text\-size\fP" and
247 "\fB\-\-print\-text\-only\fP".
248 .\" ---------------------------------------------------------------------------
250 This corresponds to the command-line option "\fB\-\-separate\-widget\fP".
257 .\" ---------------------------------------------------------------------------
259 This corresponds to the command-line option "\fB\-\-tab\-len\fP \fInumber\/\fP".
261 "\fB\-\-tab\-correct\fP"
264 .\" ---------------------------------------------------------------------------
266 The text-formatting functions set this to the number of lines used for
269 It is used by \fB\*l\fP for the command-line options
270 "\fB\-\-print\-text\-size\fP" and
271 "\fB\-\-print\-text\-only\fP".
272 .\" ---------------------------------------------------------------------------
274 \fB\*L\fP uses this in the command-line option "\fB\-\-print\-text\-only\fP".
276 The text-formatting functions
278 \fBdlg_print_line\fP, and
281 \fB\*p\fP's output or to the curses-display.
286 .\" ---------------------------------------------------------------------------
288 The text-formatting functions set this to the number of columns used for
291 It is used by \fB\*l\fP for the command-line options
292 "\fB\-\-print\-text\-size\fP" and
293 "\fB\-\-print\-text\-only\fP".
294 .\" ---------------------------------------------------------------------------
296 This corresponds to the command-line option "\fB\-\-trace\fP \fIfile\fP".
298 .\" ---------------------------------------------------------------------------
301 .\" ---------------------------------------------------------------------------
303 This corresponds to the command-line option "\fB\-\-scrollbar\fP".
306 .\" ---------------------------------------------------------------------------
308 This corresponds to the command-line option "\fB\-\-no\-shadow\fP".
311 suppress shadows that would be drawn to the right and bottom of each dialog box.
312 .\" ---------------------------------------------------------------------------
314 This corresponds to the command-line option "\fB\-\-visit\-items\fP".
315 Modify the tab-traversal of the list-oriented widgets
316 (buildlist, checklist, radiobox, menubox, inputmenu, and treeview)
320 .\" ---------------------------------------------------------------------------
325 command-line options:
326 .\" ---------------------------------------------------------------------------
331 are set by command-line options in \fB\*p\fP.
332 .\" ---------------------------------------------------------------------------
334 This corresponds to the command-line option "\fB\-\-ascii\-lines\fP.
335 It causes line-drawing to be done with ASCII characters, e.g., "+" and "\-".
337 .\" ---------------------------------------------------------------------------
339 This corresponds to the command-line option
340 "\fB\-\-backtitle\fP \fIbacktitle\/\fP".
344 .\" ---------------------------------------------------------------------------
346 This corresponds to the command-line option "\fB\-\-beep\-after\fP".
349 .\" ---------------------------------------------------------------------------
351 This corresponds to the command-line option "\fB\-\-beep\fP".
353 .\" ---------------------------------------------------------------------------
355 This is true if the command-line option "\fB\-\-begin\fP \fIy x\/\fP" was used.
358 .\" ---------------------------------------------------------------------------
361 the command-line option "\fB\-\-begin\fP \fIy x\/\fP" (second value).
362 .\" ---------------------------------------------------------------------------
365 the command-line option "\fB\-\-begin\fP \fIy x\/\fP" (first value).
366 .\" ---------------------------------------------------------------------------
368 This corresponds to the command-line option
369 "\fB--cancel-label\fP \fIstring\/\fP".
371 .\" ---------------------------------------------------------------------------
373 This corresponds to the command-line option "\fB\-\-no\-kill\fP".
381 .\" ---------------------------------------------------------------------------
383 This corresponds to the command-line option "\fB\-\-colors\fP".
394 cyan and
402 .\" ---------------------------------------------------------------------------
404 This corresponds to the command-line option "\fB\-\-column\-separator\fP".
405 \fB\*L\fP splits data for radio/checkboxes and menus on the
406 occurrences of the given string, and aligns the split data into columns.
407 .\" ---------------------------------------------------------------------------
409 This corresponds to the command-line option "\fB\-\-cr\-wrap\fP".
416 Without cr-wrap, the layout of your text may be formatted to look nice
419 .\" ---------------------------------------------------------------------------
421 This corresponds to the command-line option "\fB\-\-cursor\-off\-label\fP".
425 interacts poorly with the button-label text colors.
426 .\" ---------------------------------------------------------------------------
428 This corresponds to the command-line option
429 "\fB\-\-date\-format\fP \fIstring\/\fP".
430 If the host provides \fBstrftime\fP, and the value is nonnull,
432 .\" ---------------------------------------------------------------------------
434 This is set by the command-line option "\fB\-\-default\-button\fP.
436 .\" ---------------------------------------------------------------------------
438 This corresponds to the command-line option
439 "\fB\-\-default\-item\fP \fIstring\/\fP".
443 .\" ---------------------------------------------------------------------------
445 This corresponds to the command-line option "\fB\-\-defaultno\fP".
452 \*(``OK\*('' and \*(``Cancel\*(''
454 If \fB\-\-no\-cancel\fP was given that option overrides this,
457 .\" ---------------------------------------------------------------------------
459 This corresponds to the command-line option "\fB\-\-clear\fP".
464 .\" ---------------------------------------------------------------------------
466 This corresponds to the command-line option "\fB\-\-erase\-on\-exit\fP".
468 screen to its native background color, and place the terminal cursor
474 .\" ---------------------------------------------------------------------------
476 This corresponds to the command-line option "\fB\-\-exit\-label string\fP".
478 .\" ---------------------------------------------------------------------------
480 This corresponds to the command-line option "\fB\-\-extra\-button\fP".
482 between \*(``OK\*('' and \*(``Cancel\*('' buttons.
483 .\" ---------------------------------------------------------------------------
485 This corresponds to the command-line option
486 "\fB\-\-extra\-label\fP \fIstring\/\fP".
489 .\" ---------------------------------------------------------------------------
491 This is set by the command-line option "\fB\-\-passwordform\fP"
494 .\" ---------------------------------------------------------------------------
496 This corresponds to the command-line option "\fB\-\-help\-button\fP".
497 If true, some widgets show a help-button after
498 \*(``OK\*('' and \*(``Cancel\*('' buttons,
499 i.e., in checklist, radiolist and menu boxes.
500 If \fB\-\-item\-help\fR is also given, on exit
502 and the item-help text will be written to \fB\*p\fP's output
506 .\" ---------------------------------------------------------------------------
508 This corresponds to the command-line option "\fB\-\-hfile\fP \fIstring\/\fP".
511 .\" ---------------------------------------------------------------------------
514 command-line option "\fB\-\-help\-label\fP \fIstring\/\fP".
516 .\" ---------------------------------------------------------------------------
518 This corresponds to the command-line option "\fB\-\-hline\fP \fIstring\/\fP".
521 .\" ---------------------------------------------------------------------------
523 This corresponds to the command-line option "\fB\-\-help\-status\fP".
524 If true, and the the help-button is selected,
526 after the item-help \*(``HELP\*('' information.
529 .\" ---------------------------------------------------------------------------
531 This corresponds to the command-line option "\fB\-\-help\-tags\fP".
533 \fBdlg_add_help_formitem\fP and
535 rather than using the tag's help-text value
537 .\" ---------------------------------------------------------------------------
541 .\" ---------------------------------------------------------------------------
545 .\" ---------------------------------------------------------------------------
547 This may be either a user-supplied buffer,
557 this is a dynamically-allocated buffer used by the widgets to return
561 If the pointer is NULL, or if the length is insufficient for
565 .\" ---------------------------------------------------------------------------
567 This corresponds to the command-line option "\fB\-\-insecure\fP".
570 .\" ---------------------------------------------------------------------------
572 This variable is used to prevent \fBdialog_helpfile\fP from showing
573 anything, e.g., if F1 were pressed within a help-file display.
574 .\" ---------------------------------------------------------------------------
576 This corresponds to the command-line option "\fB\-\-iso\-week\fP".
582 If this variable is true, the calendar uses ISO 8601's convention.
586 .\" ---------------------------------------------------------------------------
588 This corresponds to the command-line option "\fB\-\-item\-help\fP".
590 interpret the tags data for checklist, radiolist and menu boxes
593 .\" ---------------------------------------------------------------------------
595 This is set by the command-line option "\fB\-\-keep\-tite\fP"
598 which correspond to xterm's alternate-screen switching.
601 .\" ---------------------------------------------------------------------------
603 This corresponds to the command-line option "\fB\-\-keep\-window\fP".
608 .\" ---------------------------------------------------------------------------
610 This corresponds to the command-line option "\fB\-\-last\-key\fP".
611 .\" ---------------------------------------------------------------------------
613 This corresponds to the command-line option "\fB\-\-max\-input\fP \fIsize\/\fP".
616 .\" ---------------------------------------------------------------------------
618 This corresponds to the command-line option "\fB\-\-no\-hot\-list\fP".
628 for which the leading capital letter in each entry is accepted as a hot-key,
631 Setting this variable to TRUE disables the feature.
632 .\" ---------------------------------------------------------------------------
634 This corresponds to the command-line option "\fB\-\-no\-items\fP".
636 with two columns (a \*(``tag\*('' and \*(``item\*('',
640 .\" ---------------------------------------------------------------------------
642 This corresponds to the command-line
643 option "\fB\-\-no\-label\fP \fIstring\/\fP".
645 .\" ---------------------------------------------------------------------------
647 This corresponds to the command-line option "\fB\-\-no\-lines\fP.
648 It suppresses line-drawing.
650 .\" ---------------------------------------------------------------------------
652 This corresponds to the command-line option "\fB\-\-no\-nl\-expand\fP".
655 .\" ---------------------------------------------------------------------------
657 This corresponds to the command-line option "\fB\-\-no\-tags\fP".
659 with two columns (a \*(``tag\*('' and \*(``item\*('',
662 The \fB\-\-no\-tags\fP option (from Xdialog) may be used to suppress the
667 When the \fB\-\-no\-tags\fP option is given, \fB\*p\fP matches against
671 Here is a table showing how the no_tags and no_items values interact:
708 \fB\*L\fP does the same on the command-line.
711 .\" ---------------------------------------------------------------------------
713 This corresponds to the command-line option "\fB\-\-no\-cancel\fP".
715 suppress the \*(``Cancel\*('' button in checklist, inputbox and menu box modes.
717 .\" ---------------------------------------------------------------------------
719 This corresponds to the command-line option "\fB\-\-no\-collapse\fP".
720 Normally \fB\*p\fR converts tabs to spaces and reduces multiple
723 Note that \fB\*p\fR will still wrap text, subject to the \fB\-\-cr\-wrap\fR
725 .\" ---------------------------------------------------------------------------
727 This corresponds to the command-line option "\fB\-\-no\-ok\fP.
730 .\" ---------------------------------------------------------------------------
732 This corresponds to the command-line
733 option "\fB\-\-ok\-label\fP \fIstring\/\fP".
735 .\" ---------------------------------------------------------------------------
739 .\" ---------------------------------------------------------------------------
741 This corresponds to the command-line option "\fB\-\-print\-size\fP".
744 .\" ---------------------------------------------------------------------------
746 This corresponds to the command-line option "\fB\-\-quoted\fP.
748 as well as the item-help text.
750 .\" ---------------------------------------------------------------------------
752 This corresponds to the command-line option "\fB\-\-reorder\fP.
757 .\" ---------------------------------------------------------------------------
759 This corresponds to the command-line option "\fB\-\-separate\-output\fP".
763 .\" ---------------------------------------------------------------------------
765 This corresponds to the command-line option "\fB\-\-single\-quoted\fP".
767 use single-quoting as needed (and no quotes if unneeded) for the
768 output of checklist's as well as the item-help text.
772 .\" ---------------------------------------------------------------------------
774 This corresponds to the command-line option "\fB\-\-size\-err\fP".
778 (This option is obsolete, since all new-window calls are checked).
779 .\" ---------------------------------------------------------------------------
781 This corresponds to the command-line option "\fB\-\-sleep\fP \fIsecs\/\fP".
785 .\" ---------------------------------------------------------------------------
787 This corresponds to the command-line option "\fB\-\-tab-correct\fP".
790 .\" ---------------------------------------------------------------------------
792 This corresponds to the command-line option
793 "\fB\-\-time\-format\fP \fIstring\/\fP".
794 If the host provides \fBstrftime\fP, and the value is nonnull,
796 .\" ---------------------------------------------------------------------------
798 This corresponds to the command-line option "\fB\-\-timeout\fP \fIsecs\/\fP".
801 .\" ---------------------------------------------------------------------------
803 This corresponds to the command-line option "\fB\-\-title\fP \fItitle\/\fP".
807 .\" ---------------------------------------------------------------------------
809 This corresponds to the command-line option "\fB\-\-trim\fP".
811 trim literal newlines and repeated blanks from message text.
812 .\" ---------------------------------------------------------------------------
814 This corresponds to the command-line option "\fB\-\-week\-start\fP".
826 .\" ---------------------------------------------------------------------------
828 This corresponds to the command-line
829 option "\fB\-\-yes\-label\fP \fIstring\/\fP".
835 Functions that implement major functionality for the command-line \fB\*p\fP
855 implements the "\fB\-\-buildlist\fP" option.
863 .B int \fIheight
867 .B int \fIwidth
871 .B int \fIlist_height
873 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
875 .B int \fIitem_no
879 is an array of strings which is viewed either as a list of rows
891 .B int \fIorder_mode
896 implements the "\fB\-\-calendar\fP" option.
904 .B int \fIheight
905 is the height excluding the fixed-height calendar grid.
907 .B int \fIwidth
911 .B int \fIday
916 .B int \fImonth
921 .B int \fIyear
926 implements the "\fB\-\-checklist\fP" and "\fB\-\-radiolist\fP" options
935 .B int \fIheight
939 .B int \fIwidth
943 .B int \fIlist_height
945 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
947 .B int \fIitem_no
950 .B int \fIitems
951 is an array of strings which is viewed either as a list of rows
967 implements the "\fB\-\-dselect\fP" option.
973 is the preselected value to show in the input-box,
974 which is used also to set the directory- and file-windows.
976 .B int \fIheight
980 .B int \fIwidth
985 implements the "\fB\-\-editbox\fP" option.
993 .B int \fIheight
997 .B int \fIwidth
1002 implements the "\fB\-\-form\fP" option.
1010 .B int \fIheight
1014 .B int \fIwidth
1018 .B int \fIform_height
1020 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
1022 .B int \fIitem_no
1025 .B int \fIitems
1026 is an array of strings which is viewed either as a list of rows
1039 implements the "\fB\-\-fselect\fP" option.
1045 is the preselected value to show in the input-box,
1046 which is used also to set the directory- and file-windows.
1048 .B int \fIheight
1052 .B int \fIwidth
1057 implements the "\fB\-\-gauge\fP" option.
1062 \fBdlg_update_gauge\fP and
1071 .B int \fIheight
1075 .B int \fIwidth
1079 .B int \fIpercent
1083 implements the "\fB\-\-inputbox\fP" or
1084 "\fB\-\-password\fP" option, depending on the value of \fIpassword\fP.
1092 .B int \fIheight
1096 .B int \fIwidth
1101 is the initial value of the input box, whose length is taken into account
1102 when auto-sizing the width of the dialog box.
1104 .B int \fIpassword
1108 implements the "\fB\-\-hfile\fP" option.
1117 The \fB\*p\fP program sets that variable when the \fB\-\-hfile\fP option
1120 .B int \fIheight
1124 .B int \fIwidth
1129 implements the "\fB\-\-menu\fP" or "\fB\-\-inputmenu\fP" option
1138 .B int \fIheight
1142 .B int \fIwidth
1146 .B int \fImenu_height
1148 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
1150 .B int \fIitem_no
1153 .B int \fIitems
1154 is an array of strings which is viewed either as a list of rows
1167 implements the "\fB\-\-mixedform\fP" option.
1175 .B int \fIheight
1179 .B int \fIwidth
1183 .B int \fIform_height
1185 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
1187 .B int \fIitem_no
1190 .B int \fIitems
1191 is an array of strings which is viewed either as a list of rows
1204 implements the "\fB\-\-mixedgauge\fP" option
1212 .B int \fIheight
1216 .B int \fIwidth
1220 .B int \fIpercent
1223 .B int \fIitem_no
1226 .B int \fIitems
1227 is an array of strings which is viewed as a list
1228 of \fItag\fP and \fIitem\fP values.
1229 The \fItag\fP values are listed,
1232 The \fIitem\fP values are decoded:
1257 A string with a leading "-" character is centered, marked with "%".
1258 For example, "-75" is displayed as "75%".
1262 implements the "\fB\-\-msgbox\fP" or "\fB\-\-infobox\fP" option
1271 .B int \fIheight
1275 .B int \fIwidth
1279 .B int \fIpauseopt
1286 implements the "\fB\-\-pause\fP" option.
1291 .B int \fIheight
1295 .B int \fIwidth
1299 .B int \fIseconds
1303 implements the "\fB\-\-prgbox\fP" option.
1315 .B int \fIheight
1319 .B int \fIwidth
1323 .B int \fIpauseopt
1328 implements the "\fB\-\-progressbox\fP" option.
1337 .B int \fIheight
1341 .B int \fIwidth
1346 implements the "\fB\-\-rangebox\fP" option.
1355 .B int \fIheight
1359 .B int \fIwidth
1363 .B int \fImin_value
1366 .B int \fImax_value
1369 .B int \fIdefault_value
1373 implements the "\fB\-\-tailbox\fP" or "\fB\-\-tailboxbg\fP" option
1382 .B int \fIheight
1386 .B int \fIwidth
1390 .B int \fIbg_task
1398 implements the "\fB\-\-textbox\fP" option.
1406 .B int \fIheight
1410 .B int \fIwidth
1415 implements the "\fB\-\-timebox\fP" option.
1423 .B int \fIheight
1427 .B int \fIwidth
1431 .B int \fIhour
1436 .B int \fIminute
1441 .B int \fIsecond
1447 implements the "\fB\-\-treeview\fP" option.
1455 .B int \fIheight
1459 .B int \fIwidth
1463 .B int \fIlist_height
1465 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
1467 .B int \fIitem_no
1471 is the list of items, contain tag, name, and optionally help strings
1475 .B int \fIflag
1481 implements the "\fB\-\-yesno\fP" option.
1489 .B int \fIheight
1493 .B int \fIwidth
1499 Most functions that implement lower-level
1500 functionality for the command-line \fB\*p\fP
1503 display and end it are named \fIinit_dialog\fP and \fIend_dialog\fP.
1505 The only non-widget function whose name begins with "\fIdialog_\fP"
1514 Here is a brief summary of the utility functions and their parameters:
1515 .\" ---------------------------------------------------------------------------
1522 .\" ---------------------------------------------------------------------------
1535 .\" ---------------------------------------------------------------------------
1538 the \fIDIALOG_VARS.help_tags\fP and \fIDIALOG_VARS.item_help\fP variables.
1540 .B int *\fIresult\fP
1544 the tag- or help-text is stored here.
1547 contains the list item to use for tag- or help-text.
1548 .\" ---------------------------------------------------------------------------
1551 the \fIDIALOG_VARS.help_tags\fP and \fIDIALOG_VARS.item_help\fP variables.
1553 .B int *\fIresult\fP
1557 the tag- or help-text is stored here.
1560 contains the list item to use for tag- or help-text.
1561 .\" ---------------------------------------------------------------------------
1564 This implements the \fB\-\-last\-key\fP command-line option,
1567 .B int \fImode
1571 -2
1574 -1
1581 (same as -1)
1583 .\" ---------------------------------------------------------------------------
1587 If \fBdialog_vars.single_quoted\fR is set, single-quotes are used.
1588 Otherwise, double-quotes are used.
1592 .\" ---------------------------------------------------------------------------
1598 .\" ---------------------------------------------------------------------------
1600 Add an output-separator to the result buffer \fBdialog_vars.input_result\fP.
1604 .\" ---------------------------------------------------------------------------
1607 (see \fBdlg_add_quoted\fP) and \fBdlg_add_result\fP),
1612 .\" ---------------------------------------------------------------------------
1614 Copy and reformat an array of pointers to strings, aligning according to
1616 If no column separator is set, the array will be unmodified;
1617 otherwise it is copied and reformatted.
1619 Caveat: This function is only implemented for 8-bit characters.
1622 This is the array to reformat.
1625 .B int \fIper_row
1626 This is the size of the struct for each row of the array.
1628 .B int \fInum_rows
1629 This is the number of rows in the array.
1630 .\" ---------------------------------------------------------------------------
1641 .B int \fIheight
1645 .B int \fIwidth
1649 .B int \fIpercent
1651 .\" ---------------------------------------------------------------------------
1654 corresponding "+" or "-", etc.,
1655 for the line-drawing characters used in \fB\*p\fP.
1656 If the parameter is not a line-drawing or other special character
1661 .\" ---------------------------------------------------------------------------
1668 .B int \fIheight
1671 .B int \fIwidth
1676 .\" ---------------------------------------------------------------------------
1678 Compute window size based on the size of the formatted \fIprompt\fP and
1682 \fBdialog_state.text_height\fP and
1685 as a side-effect.
1701 i.e., if the values referenced by \fIheight\fP and/or \fIwidth\fP are zero.
1703 .B int * \fIheight
1705 \fB\*L\fP checks the referenced value and may update it:
1710 after reserving rows for the window border and shadow,
1712 \fBdialog_vars.begin_y\fP and
1717 taking into account a (possibly) multi-line \fIprompt\fP.
1723 .B int * \fIwidth
1725 \fB\*L\fP checks the referenced value and may update it:
1730 after reserving rows for the window border and shadow,
1732 \fBdialog_vars.begin_x\fP and
1737 taking into account a (possibly) multi-line \fIprompt\fP.
1743 .B int \fIboxlines
1746 .B int \fImincols
1748 .\" ---------------------------------------------------------------------------
1759 .B int * \fIheight
1762 If it is -1, use the screen's height
1767 limit the referenced value to the screen-height
1770 .B int * \fIwidth
1773 If it is -1, use the screen's width (after subtracting \fBdialog_vars.begin_x\fP
1777 limit the referenced value to the screen-width
1780 .B int \fIboxlines
1783 .B int \fImincols
1785 .\" ---------------------------------------------------------------------------
1788 this calls \fBbeep\fP once and sets
1790 .\" ---------------------------------------------------------------------------
1797 returns the corresponding "+" or "-", etc.,
1798 for the line-drawing characters used in \fB\*p\fP.
1801 returns a space for the line-drawing characters.
1803 if the parameter is not a line-drawing or other special character
1806 .\" ---------------------------------------------------------------------------
1808 returns a suitable x-ordinate (column) for a new widget.
1813 .B int \fIwidth
1815 .\" ---------------------------------------------------------------------------
1817 returns a suitable y-ordinate (row) for a new widget.
1822 .B int \fIheight
1824 .\" ---------------------------------------------------------------------------
1836 .B int \fIheight
1840 .B int \fIwidth
1844 .B int \fIlist_height
1846 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
1848 .B int \fIitem_no
1852 is the list of items, contain tag, name, and optionally help strings
1858 Normally a buildlist provides true (1) and false (0) values,
1859 which the widget displays as "*" and space, respectively.
1860 An application may set this parameter to an arbitrary null-terminated string.
1861 The widget determines the number of states from the length of this string,
1863 presses the space-bar.
1865 .B int \fIorder_mode
1868 .B int * \fIcurrent_item
1871 .\" ---------------------------------------------------------------------------
1877 .\" ---------------------------------------------------------------------------
1879 If a key was bound to one of the button-codes in \fBdlg_result_key\fP, fake
1880 a button-value and an \*(``Cancel\*('' key
1883 See \fBdlg_ok_buttoncode\fP, which maps settings for ok/extra/help and button
1884 number into exit-code.
1885 .\" ---------------------------------------------------------------------------
1889 adding margins and limiting based on the screen size.
1894 .B int * \fIlimit
1897 if that is wider than the passed-in limit.
1898 .\" ---------------------------------------------------------------------------
1900 Compute the size of the button array in columns.
1905 .B int \fIvertical
1908 .B int * \fIlongest
1911 .B int * \fIlength
1913 .\" ---------------------------------------------------------------------------
1917 If the label is empty, return -1.
1926 However, they keep track of all of the labels and
1933 .\" ---------------------------------------------------------------------------
1935 Compute the step-size needed between elements of the button array.
1940 .B int \fIlimit
1943 .B int * \fIgap
1945 This is constrained to be at least one.
1947 .B int * \fImargin
1951 .B int * \fIstep
1952 store the step-size in the referenced location.
1953 .\" ---------------------------------------------------------------------------
1958 .B int \fIitem_no
1962 contains a \fIname\fP and \fItext\fP field,
1969 .\" ---------------------------------------------------------------------------
1971 Calculate new height and list_height values.
1973 .B int * \fIheight
1974 on input, is the height without adding the list-height.
1975 On return, this contains the total list-height and is the
1978 .B int * \fIlist_height
1979 on input, is the requested list-height.
1981 the list after taking into account the screen size and
1982 the \fBdialog_vars.begin_set\fP and \fBdialog_vars.begin_y\fP variables.
1984 .B int \fIitem_no
1986 .\" ---------------------------------------------------------------------------
1988 This function is obsolete, provided for library-compatibility.
1991 .B int \fIitem_no
1997 .B int \fIgroup
1998 is the number of items in each group, e.g., the second array index.
1999 .\" ---------------------------------------------------------------------------
2008 .B int \fIch
2013 .\" ---------------------------------------------------------------------------
2015 This entrypoint provides the \fB\-\-checklist\fP or \fB\-\-radiolist\fP
2016 functionality without the limitations of \fB\*p\fP's command-line syntax
2025 .B int \fIheight
2029 .B int \fIwidth
2033 .B int \fIlist_height
2035 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
2037 .B int \fIitem_no
2045 Normally a checklist provides true (1) and false (0) values,
2046 which the widget displays as "*" and space, respectively.
2047 An application may set this parameter to an arbitrary null-terminated string.
2048 The widget determines the number of states from the length of this string,
2050 presses the space-bar.
2052 .B int \fIflag
2056 .B int * \fIcurrent_item
2059 .\" ---------------------------------------------------------------------------
2079 Some widgets use these key bindings for scrolling the prompt-text up and
2083 and -1 if not.
2085 .B int \fIkey
2086 is the function-key to check
2088 .B int \fIlast
2094 .B int \fIpage
2102 .B int * \fIoffset
2106 .\" ---------------------------------------------------------------------------
2109 This is set in the rc-file with \fBscreen_color\fP.
2110 .\" ---------------------------------------------------------------------------
2114 .\" ---------------------------------------------------------------------------
2117 .\" ---------------------------------------------------------------------------
2120 .\" ---------------------------------------------------------------------------
2126 .\" ---------------------------------------------------------------------------
2133 .\" ---------------------------------------------------------------------------
2142 .\" ---------------------------------------------------------------------------
2144 Returns the number of wide-characters in the string.
2148 .\" ---------------------------------------------------------------------------
2152 as an rc-file.
2156 .\" ---------------------------------------------------------------------------
2162 .B int \fIheight
2165 .B int \fIwidth
2167 .\" ---------------------------------------------------------------------------
2170 return the button-index for that button code,
2173 .\" ---------------------------------------------------------------------------
2183 .\" ---------------------------------------------------------------------------
2185 This function is obsolete, provided for library-compatibility.
2186 It is replaced by \fBdlg_default_formitem\fP and \fBdlg_default_listitem\fP.
2191 .B int \fIllen
2192 is the number of items in each group, e.g., the second array index.
2193 .\" ---------------------------------------------------------------------------
2195 If \fBdialog_vars.defaultno\fP is true, and \fBdialog_vars.nocancel\fP is not,
2196 find the button-index for the \*(``Cancel\*('' button.
2198 .\" ---------------------------------------------------------------------------
2204 .\" ---------------------------------------------------------------------------
2211 .B int \fIheight
2214 .B int \fIwidth
2217 .B int \fIy
2218 is the subwindow's top-row
2220 .B int \fIx
2221 is the subwindow's left-column
2222 .\" ---------------------------------------------------------------------------
2226 so the output function in \fB\*p\fP can test this and add a separator.
2227 .\" ---------------------------------------------------------------------------
2231 \fImenubox_color\fP and \fImenubox_border_color\fP attributes.
2236 .B int \fItop_arrow
2237 is true if an up-arrow should be drawn at the top of the window.
2239 .B int \fIbottom_arrow
2240 is true if an down-arrow should be drawn at the bottom of the window.
2242 .B int \fIx
2243 is the zero-based column within the window on which to draw arrows.
2245 .B int \fItop
2246 is the zero-based row within the window on which to draw up-arrows
2249 .B int \fIbottom
2250 is the zero-based row within the window on which to draw down-arrows
2252 .\" ---------------------------------------------------------------------------
2259 .B int \fItop_arrow
2260 is true if an up-arrow should be drawn at the top of the window.
2262 .B int \fIbottom_arrow
2263 is true if an down-arrow should be drawn at the bottom of the window.
2265 .B int \fIx
2266 is the zero-based column within the window on which to draw arrows.
2268 .B int \fItop
2269 is the zero-based row within the window on which to draw up-arrows
2272 .B int \fIbottom
2273 is the zero-based row within the window on which to draw down-arrows
2281 .\" ---------------------------------------------------------------------------
2287 so it uses tee-elements rather than corner-elements
2292 .\" ---------------------------------------------------------------------------
2298 so it uses tee-elements rather than corner-elements
2305 is used to color the upper/left edges of the box, i.e., the tee-element and
2309 is used to color the right edge of the box, i.e., the tee-element
2312 is used to fill-color the inside of the box
2313 .\" ---------------------------------------------------------------------------
2320 .B int \fIy
2323 .B int \fIx
2326 .B int \fIheight
2329 .B int \fIwidth
2334 It also is fill-color used for the box contents.
2338 .\" ---------------------------------------------------------------------------
2345 .B int \fIy
2348 .B int \fIx
2351 .B int \fIheight
2354 .B int \fIwidth
2358 is used to fill-color for the box contents.
2365 .\" ---------------------------------------------------------------------------
2372 .B int \fIy
2375 .B int \fIx
2381 .B int \fIselected
2384 .B int \fIvertical
2387 .B int \fIlimit
2389 .\" ---------------------------------------------------------------------------
2398 .\" ---------------------------------------------------------------------------
2414 is the zero-based index to the first row of data in the current window.
2417 is the zero-based index to the current row of data.
2420 is the zero-based index to the next data after the current row.
2425 .B int \fIleft
2426 is the zero-based left margin/column of the window.
2429 .B int \fIright
2430 is the zero-based right margin/column of the window.
2433 .B int \fItop
2434 is the zero-based row within the window on which to draw up-arrows
2437 .B int \fIbottom
2438 is the zero-based row within the window on which to draw down-arrows
2446 .\" ---------------------------------------------------------------------------
2448 Draw shadows along the right and bottom edge of a window to give it
2449 a 3-dimensional look.
2450 (The height, etc., may not be the same as the window's actual values).
2455 .B int \fIheight
2458 .B int \fIwidth
2461 .B int \fIy
2464 .B int \fIx
2466 .\" ---------------------------------------------------------------------------
2475 .\" ---------------------------------------------------------------------------
2477 This is a utility function which supports the \fB\-\-inputmenu\fP option of
2488 .B int \fIcurrent
2489 is the index of the currently-selected item
2493 .\" ---------------------------------------------------------------------------
2495 Write all user-defined key-bindings to the given stream,
2500 .\" ---------------------------------------------------------------------------
2502 Write all user-defined key-bindings to the given stream,
2510 If it is null, then only built-in bindings are dumped.
2511 .\" ---------------------------------------------------------------------------
2515 .B int * \fIargcp
2516 in/out parameter giving the length of the argument vector.
2519 .B int \fIstart
2521 .B int \fIcount
2523 .\" ---------------------------------------------------------------------------
2525 Given the character-offset in the string,
2526 returns the display-offset where
2534 .B int \fIoffset
2535 is the character-offset
2537 .B int \fIx_last
2540 .\" ---------------------------------------------------------------------------
2542 Updates the string and character-offset, given various editing characters
2543 or literal characters which are inserted at the character-offset.
2544 Returns true if an editing change was made (and the display should
2545 be updated), and false if the key was something like \fBKEY_ENTER\fP,
2546 which is a non-editing action outside this function.
2551 .B int * \fIoffset
2552 is the character-offset
2554 .B int \fIkey
2557 .B int \fIfkey
2558 is true if the editing key is a function-key
2562 value of this function when a function-key code 0 is passed in.
2563 .\" ---------------------------------------------------------------------------
2566 check if the corresponding environment variable is set.
2567 If so, remap the exit code to match the environment variable.
2570 .B int \fIcode
2577 .\" ---------------------------------------------------------------------------
2579 Returns the name of an exit-code, e.g.,
2582 .B int \fIcode
2583 is an exit-code for \fB\*p\fP as defined in \fB<\*p.h>\fP.
2584 .\" ---------------------------------------------------------------------------
2586 Returns an exit-code as the reverse of \fBdlg_exitcode2n\fP, e.g.,
2590 is the name of an exit-code for \fB\*p\fP as defined in \fB<\*p.h>\fP
2592 .\" ---------------------------------------------------------------------------
2594 Map the given button index for \fBdlg_exit_label\fP into \fB\*p\fP's exit-code.
2596 .B int \fIbutton
2598 .\" ---------------------------------------------------------------------------
2606 .\" ---------------------------------------------------------------------------
2611 is the format of the \fBprintf\fP-like message to write.
2616 .\" ---------------------------------------------------------------------------
2618 Given the character-offset to find in the list, return the corresponding
2619 array index.
2621 .B const int *\fIlist
2622 contains a list of character-offsets,
2625 .B int \fIlimit
2628 .B int \fIto_find
2629 is the character-offset to find.
2630 .\" ---------------------------------------------------------------------------
2638 some of the caching is used for editable input-fields.
2639 .\" ---------------------------------------------------------------------------
2642 .\" ---------------------------------------------------------------------------
2644 This entrypoint provides the \fB\-\-editbox\fP
2645 functionality without the limitations of \fB\*p\fP's command-line syntax
2652 is a pointer to an array of \fBchar\ *\fP pointers.
2653 The array is allocated by the caller,
2656 array and the strings.
2658 .B int * \fIrows
2659 points to the nominal length of \fIlist\fP.
2662 .B int \fIheight
2666 .B int \fIwidth
2669 .\" ---------------------------------------------------------------------------
2671 This entrypoint provides the \fB\-\-form\fP
2672 functionality without the limitations of \fB\*p\fP's command-line syntax
2681 .B int \fIheight
2685 .B int \fIwidth
2689 .B int \fIform_height
2691 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
2693 .B int \fIitem_no
2699 .B int * \fIcurrent_item
2702 .\" ---------------------------------------------------------------------------
2707 This is the array which was reformatted.
2710 .B int \fIper_row
2711 This is the size of the struct for each row of the array.
2713 .B int \fInum_rows
2714 This is the number of rows in the array.
2715 .\" ---------------------------------------------------------------------------
2721 .\" ---------------------------------------------------------------------------
2723 Remove the gauge widget from the screen and free its associated memory.
2727 .\" ---------------------------------------------------------------------------
2732 Also, if input-callback(s) are set up,
2733 poll the corresponding files and handle the updates,
2735 Returns the key-code.
2740 .B int * \fIfkey
2741 as a side-effect, set this to true if the key-code is really a function-key.
2742 .\" ---------------------------------------------------------------------------
2747 success/failure for the function return, and the actual value via the pointer.
2751 the function-return.
2752 Use this when only values greater than zero are useful.
2755 is the name of the environment-variable to retrieve.
2757 .B int * \fIvalue
2758 is the optional pointer to a return-value.
2759 .\" ---------------------------------------------------------------------------
2764 is the name of the environment-variable to retrieve.
2765 .\" ---------------------------------------------------------------------------
2771 .\" ---------------------------------------------------------------------------
2773 passes the given key-code \fIch\fP to the current window that
2775 If the callback returns zero, remove it and try the next window.
2779 .B int \fIch
2780 is the key-code
2782 .B int \fIfkey
2783 is true if the key is a function-key
2785 .B int * \fIresult
2786 is used to pass an exit-code to the caller,
2788 .\" ---------------------------------------------------------------------------
2790 Build a list of the display-columns for the given multibyte string's characters.
2794 .\" ---------------------------------------------------------------------------
2796 Build an index of the wide-characters in the string,
2798 which byte-offset begins a given wide-character.
2802 .\" ---------------------------------------------------------------------------
2807 is the help-message
2808 .\" ---------------------------------------------------------------------------
2810 This performs the check and modifications
2811 for the command-line option "\fB\-\-keep\-tite\fP",
2813 the command-line option \fB\-\-erase\-on\-exit\fP.
2818 depending on the \fB\-\-stdout\fP option.
2819 .\" ---------------------------------------------------------------------------
2826 .B int * \fIretval
2827 stores the exit-code to pass back to the caller.
2828 .\" ---------------------------------------------------------------------------
2831 .\" ---------------------------------------------------------------------------
2841 .B int \fIlimit
2844 .B int \fIoffset
2846 .\" ---------------------------------------------------------------------------
2848 Check for a key-binding.
2850 the given curses-key.
2856 .B int \fIcurses_key
2857 is the curses key-code
2859 .B int * \fIdialog_key
2862 .\" ---------------------------------------------------------------------------
2866 .B int \fImax_len
2868 .\" ---------------------------------------------------------------------------
2874 .B int \fIch
2879 .\" ---------------------------------------------------------------------------
2881 This entrypoint provides the \fB\-\-menu\fP
2882 functionality without the limitations of \fB\*p\fP's command-line syntax
2891 .B int \fIheight
2895 .B int \fIwidth
2899 .B int \fImenu_height
2901 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
2903 .B int \fIitem_no
2909 .B int * \fIcurrent_item
2918 .\" ---------------------------------------------------------------------------
2920 Moves/resizes the given window to the given position and size.
2932 y-ordinate to use for the repositioned window.
2935 x-ordinate to use for the repositioned window.
2936 .\" ---------------------------------------------------------------------------
2938 Retrieve the big-region under the pointer.
2940 .B int \fIy
2943 .B int \fIx
2945 .\" ---------------------------------------------------------------------------
2948 .\" ---------------------------------------------------------------------------
2950 Creates a region on which the mouse-clicks will return a specified code.
2952 .B int \fIy
2953 is the top-row of the region.
2955 .B int \fIx
2956 is the left-column of the region.
2958 .B int \fIheight
2961 .B int \fIwidth
2964 .B int \fIcode
2967 .B int \fIstep_x
2968 is used in modes 2 (columns) and 3 (cells) to determine the width
2971 .B int \fIstep_y
2974 .B int \fImode
2976 a code (like a function-key):
2988 .\" ---------------------------------------------------------------------------
2991 .B int \fIy
2992 is the top-row of the region.
2994 .B int \fIx
2995 is the left-column of the region.
2997 .B int \fIheight
3000 .B int \fIwidth
3003 .B int \fIcode
3005 .\" ---------------------------------------------------------------------------
3009 .B int \fIy
3010 is the row of the mouse-click
3012 .B int \fIx
3013 is the column of the mouse-click
3014 .\" ---------------------------------------------------------------------------
3019 .B int \fIx
3020 is the left-column for the base
3022 .B int \fIy
3023 is the top-row for the base
3024 .\" ---------------------------------------------------------------------------
3028 By providing different values,
3031 The \fIbuildlist\fP widget uses this feature to recognize mouse-clicks
3034 .B int \fIcode
3036 .\" ---------------------------------------------------------------------------
3038 is a wrapper for \fBdlg_getc\fP which additionally maps mouse-clicks
3039 (if the curses library supports those) into extended function-keys
3042 Returns the corresponding key-code.
3047 .B int * \fIfkey
3048 the referenced location is set to true if the key-code is an actual
3049 or extended (mouse) function-key.
3050 .\" ---------------------------------------------------------------------------
3052 This is a non-blocking variant of \fBdlg_mouse_wgetch\fP.
3057 .B int * \fIfkey
3058 the referenced location is set to true if the key-code is an actual
3059 or extended (mouse) function-key.
3060 .\" ---------------------------------------------------------------------------
3062 Check if an output-separator is needed.
3066 .\" ---------------------------------------------------------------------------
3072 is the parent window (usually the top-level window of a widget)
3074 .B int \fIheight
3077 .B int \fIwidth
3080 .B int \fIy
3081 is the window's top-row
3083 .B int \fIx
3084 is the window's left-column
3085 .\" ---------------------------------------------------------------------------
3090 .B int \fIheight
3093 .B int \fIwidth
3096 .B int \fIy
3097 is the window's top-row
3099 .B int \fIx
3100 is the window's left-column
3101 .\" ---------------------------------------------------------------------------
3108 .B int \fIbutton
3109 is the current button-index.
3110 .\" ---------------------------------------------------------------------------
3115 .B int \fIcurrent
3118 .B int \fIextra
3120 .\" ---------------------------------------------------------------------------
3123 into \fB\*p\fP's exit-code.
3125 .B int \fIbutton
3126 is the button-index (which is not necessarily the same as the index
3128 .\" ---------------------------------------------------------------------------
3132 .\" ---------------------------------------------------------------------------
3136 .\" ---------------------------------------------------------------------------
3139 .\" ---------------------------------------------------------------------------
3142 a curses-ordinate from a dialog-ordinate.
3143 .\" ---------------------------------------------------------------------------
3145 Parse the parameters of the \*(``bindkeys\*('' configuration-file entry.
3146 This expects widget name which may be "*", followed by curses key definition and
3151 .\" ---------------------------------------------------------------------------
3153 Parse the configuration file and set up variables.
3154 .\" ---------------------------------------------------------------------------
3156 Open a pipe which ties the standard error and output together.
3163 Like \fBpopen\fP, "r" is used to read, and "w" is used to write.
3164 .\" ---------------------------------------------------------------------------
3171 .B int \fIbutton
3173 .\" ---------------------------------------------------------------------------
3177 Each list-widget has \*(``tag\*('' and \*(``description\*('' values
3190 .B int \fIclimit
3194 true if this is the first call (for \*(``tag\*('' and \*(``description\*(''),
3197 .B int \fIselected
3199 .\" ---------------------------------------------------------------------------
3202 to scroll too-long prompt text up/down.
3205 variable used as a parameter here.
3216 .B int \fIoffset
3217 is the starting line-number to write wrapped text.
3219 .B int \fIheight
3222 .B int \fIwidth
3225 .B int \fIpauseopt
3228 .\" ---------------------------------------------------------------------------
3232 The line will end on a word boundary and a pointer
3240 holds the starting attributes, and is updated to reflect the final attributes
3246 .B int \fIlm
3249 .B int \fIrm
3252 .B int *\fIx
3253 returns the ending x-ordinate.
3254 .\" ---------------------------------------------------------------------------
3258 .B int \fIcurrent
3261 .B int \fIextra
3263 .\" ---------------------------------------------------------------------------
3276 .B int \fIheight
3279 .B int \fIwidth
3281 .\" ---------------------------------------------------------------------------
3288 .B int \fIheight
3291 .B int \fIwidth
3293 .\" ---------------------------------------------------------------------------
3296 optionally rendering \fB\*p\fP's escape sequences for attributes and color.
3304 .B int \fIcol
3308 holds the starting attributes, and is updated to reflect the final attributes
3310 .\" ---------------------------------------------------------------------------
3312 implements the "\fB\-\-prgbox\fP" and "\fB\-\-progressbox\fP" options.
3321 .B int \fIheight
3325 .B int \fIwidth
3329 .B int \fIpauseopt
3337 .\" ---------------------------------------------------------------------------
3339 Display the background title if \fBdialog_vars.backtitle\fP is non-null.
3341 .\" ---------------------------------------------------------------------------
3349 Otherwise, it updates the title and cprompt values, reusing the window
3351 As a side-effect, the function stores the updated object-pointer via
3360 .B int \fIheight
3364 .B int \fIwidth
3368 .B int \fIpercent
3370 .\" ---------------------------------------------------------------------------
3384 .\" ---------------------------------------------------------------------------
3396 .\" ---------------------------------------------------------------------------
3402 .\" ---------------------------------------------------------------------------
3404 This is a utility function which supports the \fB\-\-inputmenu\fP option of
3411 followed by the menu item's name and the \fInewtext\fP value
3418 .B int \fIcurrent
3419 is the index of the currently-selected item
3423 .\" ---------------------------------------------------------------------------
3427 .\" ---------------------------------------------------------------------------
3429 Restore \fB\*p\fP's variables from the given variable
3433 is the variable from which to restore.
3436 \fIDIALOG_VARS.input_length\fP and
3440 .\" ---------------------------------------------------------------------------
3444 This is only useful if there are user-defined key bindings, since there are
3445 no built-in bindings that map directly to \fBDLGK_OK\fP, etc.
3448 .B int \fIdialog_key
3451 .B int \fIfkey
3454 .B int * \fIresultp
3456 .\" ---------------------------------------------------------------------------
3458 Save \fB\*p\fP's variables into the given variable (see \fBdlg_restore_vars\fP).
3461 is the variable into which to save.
3462 .\" ---------------------------------------------------------------------------
3468 is the parent window (usually the top-level window of a widget)
3472 .\" ---------------------------------------------------------------------------
3474 Setup a fixed-buffer for the result in \fBdialog_vars.input_result\fP
3478 .\" ---------------------------------------------------------------------------
3481 reads, e.g., to allow the gauge widget to handle window-resizing events.
3484 library processes window-resizing events.
3489 is the window whose input-timeout should be set
3494 .\" ---------------------------------------------------------------------------
3496 Displays the string, shifted as necessary, to fit within the box and show
3497 the current character-offset.
3505 .B int \fIoffset
3511 .B int \fIy_base
3514 .B int \fIx_base
3517 .B int \fIx_last
3525 .\" ---------------------------------------------------------------------------
3531 .\" ---------------------------------------------------------------------------
3540 .\" ---------------------------------------------------------------------------
3549 however you can double-quote an argument to enclose blanks.
3550 The surrounding double-quotes are removed from the string.
3552 A backslash preceding a double-quote within double-quotes is removed.
3554 A backslash preceding a newline outside double-quotes is removed.
3561 .\" ---------------------------------------------------------------------------
3568 .B int \fIheight
3571 .B int \fIwidth
3574 .B int \fIy
3575 is the subwindow's top-row
3577 .B int \fIx
3578 is the subwindow's left-column
3579 .\" ---------------------------------------------------------------------------
3587 .\" ---------------------------------------------------------------------------
3589 If the parameter is non-null, opens a trace file with that
3590 name and stores the file pointer in \fBdialog_state.trace\fP.
3591 .\" ---------------------------------------------------------------------------
3598 .B int \fIvalue
3600 .\" ---------------------------------------------------------------------------
3609 .B int \fIvalue
3611 .\" ---------------------------------------------------------------------------
3617 .B int \fIch
3620 .B int \fIfkey
3622 Some of these may be values declared in the DLG_KEYS_ENUM.
3623 .\" ---------------------------------------------------------------------------
3628 is the format of the \fBprintf\fP-like message to write.
3636 It uses an extra level of parentheses to work with a variable number of
3641 .\" ---------------------------------------------------------------------------
3646 is the format of the \fBprintf\fP-like message to write.
3660 .\" ---------------------------------------------------------------------------
3664 .\" ---------------------------------------------------------------------------
3668 .\" ---------------------------------------------------------------------------
3680 .B int \fIheight
3684 .B int \fIwidth
3688 .B int \fIlist_height
3690 If zero, it is computed based on the given \fIheight\fP and \fIwidth\fP.
3692 .B int \fIitem_no
3696 is the list of items, contain tag, name, and optionally help strings
3702 Normally a buildlist provides true (1) and false (0) values,
3703 which the widget displays as "*" and space, respectively.
3704 An application may set this parameter to an arbitrary null-terminated string.
3705 The widget determines the number of states from the length of this string,
3707 presses the space-bar.
3709 .B int * \fIdepths
3714 .B int \fIflag
3718 .B int * \fIcurrent_item
3721 .\" ---------------------------------------------------------------------------
3771 .\" ---------------------------------------------------------------------------
3777 .\" ---------------------------------------------------------------------------
3784 .B int \fIpercent
3786 .\" ---------------------------------------------------------------------------
3788 This filters out bursts of \fBKEY_RESIZE\fP values.
3791 .\" ---------------------------------------------------------------------------
3793 Map the given button index for \fBdlg_yes_labels\fP into \fB\*p\fP's exit-code.
3795 .B int \fIbutton
3797 .\" ---------------------------------------------------------------------------
3800 .\" ---------------------------------------------------------------------------
3803 .\" ---------------------------------------------------------------------------
3810 \fB\-\-input\-fd\fP option is used, it may be anything.
3815 if \fB\-\-stdout\fP or \fB\-\-output\-fd\fP is used, it may be anything.