Class TextInterface

Text output print function. By default text is written to stdout.

Parameters:

• text (string) - text to write to stdout
• header (string) - text header (decoration?)
• footer (string) - text footer (decoration?)
• back (bool) - push back cursor to the beginning of the line
• importance (int) - message importance (default valid values: 0, 1, 2, 3
• type (string) - message type (default valid values: "info", "warning", "error")
• count (tuple) - tuple of lengh 2, containing count information to make function print something like "(10/100) doing stuff". In this case tuple would be: (10, 100,)
• percent - determine whether "count" argument should be printed as percentual value (for values like (10, 100,), "(10%) doing stuff" will be printed.
• percent - bool

Returns: None

None

Questions asking function. It asks the user to answer the question given by choosing between a preset list of answers given by the "reposonses" argument.

Parameters:

• question (string) - question text
• importance (int) - question importance (no default valid values)
• responses (tuple or list) - list of valid answers which user has to choose from

Returns: None

None

Generic input box (form) creator and data collector.

@param title: input box title
@type title: string
@param input_parameters: list of properly formatted tuple items.
@type input_parameters: list
@keyword cancel_button: make possible to "cancel" the input request.
@type cancel_button: bool
@return: dict containing input box answers
@rtype: dict

input_parameters supported items:

[input id], [input text title], [input verification callback], [
    no text echo?]
('identifier 1', 'input text 1', input_verification_callback, False)

('item_3', ('checkbox', 'Checkbox option (boolean request) - please choose',),
    input_verification_callback, True)

('item_4', ('combo', ('Select your favorite option', ['option 1', 'option 2', 'option 3']),),
    input_verification_callback, True)

('item_4',('list',('Setup your list',['default list item 1', 'default list item 2']),),
    input_verification_callback, True)

Not actually implemented. Can be useful for external applications and its used to determine when a certain transaction is done.

Set application title.

Parameters:

• title (string) - new application title

Not actually implemented. Can be useful for external applications and its used to set the amount of logical transactions that this interface has to go through.

Disable coloured output. Used for terminals.