diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html --- a/src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,57 +7,53 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.EricGui.EricGenericDiffHighlighter</h1> - <p> Module implementing a syntax highlighter for diff outputs. </p> + <h3>Global Attributes</h3> - <table> <tr><td>_REGEX_CACHE</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#EricGenericDiffHighlighter">EricGenericDiffHighlighter</a></td> <td>Class implementing a generic diff highlighter.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#TERMINAL">TERMINAL</a></td> <td>Function to mark a pattern as the final one to search for.</td> </tr> </table> + <hr /> <hr /> <a NAME="EricGenericDiffHighlighter" ID="EricGenericDiffHighlighter"></a> <h2>EricGenericDiffHighlighter</h2> - <p> Class implementing a generic diff highlighter. </p> + <h3>Derived from</h3> QSyntaxHighlighter <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#EricGenericDiffHighlighter.__init__">EricGenericDiffHighlighter</a></td> <td>Constructor</td> @@ -91,19 +87,20 @@ <td>Public method to initialize or regenerate the syntax highlighter rules.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="EricGenericDiffHighlighter.__init__" ID="EricGenericDiffHighlighter.__init__"></a> <h4>EricGenericDiffHighlighter (Constructor)</h4> <b>EricGenericDiffHighlighter</b>(<i>doc</i>) - <p> Constructor </p> + <dl> <dt><i>doc</i> (QTextDocument)</dt> @@ -114,17 +111,17 @@ <a NAME="EricGenericDiffHighlighter.__initColours" ID="EricGenericDiffHighlighter.__initColours"></a> <h4>EricGenericDiffHighlighter.__initColours</h4> <b>__initColours</b>(<i></i>) - <p> Private method to initialize the highlighter colours. </p> + <a NAME="EricGenericDiffHighlighter.createRules" ID="EricGenericDiffHighlighter.createRules"></a> <h4>EricGenericDiffHighlighter.createRules</h4> <b>createRules</b>(<i>*rules</i>) - <p> Public method to create the highlighting rules. </p> + <dl> <dt><i>rules</i> (set of tuple of (str, QTextCharFormat))</dt> @@ -136,11 +133,11 @@ <a NAME="EricGenericDiffHighlighter.formats" ID="EricGenericDiffHighlighter.formats"></a> <h4>EricGenericDiffHighlighter.formats</h4> <b>formats</b>(<i>line</i>) - <p> Public method to determine the highlighting formats for a line of text. </p> + <dl> <dt><i>line</i> (str)</dt> @@ -164,7 +161,6 @@ <a NAME="EricGenericDiffHighlighter.generateRules" ID="EricGenericDiffHighlighter.generateRules"></a> <h4>EricGenericDiffHighlighter.generateRules</h4> <b>generateRules</b>(<i></i>) - <p> Public method to generate the rule set. </p> @@ -172,13 +168,14 @@ Note: This method must me implemented by derived syntax highlighters. </p> + <a NAME="EricGenericDiffHighlighter.highlightBlock" ID="EricGenericDiffHighlighter.highlightBlock"></a> <h4>EricGenericDiffHighlighter.highlightBlock</h4> <b>highlightBlock</b>(<i>text</i>) - <p> Public method to highlight a block of text. </p> + <dl> <dt><i>text</i> (str)</dt> @@ -189,10 +186,10 @@ <a NAME="EricGenericDiffHighlighter.makeFormat" ID="EricGenericDiffHighlighter.makeFormat"></a> <h4>EricGenericDiffHighlighter.makeFormat</h4> <b>makeFormat</b>(<i>fg=None, bg=None, bold=False</i>) - <p> Public method to generate a format definition. </p> + <dl> <dt><i>fg</i> (QColor)</dt> @@ -223,20 +220,20 @@ <a NAME="EricGenericDiffHighlighter.regenerateRules" ID="EricGenericDiffHighlighter.regenerateRules"></a> <h4>EricGenericDiffHighlighter.regenerateRules</h4> <b>regenerateRules</b>(<i></i>) - <p> Public method to initialize or regenerate the syntax highlighter rules. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="TERMINAL" ID="TERMINAL"></a> <h2>TERMINAL</h2> <b>TERMINAL</b>(<i>pattern</i>) - <p> Function to mark a pattern as the final one to search for. </p> + <dl> <dt><i>pattern</i> (str)</dt> @@ -258,4 +255,4 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>