Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5Gui.E5GenericDiffHighlighter.html
eric6/Documentation/Source/eric6.E5Gui.E5GenericDiffHighlighter.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5Gui.E5GenericDiffHighlighter</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.E5Gui.E5GenericDiffHighlighter</h1> | |
| 23 <p> | |
| 24 Module implementing a syntax highlighter for diff outputs. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>_REGEX_CACHE</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#E5GenericDiffHighlighter">E5GenericDiffHighlighter</a></td> | |
| 34 <td>Class implementing a generic diff highlighter.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#TERMINAL">TERMINAL</a></td> | |
| 41 <td>Function to mark a pattern as the final one to search for.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="E5GenericDiffHighlighter" ID="E5GenericDiffHighlighter"></a> | |
| 46 <h2>E5GenericDiffHighlighter</h2> | |
| 47 <p> | |
| 48 Class implementing a generic diff highlighter. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QSyntaxHighlighter | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#E5GenericDiffHighlighter.__init__">E5GenericDiffHighlighter</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#E5GenericDiffHighlighter.__initColours">__initColours</a></td> | |
| 67 <td>Private method to initialize the highlighter colours.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#E5GenericDiffHighlighter.createRules">createRules</a></td> | |
| 70 <td>Public method to create the highlighting rules.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#E5GenericDiffHighlighter.formats">formats</a></td> | |
| 73 <td>Public method to determine the highlighting formats for a line of text.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#E5GenericDiffHighlighter.generateRules">generateRules</a></td> | |
| 76 <td>Public method to generate the rule set.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#E5GenericDiffHighlighter.highlightBlock">highlightBlock</a></td> | |
| 79 <td>Public method to highlight a block of text.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#E5GenericDiffHighlighter.makeFormat">makeFormat</a></td> | |
| 82 <td>Public method to generate a format definition.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#E5GenericDiffHighlighter.regenerateRules">regenerateRules</a></td> | |
| 85 <td>Public method to initialize or regenerate the syntax highlighter rules.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="E5GenericDiffHighlighter.__init__" ID="E5GenericDiffHighlighter.__init__"></a> | |
| 93 <h4>E5GenericDiffHighlighter (Constructor)</h4> | |
| 94 <b>E5GenericDiffHighlighter</b>(<i>doc</i>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>doc</i></dt> | |
| 99 <dd> | |
| 100 reference to the text document (QTextDocument) | |
| 101 </dd> | |
| 102 </dl><a NAME="E5GenericDiffHighlighter.__initColours" ID="E5GenericDiffHighlighter.__initColours"></a> | |
| 103 <h4>E5GenericDiffHighlighter.__initColours</h4> | |
| 104 <b>__initColours</b>(<i></i>) | |
| 105 <p> | |
| 106 Private method to initialize the highlighter colours. | |
| 107 </p><a NAME="E5GenericDiffHighlighter.createRules" ID="E5GenericDiffHighlighter.createRules"></a> | |
| 108 <h4>E5GenericDiffHighlighter.createRules</h4> | |
| 109 <b>createRules</b>(<i>*rules</i>) | |
| 110 <p> | |
| 111 Public method to create the highlighting rules. | |
| 112 </p><dl> | |
| 113 <dt><i>rules</i></dt> | |
| 114 <dd> | |
| 115 set of highlighting rules (list of tuples of rule | |
| 116 pattern (string) and highlighting format (QTextCharFormat)) | |
| 117 </dd> | |
| 118 </dl><a NAME="E5GenericDiffHighlighter.formats" ID="E5GenericDiffHighlighter.formats"></a> | |
| 119 <h4>E5GenericDiffHighlighter.formats</h4> | |
| 120 <b>formats</b>(<i>line</i>) | |
| 121 <p> | |
| 122 Public method to determine the highlighting formats for a line of | |
| 123 text. | |
| 124 </p><dl> | |
| 125 <dt><i>line</i></dt> | |
| 126 <dd> | |
| 127 text line to be highlighted (string) | |
| 128 </dd> | |
| 129 </dl><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 list of matched highlighting rules (list of tuples of match | |
| 133 object and format (QTextCharFormat)) | |
| 134 </dd> | |
| 135 </dl><a NAME="E5GenericDiffHighlighter.generateRules" ID="E5GenericDiffHighlighter.generateRules"></a> | |
| 136 <h4>E5GenericDiffHighlighter.generateRules</h4> | |
| 137 <b>generateRules</b>(<i></i>) | |
| 138 <p> | |
| 139 Public method to generate the rule set. | |
| 140 </p><p> | |
| 141 Note: This method must me implemented by derived syntax | |
| 142 highlighters. | |
| 143 </p><a NAME="E5GenericDiffHighlighter.highlightBlock" ID="E5GenericDiffHighlighter.highlightBlock"></a> | |
| 144 <h4>E5GenericDiffHighlighter.highlightBlock</h4> | |
| 145 <b>highlightBlock</b>(<i>text</i>) | |
| 146 <p> | |
| 147 Public method to highlight a block of text. | |
| 148 </p><dl> | |
| 149 <dt><i>text</i></dt> | |
| 150 <dd> | |
| 151 text to be highlighted (string) | |
| 152 </dd> | |
| 153 </dl><a NAME="E5GenericDiffHighlighter.makeFormat" ID="E5GenericDiffHighlighter.makeFormat"></a> | |
| 154 <h4>E5GenericDiffHighlighter.makeFormat</h4> | |
| 155 <b>makeFormat</b>(<i>fg=None, bg=None, bold=False</i>) | |
| 156 <p> | |
| 157 Public method to generate a format definition. | |
| 158 </p><dl> | |
| 159 <dt><i>fg</i></dt> | |
| 160 <dd> | |
| 161 foreground color (QColor) | |
| 162 </dd><dt><i>bg</i></dt> | |
| 163 <dd> | |
| 164 background color (QColor) | |
| 165 </dd><dt><i>bold</i></dt> | |
| 166 <dd> | |
| 167 flag indicating bold text (boolean) | |
| 168 </dd> | |
| 169 </dl><dl> | |
| 170 <dt>Returns:</dt> | |
| 171 <dd> | |
| 172 format definiton (QTextCharFormat) | |
| 173 </dd> | |
| 174 </dl><a NAME="E5GenericDiffHighlighter.regenerateRules" ID="E5GenericDiffHighlighter.regenerateRules"></a> | |
| 175 <h4>E5GenericDiffHighlighter.regenerateRules</h4> | |
| 176 <b>regenerateRules</b>(<i></i>) | |
| 177 <p> | |
| 178 Public method to initialize or regenerate the syntax highlighter rules. | |
| 179 </p> | |
| 180 <div align="right"><a href="#top">Up</a></div> | |
| 181 <hr /><hr /> | |
| 182 <a NAME="TERMINAL" ID="TERMINAL"></a> | |
| 183 <h2>TERMINAL</h2> | |
| 184 <b>TERMINAL</b>(<i>pattern</i>) | |
| 185 <p> | |
| 186 Function to mark a pattern as the final one to search for. | |
| 187 </p><dl> | |
| 188 <dt><i>pattern</i></dt> | |
| 189 <dd> | |
| 190 pattern to be marked (string) | |
| 191 </dd> | |
| 192 </dl><dl> | |
| 193 <dt>Returns:</dt> | |
| 194 <dd> | |
| 195 marked pattern (string) | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <div align="right"><a href="#top">Up</a></div> | |
| 199 <hr /> | |
| 200 </body></html> |
