Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Dec 04 10:33:58 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Editor.html	Mon Dec 04 15:21:07 2023 +0100
@@ -255,6 +255,14 @@
 <td>Private method to generate a dummy filename for binding a lexer.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__boxCommentLine">__boxCommentLine</a></td>
+<td>Private slot to box comment the current line.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__boxCommentSelection">__boxCommentSelection</a></td>
+<td>Private slot to box comment the current selection.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__breakPointDataAboutToBeChanged">__breakPointDataAboutToBeChanged</a></td>
 <td>Private slot to handle the dataAboutToBeChanged signal of the breakpoint model.</td>
 </tr>
@@ -319,6 +327,14 @@
 <td>Private method to handle the hide code coverage annotations context menu action.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__commentLine">__commentLine</a></td>
+<td>Private slot to comment the current line.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__commentSelection">__commentSelection</a></td>
+<td>Private slot to comment the current selection.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__completionListSelected">__completionListSelected</a></td>
 <td>Private slot to handle the selection from the completion list.</td>
 </tr>
@@ -527,6 +543,10 @@
 <td>Private method to check, if a character is an autocompletion start character.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__isStreamCommentedLine">__isStreamCommentedLine</a></td>
+<td>Private method to check, if the line is commented by a stream comment.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__languageChanged">__languageChanged</a></td>
 <td>Private method handling a change of a connected editor's language.</td>
 </tr>
@@ -895,6 +915,22 @@
 <td>Private method to handle the selection of a spell check language.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__streamCommentLine">__streamCommentLine</a></td>
+<td>Private slot to stream comment the current line.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__streamCommentSelection">__streamCommentSelection</a></td>
+<td>Private slot to comment the current selection.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__streamUncommentLine">__streamUncommentLine</a></td>
+<td>Private slot to stream uncomment the current line.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__streamUncommentSelection">__streamUncommentSelection</a></td>
+<td>Private slot to stream uncomment the current selection.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__styleNeeded">__styleNeeded</a></td>
 <td>Private slot to handle the need for more styling.</td>
 </tr>
@@ -907,6 +943,10 @@
 <td>Private slot to handle the Enable Autocompletion context menu entry.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__toggleBlockComment">__toggleBlockComment</a></td>
+<td>Private slot to toggle the comment of a block.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__toggleBreakpoint">__toggleBreakpoint</a></td>
 <td>Private method to toggle a breakpoint.</td>
 </tr>
@@ -915,10 +955,22 @@
 <td>Private method to toggle a breakpoints enabled status.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__toggleStreamComment">__toggleStreamComment</a></td>
+<td>Private slot to toggle the comment of a block.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__toggleTypingAids">__toggleTypingAids</a></td>
 <td>Private slot to toggle the typing aids.</td>
 </tr>
 <tr>
+<td><a href="#Editor.__uncommentLine">__uncommentLine</a></td>
+<td>Private slot to uncomment the current line.</td>
+</tr>
+<tr>
+<td><a href="#Editor.__uncommentSelection">__uncommentSelection</a></td>
+<td>Private slot to uncomment the current selection.</td>
+</tr>
+<tr>
 <td><a href="#Editor.__updateReadOnly">__updateReadOnly</a></td>
 <td>Private method to update the readOnly information for this editor.</td>
 </tr>
@@ -947,18 +999,10 @@
 <td>Public method to perform an autocompletion using QScintilla methods.</td>
 </tr>
 <tr>
-<td><a href="#Editor.boxCommentLine">boxCommentLine</a></td>
-<td>Public slot to box comment the current line.</td>
-</tr>
-<tr>
 <td><a href="#Editor.boxCommentLineOrSelection">boxCommentLineOrSelection</a></td>
 <td>Public slot to box comment the current line or current selection.</td>
 </tr>
 <tr>
-<td><a href="#Editor.boxCommentSelection">boxCommentSelection</a></td>
-<td>Public slot to box comment the current selection.</td>
-</tr>
-<tr>
 <td><a href="#Editor.callTip">callTip</a></td>
 <td>Public method to show calltips.</td>
 </tr>
