summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-09-25 23:12:45 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-09-25 23:12:45 -0400
commit2caa254bac711bb174384d6892e4961c86de1ae8 (patch)
tree9ced1707d1c3bfdc05eaad907f2a98c01bc9b326 /docs
parent7ea8d3b57d197690ac5792ee5eeb7898dc4519a4 (diff)
parentdcd79f34466f0fa31734bbbcfcd0fb7b44bca98d (diff)
downloadcmd2-git-2caa254bac711bb174384d6892e4961c86de1ae8.tar.gz
Merged alert_printer stuff from master and resolved conflicts
Diffstat (limited to 'docs')
-rw-r--r--docs/unfreefeatures.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst
index 0124132b..364addc6 100644
--- a/docs/unfreefeatures.rst
+++ b/docs/unfreefeatures.rst
@@ -209,3 +209,33 @@ Exit code to shell
The ``self.exit_code`` attribute of your ``cmd2`` application controls
what exit code is sent to the shell when your application exits from
``cmdloop()``.
+
+
+Asynchronous Feedback
+=====================
+``cmd2`` provides two functions to provide asynchronous feedback to the user without interfering with
+the command line. This means the feedback is provided to the user when they are still entering text at
+the prompt. To use this functionality, the application must be running in a terminal that supports
+VT100 control characters and readline. Linux, Mac, and Windows 10 and greater all support these.
+
+async_alert()
+ Used to display an important message to the user while they are at the prompt in between commands.
+ To the user it appears as if an alert message is printed above the prompt and their current input
+ text and cursor location is left alone.
+
+async_update_prompt()
+ Updates the prompt while the user is still typing at it. This is good for alerting the user to system
+ changes dynamically in between commands. For instance you could alter the color of the prompt to indicate
+ a system status or increase a counter to report an event.
+
+``cmd2`` also provides a function to change the title of the terminal window. This feature requires the
+application be running in a terminal that supports VT100 control characters. Linux, Mac, and Windows 10 and
+greater all support these.
+
+set_window_title()
+ Sets the terminal window title
+
+
+The easiest way to understand these functions is to see the AsyncPrinting_ example for a demonstration.
+
+.. _AsyncPrinting: https://github.com/python-cmd2/cmd2/blob/master/examples/async_printing.py