Class cli_t

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

(inherited documentation)

Registers the CLI.

Parameters:

• flags - Feature bits. No bits are defined yet, must be 0
• sname - Short name (displayed on the button)
• lname - Long name (displayed in the menu)
• hint - Hint for the input line

The user pressed Enter. The CLI is free to execute the line immediately or ask for more lines.

This callback is mandatory.

Parameters:

• line - typed line(s)

A keyboard key has been pressed This is a generic callback and the CLI is free to do whatever it wants.

This callback is optional.

Parameters:

• line - current input line
• x - current x coordinate of the cursor
• sellen - current selection length (usually 0)
• vkey - virtual key code. if the key has been handled, it should be returned as zero
• shift - shift state

Returns:

None - Nothing was changed tuple(line, x, sellen, vkey): if either of the input line or the x coordinate or the selection length has been modified. It is possible to return a tuple with None elements to preserve old values. Example: tuple(new_line, None, None, None) or tuple(new_line)

The user pressed Tab. Find a completion number N for prefix PREFIX

This callback is optional.

Parameters:

• prefix - Line prefix at x (string)
• n - completion number (int)
• line - the current line (string)
• prefix_start - the index where PREFIX starts in LINE (int)

Returns:

None if no completion could be generated otherwise a String with the completion suggestion