@@ -1075,18 +1119,10 @@
 <td>Public method to collapse the current fold including its children.</td>
 </tr>
 <tr>
-<td><a href="#Editor.commentLine">commentLine</a></td>
-<td>Public slot to comment the current line.</td>
-</tr>
-<tr>
 <td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td>
 <td>Public slot to comment the current line or current selection.</td>
 </tr>
 <tr>
-<td><a href="#Editor.commentSelection">commentSelection</a></td>
-<td>Public slot to comment the current selection.</td>
-</tr>
-<tr>
 <td><a href="#Editor.completionsListReady">completionsListReady</a></td>
 <td>Public method to show the completions determined by a completions provider.</td>
 </tr>
@@ -1731,24 +1767,20 @@
 <td>Public slot to start a shared edit session for the editor.</td>
 </tr>
 <tr>
-<td><a href="#Editor.streamCommentLine">streamCommentLine</a></td>
-<td>Public slot to stream comment the current line.</td>
-</tr>
-<tr>
 <td><a href="#Editor.streamCommentLineOrSelection">streamCommentLineOrSelection</a></td>
 <td>Public slot to stream comment the current line or current selection.</td>
 </tr>
 <tr>
-<td><a href="#Editor.streamCommentSelection">streamCommentSelection</a></td>
-<td>Public slot to comment the current selection.</td>
+<td><a href="#Editor.streamUncommentLineOrSelection">streamUncommentLineOrSelection</a></td>
+<td>Public slot to stream uncomment the current line or current selection.</td>
 </tr>
 <tr>
 <td><a href="#Editor.toggleBookmark">toggleBookmark</a></td>
 <td>Public method to toggle a bookmark.</td>
 </tr>
 <tr>
-<td><a href="#Editor.toggleCommentBlock">toggleCommentBlock</a></td>
-<td>Public slot to toggle the comment of a block.</td>
+<td><a href="#Editor.toggleComment">toggleComment</a></td>
+<td>Public slot to toggle a block or stream comment.</td>
 </tr>
 <tr>
 <td><a href="#Editor.toggleCurrentFold">toggleCurrentFold</a></td>
@@ -1763,18 +1795,10 @@
 <td>Public method to toggle a warning indicator.</td>
 </tr>
 <tr>
-<td><a href="#Editor.uncommentLine">uncommentLine</a></td>
-<td>Public slot to uncomment the current line.</td>
-</tr>
-<tr>
 <td><a href="#Editor.uncommentLineOrSelection">uncommentLineOrSelection</a></td>
 <td>Public slot to uncomment the current line or current selection.</td>
 </tr>
 <tr>
-<td><a href="#Editor.uncommentSelection">uncommentSelection</a></td>
-<td>Public slot to uncomment the current selection.</td>
-</tr>
-<tr>
 <td><a href="#Editor.undo">undo</a></td>
 <td>Public method to undo the last recorded change.</td>
 </tr>
@@ -2088,6 +2112,20 @@
 dummy file name to be used for binding a lexer (string)
 </dd>
 </dl>
+<a NAME="Editor.__boxCommentLine" ID="Editor.__boxCommentLine"></a>
+<h4>Editor.__boxCommentLine</h4>
+<b>__boxCommentLine</b>(<i></i>)
+
+<p>
+        Private slot to box comment the current line.
+</p>
+<a NAME="Editor.__boxCommentSelection" ID="Editor.__boxCommentSelection"></a>
+<h4>Editor.__boxCommentSelection</h4>
+<b>__boxCommentSelection</b>(<i></i>)
+
+<p>
+        Private slot to box comment the current selection.
+</p>
 <a NAME="Editor.__breakPointDataAboutToBeChanged" ID="Editor.__breakPointDataAboutToBeChanged"></a>
 <h4>Editor.__breakPointDataAboutToBeChanged</h4>
 <b>__breakPointDataAboutToBeChanged</b>(<i>startIndex, endIndex</i>)
@@ -2264,6 +2302,20 @@
         Private method to handle the hide code coverage annotations context
         menu action.
 </p>
