diff -r e440aaf179ce -r 64157aeb0312 src/eric7/Documentation/Source/eric7.QScintilla.Shell.html --- a/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html Wed Dec 20 19:28:22 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Shell.html Thu Dec 21 12:03:40 2023 +0100 @@ -611,7 +611,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -653,7 +653,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -667,7 +667,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -723,7 +723,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -737,7 +737,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -751,14 +751,14 @@ </p> <dl> -<dt><i>method</i></dt> +<dt><i>method</i> (int)</dt> <dd> shell method to execute </dd> -<dt><i>allLinesAllowed</i></dt> +<dt><i>allLinesAllowed</i> (bool)</dt> <dd> flag indicating that the command may be executed - on any line (boolean) + on any line </dd> </dl> <a NAME="Shell.__QScintillaLeftDeleteCommand" ID="Shell.__QScintillaLeftDeleteCommand"></a> @@ -771,7 +771,7 @@ </p> <dl> -<dt><i>method</i></dt> +<dt><i>method</i> (int)</dt> <dd> shell method to execute </dd> @@ -785,7 +785,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -799,7 +799,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -813,7 +813,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -827,7 +827,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -841,7 +841,7 @@ </p> <dl> -<dt><i>method</i></dt> +<dt><i>method</i> (function)</dt> <dd> shell method to execute </dd> @@ -855,7 +855,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -869,7 +869,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> QScintilla command </dd> @@ -911,9 +911,9 @@ </p> <dl> -<dt><i>language</i></dt> +<dt><i>language</i> (str)</dt> <dd> -lexer language to set (string) +lexer language to set </dd> </dl> <a NAME="Shell.__clearCurrentLine" ID="Shell.__clearCurrentLine"></a> @@ -961,17 +961,17 @@ </p> <dl> -<dt><i>exceptionType</i></dt> +<dt><i>exceptionType</i> (str)</dt> <dd> -type of exception raised (string) +type of exception raised </dd> -<dt><i>exceptionMessage</i></dt> +<dt><i>exceptionMessage</i> (str)</dt> <dd> -message given by the exception (string) +message given by the exception </dd> -<dt><i>stackTrace</i></dt> +<dt><i>stackTrace</i> (list of str)</dt> <dd> -list of stack entries (list of string) +list of stack entries </dd> </dl> <a NAME="Shell.__clientSignal" ID="Shell.__clientSignal"></a> @@ -1027,23 +1027,21 @@ </p> <dl> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -message of the syntax error (string) +message of the syntax error </dd> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> translated filename of the syntax error position - (string) </dd> -<dt><i>lineNo</i></dt> +<dt><i>lineNo</i> (int)</dt> <dd> -line number of the syntax error position (integer) +line number of the syntax error position </dd> -<dt><i>characterNo</i></dt> +<dt><i>characterNo</i> (int)</dt> <dd> character number of the syntax error position - (integer) </dd> </dl> <a NAME="Shell.__completionListSelected" ID="Shell.__completionListSelected"></a> @@ -1055,13 +1053,13 @@ </p> <dl> -<dt><i>listId</i></dt> +<dt><i>listId</i> (int)</dt> <dd> -the ID of the user list (should be 1) (integer) +the ID of the user list (should be 1) </dd> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -the selected text (string) +the selected text </dd> </dl> <a NAME="Shell.__concatenateText" ID="Shell.__concatenateText"></a> @@ -1138,7 +1136,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of two values (int, int) giving the line and column +tuple of two values giving the line and column +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int) </dd> </dl> <a NAME="Shell.__indentLength" ID="Shell.__indentLength"></a> @@ -1183,9 +1187,9 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (str)</dt> <dd> -history entry to be inserted (string) +history entry to be inserted </dd> </dl> <a NAME="Shell.__insertText" ID="Shell.__insertText"></a> @@ -1197,9 +1201,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be inserted (string) +text to be inserted </dd> </dl> <a NAME="Shell.__insertTextAtEnd" ID="Shell.__insertTextAtEnd"></a> @@ -1211,9 +1215,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be inserted (string) +text to be inserted </dd> </dl> <a NAME="Shell.__insertTextNoEcho" ID="Shell.__insertTextNoEcho"></a> @@ -1226,9 +1230,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be inserted (string) +text to be inserted </dd> </dl> <a NAME="Shell.__isCursorOnLastLine" ID="Shell.__isCursorOnLastLine"></a> @@ -1241,7 +1245,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating that the cursor is on the last line (boolean) +flag indicating that the cursor is on the last line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shell.__isHistoryIndexValid" ID="Shell.__isHistoryIndexValid"></a> @@ -1433,9 +1443,9 @@ </p> <dl> -<dt><i>on</i></dt> +<dt><i>on</i> (bool)</dt> <dd> -flag to indicate usage of a monospace font (boolean) +flag to indicate usage of a monospace font </dd> </dl> <a NAME="Shell.__setTextDisplay" ID="Shell.__setTextDisplay"></a> @@ -1454,13 +1464,13 @@ </p> <dl> -<dt><i>completions</i></dt> +<dt><i>completions</i> (list of str)</dt> <dd> -list of possible completions (list of strings) +list of possible completions </dd> -<dt><i>text</i></dt> +<dt><i>text</i> (str)</dt> <dd> -text that is about to be completed (string) +text that is about to be completed </dd> </dl> <a NAME="Shell.__showContextMenu" ID="Shell.__showContextMenu"></a> @@ -1509,9 +1519,9 @@ </p> <dl> -<dt><i>action</i></dt> +<dt><i>action</i> (QAction)</dt> <dd> -context menu action that was triggered (QAction) +context menu action that was triggered </dd> </dl> <a NAME="Shell.__useHistory" ID="Shell.__useHistory"></a> @@ -1573,9 +1583,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be displayed (string) +text to be displayed </dd> </dl> <a NAME="Shell.__writeStdErr" ID="Shell.__writeStdErr"></a> @@ -1587,9 +1597,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be displayed (string) +text to be displayed </dd> </dl> <a NAME="Shell.__writeStdOut" ID="Shell.__writeStdOut"></a> @@ -1601,9 +1611,9 @@ </p> <dl> -<dt><i>s</i></dt> +<dt><i>s</i> (str)</dt> <dd> -text to be displayed (string) +text to be displayed </dd> </dl> <a NAME="Shell.clear" ID="Shell.clear"></a> @@ -1664,9 +1674,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDragEnterEvent)</dt> <dd> -the drag enter event (QDragEnterEvent) +the drag enter event </dd> </dl> <a NAME="Shell.dragLeaveEvent" ID="Shell.dragLeaveEvent"></a> @@ -1678,9 +1688,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDragLeaveEvent)</dt> <dd> -the drag leave event (QDragLeaveEvent) +the drag leave event </dd> </dl> <a NAME="Shell.dragMoveEvent" ID="Shell.dragMoveEvent"></a> @@ -1692,9 +1702,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDragMoveEvent)</dt> <dd> -the drag move event (QDragMoveEvent) +the drag move event </dd> </dl> <a NAME="Shell.dropEvent" ID="Shell.dropEvent"></a> @@ -1706,9 +1716,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QDropEvent)</dt> <dd> -the drop event (QDropEvent) +the drop event </dd> </dl> <a NAME="Shell.editorCommand" ID="Shell.editorCommand"></a> @@ -1720,7 +1730,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> the scintilla command to be performed </dd> @@ -1734,15 +1744,21 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QEvent)</dt> <dd> -reference to the event (QEvent) +reference to the event </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, if the event was handled (boolean) +flag indicating, if the event was handled +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Shell.executeLines" ID="Shell.executeLines"></a> @@ -1773,9 +1789,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QFocusEvent)</dt> <dd> -the event object (QFocusEvent) +the event object </dd> </dl> <a NAME="Shell.focusNextPrevChild" ID="Shell.focusNextPrevChild"></a> @@ -1791,7 +1807,7 @@ </p> <dl> -<dt><i>nextChild</i></dt> +<dt><i>nextChild</i> (QWidget)</dt> <dd> next window </dd> @@ -1802,6 +1818,12 @@ flag indicating the movement </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="Shell.focusOutEvent" ID="Shell.focusOutEvent"></a> <h4>Shell.focusOutEvent</h4> <b>focusOutEvent</b>(<i>event</i>) @@ -1811,9 +1833,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QFocusEvent)</dt> <dd> -the event object (QFocusEvent) +the event object </dd> </dl> <a NAME="Shell.gestureEvent" ID="Shell.gestureEvent"></a> @@ -1825,7 +1847,7 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (int)</dt> <dd> reference to the gesture event (QGestureEvent </dd> @@ -1840,7 +1862,13 @@ <dl> <dt>Return:</dt> <dd> -client type (string) +client type +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Shell.getHistory" ID="Shell.getHistory"></a> @@ -1852,16 +1880,22 @@ </p> <dl> -<dt><i>clientType</i></dt> +<dt><i>clientType</i> (str)</dt> <dd> -type of the debug client (string). - If it is None, the current history is returned. +type of the debug client. If it is None, the current + history is returned. </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the history list (list of strings) +reference to the history list +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Shell.getHistoryIndex" ID="Shell.getHistoryIndex"></a> @@ -1921,9 +1955,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text to be inserted (string) +text to be inserted </dd> </dl> <a NAME="Shell.isHistoryEnabled" ID="Shell.isHistoryEnabled"></a> @@ -1954,7 +1988,7 @@ </p> <dl> -<dt><i>ev</i></dt> +<dt><i>ev</i> (int)</dt> <dd> key event (QKeyEvent) </dd> @@ -1968,9 +2002,9 @@ </p> <dl> -<dt><i>clientType</i></dt> +<dt><i>clientType</i> (str)</dt> <dd> -type of the debug client (string) +type of the debug client </dd> </dl> <a NAME="Shell.mousePressEvent" ID="Shell.mousePressEvent"></a> @@ -1982,9 +2016,9 @@ </p> <dl> -<dt><i>event</i></dt> +<dt><i>event</i> (QMouseEvent)</dt> <dd> -the mouse press event (QMouseEvent) +the mouse press event </dd> </dl> <a NAME="Shell.paste" ID="Shell.paste"></a> @@ -2040,9 +2074,9 @@ </p> <dl> -<dt><i>clientType</i></dt> +<dt><i>clientType</i> (str)</dt> <dd> -type of the debug client (string) +type of the debug client </dd> </dl> <a NAME="Shell.searchNext" ID="Shell.searchNext"></a> @@ -2117,9 +2151,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (DebugUI)</dt> <dd> -reference to the debugger UI object (DebugUI) +reference to the debugger UI object </dd> </dl> <a NAME="Shell.showHistory" ID="Shell.showHistory"></a> @@ -2146,9 +2180,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QWheelEvent)</dt> <dd> -reference to the wheel event (QWheelEvent) +reference to the wheel event </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -2235,7 +2269,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the shell widget (Shell) +reference to the shell widget +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +Shell </dd> </dl> <a NAME="ShellAssembly.showFind" ID="ShellAssembly.showFind"></a> @@ -2247,9 +2287,9 @@ </p> <dl> -<dt><i>txt</i></dt> +<dt><i>txt</i> (str)</dt> <dd> -text to be shown in the combo (string) +text to be shown in the combo </dd> </dl> <div align="right"><a href="#top">Up</a></div>