--- a/Documentation/Source/eric5.QScintilla.Editor.html Sat Nov 02 11:55:46 2013 +0100
+++ b/Documentation/Source/eric5.QScintilla.Editor.html Wed Nov 06 19:23:06 2013 +0100
@@ -224,6 +224,9 @@
<td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td>
<td>Private slot to clear all breakpoints.</td>
</tr><tr>
+<td><a href="#Editor.__clearTypedWarning">__clearTypedWarning</a></td>
+<td>Public method to clear warnings of a specific kind.</td>
+</tr><tr>
<td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td>
<td>Private method to handle the hide code coverage annotations context menu action.</td>
</tr><tr>
@@ -545,9 +548,6 @@
<td><a href="#Editor.__showContextMenuSpelling">__showContextMenuSpelling</a></td>
<td>Private slot to set up the spelling menu before it is shown.</td>
</tr><tr>
-<td><a href="#Editor.__showFlakesWarning">__showFlakesWarning</a></td>
-<td>Private slot to handle the 'Show warning' context menu action.</td>
-</tr><tr>
<td><a href="#Editor.__showImportsDiagram">__showImportsDiagram</a></td>
<td>Private method to handle the Imports Diagram context menu action.</td>
</tr><tr>
@@ -560,6 +560,9 @@
<td><a href="#Editor.__showSyntaxError">__showSyntaxError</a></td>
<td>Private slot to handle the 'Show syntax error message' context menu action.</td>
</tr><tr>
+<td><a href="#Editor.__showWarning">__showWarning</a></td>
+<td>Private slot to handle the 'Show warning' context menu action.</td>
+</tr><tr>
<td><a href="#Editor.__spellCharAdded">__spellCharAdded</a></td>
<td>Public slot called to handle the user entering a character.</td>
</tr><tr>
@@ -636,14 +639,20 @@
<td>Public method to clear a breakpoint.</td>
</tr><tr>
<td><a href="#Editor.clearFlakesWarnings">clearFlakesWarnings</a></td>
-<td>Public slot to handle the 'Clear all warnings' context menu action.</td>
+<td>Public slot to clear all pyflakes warnings.</td>
</tr><tr>
<td><a href="#Editor.clearSearchIndicators">clearSearchIndicators</a></td>
<td>Public method to clear all search indicators.</td>
</tr><tr>
+<td><a href="#Editor.clearStyleWarnings">clearStyleWarnings</a></td>
+<td>Public slot to clear all style warnings.</td>
+</tr><tr>
<td><a href="#Editor.clearSyntaxError">clearSyntaxError</a></td>
<td>Public slot to handle the 'Clear all syntax error' context menu action.</td>
</tr><tr>
+<td><a href="#Editor.clearWarnings">clearWarnings</a></td>
+<td>Public slot to clear all warnings.</td>
+</tr><tr>
<td><a href="#Editor.close">close</a></td>
<td>Public method called when the window gets closed.</td>
</tr><tr>
@@ -737,9 +746,6 @@
<td><a href="#Editor.getFileTypeByFlag">getFileTypeByFlag</a></td>
<td>Public method to return the type of the file, if it was set by an eflag: marker.</td>
</tr><tr>
-<td><a href="#Editor.getFlakesWarnings">getFlakesWarnings</a></td>
-<td>Public method to retrieve the flakes warning markers.</td>
-</tr><tr>
<td><a href="#Editor.getHighlightPosition">getHighlightPosition</a></td>
<td>Public method to return the position of the highlight bar.</td>
</tr><tr>
@@ -764,6 +770,9 @@
<td><a href="#Editor.getSyntaxErrors">getSyntaxErrors</a></td>
<td>Public method to retrieve the syntax error markers.</td>
</tr><tr>
+<td><a href="#Editor.getWarnings">getWarnings</a></td>
+<td>Public method to retrieve the warning markers.</td>
+</tr><tr>
<td><a href="#Editor.getWord">getWord</a></td>
<td>Public method to get the word at a position.</td>
</tr><tr>
@@ -806,9 +815,6 @@
<td><a href="#Editor.hasCoverageMarkers">hasCoverageMarkers</a></td>
<td>Public method to test, if there are coverage markers.</td>
</tr><tr>
-<td><a href="#Editor.hasFlakesWarnings">hasFlakesWarnings</a></td>
-<td>Public method to check for the presence of flakes warnings.</td>
-</tr><tr>
<td><a href="#Editor.hasMiniMenu">hasMiniMenu</a></td>
<td>Public method to check the miniMenu flag.</td>
</tr><tr>
@@ -818,6 +824,9 @@
<td><a href="#Editor.hasTaskMarkers">hasTaskMarkers</a></td>
<td>Public method to determine, if this editor contains any task markers.</td>
</tr><tr>
+<td><a href="#Editor.hasWarnings">hasWarnings</a></td>
+<td>Public method to check for the presence of warnings.</td>
+</tr><tr>
<td><a href="#Editor.highlight">highlight</a></td>
<td>Public method to highlight [or de-highlight] a particular line.</td>
</tr><tr>
@@ -893,30 +902,30 @@
<td><a href="#Editor.nextChange">nextChange</a></td>
<td>Public slot to handle the 'Next change' context menu action.</td>
</tr><tr>
-<td><a href="#Editor.nextFlakesWarning">nextFlakesWarning</a></td>
-<td>Public slot to handle the 'Next warning' context menu action.</td>
-</tr><tr>
<td><a href="#Editor.nextTask">nextTask</a></td>
<td>Public slot to handle the 'Next task' context menu action.</td>
</tr><tr>
<td><a href="#Editor.nextUncovered">nextUncovered</a></td>
<td>Public slot to handle the 'Next uncovered' context menu action.</td>
</tr><tr>
+<td><a href="#Editor.nextWarning">nextWarning</a></td>
+<td>Public slot to handle the 'Next warning' context menu action.</td>
+</tr><tr>
<td><a href="#Editor.previousBookmark">previousBookmark</a></td>
<td>Public slot to handle the 'Previous bookmark' context menu action.</td>
</tr><tr>
<td><a href="#Editor.previousChange">previousChange</a></td>
<td>Public slot to handle the 'Previous task' context menu action.</td>
</tr><tr>
-<td><a href="#Editor.previousFlakesWarning">previousFlakesWarning</a></td>
-<td>Public slot to handle the 'Previous warning' context menu action.</td>
-</tr><tr>
<td><a href="#Editor.previousTask">previousTask</a></td>
<td>Public slot to handle the 'Previous task' context menu action.</td>
</tr><tr>
<td><a href="#Editor.previousUncovered">previousUncovered</a></td>
<td>Public slot to handle the 'Previous uncovered' context menu action.</td>
</tr><tr>
+<td><a href="#Editor.previousWarning">previousWarning</a></td>
+<td>Public slot to handle the 'Previous warning' context menu action.</td>
+</tr><tr>
<td><a href="#Editor.printFile">printFile</a></td>
<td>Public slot to print the text.</td>
</tr><tr>
@@ -1040,12 +1049,12 @@
<td><a href="#Editor.toggleCommentBlock">toggleCommentBlock</a></td>
<td>Public slot to toggle the comment of a block.</td>
</tr><tr>
-<td><a href="#Editor.toggleFlakesWarning">toggleFlakesWarning</a></td>
-<td>Public method to toggle a flakes warning indicator.</td>
-</tr><tr>
<td><a href="#Editor.toggleSyntaxError">toggleSyntaxError</a></td>
<td>Public method to toggle a syntax error indicator.</td>
</tr><tr>
+<td><a href="#Editor.toggleWarning">toggleWarning</a></td>
+<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>
@@ -1352,6 +1361,17 @@
<dd>
name of the file (string)
</dd>
+</dl><a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a>
+<h4>Editor.__clearTypedWarning</h4>
+<b>__clearTypedWarning</b>(<i>warningKind</i>)
+<p>
+ Public method to clear warnings of a specific kind.
+</p><dl>
+<dt><i>warningKind</i></dt>
+<dd>
+kind of warning to clear (Editor.WarningCode,
+ Editor.WarningStyle)
+</dd>
</dl><a NAME="Editor.__codeCoverageHideAnnotations" ID="Editor.__codeCoverageHideAnnotations"></a>
<h4>Editor.__codeCoverageHideAnnotations</h4>
<b>__codeCoverageHideAnnotations</b>(<i></i>)
@@ -2238,17 +2258,7 @@
<b>__showContextMenuSpelling</b>(<i></i>)
<p>
Private slot to set up the spelling menu before it is shown.
-</p><a NAME="Editor.__showFlakesWarning" ID="Editor.__showFlakesWarning"></a>
-<h4>Editor.__showFlakesWarning</h4>
-<b>__showFlakesWarning</b>(<i>line=-1</i>)
-<p>
- Private slot to handle the 'Show warning' context menu action.
-</p><dl>
-<dt><i>line</i></dt>
-<dd>
-line number to show the flakes warning for (integer)
-</dd>
-</dl><a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a>
+</p><a NAME="Editor.__showImportsDiagram" ID="Editor.__showImportsDiagram"></a>
<h4>Editor.__showImportsDiagram</h4>
<b>__showImportsDiagram</b>(<i></i>)
<p>
@@ -2274,6 +2284,16 @@
<dd>
line number to show the syntax error for (integer)
</dd>
+</dl><a NAME="Editor.__showWarning" ID="Editor.__showWarning"></a>
+<h4>Editor.__showWarning</h4>
+<b>__showWarning</b>(<i>line=-1</i>)
+<p>
+ Private slot to handle the 'Show warning' context menu action.
+</p><dl>
+<dt><i>line</i></dt>
+<dd>
+line number to show the warning for (integer)
+</dd>
</dl><a NAME="Editor.__spellCharAdded" ID="Editor.__spellCharAdded"></a>
<h4>Editor.__spellCharAdded</h4>
<b>__spellCharAdded</b>(<i>charNumber</i>)
@@ -2499,17 +2519,27 @@
<h4>Editor.clearFlakesWarnings</h4>
<b>clearFlakesWarnings</b>(<i></i>)
<p>
- Public slot to handle the 'Clear all warnings' context menu action.
+ Public slot to clear all pyflakes warnings.
</p><a NAME="Editor.clearSearchIndicators" ID="Editor.clearSearchIndicators"></a>
<h4>Editor.clearSearchIndicators</h4>
<b>clearSearchIndicators</b>(<i></i>)
<p>
Public method to clear all search indicators.
+</p><a NAME="Editor.clearStyleWarnings" ID="Editor.clearStyleWarnings"></a>
+<h4>Editor.clearStyleWarnings</h4>
+<b>clearStyleWarnings</b>(<i></i>)
+<p>
+ Public slot to clear all style warnings.
</p><a NAME="Editor.clearSyntaxError" ID="Editor.clearSyntaxError"></a>
<h4>Editor.clearSyntaxError</h4>
<b>clearSyntaxError</b>(<i></i>)
<p>
Public slot to handle the 'Clear all syntax error' context menu action.
+</p><a NAME="Editor.clearWarnings" ID="Editor.clearWarnings"></a>
+<h4>Editor.clearWarnings</h4>
+<b>clearWarnings</b>(<i></i>)
+<p>
+ Public slot to clear all warnings.
</p><a NAME="Editor.close" ID="Editor.close"></a>
<h4>Editor.close</h4>
<b>close</b>(<i>alsoDelete=False</i>)
@@ -2821,17 +2851,6 @@
type of the displayed file, if set by an eflag: marker or an
empty string (string)
</dd>
-</dl><a NAME="Editor.getFlakesWarnings" ID="Editor.getFlakesWarnings"></a>
-<h4>Editor.getFlakesWarnings</h4>
-<b>getFlakesWarnings</b>(<i></i>)
-<p>
- Public method to retrieve the flakes warning markers.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-sorted list of all lines containing a flakes warning
- (list of integer)
-</dd>
</dl><a NAME="Editor.getHighlightPosition" ID="Editor.getHighlightPosition"></a>
<h4>Editor.getHighlightPosition</h4>
<b>getHighlightPosition</b>(<i></i>)
@@ -2938,6 +2957,17 @@
sorted list of all lines containing a syntax error
(list of integer)
</dd>
+</dl><a NAME="Editor.getWarnings" ID="Editor.getWarnings"></a>
+<h4>Editor.getWarnings</h4>
+<b>getWarnings</b>(<i></i>)
+<p>
+ Public method to retrieve the warning markers.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+sorted list of all lines containing a warning
+ (list of integer)
+</dd>
</dl><a NAME="Editor.getWord" ID="Editor.getWord"></a>
<h4>Editor.getWord</h4>
<b>getWord</b>(<i>line, index, direction=0, useWordChars=True</i>)
@@ -3115,16 +3145,6 @@
<dd>
flag indicating the presence of coverage markers (boolean)
</dd>
-</dl><a NAME="Editor.hasFlakesWarnings" ID="Editor.hasFlakesWarnings"></a>
-<h4>Editor.hasFlakesWarnings</h4>
-<b>hasFlakesWarnings</b>(<i></i>)
-<p>
- Public method to check for the presence of flakes warnings.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating the presence of flakes warnings (boolean)
-</dd>
</dl><a NAME="Editor.hasMiniMenu" ID="Editor.hasMiniMenu"></a>
<h4>Editor.hasMiniMenu</h4>
<b>hasMiniMenu</b>(<i></i>)
@@ -3155,6 +3175,16 @@
<dd>
flag indicating the presence of task markers (boolean)
</dd>
+</dl><a NAME="Editor.hasWarnings" ID="Editor.hasWarnings"></a>
+<h4>Editor.hasWarnings</h4>
+<b>hasWarnings</b>(<i></i>)
+<p>
+ Public method to check for the presence of warnings.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the presence of warnings (boolean)
+</dd>
</dl><a NAME="Editor.highlight" ID="Editor.highlight"></a>
<h4>Editor.highlight</h4>
<b>highlight</b>(<i>line=None, error=False, syntaxError=False</i>)
@@ -3347,11 +3377,6 @@
<b>nextChange</b>(<i></i>)
<p>
Public slot to handle the 'Next change' context menu action.
-</p><a NAME="Editor.nextFlakesWarning" ID="Editor.nextFlakesWarning"></a>
-<h4>Editor.nextFlakesWarning</h4>
-<b>nextFlakesWarning</b>(<i></i>)
-<p>
- Public slot to handle the 'Next warning' context menu action.
</p><a NAME="Editor.nextTask" ID="Editor.nextTask"></a>
<h4>Editor.nextTask</h4>
<b>nextTask</b>(<i></i>)
@@ -3362,6 +3387,11 @@
<b>nextUncovered</b>(<i></i>)
<p>
Public slot to handle the 'Next uncovered' context menu action.
+</p><a NAME="Editor.nextWarning" ID="Editor.nextWarning"></a>
+<h4>Editor.nextWarning</h4>
+<b>nextWarning</b>(<i></i>)
+<p>
+ Public slot to handle the 'Next warning' context menu action.
</p><a NAME="Editor.previousBookmark" ID="Editor.previousBookmark"></a>
<h4>Editor.previousBookmark</h4>
<b>previousBookmark</b>(<i></i>)
@@ -3372,11 +3402,6 @@
<b>previousChange</b>(<i></i>)
<p>
Public slot to handle the 'Previous task' context menu action.
-</p><a NAME="Editor.previousFlakesWarning" ID="Editor.previousFlakesWarning"></a>
-<h4>Editor.previousFlakesWarning</h4>
-<b>previousFlakesWarning</b>(<i></i>)
-<p>
- Public slot to handle the 'Previous warning' context menu action.
</p><a NAME="Editor.previousTask" ID="Editor.previousTask"></a>
<h4>Editor.previousTask</h4>
<b>previousTask</b>(<i></i>)
@@ -3387,6 +3412,11 @@
<b>previousUncovered</b>(<i></i>)
<p>
Public slot to handle the 'Previous uncovered' context menu action.
+</p><a NAME="Editor.previousWarning" ID="Editor.previousWarning"></a>
+<h4>Editor.previousWarning</h4>
+<b>previousWarning</b>(<i></i>)
+<p>
+ Public slot to handle the 'Previous warning' context menu action.
</p><a NAME="Editor.printFile" ID="Editor.printFile"></a>
<h4>Editor.printFile</h4>
<b>printFile</b>(<i></i>)
@@ -3730,29 +3760,7 @@
If the line of the cursor or the selection is not commented, it will
be commented. If it is commented, the comment block will be removed.
The later works independent of the current selection.
-</p><a NAME="Editor.toggleFlakesWarning" ID="Editor.toggleFlakesWarning"></a>
-<h4>Editor.toggleFlakesWarning</h4>
-<b>toggleFlakesWarning</b>(<i>line, warning, msg="", warningType=WarningCode</i>)
-<p>
- Public method to toggle a flakes warning indicator.
-</p><p>
- Note: This method is used to set code style warnings as well.
-</p><dl>
-<dt><i>line</i></dt>
-<dd>
-line number of the flakes warning
-</dd><dt><i>warning</i></dt>
-<dd>
-flag indicating if the warning marker should be
- set or deleted (boolean)
-</dd><dt><i>msg</i></dt>
-<dd>
-warning message (string)
-</dd><dt><i>warningType=</i></dt>
-<dd>
-type of warning message (integer)
-</dd>
-</dl><a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a>
+</p><a NAME="Editor.toggleSyntaxError" ID="Editor.toggleSyntaxError"></a>
<h4>Editor.toggleSyntaxError</h4>
<b>toggleSyntaxError</b>(<i>line, index, error, msg="", show=False</i>)
<p>
@@ -3776,6 +3784,28 @@
flag indicating to set the cursor to the error position
(boolean)
</dd>
+</dl><a NAME="Editor.toggleWarning" ID="Editor.toggleWarning"></a>
+<h4>Editor.toggleWarning</h4>
+<b>toggleWarning</b>(<i>line, warning, msg="", warningType=WarningCode</i>)
+<p>
+ Public method to toggle a warning indicator.
+</p><p>
+ Note: This method is used to set pyflakes and code style warnings.
+</p><dl>
+<dt><i>line</i></dt>
+<dd>
+line number of the warning
+</dd><dt><i>warning</i></dt>
+<dd>
+flag indicating if the warning marker should be
+ set or deleted (boolean)
+</dd><dt><i>msg</i></dt>
+<dd>
+warning message (string)
+</dd><dt><i>warningType=</i></dt>
+<dd>
+type of warning message (integer)
+</dd>
</dl><a NAME="Editor.uncommentLine" ID="Editor.uncommentLine"></a>
<h4>Editor.uncommentLine</h4>
<b>uncommentLine</b>(<i></i>)