+<a NAME="Editor.__commentLine" ID="Editor.__commentLine"></a>
+<h4>Editor.__commentLine</h4>
+<b>__commentLine</b>(<i></i>)
+
+<p>
+        Private slot to comment the current line.
+</p>
+<a NAME="Editor.__commentSelection" ID="Editor.__commentSelection"></a>
+<h4>Editor.__commentSelection</h4>
+<b>__commentSelection</b>(<i></i>)
+
+<p>
+        Private slot to comment the current selection.
+</p>
 <a NAME="Editor.__completionListSelected" ID="Editor.__completionListSelected"></a>
 <h4>Editor.__completionListSelected</h4>
 <b>__completionListSelected</b>(<i>listId, txt</i>)
@@ -3055,6 +3107,37 @@
 flag indicating the result (boolean)
 </dd>
 </dl>
+<a NAME="Editor.__isStreamCommentedLine" ID="Editor.__isStreamCommentedLine"></a>
+<h4>Editor.__isStreamCommentedLine</h4>
+<b>__isStreamCommentedLine</b>(<i>line, streamCommentStr</i>)
+
+<p>
+        Private method to check, if the line is commented by a stream comment.
+</p>
+<dl>
+
+<dt><i>line</i> (str)</dt>
+<dd>
+text of the line to check
+</dd>
+<dt><i>streamCommentStr</i> (dict)</dt>
+<dd>
+dictionary containing the stream comment start and
+            end strings
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a stream commented line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="Editor.__languageChanged" ID="Editor.__languageChanged"></a>
 <h4>Editor.__languageChanged</h4>
 <b>__languageChanged</b>(<i>language, propagate=True</i>)
@@ -4151,6 +4234,34 @@
 reference to the action that was triggered
 </dd>
 </dl>
+<a NAME="Editor.__streamCommentLine" ID="Editor.__streamCommentLine"></a>
+<h4>Editor.__streamCommentLine</h4>
+<b>__streamCommentLine</b>(<i></i>)
+
+<p>
+        Private slot to stream comment the current line.
+</p>
+<a NAME="Editor.__streamCommentSelection" ID="Editor.__streamCommentSelection"></a>
+<h4>Editor.__streamCommentSelection</h4>
+<b>__streamCommentSelection</b>(<i></i>)
+
+<p>
+        Private slot to comment the current selection.
+</p>
+<a NAME="Editor.__streamUncommentLine" ID="Editor.__streamUncommentLine"></a>
+<h4>Editor.__streamUncommentLine</h4>
+<b>__streamUncommentLine</b>(<i></i>)
+
+<p>
+        Private slot to stream uncomment the current line.
+</p>
+<a NAME="Editor.__streamUncommentSelection" ID="Editor.__streamUncommentSelection"></a>
+<h4>Editor.__streamUncommentSelection</h4>
+<b>__streamUncommentSelection</b>(<i></i>)
+
+<p>
+        Private slot to stream uncomment the current selection.
+</p>
 <a NAME="Editor.__styleNeeded" ID="Editor.__styleNeeded"></a>
 <h4>Editor.__styleNeeded</h4>
 <b>__styleNeeded</b>(<i>position</i>)
@@ -4184,6 +4295,19 @@
 <p>
         Private slot to handle the Enable Autocompletion context menu entry.
 </p>
+<a NAME="Editor.__toggleBlockComment" ID="Editor.__toggleBlockComment"></a>
+<h4>Editor.__toggleBlockComment</h4>
+<b>__toggleBlockComment</b>(<i></i>)
+
+<p>
+        Private slot to toggle the comment of a block.
+</p>
+<p>
+        If the editor contains selected text and the start line is not commented, it
+        will be commented. Otherwise the selection will be un-commented. In case there
+        is no selected text and the current line is not commented, it will be commented.
+        If is commented, the comment block will be removed.
+</p>
 <a NAME="Editor.__toggleBreakpoint" ID="Editor.__toggleBreakpoint"></a>
 <h4>Editor.__toggleBreakpoint</h4>
 <b>__toggleBreakpoint</b>(<i>line, temporary=False</i>)
@@ -4216,6 +4340,19 @@
 line number of the breakpoint (integer)
 </dd>
 </dl>
