Lines Matching +full:enforce +full:- +full:video +full:- +full:mode

3 .\" Copyright 2005-2020,2021  Thomas E. Dickey
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
110 The \fB\*p\fP application passes its command-line parameters
115 When the \fB\-\-item\-help\fP option is given, an extra column
139 .\" ---------------------------------------------------------------------------
143 .\" ---------------------------------------------------------------------------
148 .\" ---------------------------------------------------------------------------
153 .\" ---------------------------------------------------------------------------
155 This corresponds to the command-line option "\fB\-\-aspect\-ratio\fP".
161 .\" ---------------------------------------------------------------------------
167 .\" ---------------------------------------------------------------------------
172 .\" ---------------------------------------------------------------------------
177 .\" ---------------------------------------------------------------------------
183 .\" ---------------------------------------------------------------------------
185 This corresponds to the command-line option "\fB\-\-no\-mouse\fP".
188 .\" ---------------------------------------------------------------------------
196 e.g., by using the "\fB\-\-stdout\fP" option.
197 .\" ---------------------------------------------------------------------------
205 .\" ---------------------------------------------------------------------------
211 "\fB\-\-input\-fd\fP" option.
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 .\" ---------------------------------------------------------------------------
233 .\" ---------------------------------------------------------------------------
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
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".
312 .\" ---------------------------------------------------------------------------
314 This corresponds to the command-line option "\fB\-\-visit\-items\fP".
315 Modify the tab-traversal of the list-oriented widgets
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".
386 which tells \fB\*p\fP to set colors or video attributes:
402 .\" ---------------------------------------------------------------------------
404 This corresponds to the command-line option "\fB\-\-column\-separator\fP".
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".
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".
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".
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".
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
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".
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
565 .\" ---------------------------------------------------------------------------
567 This corresponds to the command-line option "\fB\-\-insecure\fP".
570 .\" ---------------------------------------------------------------------------
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".
586 .\" ---------------------------------------------------------------------------
588 This corresponds to the command-line option "\fB\-\-item\-help\fP".
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,
632 .\" ---------------------------------------------------------------------------
634 This corresponds to the command-line option "\fB\-\-no\-items\fP".
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".
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
708 \fB\*L\fP does the same on the command-line.
711 .\" ---------------------------------------------------------------------------
713 This corresponds to the command-line option "\fB\-\-no\-cancel\fP".
717 .\" ---------------------------------------------------------------------------
719 This corresponds to the command-line option "\fB\-\-no\-collapse\fP".
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".
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".
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.
896 implements the "\fB\-\-calendar\fP" option.
905 is the height excluding the fixed-height calendar grid.
926 implements the "\fB\-\-checklist\fP" and "\fB\-\-radiolist\fP" options
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.
985 implements the "\fB\-\-editbox\fP" option.
1002 implements the "\fB\-\-form\fP" option.
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.
1057 implements the "\fB\-\-gauge\fP" option.
1083 implements the "\fB\-\-inputbox\fP" or
1084 "\fB\-\-password\fP" option, depending on the value of \fIpassword\fP.
1102 when auto-sizing the width of the dialog box.
1108 implements the "\fB\-\-hfile\fP" option.
1117 The \fB\*p\fP program sets that variable when the \fB\-\-hfile\fP option
1129 implements the "\fB\-\-menu\fP" or "\fB\-\-inputmenu\fP" option
1167 implements the "\fB\-\-mixedform\fP" option.
1204 implements the "\fB\-\-mixedgauge\fP" option
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
1286 implements the "\fB\-\-pause\fP" option.
1303 implements the "\fB\-\-prgbox\fP" option.
1328 implements the "\fB\-\-progressbox\fP" option.
1346 implements the "\fB\-\-rangebox\fP" option.
1373 implements the "\fB\-\-tailbox\fP" or "\fB\-\-tailboxbg\fP" option
1398 implements the "\fB\-\-textbox\fP" option.
1415 implements the "\fB\-\-timebox\fP" option.
1447 implements the "\fB\-\-treeview\fP" option.
1481 implements the "\fB\-\-yesno\fP" option.
1499 Most functions that implement lower-level
1500 functionality for the command-line \fB\*p\fP
1505 The only non-widget function whose name begins with "\fIdialog_\fP"
1515 .\" ---------------------------------------------------------------------------
1522 .\" ---------------------------------------------------------------------------
1535 .\" ---------------------------------------------------------------------------
1537 This is a utility function used enforce consistent behavior for
1544 the tag- or help-text is stored here.
1547 contains the list item to use for tag- or help-text.
1548 .\" ---------------------------------------------------------------------------
1550 This is a utility function used enforce consistent behavior for
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 .\" ---------------------------------------------------------------------------
1612 .\" ---------------------------------------------------------------------------
1619 Caveat: This function is only implemented for 8-bit characters.
1630 .\" ---------------------------------------------------------------------------
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 .\" ---------------------------------------------------------------------------
1676 .\" ---------------------------------------------------------------------------
1685 as a side-effect.
1717 taking into account a (possibly) multi-line \fIprompt\fP.
1737 taking into account a (possibly) multi-line \fIprompt\fP.
1748 .\" ---------------------------------------------------------------------------
1762 If it is -1, use the screen's height
1767 limit the referenced value to the screen-height
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
1785 .\" ---------------------------------------------------------------------------
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.
1815 .\" ---------------------------------------------------------------------------
1817 returns a suitable y-ordinate (row) for a new widget.
1824 .\" ---------------------------------------------------------------------------
1860 An application may set this parameter to an arbitrary null-terminated string.
1863 presses the space-bar.
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
1884 number into exit-code.
1885 .\" ---------------------------------------------------------------------------
1897 if that is wider than the passed-in limit.
1898 .\" ---------------------------------------------------------------------------
1913 .\" ---------------------------------------------------------------------------
1917 If the label is empty, return -1.
1933 .\" ---------------------------------------------------------------------------
1935 Compute the step-size needed between elements of the button array.
1952 store the step-size in the referenced location.
1953 .\" ---------------------------------------------------------------------------
1969 .\" ---------------------------------------------------------------------------
1974 on input, is the height without adding the list-height.
1975 On return, this contains the total list-height and is the
1979 on input, is the requested list-height.
1986 .\" ---------------------------------------------------------------------------
1988 This function is obsolete, provided for library-compatibility.
1999 .\" ---------------------------------------------------------------------------
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
2047 An application may set this parameter to an arbitrary null-terminated string.
2050 presses the space-bar.
2059 .\" ---------------------------------------------------------------------------
2079 Some widgets use these key bindings for scrolling the prompt-text up and
2083 and -1 if not.
2086 is the function-key to check
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 .\" ---------------------------------------------------------------------------
2167 .\" ---------------------------------------------------------------------------
2170 return the button-index for that button code,
2173 .\" ---------------------------------------------------------------------------
2183 .\" ---------------------------------------------------------------------------
2185 This function is obsolete, provided for library-compatibility.
2193 .\" ---------------------------------------------------------------------------
2196 find the button-index for the \*(``Cancel\*('' button.
2198 .\" ---------------------------------------------------------------------------
2204 .\" ---------------------------------------------------------------------------
2218 is the subwindow's top-row
2221 is the subwindow's left-column
2222 .\" ---------------------------------------------------------------------------
2227 .\" ---------------------------------------------------------------------------
2237 is true if an up-arrow should be drawn at the top of the window.
2240 is true if an down-arrow should be drawn at the bottom of the window.
2243 is the zero-based column within the window on which to draw arrows.
2246 is the zero-based row within the window on which to draw up-arrows
2250 is the zero-based row within the window on which to draw down-arrows
2252 .\" ---------------------------------------------------------------------------
2260 is true if an up-arrow should be drawn at the top of the window.
2263 is true if an down-arrow should be drawn at the bottom of the window.
2266 is the zero-based column within the window on which to draw arrows.
2269 is the zero-based row within the window on which to draw up-arrows
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 .\" ---------------------------------------------------------------------------
2334 It also is fill-color used for the box contents.
2338 .\" ---------------------------------------------------------------------------
2358 is used to fill-color for the box contents.
2365 .\" ---------------------------------------------------------------------------
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.
2426 is the zero-based left margin/column of the window.
2430 is the zero-based right margin/column of the window.
2434 is the zero-based row within the window on which to draw up-arrows
2438 is the zero-based row within the window on which to draw down-arrows
2446 .\" ---------------------------------------------------------------------------
2449 a 3-dimensional look.
2466 .\" ---------------------------------------------------------------------------
2475 .\" ---------------------------------------------------------------------------
2477 This is a utility function which supports the \fB\-\-inputmenu\fP option of
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 .\" ---------------------------------------------------------------------------
2523 .\" ---------------------------------------------------------------------------
2525 Given the character-offset in the string,
2526 returns the display-offset where
2535 is the character-offset
2540 .\" ---------------------------------------------------------------------------
2542 Updates the string and character-offset, given various editing characters
2543 or literal characters which are inserted at the character-offset.
2546 which is a non-editing action outside this function.
2552 is the character-offset
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 .\" ---------------------------------------------------------------------------
2577 .\" ---------------------------------------------------------------------------
2579 Returns the name of an exit-code, e.g.,
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.
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
2622 contains a list of character-offsets,
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
2669 .\" ---------------------------------------------------------------------------
2671 This entrypoint provides the \fB\-\-form\fP
2672 functionality without the limitations of \fB\*p\fP's command-line syntax
2702 .\" ---------------------------------------------------------------------------
2715 .\" ---------------------------------------------------------------------------
2721 .\" ---------------------------------------------------------------------------
2727 .\" ---------------------------------------------------------------------------
2732 Also, if input-callback(s) are set up,
2735 Returns the key-code.
2741 as a side-effect, set this to true if the key-code is really a function-key.
2742 .\" ---------------------------------------------------------------------------
2751 the function-return.
2755 is the name of the environment-variable to retrieve.
2758 is the optional pointer to a return-value.
2759 .\" ---------------------------------------------------------------------------
2764 is the name of the environment-variable to retrieve.
2765 .\" ---------------------------------------------------------------------------
2767 extract the video attributes from the given window.
2771 .\" ---------------------------------------------------------------------------
2773 passes the given key-code \fIch\fP to the current window that
2780 is the key-code
2783 is true if the key is a function-key
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 .\" ---------------------------------------------------------------------------
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 .\" ---------------------------------------------------------------------------
2827 stores the exit-code to pass back to the caller.
2828 .\" ---------------------------------------------------------------------------
2831 .\" ---------------------------------------------------------------------------
2846 .\" ---------------------------------------------------------------------------
2848 Check for a key-binding.
2850 the given curses-key.
2857 is the curses key-code
2862 .\" ---------------------------------------------------------------------------
2868 .\" ---------------------------------------------------------------------------
2879 .\" ---------------------------------------------------------------------------
2881 This entrypoint provides the \fB\-\-menu\fP
2882 functionality without the limitations of \fB\*p\fP's command-line syntax
2918 .\" ---------------------------------------------------------------------------
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.
2945 .\" ---------------------------------------------------------------------------
2948 .\" ---------------------------------------------------------------------------
2950 Creates a region on which the mouse-clicks will return a specified code.
2953 is the top-row of the region.
2956 is the left-column of the region.
2974 .B int \fImode
2976 a code (like a function-key):
2988 .\" ---------------------------------------------------------------------------
2992 is the top-row of the region.
2995 is the left-column of the region.
3005 .\" ---------------------------------------------------------------------------
3010 is the row of the mouse-click
3013 is the column of the mouse-click
3014 .\" ---------------------------------------------------------------------------
3020 is the left-column for the base
3023 is the top-row for the base
3024 .\" ---------------------------------------------------------------------------
3031 The \fIbuildlist\fP widget uses this feature to recognize mouse-clicks
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
3040 which encode the position according to the \fImode\fP in
3042 Returns the corresponding key-code.
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.
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)
3081 is the window's top-row
3084 is the window's left-column
3085 .\" ---------------------------------------------------------------------------
3097 is the window's top-row
3100 is the window's left-column
3101 .\" ---------------------------------------------------------------------------
3109 is the current button-index.
3110 .\" ---------------------------------------------------------------------------
3120 .\" ---------------------------------------------------------------------------
3123 into \fB\*p\fP's exit-code.
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.
3151 .\" ---------------------------------------------------------------------------
3154 .\" ---------------------------------------------------------------------------
3164 .\" ---------------------------------------------------------------------------
3173 .\" ---------------------------------------------------------------------------
3177 Each list-widget has \*(``tag\*('' and \*(``description\*('' values
3199 .\" ---------------------------------------------------------------------------
3202 to scroll too-long prompt text up/down.
3217 is the starting line-number to write wrapped text.
3228 .\" ---------------------------------------------------------------------------
3253 returns the ending x-ordinate.
3254 .\" ---------------------------------------------------------------------------
3263 .\" ---------------------------------------------------------------------------
3281 .\" ---------------------------------------------------------------------------
3293 .\" ---------------------------------------------------------------------------
3310 .\" ---------------------------------------------------------------------------
3312 implements the "\fB\-\-prgbox\fP" and "\fB\-\-progressbox\fP" options.
3337 .\" ---------------------------------------------------------------------------
3339 Display the background title if \fBdialog_vars.backtitle\fP is non-null.
3341 .\" ---------------------------------------------------------------------------
3351 As a side-effect, the function stores the updated object-pointer via
3370 .\" ---------------------------------------------------------------------------
3384 .\" ---------------------------------------------------------------------------
3396 .\" ---------------------------------------------------------------------------
3402 .\" ---------------------------------------------------------------------------
3404 This is a utility function which supports the \fB\-\-inputmenu\fP option of
3419 is the index of the currently-selected item
3423 .\" ---------------------------------------------------------------------------
3427 .\" ---------------------------------------------------------------------------
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.
3456 .\" ---------------------------------------------------------------------------
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 .\" ---------------------------------------------------------------------------
3497 the current character-offset.
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 .\" ---------------------------------------------------------------------------
3575 is the subwindow's top-row
3578 is the subwindow's left-column
3579 .\" ---------------------------------------------------------------------------
3587 .\" ---------------------------------------------------------------------------
3589 If the parameter is non-null, opens a trace file with that
3591 .\" ---------------------------------------------------------------------------
3600 .\" ---------------------------------------------------------------------------
3611 .\" ---------------------------------------------------------------------------
3623 .\" ---------------------------------------------------------------------------
3628 is the format of the \fBprintf\fP-like message to write.
3641 .\" ---------------------------------------------------------------------------
3646 is the format of the \fBprintf\fP-like message to write.
3660 .\" ---------------------------------------------------------------------------
3664 .\" ---------------------------------------------------------------------------
3668 .\" ---------------------------------------------------------------------------
3704 An application may set this parameter to an arbitrary null-terminated string.
3707 presses the space-bar.
3721 .\" ---------------------------------------------------------------------------
3771 .\" ---------------------------------------------------------------------------
3777 .\" ---------------------------------------------------------------------------
3786 .\" ---------------------------------------------------------------------------
3791 .\" ---------------------------------------------------------------------------
3793 Map the given button index for \fBdlg_yes_labels\fP into \fB\*p\fP's exit-code.
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.