diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-09-09 01:03:21 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-09-09 01:03:21 -0400 |
| commit | d582466335d3182a15dc40bf2d8b6737fb158d46 (patch) | |
| tree | 912c44bae977727cb0faa2d307fe87d1c48495b4 /docs/api/utils.rst | |
| parent | a95034f9537b498acb09943cde7c323001206937 (diff) | |
| download | cmd2-git-d582466335d3182a15dc40bf2d8b6737fb158d46.tar.gz | |
Moved two classes from cmd2.py to utils.py.
Diffstat (limited to 'docs/api/utils.rst')
| -rw-r--r-- | docs/api/utils.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 188f5b16..9276587f 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -36,6 +36,33 @@ IO Handling :members: +Tab Completion +-------------- + +.. autoclass:: cmd2.utils.CompletionMode + + .. attribute:: NONE + + Tab completion will be disabled during read_input() call. Use of custom + up-arrow history supported. + + .. attribute:: COMMANDS + + read_input() will tab complete cmd2 commands and their arguments. + cmd2's command line history will be used for up arrow if history is not + provided. Otherwise use of custom up-arrow history supported. + + .. attribute:: CUSTOM + + read_input() will tab complete based on one of its following parameters + (choices, choices_provider, completer, parser). Use of custom up-arrow + history supported + +.. autoclass:: cmd2.utils.CustomCompletionSettings + + .. automethod:: __init__ + + Text Alignment -------------- |