+<a NAME="Editor.__toggleStreamComment" ID="Editor.__toggleStreamComment"></a>
+<h4>Editor.__toggleStreamComment</h4>
+<b>__toggleStreamComment</b>(<i></i>)
+
+<p>
+        Private slot to toggle the comment of a block.
+</p>
+<p>
+        If the editor contains selected text and the start line is not commented, it
+        will be commented. Otherwise the selection will be un-commented. In case there
+        is no selected text and the current line is not commented, it will be commented.
+        If is commented, the comment block will be removed.
+</p>
 <a NAME="Editor.__toggleTypingAids" ID="Editor.__toggleTypingAids"></a>
 <h4>Editor.__toggleTypingAids</h4>
 <b>__toggleTypingAids</b>(<i></i>)
@@ -4223,6 +4360,20 @@
 <p>
         Private slot to toggle the typing aids.
 </p>
+<a NAME="Editor.__uncommentLine" ID="Editor.__uncommentLine"></a>
+<h4>Editor.__uncommentLine</h4>
+<b>__uncommentLine</b>(<i></i>)
+
+<p>
+        Private slot to uncomment the current line.
+</p>
+<a NAME="Editor.__uncommentSelection" ID="Editor.__uncommentSelection"></a>
+<h4>Editor.__uncommentSelection</h4>
+<b>__uncommentSelection</b>(<i></i>)
+
+<p>
+        Private slot to uncomment the current selection.
+</p>
 <a NAME="Editor.__updateReadOnly" ID="Editor.__updateReadOnly"></a>
 <h4>Editor.__updateReadOnly</h4>
 <b>__updateReadOnly</b>(<i>bForce=True</i>)
@@ -4340,13 +4491,6 @@
 <p>
         Public method to perform an autocompletion using QScintilla methods.
 </p>
-<a NAME="Editor.boxCommentLine" ID="Editor.boxCommentLine"></a>
-<h4>Editor.boxCommentLine</h4>
-<b>boxCommentLine</b>(<i></i>)
-
-<p>
-        Public slot to box comment the current line.
-</p>
 <a NAME="Editor.boxCommentLineOrSelection" ID="Editor.boxCommentLineOrSelection"></a>
 <h4>Editor.boxCommentLineOrSelection</h4>
 <b>boxCommentLineOrSelection</b>(<i></i>)
@@ -4354,13 +4498,6 @@
 <p>
         Public slot to box comment the current line or current selection.
 </p>
-<a NAME="Editor.boxCommentSelection" ID="Editor.boxCommentSelection"></a>
-<h4>Editor.boxCommentSelection</h4>
-<b>boxCommentSelection</b>(<i></i>)
-
-<p>
-        Public slot to box comment the current selection.
-</p>
 <a NAME="Editor.callTip" ID="Editor.callTip"></a>
 <h4>Editor.callTip</h4>
 <b>callTip</b>(<i></i>)
@@ -4685,13 +4822,6 @@
 number of line to be expanded
 </dd>
 </dl>
-<a NAME="Editor.commentLine" ID="Editor.commentLine"></a>
-<h4>Editor.commentLine</h4>
-<b>commentLine</b>(<i></i>)
-
-<p>
-        Public slot to comment the current line.
-</p>
 <a NAME="Editor.commentLineOrSelection" ID="Editor.commentLineOrSelection"></a>
 <h4>Editor.commentLineOrSelection</h4>
 <b>commentLineOrSelection</b>(<i></i>)
@@ -4699,12 +4829,10 @@
 <p>
         Public slot to comment the current line or current selection.
 </p>
-<a NAME="Editor.commentSelection" ID="Editor.commentSelection"></a>
-<h4>Editor.commentSelection</h4>
-<b>commentSelection</b>(<i></i>)
-
-<p>
-        Public slot to comment the current selection.
+<p>
+        If the lexer supports a block comment, that is used for commenting.
+        Otherwise a stream comment is used if that is supported. If none of
+        these are supported, the request is ignored silently.
 </p>
 <a NAME="Editor.completionsListReady" ID="Editor.completionsListReady"></a>
 <h4>Editor.completionsListReady</h4>
