--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Wed Dec 20 19:28:22 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html Thu Dec 21 12:03:40 2023 +0100 @@ -1891,13 +1891,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the breakpoint (integer) -</dd> -<dt><i>temporary</i></dt> -<dd> -flag indicating a temporary breakpoint (boolean) +<dt><i>line</i> (int)</dt> +<dd> +line number of the breakpoint +</dd> +<dt><i>temporary</i> (bool)</dt> +<dd> +flag indicating a temporary breakpoint </dd> </dl> <a NAME="Editor.__addBreakPoints" ID="Editor.__addBreakPoints"></a> @@ -1975,19 +1975,25 @@ </p> <dl> -<dt><i>ctshift</i></dt> -<dd> -amount the calltip shall be shifted (integer) -</dd> -<dt><i>pos</i></dt> -<dd> -position into the text (integer) +<dt><i>ctshift</i> (int)</dt> +<dd> +amount the calltip shall be shifted +</dd> +<dt><i>pos</i> (int)</dt> +<dd> +position into the text </dd> </dl> <dl> <dt>Return:</dt> <dd> -new position for the calltip (integer) +new position for the calltip +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Editor.__applyTemplate" ID="Editor.__applyTemplate"></a> @@ -1999,14 +2005,14 @@ </p> <dl> -<dt><i>templateName</i></dt> -<dd> -name of the template to apply (string) -</dd> -<dt><i>language</i></dt> +<dt><i>templateName</i> (str)</dt> +<dd> +name of the template to apply +</dd> +<dt><i>language</i> (str)</dt> <dd> name of the language (group) to get the template - from (string) + from </dd> </dl> <a NAME="Editor.__autoComplete" ID="Editor.__autoComplete"></a> @@ -2018,10 +2024,9 @@ </p> <dl> -<dt><i>auto</i></dt> +<dt><i>auto</i> (bool)</dt> <dd> flag indicating a call from the __charAdded method - (boolean) </dd> <dt><i>context</i> (bool or None)</dt> <dd> @@ -2096,16 +2101,21 @@ </p> <dl> -<dt><i>line0</i></dt> +<dt><i>line0</i> (str)</dt> <dd> first line of text to use in the generation process - (string) </dd> </dl> <dl> <dt>Return:</dt> <dd> -dummy file name to be used for binding a lexer (string) +dummy file name to be used for binding a lexer +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.__boxCommentLine" ID="Editor.__boxCommentLine"></a> @@ -2151,19 +2161,25 @@ </p> <dl> -<dt><i>old</i></dt> -<dd> -old text (string) -</dd> -<dt><i>new</i></dt> -<dd> -new text (string) +<dt><i>old</i> (str)</dt> +<dd> +old text +</dd> +<dt><i>new</i> (str)</dt> +<dd> +new text </dd> </dl> <dl> <dt>Return:</dt> <dd> -commands to change old into new (string) +commands to change old into new +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.__callTip" ID="Editor.__callTip"></a> @@ -2284,7 +2300,7 @@ </p> <dl> -<dt><i>warningKind</i></dt> +<dt><i>warningKind</i> (int)</dt> <dd> kind of warning to clear (Editor.WarningCode, Editor.WarningPython, Editor.WarningStyle) @@ -2403,19 +2419,25 @@ </p> <dl> -<dt><i>key</i></dt> -<dd> -key of the color to use (string) -</dd> -<dt><i>size</i></dt> -<dd> -size of the pixmap (integer) +<dt><i>key</i> (str)</dt> +<dd> +key of the color to use +</dd> +<dt><i>size</i> (int)</dt> +<dd> +size of the pixmap </dd> </dl> <dl> <dt>Return:</dt> <dd> -create pixmap (QPixmap) +create pixmap +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QPixmap </dd> </dl> <a NAME="Editor.__cursorPositionChanged" ID="Editor.__cursorPositionChanged"></a> @@ -2499,9 +2521,9 @@ </p> <dl> -<dt><i>command</i></dt> -<dd> -command to be processed (string) +<dt><i>command</i> (str)</dt> +<dd> +command to be processed </dd> </dl> <a NAME="Editor.__encodingChanged" ID="Editor.__encodingChanged"></a> @@ -2531,9 +2553,9 @@ </p> <dl> -<dt><i>act</i></dt> -<dd> -reference to the action that was triggered (QAction) +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that was triggered </dd> </dl> <a NAME="Editor.__eolChanged" ID="Editor.__eolChanged"></a> @@ -2552,9 +2574,9 @@ </p> <dl> -<dt><i>act</i></dt> -<dd> -reference to the action that was triggered (QAction) +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that was triggered </dd> </dl> <a NAME="Editor.__executeSelection" ID="Editor.__executeSelection"></a> @@ -2593,16 +2615,22 @@ </p> <dl> -<dt><i>pos</i></dt> -<dd> -position to get character at (integer) +<dt><i>pos</i> (int)</dt> +<dd> +position to get character at </dd> </dl> <dl> <dt>Return:</dt> <dd> -requested character or "", if there are no more (string) and - the next position (i.e. pos - 1) +requested character or "", if there are no more and the next position + (i.e. pos - 1) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, int) </dd> </dl> <a NAME="Editor.__getCodeCoverageFile" ID="Editor.__getCodeCoverageFile"></a> @@ -2678,7 +2706,13 @@ <dt>Return:</dt> <dd> Tuple of macro name and a flag, indicating, if the user - pressed ok or canceled the operation. (string, boolean) + pressed ok or canceled the operation. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) </dd> </dl> <a NAME="Editor.__getOverrideValue" ID="Editor.__getOverrideValue"></a> @@ -2718,7 +2752,13 @@ <dl> <dt>Return:</dt> <dd> -Python version or 0 if it's not a Python file (int) +Python version or 0 if it's not a Python file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Editor.__getSaveFileName" ID="Editor.__getSaveFileName"></a> @@ -2730,15 +2770,21 @@ </p> <dl> -<dt><i>path</i></dt> -<dd> -directory to save the file in (string) +<dt><i>path</i> (str)</dt> +<dd> +directory to save the file in </dd> </dl> <dl> <dt>Return:</dt> <dd> -file name (string) +file name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.__ignoreSpellingAlways" ID="Editor.__ignoreSpellingAlways"></a> @@ -2757,11 +2803,11 @@ </p> <dl> -<dt><i>indent</i></dt> -<dd> -flag indicating an indent operation (boolean) - <br />If the flag is true, an indent operation is performed. - Otherwise the current line is unindented. +<dt><i>indent</i> (bool)</dt> +<dd> +flag indicating an indent operation + <br />If the flag is true, an indent operation is performed. + Otherwise the current line is unindented. </dd> </dl> <a NAME="Editor.__indentSelection" ID="Editor.__indentSelection"></a> @@ -2773,11 +2819,11 @@ </p> <dl> -<dt><i>indent</i></dt> -<dd> -flag indicating an indent operation (boolean) - <br />If the flag is true, an indent operation is performed. - Otherwise the current line is unindented. +<dt><i>indent</i> (bool)</dt> +<dd> +flag indicating an indent operation + <br />If the flag is true, an indent operation is performed. + Otherwise the current line is unindented. </dd> </dl> <a NAME="Editor.__initContextMenu" ID="Editor.__initContextMenu"></a> @@ -2956,7 +3002,13 @@ <dl> <dt>Return:</dt> <dd> -reference to the generated menu (QMenu) +reference to the generated menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="Editor.__initContextMenuShow" ID="Editor.__initContextMenuShow"></a> @@ -3067,19 +3119,25 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -text of the line to check (string) -</dd> -<dt><i>commentStr</i></dt> -<dd> -comment string to check against (string) +<dt><i>line</i> (str)</dt> +<dd> +text of the line to check +</dd> +<dt><i>commentStr</i> (str)</dt> +<dd> +comment string to check against </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating a commented line (boolean) +flag indicating a commented line +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.__isStartChar" ID="Editor.__isStartChar"></a> @@ -3092,15 +3150,21 @@ </p> <dl> -<dt><i>ch</i></dt> -<dd> -character to be checked (one character string) +<dt><i>ch</i> (str)</dt> +<dd> +character to be checked </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating the result (boolean) +flag indicating the result +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.__isStreamCommentedLine" ID="Editor.__isStreamCommentedLine"></a> @@ -3143,13 +3207,13 @@ </p> <dl> -<dt><i>language</i></dt> -<dd> -language to be set (string) -</dd> -<dt><i>propagate</i></dt> -<dd> -flag indicating to propagate the change (boolean) +<dt><i>language</i> (str)</dt> +<dd> +language to be set +</dd> +<dt><i>propagate</i> (bool)</dt> +<dd> +flag indicating to propagate the change </dd> </dl> <a NAME="Editor.__languageMenuTriggered" ID="Editor.__languageMenuTriggered"></a> @@ -3161,9 +3225,9 @@ </p> <dl> -<dt><i>act</i></dt> -<dd> -reference to the action that was triggered (QAction) +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that was triggered </dd> </dl> <a NAME="Editor.__lmBbookmarks" ID="Editor.__lmBbookmarks"></a> @@ -3261,9 +3325,9 @@ </p> <dl> -<dt><i>xPos</i></dt> -<dd> -x position (integer) +<dt><i>xPos</i> (int)</dt> +<dd> +x position </dd> </dl> <dl> @@ -3272,6 +3336,12 @@ margin number (integer, -1 for no margin) </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +int +</dd> +</dl> <a NAME="Editor.__markOccurrences" ID="Editor.__markOccurrences"></a> <h4>Editor.__markOccurrences</h4> <b>__markOccurrences</b>(<i></i>) @@ -3336,46 +3406,45 @@ </p> <dl> -<dt><i>pos</i></dt> -<dd> -start position of change (integer) -</dd> -<dt><i>mtype</i></dt> -<dd> -flags identifying the change (integer) -</dd> -<dt><i>text</i></dt> -<dd> -text that is given to the Undo system (string) -</dd> -<dt><i>length</i></dt> -<dd> -length of the change (integer) -</dd> -<dt><i>linesAdded</i></dt> -<dd> -number of added/deleted lines (integer) -</dd> -<dt><i>line</i></dt> -<dd> -line number of a fold level or marker change (integer) -</dd> -<dt><i>foldNow</i></dt> -<dd> -new fold level (integer) -</dd> -<dt><i>foldPrev</i></dt> -<dd> -previous fold level (integer) -</dd> -<dt><i>token</i></dt> +<dt><i>pos</i> (int)</dt> +<dd> +start position of change +</dd> +<dt><i>mtype</i> (int)</dt> +<dd> +flags identifying the change +</dd> +<dt><i>text</i> (str)</dt> +<dd> +text that is given to the Undo system +</dd> +<dt><i>length</i> (int)</dt> +<dd> +length of the change +</dd> +<dt><i>linesAdded</i> (int)</dt> +<dd> +number of added/deleted lines +</dd> +<dt><i>line</i> (int)</dt> +<dd> +line number of a fold level or marker change +</dd> +<dt><i>foldNow</i> (int)</dt> +<dd> +new fold level +</dd> +<dt><i>foldPrev</i> (int)</dt> +<dd> +previous fold level +</dd> +<dt><i>token</i> (int)</dt> <dd> ??? </dd> -<dt><i>annotationLinesAdded</i></dt> +<dt><i>annotationLinesAdded</i> (int)</dt> <dd> number of added/deleted annotation lines - (integer) </dd> </dl> <a NAME="Editor.__newView" ID="Editor.__newView"></a> @@ -3401,15 +3470,21 @@ </p> <dl> -<dt><i>encoding</i></dt> -<dd> -encoding to be normalized (string) +<dt><i>encoding</i> (str)</dt> +<dd> +encoding to be normalized </dd> </dl> <dl> <dt>Return:</dt> <dd> -normalized encoding (string) +normalized encoding +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.__onlineChangeTraceTimerTimeout" ID="Editor.__onlineChangeTraceTimerTimeout"></a> @@ -3496,10 +3571,9 @@ </p> <dl> -<dt><i>printer</i></dt> +<dt><i>printer</i> (QScintilla.Printer.Printer)</dt> <dd> reference to the printer object - (QScintilla.Printer.Printer) </dd> </dl> <a NAME="Editor.__processEndEditCommand" ID="Editor.__processEndEditCommand"></a> @@ -3526,7 +3600,13 @@ <dl> <dt>Return:</dt> <dd> -list of change flags (list of string) +list of change flags +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="Editor.__processRequestSyncCommand" ID="Editor.__processRequestSyncCommand"></a> @@ -3663,9 +3743,9 @@ </p> <dl> -<dt><i>act</i></dt> -<dd> -reference to the action that was triggered (QAction) +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the action that was triggered </dd> </dl> <a NAME="Editor.__replaceLeadingUnderscores" ID="Editor.__replaceLeadingUnderscores"></a> @@ -3703,9 +3783,9 @@ </p> <dl> -<dt><i>propagate</i></dt> -<dd> -flag indicating to propagate the change (boolean) +<dt><i>propagate</i> (bool)</dt> +<dd> +flag indicating to propagate the change </dd> </dl> <a NAME="Editor.__resetOnlineChangeTraceTimer" ID="Editor.__resetOnlineChangeTraceTimer"></a> @@ -3778,9 +3858,9 @@ </p> <dl> -<dt><i>forward</i></dt> -<dd> -flag indicating the search direction (boolean) +<dt><i>forward</i> (bool)</dt> +<dd> +flag indicating the search direction </dd> </dl> <a NAME="Editor.__selectAll" ID="Editor.__selectAll"></a> @@ -3800,7 +3880,13 @@ <dl> <dt>Return:</dt> <dd> -name of the selected pygments lexer (string) +name of the selected pygments lexer +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.__send" ID="Editor.__send"></a> @@ -3812,13 +3898,13 @@ </p> <dl> -<dt><i>token</i></dt> -<dd> -command token (string) -</dd> -<dt><i>args</i></dt> -<dd> -arguments for the command (string) +<dt><i>token</i> (str)</dt> +<dd> +command token +</dd> +<dt><i>args</i> (str)</dt> +<dd> +arguments for the command </dd> </dl> <a NAME="Editor.__setAnnotation" ID="Editor.__setAnnotation"></a> @@ -3830,9 +3916,9 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -number of the line that needs annotation (integer) +<dt><i>line</i> (int)</dt> +<dd> +number of the line that needs annotation </dd> </dl> <a NAME="Editor.__setAnnotationStyles" ID="Editor.__setAnnotationStyles"></a> @@ -3893,17 +3979,17 @@ </p> <dl> -<dt><i>language</i></dt> -<dd> -spell checking language to be set (string) -</dd> -<dt><i>pwl</i></dt> -<dd> -name of the personal/project word list (string) -</dd> -<dt><i>pel</i></dt> -<dd> -name of the personal/project exclude list (string) +<dt><i>language</i> (str)</dt> +<dd> +spell checking language to be set +</dd> +<dt><i>pwl</i> (str)</dt> +<dd> +name of the personal/project word list +</dd> +<dt><i>pel</i> (str)</dt> +<dd> +name of the personal/project exclude list </dd> </dl> <a NAME="Editor.__setTabAndIndent" ID="Editor.__setTabAndIndent"></a> @@ -3930,7 +4016,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating this editor should be saved (boolean) +flag indicating this editor should be saved +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.__showApplicationDiagram" ID="Editor.__showApplicationDiagram"></a> @@ -4313,13 +4405,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the breakpoint (integer) -</dd> -<dt><i>temporary</i></dt> -<dd> -flag indicating a temporary breakpoint (boolean) +<dt><i>line</i> (int)</dt> +<dd> +line number of the breakpoint +</dd> +<dt><i>temporary</i> (bool)</dt> +<dd> +flag indicating a temporary breakpoint </dd> </dl> <a NAME="Editor.__toggleBreakpointEnabled" ID="Editor.__toggleBreakpointEnabled"></a> @@ -4331,9 +4423,9 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the breakpoint (integer) +<dt><i>line</i> (int)</dt> +<dd> +line number of the breakpoint </dd> </dl> <a NAME="Editor.__toggleStreamComment" ID="Editor.__toggleStreamComment"></a> @@ -4385,7 +4477,7 @@ </p> <dl> -<dt><i>bForce</i></dt> +<dt><i>bForce</i> (bool)</dt> <dd> True to force change, False to only update and emit signal if there was an attribute change. @@ -4470,14 +4562,13 @@ </p> <dl> -<dt><i>auto</i></dt> +<dt><i>auto</i> (bool)</dt> <dd> flag indicating a call from the __charAdded method - (boolean) -</dd> -<dt><i>context</i></dt> -<dd> -flag indicating to complete a context (boolean) +</dd> +<dt><i>context</i> (bool)</dt> +<dd> +flag indicating to complete a context </dd> </dl> <a NAME="Editor.autoCompleteQScintilla" ID="Editor.autoCompleteQScintilla"></a> @@ -4511,7 +4602,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating autocompletion from APIs is available (boolean) +flag indicating autocompletion from APIs is available +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.canProvideCallTipps" ID="Editor.canProvideCallTipps"></a> @@ -4524,7 +4621,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the availability of calltips (boolean) +flag indicating the availability of calltips +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.canProvideDynamicAutoCompletion" ID="Editor.canProvideDynamicAutoCompletion"></a> @@ -4538,7 +4641,12 @@ <dt>Return:</dt> <dd> flag indicating the availability of dynamic auto-completion - (boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.cancelSharedEdit" ID="Editor.cancelSharedEdit"></a> @@ -4550,9 +4658,9 @@ </p> <dl> -<dt><i>send</i></dt> -<dd> -flag indicating to send the CancelEdit command (boolean) +<dt><i>send</i> (bool)</dt> +<dd> +flag indicating to send the CancelEdit command </dd> </dl> <a NAME="Editor.changeEvent" ID="Editor.changeEvent"></a> @@ -4586,7 +4694,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating successful reset of the dirty flag (boolean) +flag indicating successful reset of the dirty flag +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.checkReadOnly" ID="Editor.checkReadOnly"></a> @@ -4657,9 +4771,9 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the breakpoint (integer) +<dt><i>line</i> (int)</dt> +<dd> +line number of the breakpoint </dd> </dl> <a NAME="Editor.clearChangeMarkers" ID="Editor.clearChangeMarkers"></a> @@ -4781,7 +4895,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a successful close of the editor (boolean) +flag indicating a successful close of the editor +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.closeIt" ID="Editor.closeIt"></a> @@ -4868,7 +4988,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of a breakpoint (boolean) +flag indicating the presence of a breakpoint +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.determineFileType" ID="Editor.determineFileType"></a> @@ -4881,7 +5007,13 @@ <dl> <dt>Return:</dt> <dd> -type of the displayed file or an empty string (string) +type of the displayed file or an empty string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.dragEnterEvent" ID="Editor.dragEnterEvent"></a> @@ -4893,9 +5025,9 @@ </p> <dl> -<dt><i>event</i></dt> -<dd> -the drag enter event (QDragEnterEvent) +<dt><i>event</i> (QDragEnterEvent)</dt> +<dd> +the drag enter event </dd> </dl> <a NAME="Editor.dragLeaveEvent" ID="Editor.dragLeaveEvent"></a> @@ -4907,9 +5039,9 @@ </p> <dl> -<dt><i>event</i></dt> -<dd> -the drag leave event (QDragLeaveEvent) +<dt><i>event</i> (QDragLeaveEvent)</dt> +<dd> +the drag leave event </dd> </dl> <a NAME="Editor.dragMoveEvent" ID="Editor.dragMoveEvent"></a> @@ -4921,9 +5053,9 @@ </p> <dl> -<dt><i>event</i></dt> -<dd> -the drag move event (QDragMoveEvent) +<dt><i>event</i> (QDragMoveEvent)</dt> +<dd> +the drag move event </dd> </dl> <a NAME="Editor.dropEvent" ID="Editor.dropEvent"></a> @@ -4935,9 +5067,9 @@ </p> <dl> -<dt><i>event</i></dt> -<dd> -the drop event (QDropEvent) +<dt><i>event</i> (QDropEvent)</dt> +<dd> +the drop event </dd> </dl> <a NAME="Editor.editorCommand" ID="Editor.editorCommand"></a> @@ -4949,7 +5081,7 @@ </p> <dl> -<dt><i>cmd</i></dt> +<dt><i>cmd</i> (int)</dt> <dd> the scintilla command to be performed </dd> @@ -5056,9 +5188,9 @@ </p> <dl> -<dt><i>exporterFormat</i></dt> -<dd> -format the file should be exported into (string) +<dt><i>exporterFormat</i> (str)</dt> +<dd> +format the file should be exported into </dd> </dl> <a NAME="Editor.extractTasks" ID="Editor.extractTasks"></a> @@ -5159,7 +5291,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a bookmark (list of integer) +list of lines containing a bookmark +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getBookmarks" ID="Editor.getBookmarks"></a> @@ -5173,7 +5311,12 @@ <dt>Return:</dt> <dd> sorted list of all lines containing a bookmark - (list of integer) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getBreakpointLines" ID="Editor.getBreakpointLines"></a> @@ -5186,7 +5329,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a breakpoint (list of integer) +list of lines containing a breakpoint +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getCallTipHook" ID="Editor.getCallTipHook"></a> @@ -5225,7 +5374,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a change (list of integer) +list of lines containing a change +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getCompleter" ID="Editor.getCompleter"></a> @@ -5238,7 +5393,13 @@ <dl> <dt>Return:</dt> <dd> -the completer object (CompleterBase) +the completer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +CompleterBase </dd> </dl> <a NAME="Editor.getCompletionListHook" ID="Editor.getCompletionListHook"></a> @@ -5277,7 +5438,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a coverage marker (list of integer) +list of lines containing a coverage marker +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getCurrentWord" ID="Editor.getCurrentWord"></a> @@ -5290,7 +5457,13 @@ <dl> <dt>Return:</dt> <dd> -the word at that current position (string) +the word at that current position +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getCurrentWordBoundaries" ID="Editor.getCurrentWordBoundaries"></a> @@ -5304,7 +5477,12 @@ <dt>Return:</dt> <dd> tuple with start and end indexes of the current word - (integer, integer) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int) </dd> </dl> <a NAME="Editor.getDocstringGenerator" ID="Editor.getDocstringGenerator"></a> @@ -5362,7 +5540,13 @@ <dl> <dt>Return:</dt> <dd> -current encoding (string) +current encoding +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getFileName" ID="Editor.getFileName"></a> @@ -5375,7 +5559,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the displayed file (string) +filename of the displayed file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getFileType" ID="Editor.getFileType"></a> @@ -5388,7 +5578,13 @@ <dl> <dt>Return:</dt> <dd> -type of the displayed file (string) +type of the displayed file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getFileTypeByFlag" ID="Editor.getFileTypeByFlag"></a> @@ -5403,7 +5599,13 @@ <dt>Return:</dt> <dd> type of the displayed file, if set by an eflag: marker or an - empty string (string) + empty string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a> @@ -5416,7 +5618,13 @@ <dl> <dt>Return:</dt> <dd> -line number of the highlight bar (integer) +line number of the highlight bar +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Editor.getLanguage" ID="Editor.getLanguage"></a> @@ -5428,21 +5636,27 @@ </p> <dl> -<dt><i>normalized</i></dt> +<dt><i>normalized</i> (bool)</dt> <dd> flag indicating to normalize some Pygments - lexer names (boolean) -</dd> -<dt><i>forPygments</i></dt> + lexer names +</dd> +<dt><i>forPygments</i> (bool)</dt> <dd> flag indicating to normalize some lexer - names for Pygments (boolean) + names for Pygments </dd> </dl> <dl> <dt>Return:</dt> <dd> -language of the editor (string) +language of the editor +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getLexer" ID="Editor.getLexer"></a> @@ -5455,7 +5669,13 @@ <dl> <dt>Return:</dt> <dd> -the lexer object (Lexer) +the lexer object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +Lexer </dd> </dl> <a NAME="Editor.getMenu" ID="Editor.getMenu"></a> @@ -5467,15 +5687,21 @@ </p> <dl> -<dt><i>menuName</i></dt> -<dd> -name of the menu (string) +<dt><i>menuName</i> (str)</dt> +<dd> +name of the menu </dd> </dl> <dl> <dt>Return:</dt> <dd> -reference to the requested menu (QMenu) or None +reference to the requested menu or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu </dd> </dl> <a NAME="Editor.getMouseClickHandler" ID="Editor.getMouseClickHandler"></a> @@ -5546,7 +5772,13 @@ <dl> <dt>Return:</dt> <dd> -display string for this unnamed editor (string) +display string for this unnamed editor +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getSearchIndicatorLines" ID="Editor.getSearchIndicatorLines"></a> @@ -5559,7 +5791,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a search indicator (list of integer) +list of lines containing a search indicator +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getSearchSelectionHighlight" ID="Editor.getSearchSelectionHighlight"></a> @@ -5591,16 +5829,22 @@ </p> <dl> -<dt><i>selectionOnly</i></dt> +<dt><i>selectionOnly</i> (bool)</dt> <dd> flag indicating that only selected text should be - returned (boolean) + returned </dd> </dl> <dl> <dt>Return:</dt> <dd> -selection or current word (string) +selection or current word +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getSharingStatus" ID="Editor.getSharingStatus"></a> @@ -5616,7 +5860,12 @@ tuple indicating, if the editor is sharable, the sharing status, if it is inside a locally initiated shared edit session and if it is inside a remotely initiated shared edit session - (boolean, boolean, boolean, boolean) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, bool, bool, bool) </dd> </dl> <a NAME="Editor.getSpellingLanguage" ID="Editor.getSpellingLanguage"></a> @@ -5648,7 +5897,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a syntax error (list of integer) +list of lines containing a syntax error +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getTaskLines" ID="Editor.getTaskLines"></a> @@ -5661,7 +5916,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a task (list of integer) +list of lines containing a task +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getVcsConflictMarkerLines" ID="Editor.getVcsConflictMarkerLines"></a> @@ -5693,7 +5954,13 @@ <dl> <dt>Return:</dt> <dd> -list of lines containing a warning (list of integer) +list of lines containing a warning +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of int </dd> </dl> <a NAME="Editor.getWord" ID="Editor.getWord"></a> @@ -5790,19 +6057,25 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -number of line to look at (int) -</dd> -<dt><i>index</i></dt> -<dd> -position to look at (int) +<dt><i>line</i> (int)</dt> +<dd> +number of line to look at +</dd> +<dt><i>index</i> (int)</dt> +<dd> +position to look at </dd> </dl> <dl> <dt>Return:</dt> <dd> -the word to the left of that position (string) +the word to the left of that position +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.getWordRight" ID="Editor.getWordRight"></a> @@ -5814,19 +6087,25 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -number of line to look at (int) -</dd> -<dt><i>index</i></dt> -<dd> -position to look at (int) +<dt><i>line</i> (int)</dt> +<dd> +number of line to look at +</dd> +<dt><i>index</i> (int)</dt> +<dd> +position to look at </dd> </dl> <dl> <dt>Return:</dt> <dd> -the word to the right of that position (string) +the word to the right of that position +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Editor.gotoLastEditPosition" ID="Editor.gotoLastEditPosition"></a> @@ -5872,9 +6151,9 @@ </p> <dl> -<dt><i>goUp</i></dt> -<dd> -flag indicating the move direction (boolean) +<dt><i>goUp</i> (bool)</dt> +<dd> +flag indicating the move direction </dd> </dl> <a NAME="Editor.gotoReferenceHandler" ID="Editor.gotoReferenceHandler"></a> @@ -5914,9 +6193,9 @@ </p> <dl> -<dt><i>fn</i></dt> -<dd> -filename to be set for the editor (string). +<dt><i>fn</i> (str)</dt> +<dd> +filename to be set for the editor </dd> </dl> <a NAME="Editor.hasBookmarks" ID="Editor.hasBookmarks"></a> @@ -5929,7 +6208,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of bookmarks (boolean) +flag indicating the presence of bookmarks +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasBreakpoints" ID="Editor.hasBreakpoints"></a> @@ -5942,7 +6227,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of breakpoints (boolean) +flag indicating the presence of breakpoints +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasChangeMarkers" ID="Editor.hasChangeMarkers"></a> @@ -5955,7 +6246,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of change markers (boolean) +flag indicating the presence of change markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasCoverageMarkers" ID="Editor.hasCoverageMarkers"></a> @@ -5968,7 +6265,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of coverage markers (boolean) +flag indicating the presence of coverage markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a> @@ -5981,7 +6284,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a minimized context menu (boolean) +flag indicating a minimized context menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasSyntaxErrors" ID="Editor.hasSyntaxErrors"></a> @@ -5994,7 +6303,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of syntax errors (boolean) +flag indicating the presence of syntax errors +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasTaskMarkers" ID="Editor.hasTaskMarkers"></a> @@ -6007,7 +6322,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of task markers (boolean) +flag indicating the presence of task markers +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a> @@ -6020,7 +6341,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating the presence of warnings (boolean) +flag indicating the presence of warnings +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.highlight" ID="Editor.highlight"></a> @@ -6032,18 +6359,18 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number to highlight (integer) -</dd> -<dt><i>error</i></dt> +<dt><i>line</i> (int)</dt> +<dd> +line number to highlight +</dd> +<dt><i>error</i> (bool)</dt> <dd> flag indicating whether the error highlight should be - used (boolean) -</dd> -<dt><i>syntaxError</i></dt> -<dd> -flag indicating a syntax error (boolean) + used +</dd> +<dt><i>syntaxError</i> (bool)</dt> +<dd> +flag indicating a syntax error </dd> </dl> <a NAME="Editor.highlightSearchSelection" ID="Editor.highlightSearchSelection"></a> @@ -6153,7 +6480,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a Javascript file (boolean) +flag indicating a Javascript file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.isLastEditPositionAvailable" ID="Editor.isLastEditPositionAvailable"></a> @@ -6166,7 +6499,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating availability (boolean) +flag indicating availability +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.isMicroPythonFile" ID="Editor.isMicroPythonFile"></a> @@ -6218,7 +6557,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a Python3 file (boolean) +flag indicating a Python3 file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.isPyFile" ID="Editor.isPyFile"></a> @@ -6231,7 +6576,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a Python3 file (boolean) +flag indicating a Python3 file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.isRubyFile" ID="Editor.isRubyFile"></a> @@ -6244,7 +6595,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a Ruby file (boolean) +flag indicating a Ruby file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.isSpellCheckRegion" ID="Editor.isSpellCheckRegion"></a> @@ -6436,13 +6793,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the breakpoint (integer) -</dd> -<dt><i>properties</i></dt> -<dd> -properties for the breakpoint (tuple) +<dt><i>line</i> (int)</dt> +<dd> +line number of the breakpoint +</dd> +<dt><i>properties</i> (tuple of (str, bool, bool, int))</dt> +<dd> +properties for the breakpoint (condition, temporary flag, enabled flag, ignore count) </dd> </dl> @@ -6760,19 +7117,25 @@ </p> <dl> -<dt><i>saveas</i></dt> -<dd> -flag indicating a 'save as' action (boolean) -</dd> -<dt><i>path</i></dt> -<dd> -directory to save the file in (string) +<dt><i>saveas</i> (bool)</dt> +<dd> +flag indicating a 'save as' action +</dd> +<dt><i>path</i> (str)</dt> +<dd> +directory to save the file in </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating success (boolean) +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.saveFileAs" ID="Editor.saveFileAs"></a> @@ -6810,15 +7173,21 @@ </p> <dl> -<dt><i>path</i></dt> -<dd> -directory to save the file in (string) +<dt><i>path</i> (str)</dt> +<dd> +directory to save the file in </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating success (boolean) +flag indicating success +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Editor.searchCurrentWordBackward" ID="Editor.searchCurrentWordBackward"></a> @@ -6851,13 +7220,13 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -number of line to look at (int) -</dd> -<dt><i>index</i></dt> -<dd> -position to look at (int) +<dt><i>line</i> (int)</dt> +<dd> +number of line to look at +</dd> +<dt><i>index</i> (int)</dt> +<dd> +position to look at </dd> </dl> <a NAME="Editor.sendSharedEdit" ID="Editor.sendSharedEdit"></a> @@ -6877,10 +7246,9 @@ </p> <dl> -<dt><i>enable</i></dt> +<dt><i>enable</i> (bool)</dt> <dd> flag indicating the desired autocompletion status - (boolean) </dd> </dl> <a NAME="Editor.setAutoSpellChecking" ID="Editor.setAutoSpellChecking"></a> @@ -6939,23 +7307,23 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> filename used to determine the associated lexer - language (string) -</dd> -<dt><i>initTextDisplay</i></dt> + language +</dd> +<dt><i>initTextDisplay</i> (bool)</dt> <dd> flag indicating an initialization of the text - display is required as well (boolean) -</dd> -<dt><i>propagate</i></dt> -<dd> -flag indicating to propagate the change (boolean) -</dd> -<dt><i>pyname</i></dt> -<dd> -name of the pygments lexer to use (string) + display is required as well +</dd> +<dt><i>propagate</i> (bool)</dt> +<dd> +flag indicating to propagate the change +</dd> +<dt><i>pyname</i> (str)</dt> +<dd> +name of the pygments lexer to use </dd> </dl> <a NAME="Editor.setMonospaced" ID="Editor.setMonospaced"></a> @@ -6967,9 +7335,9 @@ </p> <dl> -<dt><i>on</i></dt> -<dd> -flag to indicate usage of a monospace font (boolean) +<dt><i>on</i> (bool)</dt> +<dd> +flag to indicate usage of a monospace font </dd> </dl> <a NAME="Editor.setMouseClickHandler" ID="Editor.setMouseClickHandler"></a> @@ -7019,9 +7387,9 @@ </p> <dl> -<dt><i>noName</i></dt> -<dd> -display string for this unnamed editor (string) +<dt><i>noName</i> (str)</dt> +<dd> +display string for this unnamed editor </dd> </dl> <a NAME="Editor.setSearchIndicator" ID="Editor.setSearchIndicator"></a> @@ -7033,13 +7401,13 @@ </p> <dl> -<dt><i>startPos</i></dt> -<dd> -start position of the indicator (integer) -</dd> -<dt><i>indicLength</i></dt> -<dd> -length of the indicator (integer) +<dt><i>startPos</i> (int)</dt> +<dd> +start position of the indicator +</dd> +<dt><i>indicLength</i> (int)</dt> +<dd> +length of the indicator </dd> </dl> <a NAME="Editor.setSpellingForProject" ID="Editor.setSpellingForProject"></a> @@ -7059,9 +7427,9 @@ </p> <dl> -<dt><i>connected</i></dt> -<dd> -flag indicating the connected state (boolean) +<dt><i>connected</i> (bool)</dt> +<dd> +flag indicating the connected state </dd> </dl> <a NAME="Editor.shareEditor" ID="Editor.shareEditor"></a> @@ -7073,9 +7441,9 @@ </p> <dl> -<dt><i>share</i></dt> -<dd> -flag indicating the share status (boolean) +<dt><i>share</i> (bool)</dt> +<dd> +flag indicating the share status </dd> </dl> <a NAME="Editor.shortenEmptyLines" ID="Editor.shortenEmptyLines"></a> @@ -7152,9 +7520,9 @@ </p> <dl> -<dt><i>line</i></dt> -<dd> -line number of the bookmark (integer) +<dt><i>line</i> (int)</dt> +<dd> +line number of the bookmark </dd> </dl> <a NAME="Editor.toggleComment" ID="Editor.toggleComment"></a>