Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffHighlighter.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDiffHighlighter.html
- branch
- without_py2_and_pyqt4
- changeset 7204
- cbf6d88004ce
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 7203:2079ccbfa335 | 7204:cbf6d88004ce |
|---|---|
| 28 <tr><td>None</td></tr> | 28 <tr><td>None</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#E5GenericDiffHighlighter">E5GenericDiffHighlighter</a></td> | |
| 34 <td>Class implementing a generic diff highlighter.</td> | |
| 35 </tr><tr> | |
| 36 <td><a href="#GitDiffHighlighter">GitDiffHighlighter</a></td> | 33 <td><a href="#GitDiffHighlighter">GitDiffHighlighter</a></td> |
| 37 <td>Class implementing a diff highlighter for Git.</td> | 34 <td>Class implementing a diff highlighter for Git.</td> |
| 38 </tr> | 35 </tr> |
| 39 </table> | 36 </table> |
| 40 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 41 <table> | 38 <table> |
| 42 <tr> | |
| 43 <td><a href="#TERMINAL">TERMINAL</a></td> | |
| 44 <td>Function to mark a pattern as the final one to search for.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="E5GenericDiffHighlighter" ID="E5GenericDiffHighlighter"></a> | |
| 49 <h2>E5GenericDiffHighlighter</h2> | |
| 50 <p> | |
| 51 Class implementing a generic diff highlighter. | |
| 52 </p> | |
| 53 <h3>Derived from</h3> | |
| 54 QSyntaxHighlighter | |
| 55 <h3>Class Attributes</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | 39 <tr><td>None</td></tr> |
| 58 </table> | 40 </table> |
| 59 <h3>Class Methods</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Methods</h3> | |
| 64 <table> | |
| 65 <tr> | |
| 66 <td><a href="#E5GenericDiffHighlighter.__init__">E5GenericDiffHighlighter</a></td> | |
| 67 <td>Constructor</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> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="E5GenericDiffHighlighter.__init__" ID="E5GenericDiffHighlighter.__init__"></a> | |
| 90 <h4>E5GenericDiffHighlighter (Constructor)</h4> | |
| 91 <b>E5GenericDiffHighlighter</b>(<i>doc</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>doc</i></dt> | |
| 96 <dd> | |
| 97 reference to the text document (QTextDocument) | |
| 98 </dd> | |
| 99 </dl><a NAME="E5GenericDiffHighlighter.createRules" ID="E5GenericDiffHighlighter.createRules"></a> | |
| 100 <h4>E5GenericDiffHighlighter.createRules</h4> | |
| 101 <b>createRules</b>(<i>*rules</i>) | |
| 102 <p> | |
| 103 Public method to create the highlighting rules. | |
| 104 </p><dl> | |
| 105 <dt><i>rules</i></dt> | |
| 106 <dd> | |
| 107 set of highlighting rules (list of tuples of rule | |
| 108 pattern (string) and highlighting format (QTextCharFormat)) | |
| 109 </dd> | |
| 110 </dl><a NAME="E5GenericDiffHighlighter.formats" ID="E5GenericDiffHighlighter.formats"></a> | |
| 111 <h4>E5GenericDiffHighlighter.formats</h4> | |
| 112 <b>formats</b>(<i>line</i>) | |
| 113 <p> | |
| 114 Public method to determine the highlighting formats for a line of | |
| 115 text. | |
| 116 </p><dl> | |
| 117 <dt><i>line</i></dt> | |
| 118 <dd> | |
| 119 text line to be highlighted (string) | |
| 120 </dd> | |
| 121 </dl><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 list of matched highlighting rules (list of tuples of match | |
| 125 object and format (QTextCharFormat)) | |
| 126 </dd> | |
| 127 </dl><a NAME="E5GenericDiffHighlighter.generateRules" ID="E5GenericDiffHighlighter.generateRules"></a> | |
| 128 <h4>E5GenericDiffHighlighter.generateRules</h4> | |
| 129 <b>generateRules</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method to generate the rule set. | |
| 132 </p><p> | |
| 133 Note: This method must me implemented by derived syntax | |
| 134 highlighters. | |
| 135 </p><a NAME="E5GenericDiffHighlighter.highlightBlock" ID="E5GenericDiffHighlighter.highlightBlock"></a> | |
| 136 <h4>E5GenericDiffHighlighter.highlightBlock</h4> | |
| 137 <b>highlightBlock</b>(<i>text</i>) | |
| 138 <p> | |
| 139 Public method to highlight a block of text. | |
| 140 </p><dl> | |
| 141 <dt><i>text</i></dt> | |
| 142 <dd> | |
| 143 text to be highlighted (string) | |
| 144 </dd> | |
| 145 </dl><a NAME="E5GenericDiffHighlighter.makeFormat" ID="E5GenericDiffHighlighter.makeFormat"></a> | |
| 146 <h4>E5GenericDiffHighlighter.makeFormat</h4> | |
| 147 <b>makeFormat</b>(<i>fg=None, bg=None, bold=False</i>) | |
| 148 <p> | |
| 149 Public method to generate a format definition. | |
| 150 </p><dl> | |
| 151 <dt><i>fg</i></dt> | |
| 152 <dd> | |
| 153 foreground color (QColor) | |
| 154 </dd><dt><i>bg</i></dt> | |
| 155 <dd> | |
| 156 background color (QColor) | |
| 157 </dd><dt><i>bold</i></dt> | |
| 158 <dd> | |
| 159 flag indicating bold text (boolean) | |
| 160 </dd> | |
| 161 </dl><dl> | |
| 162 <dt>Returns:</dt> | |
| 163 <dd> | |
| 164 format definiton (QTextCharFormat) | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <div align="right"><a href="#top">Up</a></div> | |
| 168 <hr /><hr /> | 41 <hr /><hr /> |
| 169 <a NAME="GitDiffHighlighter" ID="GitDiffHighlighter"></a> | 42 <a NAME="GitDiffHighlighter" ID="GitDiffHighlighter"></a> |
| 170 <h2>GitDiffHighlighter</h2> | 43 <h2>GitDiffHighlighter</h2> |
| 171 <p> | 44 <p> |
| 172 Class implementing a diff highlighter for Git. | 45 Class implementing a diff highlighter for Git. |
| 214 <b>generateRules</b>(<i></i>) | 87 <b>generateRules</b>(<i></i>) |
| 215 <p> | 88 <p> |
| 216 Public method to generate the rule set. | 89 Public method to generate the rule set. |
| 217 </p> | 90 </p> |
| 218 <div align="right"><a href="#top">Up</a></div> | 91 <div align="right"><a href="#top">Up</a></div> |
| 219 <hr /><hr /> | |
| 220 <a NAME="TERMINAL" ID="TERMINAL"></a> | |
| 221 <h2>TERMINAL</h2> | |
| 222 <b>TERMINAL</b>(<i>pattern</i>) | |
| 223 <p> | |
| 224 Function to mark a pattern as the final one to search for. | |
| 225 </p><dl> | |
| 226 <dt><i>pattern</i></dt> | |
| 227 <dd> | |
| 228 pattern to be marked (string) | |
| 229 </dd> | |
| 230 </dl><dl> | |
| 231 <dt>Returns:</dt> | |
| 232 <dd> | |
| 233 marked pattern (string) | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <div align="right"><a href="#top">Up</a></div> | |
| 237 <hr /> | 92 <hr /> |
| 238 </body></html> | 93 </body></html> |
