diff options
| author | Katja Marttila <katja.marttila@qt.io> | 2020-05-08 08:42:53 +0300 |
|---|---|---|
| committer | Katja Marttila <katja.marttila@qt.io> | 2020-05-15 13:07:22 +0300 |
| commit | 20f1400a11837005f0904f2c7cdb40dcd4d5b669 (patch) | |
| tree | 366d4f8ba0b3ffd03d0a5ba06ef0a66961d78d32 /doc | |
| parent | 7f33b7b83320f8d6c9cb40f7d5d9d9842a22e8f8 (diff) | |
CLI: Add option to read arbitrary user input
Added new readConsoleLine() function which can be used to read user
input from console. Function can be only called when command line
instance is used without gui.
Task-number: QTIFW-1631
Change-Id: Ic856f4bafc4a8d469d3fe497b4e0321e104df499
Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/scripting-api/packagemanagercore.qdoc | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc index 50666d3be..ac6cad2ce 100644 --- a/doc/scripting-api/packagemanagercore.qdoc +++ b/doc/scripting-api/packagemanagercore.qdoc @@ -358,6 +358,20 @@ */ /*! + \qmlmethod string installer::readConsoleLine(string title, int maxlen) + + Prints \a title to a console and reads console input. Function halts the + installer and waits for user input. Function returns a line which user has + typed into the console. The maximum allowed line length is set to + \a maxlen. If the stream contains lines longer than this, then the line is + split after \a maxlen characters. If \a maxlen is 0, the line can be of + any length. + + \note This function can only be called when installing from a command line + instance without GUI. +*/ + +/*! \qmlmethod boolean installer::fileExists(string filePath) Returns \c true if the \a filePath exists; otherwise returns \c false. |