Making a Text User Interface (TUI) dialog from Quo Renderables

Installation

Install from the command line

  pip install -U quo

Quo ships with a high level API for displaying dialog boxes to the user for informational purposes, or get input from the user.

Message Box

Use the quo.dialog.MessageBox function to display a
simple message box. For instance:

 from quo.dialog import MessageBox

 MessageBox(
    title='Example dialog window',
    text='Do you want to continue?\nPress ENTER to quit.')

Input Box`

Function quo.dialog.InputBox function can display an
input box. It will return the user input as a string.
python
from quo.dialog import InputBox
InputBox(
title='Input dialog example',
text='Please type your name:')


The hide=True option can be passed to the quo.dialog.InputBox function to turn this into a password input box.

Confirmation Box

Function quo.dialog.ConfirmBoxdisplays a yes/no
confirmation dialog. It will return a boolean according to the selection.
`python
from quo.dialog import ConfirmBox

ConfirmBox(
title='Yes/No dialog example',
text='Do you want to confirm?')
`

Choice Box

Function quo.dialog.ChoiceBox function displays a dialog
with choices offered as buttons. Buttons are indicated as a list of tuples, each providing the label (first) and return value if clicked (second).

`python
from quo.dialog import ChoiceBox

ChoiceBox(
title='Button dialog example',
text='Do you want to confirm?',
buttons=[
('Yes', True),
('No', False),
('Maybe...', None)
])
`

Radiolist Box

Function quo.dialog.RadiolistBox function displays a dialog
with choices offered as a radio list. The values are provided as a list of tuples,
each providing the return value (first element) and the displayed value (second element).
`python
from quo.dialog import RadiolistBox

RadiolistBox(
title="RadioList dialog",
text="Which breakfast would you like ?",
values=[
("breakfast1", "Eggs and beacon"),
("breakfast2", "French breakfast"),
("breakfast3", "Equestrian breakfast")
])
`

Check Box

Function quo.dialog.CheckBox has the same usage and purpose than the Radiolist dialog, but allows several values to be selected and therefore returned.
`python
from quo.dialog import CheckBox

CheckBox(
title="CheckboxList dialog",
text="What would you like in your breakfast ?",
values=[
("eggs", "Eggs"),
("bacon", "Bacon"),
("croissants", "20 Croissants"),
("daily", "The breakfast of the day")
])
`

Styling of dialogs

A custom class quo.style.Style instance can be passed to all
dialogs to override the default style. Also, text can be styled by passing a quo.text.Text object.

`python
from quo.dialog import MessageBox
from quo.style import Style
from quo.text import Text

example = Style.add({
'dialog': 'bg:#88ff88',
'dialog frame.label': 'bg:#ffffff fg:#000000',
'dialog.body': 'bg:#000000 fg:#00ff00',
'dialog shadow': 'bg:#00aa00' })
MessageBox(
title=Text('Styled '
'dialog window'),
text='Do you want to continue?\nPress ENTER to quit.',
style=example)
`