src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorStylesPage.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.EditorStylesPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.EditorStylesPage</h1>
10
11 <p> 10 <p>
12 Module implementing the Editor Styles configuration page. 11 Module implementing the Editor Styles configuration page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EditorStylesPage">EditorStylesPage</a></td> 22 <td><a href="#EditorStylesPage">EditorStylesPage</a></td>
25 <td>Class implementing the Editor Styles configuration page.</td> 23 <td>Class implementing the Editor Styles configuration page.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#create">create</a></td> 30 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td> 31 <td>Module function to create the configuration page.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="EditorStylesPage" ID="EditorStylesPage"></a> 37 <a NAME="EditorStylesPage" ID="EditorStylesPage"></a>
40 <h2>EditorStylesPage</h2> 38 <h2>EditorStylesPage</h2>
41
42 <p> 39 <p>
43 Class implementing the Editor Styles configuration page. 40 Class implementing the Editor Styles configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorStylesPage 44 ConfigurationPageBase, Ui_EditorStylesPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48
49 <table> 46 <table>
50 <tr><td>None</td></tr> 47 <tr><td>None</td></tr>
51 </table> 48 </table>
49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53
54 <table> 51 <table>
55 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
56 </table> 53 </table>
54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#EditorStylesPage.__init__">EditorStylesPage</a></td> 58 <td><a href="#EditorStylesPage.__init__">EditorStylesPage</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
125 <tr> 121 <tr>
126 <td><a href="#EditorStylesPage.setMode">setMode</a></td> 122 <td><a href="#EditorStylesPage.setMode">setMode</a></td>
127 <td>Public method to perform mode dependent setups.</td> 123 <td>Public method to perform mode dependent setups.</td>
128 </tr> 124 </tr>
129 </table> 125 </table>
126
130 <h3>Static Methods</h3> 127 <h3>Static Methods</h3>
131
132 <table> 128 <table>
133 <tr><td>None</td></tr> 129 <tr><td>None</td></tr>
134 </table> 130 </table>
131
135 132
136 <a NAME="EditorStylesPage.__init__" ID="EditorStylesPage.__init__"></a> 133 <a NAME="EditorStylesPage.__init__" ID="EditorStylesPage.__init__"></a>
137 <h4>EditorStylesPage (Constructor)</h4> 134 <h4>EditorStylesPage (Constructor)</h4>
138 <b>EditorStylesPage</b>(<i></i>) 135 <b>EditorStylesPage</b>(<i></i>)
139
140 <p> 136 <p>
141 Constructor 137 Constructor
142 </p> 138 </p>
139
143 <a NAME="EditorStylesPage.__selectAnnotationColor" ID="EditorStylesPage.__selectAnnotationColor"></a> 140 <a NAME="EditorStylesPage.__selectAnnotationColor" ID="EditorStylesPage.__selectAnnotationColor"></a>
144 <h4>EditorStylesPage.__selectAnnotationColor</h4> 141 <h4>EditorStylesPage.__selectAnnotationColor</h4>
145 <b>__selectAnnotationColor</b>(<i>annotationType, isBackground, annotationSample</i>) 142 <b>__selectAnnotationColor</b>(<i>annotationType, isBackground, annotationSample</i>)
146
147 <p> 143 <p>
148 Private method to select an annotation color and update the sample. 144 Private method to select an annotation color and update the sample.
149 </p> 145 </p>
146
150 <dl> 147 <dl>
151 148
152 <dt><i>annotationType</i> (str)</dt> 149 <dt><i>annotationType</i> (str)</dt>
153 <dd> 150 <dd>
154 type of the annotation 151 type of the annotation
163 </dd> 160 </dd>
164 </dl> 161 </dl>
165 <a NAME="EditorStylesPage.__setSampleStyleSheet" ID="EditorStylesPage.__setSampleStyleSheet"></a> 162 <a NAME="EditorStylesPage.__setSampleStyleSheet" ID="EditorStylesPage.__setSampleStyleSheet"></a>
166 <h4>EditorStylesPage.__setSampleStyleSheet</h4> 163 <h4>EditorStylesPage.__setSampleStyleSheet</h4>
167 <b>__setSampleStyleSheet</b>(<i>sampleLineEdit, color, background</i>) 164 <b>__setSampleStyleSheet</b>(<i>sampleLineEdit, color, background</i>)
168
169 <p> 165 <p>
170 Private method to colorize a sample with given foreground and 166 Private method to colorize a sample with given foreground and
171 background colors. 167 background colors.
172 </p> 168 </p>
169
173 <dl> 170 <dl>
174 171
175 <dt><i>sampleLineEdit</i> (QLineEdit)</dt> 172 <dt><i>sampleLineEdit</i> (QLineEdit)</dt>
176 <dd> 173 <dd>
177 line edit element to be colorized 174 line edit element to be colorized
186 </dd> 183 </dd>
187 </dl> 184 </dl>
188 <a NAME="EditorStylesPage.on_annotationsErrorBgButton_clicked" ID="EditorStylesPage.on_annotationsErrorBgButton_clicked"></a> 185 <a NAME="EditorStylesPage.on_annotationsErrorBgButton_clicked" ID="EditorStylesPage.on_annotationsErrorBgButton_clicked"></a>
189 <h4>EditorStylesPage.on_annotationsErrorBgButton_clicked</h4> 186 <h4>EditorStylesPage.on_annotationsErrorBgButton_clicked</h4>
190 <b>on_annotationsErrorBgButton_clicked</b>(<i></i>) 187 <b>on_annotationsErrorBgButton_clicked</b>(<i></i>)
191
192 <p> 188 <p>
193 Private slot to set the background colour of the error annotations. 189 Private slot to set the background colour of the error annotations.
194 </p> 190 </p>
191
195 <a NAME="EditorStylesPage.on_annotationsErrorFgButton_clicked" ID="EditorStylesPage.on_annotationsErrorFgButton_clicked"></a> 192 <a NAME="EditorStylesPage.on_annotationsErrorFgButton_clicked" ID="EditorStylesPage.on_annotationsErrorFgButton_clicked"></a>
196 <h4>EditorStylesPage.on_annotationsErrorFgButton_clicked</h4> 193 <h4>EditorStylesPage.on_annotationsErrorFgButton_clicked</h4>
197 <b>on_annotationsErrorFgButton_clicked</b>(<i></i>) 194 <b>on_annotationsErrorFgButton_clicked</b>(<i></i>)
198
199 <p> 195 <p>
200 Private slot to set the foreground colour of the error annotations. 196 Private slot to set the foreground colour of the error annotations.
201 </p> 197 </p>
198
202 <a NAME="EditorStylesPage.on_annotationsInformationBgButton_clicked" ID="EditorStylesPage.on_annotationsInformationBgButton_clicked"></a> 199 <a NAME="EditorStylesPage.on_annotationsInformationBgButton_clicked" ID="EditorStylesPage.on_annotationsInformationBgButton_clicked"></a>
203 <h4>EditorStylesPage.on_annotationsInformationBgButton_clicked</h4> 200 <h4>EditorStylesPage.on_annotationsInformationBgButton_clicked</h4>
204 <b>on_annotationsInformationBgButton_clicked</b>(<i></i>) 201 <b>on_annotationsInformationBgButton_clicked</b>(<i></i>)
205
206 <p> 202 <p>
207 Private slot to set the background colour of the information annotations. 203 Private slot to set the background colour of the information annotations.
208 </p> 204 </p>
205
209 <a NAME="EditorStylesPage.on_annotationsInformationFgButton_clicked" ID="EditorStylesPage.on_annotationsInformationFgButton_clicked"></a> 206 <a NAME="EditorStylesPage.on_annotationsInformationFgButton_clicked" ID="EditorStylesPage.on_annotationsInformationFgButton_clicked"></a>
210 <h4>EditorStylesPage.on_annotationsInformationFgButton_clicked</h4> 207 <h4>EditorStylesPage.on_annotationsInformationFgButton_clicked</h4>
211 <b>on_annotationsInformationFgButton_clicked</b>(<i></i>) 208 <b>on_annotationsInformationFgButton_clicked</b>(<i></i>)
212
213 <p> 209 <p>
214 Private slot to set the foreground colour of the information annotations. 210 Private slot to set the foreground colour of the information annotations.
215 </p> 211 </p>
212
216 <a NAME="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked"></a> 213 <a NAME="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked"></a>
217 <h4>EditorStylesPage.on_annotationsStyleWarningBgButton_clicked</h4> 214 <h4>EditorStylesPage.on_annotationsStyleWarningBgButton_clicked</h4>
218 <b>on_annotationsStyleWarningBgButton_clicked</b>(<i></i>) 215 <b>on_annotationsStyleWarningBgButton_clicked</b>(<i></i>)
219
220 <p> 216 <p>
221 Private slot to set the background colour of the style annotations. 217 Private slot to set the background colour of the style annotations.
222 </p> 218 </p>
219
223 <a NAME="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked"></a> 220 <a NAME="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked"></a>
224 <h4>EditorStylesPage.on_annotationsStyleWarningFgButton_clicked</h4> 221 <h4>EditorStylesPage.on_annotationsStyleWarningFgButton_clicked</h4>
225 <b>on_annotationsStyleWarningFgButton_clicked</b>(<i></i>) 222 <b>on_annotationsStyleWarningFgButton_clicked</b>(<i></i>)
226
227 <p> 223 <p>
228 Private slot to set the foreground colour of the style annotations. 224 Private slot to set the foreground colour of the style annotations.
229 </p> 225 </p>
226
230 <a NAME="EditorStylesPage.on_annotationsWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsWarningBgButton_clicked"></a> 227 <a NAME="EditorStylesPage.on_annotationsWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsWarningBgButton_clicked"></a>
231 <h4>EditorStylesPage.on_annotationsWarningBgButton_clicked</h4> 228 <h4>EditorStylesPage.on_annotationsWarningBgButton_clicked</h4>
232 <b>on_annotationsWarningBgButton_clicked</b>(<i></i>) 229 <b>on_annotationsWarningBgButton_clicked</b>(<i></i>)
233
234 <p> 230 <p>
235 Private slot to set the background colour of the warning annotations. 231 Private slot to set the background colour of the warning annotations.
236 </p> 232 </p>
233
237 <a NAME="EditorStylesPage.on_annotationsWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsWarningFgButton_clicked"></a> 234 <a NAME="EditorStylesPage.on_annotationsWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsWarningFgButton_clicked"></a>
238 <h4>EditorStylesPage.on_annotationsWarningFgButton_clicked</h4> 235 <h4>EditorStylesPage.on_annotationsWarningFgButton_clicked</h4>
239 <b>on_annotationsWarningFgButton_clicked</b>(<i></i>) 236 <b>on_annotationsWarningFgButton_clicked</b>(<i></i>)
240
241 <p> 237 <p>
242 Private slot to set the foreground colour of the warning annotations. 238 Private slot to set the foreground colour of the warning annotations.
243 </p> 239 </p>
240
244 <a NAME="EditorStylesPage.on_defaultFontButton_clicked" ID="EditorStylesPage.on_defaultFontButton_clicked"></a> 241 <a NAME="EditorStylesPage.on_defaultFontButton_clicked" ID="EditorStylesPage.on_defaultFontButton_clicked"></a>
245 <h4>EditorStylesPage.on_defaultFontButton_clicked</h4> 242 <h4>EditorStylesPage.on_defaultFontButton_clicked</h4>
246 <b>on_defaultFontButton_clicked</b>(<i></i>) 243 <b>on_defaultFontButton_clicked</b>(<i></i>)
247
248 <p> 244 <p>
249 Private method used to select the default font for the editor. 245 Private method used to select the default font for the editor.
250 </p> 246 </p>
247
251 <a NAME="EditorStylesPage.on_linenumbersFontButton_clicked" ID="EditorStylesPage.on_linenumbersFontButton_clicked"></a> 248 <a NAME="EditorStylesPage.on_linenumbersFontButton_clicked" ID="EditorStylesPage.on_linenumbersFontButton_clicked"></a>
252 <h4>EditorStylesPage.on_linenumbersFontButton_clicked</h4> 249 <h4>EditorStylesPage.on_linenumbersFontButton_clicked</h4>
253 <b>on_linenumbersFontButton_clicked</b>(<i></i>) 250 <b>on_linenumbersFontButton_clicked</b>(<i></i>)
254
255 <p> 251 <p>
256 Private method used to select the font for the editor margins. 252 Private method used to select the font for the editor margins.
257 </p> 253 </p>
254
258 <a NAME="EditorStylesPage.on_monospacedFontButton_clicked" ID="EditorStylesPage.on_monospacedFontButton_clicked"></a> 255 <a NAME="EditorStylesPage.on_monospacedFontButton_clicked" ID="EditorStylesPage.on_monospacedFontButton_clicked"></a>
259 <h4>EditorStylesPage.on_monospacedFontButton_clicked</h4> 256 <h4>EditorStylesPage.on_monospacedFontButton_clicked</h4>
260 <b>on_monospacedFontButton_clicked</b>(<i></i>) 257 <b>on_monospacedFontButton_clicked</b>(<i></i>)
261
262 <p> 258 <p>
263 Private method used to select the font to be used as the monospaced 259 Private method used to select the font to be used as the monospaced
264 font. 260 font.
265 </p> 261 </p>
262
266 <a NAME="EditorStylesPage.polishPage" ID="EditorStylesPage.polishPage"></a> 263 <a NAME="EditorStylesPage.polishPage" ID="EditorStylesPage.polishPage"></a>
267 <h4>EditorStylesPage.polishPage</h4> 264 <h4>EditorStylesPage.polishPage</h4>
268 <b>polishPage</b>(<i></i>) 265 <b>polishPage</b>(<i></i>)
269
270 <p> 266 <p>
271 Public slot to perform some polishing actions. 267 Public slot to perform some polishing actions.
272 </p> 268 </p>
269
273 <a NAME="EditorStylesPage.save" ID="EditorStylesPage.save"></a> 270 <a NAME="EditorStylesPage.save" ID="EditorStylesPage.save"></a>
274 <h4>EditorStylesPage.save</h4> 271 <h4>EditorStylesPage.save</h4>
275 <b>save</b>(<i></i>) 272 <b>save</b>(<i></i>)
276
277 <p> 273 <p>
278 Public slot to save the Editor Styles configuration. 274 Public slot to save the Editor Styles configuration.
279 </p> 275 </p>
276
280 <a NAME="EditorStylesPage.setMode" ID="EditorStylesPage.setMode"></a> 277 <a NAME="EditorStylesPage.setMode" ID="EditorStylesPage.setMode"></a>
281 <h4>EditorStylesPage.setMode</h4> 278 <h4>EditorStylesPage.setMode</h4>
282 <b>setMode</b>(<i>displayMode</i>) 279 <b>setMode</b>(<i>displayMode</i>)
283
284 <p> 280 <p>
285 Public method to perform mode dependent setups. 281 Public method to perform mode dependent setups.
286 </p> 282 </p>
283
287 <dl> 284 <dl>
288 285
289 <dt><i>displayMode</i> (ConfigurationMode)</dt> 286 <dt><i>displayMode</i> (ConfigurationMode)</dt>
290 <dd> 287 <dd>
291 mode of the configuration dialog 288 mode of the configuration dialog
295 <hr /> 292 <hr />
296 <hr /> 293 <hr />
297 <a NAME="create" ID="create"></a> 294 <a NAME="create" ID="create"></a>
298 <h2>create</h2> 295 <h2>create</h2>
299 <b>create</b>(<i>dlg</i>) 296 <b>create</b>(<i>dlg</i>)
300
301 <p> 297 <p>
302 Module function to create the configuration page. 298 Module function to create the configuration page.
303 </p> 299 </p>
300
304 <dl> 301 <dl>
305 302
306 <dt><i>dlg</i> (ConfigurationDialog)</dt> 303 <dt><i>dlg</i> (ConfigurationDialog)</dt>
307 <dd> 304 <dd>
308 reference to the configuration dialog 305 reference to the configuration dialog

eric ide

mercurial