Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html

Documentation/Source/eric5.Preferences.ConfigurationPages.EditorHighlightingStylesPage.html

changeset 244
30be2b4a9721
parent 58
37f0444c3479
child 409
0ea528e80202
equal deleted inserted replaced
243:a1d982e68edf 244:30be2b4a9721
50 </p> 50 </p>
51 <h3>Derived from</h3> 51 <h3>Derived from</h3>
52 ConfigurationPageBase, Ui_EditorHighlightingStylesPage 52 ConfigurationPageBase, Ui_EditorHighlightingStylesPage
53 <h3>Class Attributes</h3> 53 <h3>Class Attributes</h3>
54 <table> 54 <table>
55 <tr><td>None</td></tr> 55 <tr><td>FAMILYANDSIZE</td></tr><tr><td>FAMILYONLY</td></tr><tr><td>FONT</td></tr><tr><td>SIZEONLY</td></tr>
56 </table> 56 </table>
57 <h3>Methods</h3> 57 <h3>Methods</h3>
58 <table> 58 <table>
59 <tr> 59 <tr>
60 <td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td> 60 <td><a href="#EditorHighlightingStylesPage.__init__">EditorHighlightingStylesPage</a></td>
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#EditorHighlightingStylesPage.__allFontsButtonMenuTriggered">__allFontsButtonMenuTriggered</a></td>
64 <td>Private slot used to change the font of all styles of a selected lexer.</td>
65 </tr><tr>
66 <td><a href="#EditorHighlightingStylesPage.__changeFont">__changeFont</a></td>
67 <td>Private slot to change the highlighter font.</td>
68 </tr><tr>
63 <td><a href="#EditorHighlightingStylesPage.__exportStyles">__exportStyles</a></td> 69 <td><a href="#EditorHighlightingStylesPage.__exportStyles">__exportStyles</a></td>
64 <td>Private method to export the styles of the given lexers.</td> 70 <td>Private method to export the styles of the given lexers.</td>
65 </tr><tr> 71 </tr><tr>
72 <td><a href="#EditorHighlightingStylesPage.__fontButtonMenuTriggered">__fontButtonMenuTriggered</a></td>
73 <td>Private slot used to select the font of the selected style and lexer.</td>
74 </tr><tr>
66 <td><a href="#EditorHighlightingStylesPage.__importStyles">__importStyles</a></td> 75 <td><a href="#EditorHighlightingStylesPage.__importStyles">__importStyles</a></td>
67 <td>Private method to import the styles of the given lexers.</td> 76 <td>Private method to import the styles of the given lexers.</td>
68 </tr><tr> 77 </tr><tr>
69 <td><a href="#EditorHighlightingStylesPage.__setToDefault">__setToDefault</a></td> 78 <td><a href="#EditorHighlightingStylesPage.__setToDefault">__setToDefault</a></td>
70 <td>Private method to set a specific style to it's default values.</td> 79 <td>Private method to set a specific style to it's default values.</td>
76 <td>Private method to set all styles to their default values.</td> 85 <td>Private method to set all styles to their default values.</td>
77 </tr><tr> 86 </tr><tr>
78 <td><a href="#EditorHighlightingStylesPage.on_allEolFillButton_clicked">on_allEolFillButton_clicked</a></td> 87 <td><a href="#EditorHighlightingStylesPage.on_allEolFillButton_clicked">on_allEolFillButton_clicked</a></td>
79 <td>Private method used to set the eolfill for all styles of a selected lexer.</td> 88 <td>Private method used to set the eolfill for all styles of a selected lexer.</td>
80 </tr><tr> 89 </tr><tr>
81 <td><a href="#EditorHighlightingStylesPage.on_allFontsButton_clicked">on_allFontsButton_clicked</a></td>
82 <td>Private method used to change the font of all styles of a selected lexer.</td>
83 </tr><tr>
84 <td><a href="#EditorHighlightingStylesPage.on_backgroundButton_clicked">on_backgroundButton_clicked</a></td> 90 <td><a href="#EditorHighlightingStylesPage.on_backgroundButton_clicked">on_backgroundButton_clicked</a></td>
85 <td>Private method used to select the background colour of the selected style and lexer.</td> 91 <td>Private method used to select the background colour of the selected style and lexer.</td>
86 </tr><tr> 92 </tr><tr>
87 <td><a href="#EditorHighlightingStylesPage.on_defaultButton_clicked">on_defaultButton_clicked</a></td> 93 <td><a href="#EditorHighlightingStylesPage.on_defaultButton_clicked">on_defaultButton_clicked</a></td>
88 <td>Private method to set the current style to it's default values.</td> 94 <td>Private method to set the current style to it's default values.</td>
94 <td>Private slot to export the styles of all lexers.</td> 100 <td>Private slot to export the styles of all lexers.</td>
95 </tr><tr> 101 </tr><tr>
96 <td><a href="#EditorHighlightingStylesPage.on_exportCurrentButton_clicked">on_exportCurrentButton_clicked</a></td> 102 <td><a href="#EditorHighlightingStylesPage.on_exportCurrentButton_clicked">on_exportCurrentButton_clicked</a></td>
97 <td>Private slot to export the styles of the current lexer.</td> 103 <td>Private slot to export the styles of the current lexer.</td>
98 </tr><tr> 104 </tr><tr>
99 <td><a href="#EditorHighlightingStylesPage.on_fontButton_clicked">on_fontButton_clicked</a></td>
100 <td>Private method used to select the font of the selected style and lexer.</td>
101 </tr><tr>
102 <td><a href="#EditorHighlightingStylesPage.on_foregroundButton_clicked">on_foregroundButton_clicked</a></td> 105 <td><a href="#EditorHighlightingStylesPage.on_foregroundButton_clicked">on_foregroundButton_clicked</a></td>
103 <td>Private method used to select the foreground colour of the selected style and lexer.</td> 106 <td>Private method used to select the foreground colour of the selected style and lexer.</td>
104 </tr><tr> 107 </tr><tr>
105 <td><a href="#EditorHighlightingStylesPage.on_importAllButton_clicked">on_importAllButton_clicked</a></td> 108 <td><a href="#EditorHighlightingStylesPage.on_importAllButton_clicked">on_importAllButton_clicked</a></td>
106 <td>Private slot to import the styles of all lexers.</td> 109 <td>Private slot to import the styles of all lexers.</td>
117 <td><a href="#EditorHighlightingStylesPage.save">save</a></td> 120 <td><a href="#EditorHighlightingStylesPage.save">save</a></td>
118 <td>Public slot to save the Editor Highlighting Styles configuration.</td> 121 <td>Public slot to save the Editor Highlighting Styles configuration.</td>
119 </tr><tr> 122 </tr><tr>
120 <td><a href="#EditorHighlightingStylesPage.saveState">saveState</a></td> 123 <td><a href="#EditorHighlightingStylesPage.saveState">saveState</a></td>
121 <td>Public method to save the current state of the widget.</td> 124 <td>Public method to save the current state of the widget.</td>
125 </tr><tr>
126 <td><a href="#EditorHighlightingStylesPage.setFont">setFont</a></td>
127 <td>Local function to set the font.</td>
128 </tr><tr>
129 <td><a href="#EditorHighlightingStylesPage.setSampleFont">setSampleFont</a></td>
130 <td>Local function to set the font of the sample text.</td>
122 </tr><tr> 131 </tr><tr>
123 <td><a href="#EditorHighlightingStylesPage.setState">setState</a></td> 132 <td><a href="#EditorHighlightingStylesPage.setState">setState</a></td>
124 <td>Public method to set the state of the widget.</td> 133 <td>Public method to set the state of the widget.</td>
125 </tr> 134 </tr>
126 </table> 135 </table>
132 </p><dl> 141 </p><dl>
133 <dt><i>lexers</i></dt> 142 <dt><i>lexers</i></dt>
134 <dd> 143 <dd>
135 reference to the lexers dictionary 144 reference to the lexers dictionary
136 </dd> 145 </dd>
146 </dl><a NAME="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered" ID="EditorHighlightingStylesPage.__allFontsButtonMenuTriggered"></a>
147 <h4>EditorHighlightingStylesPage.__allFontsButtonMenuTriggered</h4>
148 <b>__allFontsButtonMenuTriggered</b>(<i>act</i>)
149 <p>
150 Private slot used to change the font of all styles of a selected lexer.
151 </p><dl>
152 <dt><i>act</i></dt>
153 <dd>
154 reference to the triggering action (QAction)
155 </dd>
156 </dl><a NAME="EditorHighlightingStylesPage.__changeFont" ID="EditorHighlightingStylesPage.__changeFont"></a>
157 <h4>EditorHighlightingStylesPage.__changeFont</h4>
158 <b>__changeFont</b>(<i>doAll, familyOnly, sizeOnly</i>)
159 <p>
160 Private slot to change the highlighter font.
161 </p><dl>
162 <dt><i>doAll</i></dt>
163 <dd>
164 flag indicating to change the font for all styles (boolean)
165 </dd><dt><i>familyOnly</i></dt>
166 <dd>
167 flag indicating to set the font family only (boolean)
168 </dd><dt><i>sizeOnly</i></dt>
169 <dd>
170 flag indicating to set the font size only (boolean
171 </dd>
137 </dl><a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a> 172 </dl><a NAME="EditorHighlightingStylesPage.__exportStyles" ID="EditorHighlightingStylesPage.__exportStyles"></a>
138 <h4>EditorHighlightingStylesPage.__exportStyles</h4> 173 <h4>EditorHighlightingStylesPage.__exportStyles</h4>
139 <b>__exportStyles</b>(<i>lexers</i>) 174 <b>__exportStyles</b>(<i>lexers</i>)
140 <p> 175 <p>
141 Private method to export the styles of the given lexers. 176 Private method to export the styles of the given lexers.
142 </p><dl> 177 </p><dl>
143 <dt><i>lexers</i></dt> 178 <dt><i>lexers</i></dt>
144 <dd> 179 <dd>
145 list of lexer objects for which to export the styles 180 list of lexer objects for which to export the styles
181 </dd>
182 </dl><a NAME="EditorHighlightingStylesPage.__fontButtonMenuTriggered" ID="EditorHighlightingStylesPage.__fontButtonMenuTriggered"></a>
183 <h4>EditorHighlightingStylesPage.__fontButtonMenuTriggered</h4>
184 <b>__fontButtonMenuTriggered</b>(<i>act</i>)
185 <p>
186 Private slot used to select the font of the selected style and lexer.
187 </p><dl>
188 <dt><i>act</i></dt>
189 <dd>
190 reference to the triggering action (QAction)
146 </dd> 191 </dd>
147 </dl><a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a> 192 </dl><a NAME="EditorHighlightingStylesPage.__importStyles" ID="EditorHighlightingStylesPage.__importStyles"></a>
148 <h4>EditorHighlightingStylesPage.__importStyles</h4> 193 <h4>EditorHighlightingStylesPage.__importStyles</h4>
149 <b>__importStyles</b>(<i>lexers</i>) 194 <b>__importStyles</b>(<i>lexers</i>)
150 <p> 195 <p>
178 </p><a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a> 223 </p><a NAME="EditorHighlightingStylesPage.on_allEolFillButton_clicked" ID="EditorHighlightingStylesPage.on_allEolFillButton_clicked"></a>
179 <h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4> 224 <h4>EditorHighlightingStylesPage.on_allEolFillButton_clicked</h4>
180 <b>on_allEolFillButton_clicked</b>(<i></i>) 225 <b>on_allEolFillButton_clicked</b>(<i></i>)
181 <p> 226 <p>
182 Private method used to set the eolfill for all styles of a selected lexer. 227 Private method used to set the eolfill for all styles of a selected lexer.
183 </p><a NAME="EditorHighlightingStylesPage.on_allFontsButton_clicked" ID="EditorHighlightingStylesPage.on_allFontsButton_clicked"></a>
184 <h4>EditorHighlightingStylesPage.on_allFontsButton_clicked</h4>
185 <b>on_allFontsButton_clicked</b>(<i></i>)
186 <p>
187 Private method used to change the font of all styles of a selected lexer.
188 </p><a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a> 228 </p><a NAME="EditorHighlightingStylesPage.on_backgroundButton_clicked" ID="EditorHighlightingStylesPage.on_backgroundButton_clicked"></a>
189 <h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4> 229 <h4>EditorHighlightingStylesPage.on_backgroundButton_clicked</h4>
190 <b>on_backgroundButton_clicked</b>(<i></i>) 230 <b>on_backgroundButton_clicked</b>(<i></i>)
191 <p> 231 <p>
192 Private method used to select the background colour of the selected style 232 Private method used to select the background colour of the selected style
214 </p><a NAME="EditorHighlightingStylesPage.on_exportCurrentButton_clicked" ID="EditorHighlightingStylesPage.on_exportCurrentButton_clicked"></a> 254 </p><a NAME="EditorHighlightingStylesPage.on_exportCurrentButton_clicked" ID="EditorHighlightingStylesPage.on_exportCurrentButton_clicked"></a>
215 <h4>EditorHighlightingStylesPage.on_exportCurrentButton_clicked</h4> 255 <h4>EditorHighlightingStylesPage.on_exportCurrentButton_clicked</h4>
216 <b>on_exportCurrentButton_clicked</b>(<i></i>) 256 <b>on_exportCurrentButton_clicked</b>(<i></i>)
217 <p> 257 <p>
218 Private slot to export the styles of the current lexer. 258 Private slot to export the styles of the current lexer.
219 </p><a NAME="EditorHighlightingStylesPage.on_fontButton_clicked" ID="EditorHighlightingStylesPage.on_fontButton_clicked"></a>
220 <h4>EditorHighlightingStylesPage.on_fontButton_clicked</h4>
221 <b>on_fontButton_clicked</b>(<i></i>)
222 <p>
223 Private method used to select the font of the selected style and lexer.
224 </p><a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a> 259 </p><a NAME="EditorHighlightingStylesPage.on_foregroundButton_clicked" ID="EditorHighlightingStylesPage.on_foregroundButton_clicked"></a>
225 <h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4> 260 <h4>EditorHighlightingStylesPage.on_foregroundButton_clicked</h4>
226 <b>on_foregroundButton_clicked</b>(<i></i>) 261 <b>on_foregroundButton_clicked</b>(<i></i>)
227 <p> 262 <p>
228 Private method used to select the foreground colour of the selected style 263 Private method used to select the foreground colour of the selected style
270 </p><dl> 305 </p><dl>
271 <dt>Returns:</dt> 306 <dt>Returns:</dt>
272 <dd> 307 <dd>
273 array containing the index of the selected lexer language (integer) 308 array containing the index of the selected lexer language (integer)
274 and the index of the selected lexer entry (integer) 309 and the index of the selected lexer entry (integer)
310 </dd>
311 </dl><a NAME="EditorHighlightingStylesPage.setFont" ID="EditorHighlightingStylesPage.setFont"></a>
312 <h4>EditorHighlightingStylesPage.setFont</h4>
313 <b>setFont</b>(<i>style, familyOnly, sizeOnly</i>)
314 <p>
315 Local function to set the font.
316 </p><dl>
317 <dt><i>font</i></dt>
318 <dd>
319 font to be set (QFont)
320 </dd><dt><i>style</i></dt>
321 <dd>
322 style to set the font for (integer)
323 </dd><dt><i>familyOnly</i></dt>
324 <dd>
325 flag indicating to set the font family only (boolean)
326 </dd><dt><i>sizeOnly</i></dt>
327 <dd>
328 flag indicating to set the font size only (boolean
329 </dd>
330 </dl><a NAME="EditorHighlightingStylesPage.setSampleFont" ID="EditorHighlightingStylesPage.setSampleFont"></a>
331 <h4>EditorHighlightingStylesPage.setSampleFont</h4>
332 <b>setSampleFont</b>(<i>familyOnly, sizeOnly</i>)
333 <p>
334 Local function to set the font of the sample text.
335 </p><dl>
336 <dt><i>font</i></dt>
337 <dd>
338 font to be set (QFont)
339 </dd><dt><i>familyOnly</i></dt>
340 <dd>
341 flag indicating to set the font family only (boolean)
342 </dd><dt><i>sizeOnly</i></dt>
343 <dd>
344 flag indicating to set the font size only (boolean
275 </dd> 345 </dd>
276 </dl><a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a> 346 </dl><a NAME="EditorHighlightingStylesPage.setState" ID="EditorHighlightingStylesPage.setState"></a>
277 <h4>EditorHighlightingStylesPage.setState</h4> 347 <h4>EditorHighlightingStylesPage.setState</h4>
278 <b>setState</b>(<i>state</i>) 348 <b>setState</b>(<i>state</i>)
279 <p> 349 <p>

Mercurial Repository: eric

eric ide

mercurial