@@ -7043,13 +7171,6 @@
 <p>
         Public slot to start a shared edit session for the editor.
 </p>
-<a NAME="Editor.streamCommentLine" ID="Editor.streamCommentLine"></a>
-<h4>Editor.streamCommentLine</h4>
-<b>streamCommentLine</b>(<i></i>)
-
-<p>
-        Public slot to stream comment the current line.
-</p>
 <a NAME="Editor.streamCommentLineOrSelection" ID="Editor.streamCommentLineOrSelection"></a>
 <h4>Editor.streamCommentLineOrSelection</h4>
 <b>streamCommentLineOrSelection</b>(<i></i>)
@@ -7057,12 +7178,12 @@
 <p>
         Public slot to stream comment the current line or current selection.
 </p>
-<a NAME="Editor.streamCommentSelection" ID="Editor.streamCommentSelection"></a>
-<h4>Editor.streamCommentSelection</h4>
-<b>streamCommentSelection</b>(<i></i>)
-
-<p>
-        Public slot to comment the current selection.
+<a NAME="Editor.streamUncommentLineOrSelection" ID="Editor.streamUncommentLineOrSelection"></a>
+<h4>Editor.streamUncommentLineOrSelection</h4>
+<b>streamUncommentLineOrSelection</b>(<i></i>)
+
+<p>
+        Public slot to stream uncomment the current line or current selection.
 </p>
 <a NAME="Editor.toggleBookmark" ID="Editor.toggleBookmark"></a>
 <h4>Editor.toggleBookmark</h4>
@@ -7078,18 +7199,17 @@
 line number of the bookmark (integer)
 </dd>
 </dl>
-<a NAME="Editor.toggleCommentBlock" ID="Editor.toggleCommentBlock"></a>
-<h4>Editor.toggleCommentBlock</h4>
-<b>toggleCommentBlock</b>(<i></i>)
-
-<p>
-        Public slot to toggle the comment of a block.
-</p>
-<p>
-        If the editor contains selected text and the start line is not commented, it
-        will be commented. Otherwise the selection will be un-commented. In case there
-        is no selected text and the current line is not commented, it will be commented.
-        If is commented, the comment block will be removed.
+<a NAME="Editor.toggleComment" ID="Editor.toggleComment"></a>
+<h4>Editor.toggleComment</h4>
+<b>toggleComment</b>(<i></i>)
+
+<p>
+        Public slot to toggle a block or stream comment.
+</p>
+<p>
+        If the lexer supports a block comment, that is used for toggling the
+        comment. Otherwise a stream comment is used if that is supported. If
+        none of these are supported, the request is ignored silently.
 </p>
 <a NAME="Editor.toggleCurrentFold" ID="Editor.toggleCurrentFold"></a>
 <h4>Editor.toggleCurrentFold</h4>
@@ -7163,13 +7283,6 @@
 type of warning message
 </dd>
 </dl>
-<a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a>
-<h4>Editor.uncommentLine</h4>
-<b>uncommentLine</b>(<i></i>)
-
-<p>
-        Public slot to uncomment the current line.
-</p>
 <a NAME="Editor.uncommentLineOrSelection" ID="Editor.uncommentLineOrSelection"></a>
 <h4>Editor.uncommentLineOrSelection</h4>
 <b>uncommentLineOrSelection</b>(<i></i>)
@@ -7177,12 +7290,10 @@
 <p>
         Public slot to uncomment the current line or current selection.
 </p>
-<a NAME="Editor.uncommentSelection" ID="Editor.uncommentSelection"></a>
-<h4>Editor.uncommentSelection</h4>
-<b>uncommentSelection</b>(<i></i>)
-
-<p>
-        Public slot to uncomment the current selection.
+<p>
+        If the lexer supports a block comment, that is used for uncommenting.
+        Otherwise a stream comment is used if that is supported. If none of
+        these are supported, the request is ignored silently.
 </p>
 <a NAME="Editor.undo" ID="Editor.undo"></a>
 <h4>Editor.undo</h4>