mcui

Mandolin Creek User Interface (MCUI) support

Dependency Graph

mcui: Library Dependencies

View the full-size SVG (svg) or PDF (pdf) image or graphviz source (dot)

View color source code (raw) for this file

View reStructuredText (rst) source code for this page

Library initialization

mcui_lib_init

detects best MCUI backend and loads it

mcui_backend_load

selects the best available backend

mcui_backend_load

loads the selected backend

Configuration

mcui_remember

name of flag to remember to ignore a dialog

mcui_multiple

allow multiple selections

mcui_separate_output

output one selection per line

Internal functions

mcui_run_prompt()

Runs a MCUI prompt function

$1 - function

$2 - output variable

$3 - prompt

mcui_prompt_result()

Interprets result of a MCUI prompt function

$1 - output variable

$2 - return code

Output UI functions

mcui_error

display error string and wait for acknowledgement

$1 - message

mcui_error_details

display error w/ details and wait for acknowledgement

$1 - message

$2 - details

mcui_warn

display warning string and wait for acknowledgement

$1 - message

mcui_warn_details

display warning w/ details and wait for acknowledgement

$1 - message

$2 - details

mcui_info

display info string and wait for acknowledgement

$1 - message

mcui_textbox

display text file and wait for acknowledgement

$1 - file

mcui_passive

display passive information

$1 - message

mcui_progress

display progress bar

$1 - message

$2 - percent (0--100)

Prompt UI functions

mcui_yesno

prompt user with a benign yes/no question

$1 - output variable

$2 - prompt

mcui_yesno_warn

prompt user with a risky yes/no question

$1 - output variable

$2 - prompt

mcui_yesnocancel

prompt user with a benign yes/no/cancel question

$1 - output variable

$2 - prompt

mcui_yesnocancel_warn

prompt user with a risk yes/no/cancel question

$1 - output variable

$2 - prompt

mcui_continue_cancel

prompt user with a risk continue/cancel question

$1 - output variable

$2 - prompt

Input UI functions

mcui_input_run

wraps input functions to echo result to stdout

mcui_input

prompt user with a input box

$1 - output variable

$2 - prompt

$3 - initial text

mcui_input_file

prompt user with a file in an input box

$1 - output variable

$2 - prompt

$3 - file

mcui_input_text

prompt user with a large text input box

$1 - output variable

$2 - prompt

$3 - initial text

mcui_askpass

prompt user for a password

$1 - output variable

$2 - prompt

$3 - initial text

High-level UI support

Unimplemented functions

unimplemented

Function to use as placeholder for later implementation

set default behavior to error


View the Developer Guide Index

View the Reference Manual Index


Generated on Thu May 4 19:02:30 PDT 2017 by mcsh i7 v0.19.0.