Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html
src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricGui.EricGenericDiffHighlighter</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.EricGui.EricGenericDiffHighlighter</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a syntax highlighter for diff outputs. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>_REGEX_CACHE</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#EricGenericDiffHighlighter">EricGenericDiffHighlighter</a></td> | |
| 25 <td>Class implementing a generic diff highlighter.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#TERMINAL">TERMINAL</a></td> | |
| 34 <td>Function to mark a pattern as the final one to search for.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="EricGenericDiffHighlighter" ID="EricGenericDiffHighlighter"></a> | |
| 40 <h2>EricGenericDiffHighlighter</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a generic diff highlighter. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QSyntaxHighlighter | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#EricGenericDiffHighlighter.__init__">EricGenericDiffHighlighter</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#EricGenericDiffHighlighter.__initColours">__initColours</a></td> | |
| 67 <td>Private method to initialize the highlighter colours.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#EricGenericDiffHighlighter.createRules">createRules</a></td> | |
| 71 <td>Public method to create the highlighting rules.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#EricGenericDiffHighlighter.formats">formats</a></td> | |
| 75 <td>Public method to determine the highlighting formats for a line of text.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EricGenericDiffHighlighter.generateRules">generateRules</a></td> | |
| 79 <td>Public method to generate the rule set.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EricGenericDiffHighlighter.highlightBlock">highlightBlock</a></td> | |
| 83 <td>Public method to highlight a block of text.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EricGenericDiffHighlighter.makeFormat">makeFormat</a></td> | |
| 87 <td>Public method to generate a format definition.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#EricGenericDiffHighlighter.regenerateRules">regenerateRules</a></td> | |
| 91 <td>Public method to initialize or regenerate the syntax highlighter rules.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="EricGenericDiffHighlighter.__init__" ID="EricGenericDiffHighlighter.__init__"></a> | |
| 101 <h4>EricGenericDiffHighlighter (Constructor)</h4> | |
| 102 <b>EricGenericDiffHighlighter</b>(<i>doc</i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>doc</i></dt> | |
| 110 <dd> | |
| 111 reference to the text document (QTextDocument) | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <a NAME="EricGenericDiffHighlighter.__initColours" ID="EricGenericDiffHighlighter.__initColours"></a> | |
| 115 <h4>EricGenericDiffHighlighter.__initColours</h4> | |
| 116 <b>__initColours</b>(<i></i>) | |
| 117 | |
| 118 <p> | |
| 119 Private method to initialize the highlighter colours. | |
| 120 </p> | |
| 121 <a NAME="EricGenericDiffHighlighter.createRules" ID="EricGenericDiffHighlighter.createRules"></a> | |
| 122 <h4>EricGenericDiffHighlighter.createRules</h4> | |
| 123 <b>createRules</b>(<i>*rules</i>) | |
| 124 | |
| 125 <p> | |
| 126 Public method to create the highlighting rules. | |
| 127 </p> | |
| 128 <dl> | |
| 129 | |
| 130 <dt><i>rules</i></dt> | |
| 131 <dd> | |
| 132 set of highlighting rules (list of tuples of rule | |
| 133 pattern (string) and highlighting format (QTextCharFormat)) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="EricGenericDiffHighlighter.formats" ID="EricGenericDiffHighlighter.formats"></a> | |
| 137 <h4>EricGenericDiffHighlighter.formats</h4> | |
| 138 <b>formats</b>(<i>line</i>) | |
| 139 | |
| 140 <p> | |
| 141 Public method to determine the highlighting formats for a line of | |
| 142 text. | |
| 143 </p> | |
| 144 <dl> | |
| 145 | |
| 146 <dt><i>line</i></dt> | |
| 147 <dd> | |
| 148 text line to be highlighted (string) | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <dl> | |
| 152 <dt>Return:</dt> | |
| 153 <dd> | |
| 154 list of matched highlighting rules (list of tuples of match | |
| 155 object and format (QTextCharFormat)) | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <a NAME="EricGenericDiffHighlighter.generateRules" ID="EricGenericDiffHighlighter.generateRules"></a> | |
| 159 <h4>EricGenericDiffHighlighter.generateRules</h4> | |
| 160 <b>generateRules</b>(<i></i>) | |
| 161 | |
| 162 <p> | |
| 163 Public method to generate the rule set. | |
| 164 </p> | |
| 165 <p> | |
| 166 Note: This method must me implemented by derived syntax | |
| 167 highlighters. | |
| 168 </p> | |
| 169 <a NAME="EricGenericDiffHighlighter.highlightBlock" ID="EricGenericDiffHighlighter.highlightBlock"></a> | |
| 170 <h4>EricGenericDiffHighlighter.highlightBlock</h4> | |
| 171 <b>highlightBlock</b>(<i>text</i>) | |
| 172 | |
| 173 <p> | |
| 174 Public method to highlight a block of text. | |
| 175 </p> | |
| 176 <dl> | |
| 177 | |
| 178 <dt><i>text</i></dt> | |
| 179 <dd> | |
| 180 text to be highlighted (string) | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <a NAME="EricGenericDiffHighlighter.makeFormat" ID="EricGenericDiffHighlighter.makeFormat"></a> | |
| 184 <h4>EricGenericDiffHighlighter.makeFormat</h4> | |
| 185 <b>makeFormat</b>(<i>fg=None, bg=None, bold=False</i>) | |
| 186 | |
| 187 <p> | |
| 188 Public method to generate a format definition. | |
| 189 </p> | |
| 190 <dl> | |
| 191 | |
| 192 <dt><i>fg</i></dt> | |
| 193 <dd> | |
| 194 foreground color (QColor) | |
| 195 </dd> | |
| 196 <dt><i>bg</i></dt> | |
| 197 <dd> | |
| 198 background color (QColor) | |
| 199 </dd> | |
| 200 <dt><i>bold</i></dt> | |
| 201 <dd> | |
| 202 flag indicating bold text (boolean) | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return:</dt> | |
| 207 <dd> | |
| 208 format definiton (QTextCharFormat) | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <a NAME="EricGenericDiffHighlighter.regenerateRules" ID="EricGenericDiffHighlighter.regenerateRules"></a> | |
| 212 <h4>EricGenericDiffHighlighter.regenerateRules</h4> | |
| 213 <b>regenerateRules</b>(<i></i>) | |
| 214 | |
| 215 <p> | |
| 216 Public method to initialize or regenerate the syntax highlighter rules. | |
| 217 </p> | |
| 218 <div align="right"><a href="#top">Up</a></div> | |
| 219 <hr /> | |
| 220 <hr /> | |
| 221 <a NAME="TERMINAL" ID="TERMINAL"></a> | |
| 222 <h2>TERMINAL</h2> | |
| 223 <b>TERMINAL</b>(<i>pattern</i>) | |
| 224 | |
| 225 <p> | |
| 226 Function to mark a pattern as the final one to search for. | |
| 227 </p> | |
| 228 <dl> | |
| 229 | |
| 230 <dt><i>pattern</i></dt> | |
| 231 <dd> | |
| 232 pattern to be marked (string) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <dl> | |
| 236 <dt>Return:</dt> | |
| 237 <dd> | |
| 238 marked pattern (string) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <div align="right"><a href="#top">Up</a></div> | |
| 242 <hr /> | |
| 243 </body></html> |
