Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5GenericDiffHighlighter.html

eric6/Documentation/Source/eric6.E5Gui.E5GenericDiffHighlighter.html

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

Mercurial Repository: eric

eric ide

mercurial