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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8877
548d45c3f571
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.EditorStylesPage</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.EditorStylesPage</h1>
10
11 <p>
12 Module implementing the Editor Styles configuration page.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#EditorStylesPage">EditorStylesPage</a></td>
25 <td>Class implementing the Editor Styles configuration page.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31
32 <tr>
33 <td><a href="#create">create</a></td>
34 <td>Module function to create the configuration page.</td>
35 </tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="EditorStylesPage" ID="EditorStylesPage"></a>
40 <h2>EditorStylesPage</h2>
41
42 <p>
43 Class implementing the Editor Styles configuration page.
44 </p>
45 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorStylesPage
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#EditorStylesPage.__init__">EditorStylesPage</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#EditorStylesPage.__setSampleStyleSheet">__setSampleStyleSheet</a></td>
67 <td>Private method to colorize a sample with given foreground and background colors.</td>
68 </tr>
69 <tr>
70 <td><a href="#EditorStylesPage.on_annotationsErrorBgButton_clicked">on_annotationsErrorBgButton_clicked</a></td>
71 <td>Private slot to set the background colour of the error annotations.</td>
72 </tr>
73 <tr>
74 <td><a href="#EditorStylesPage.on_annotationsErrorFgButton_clicked">on_annotationsErrorFgButton_clicked</a></td>
75 <td>Private slot to set the foreground colour of the error annotations.</td>
76 </tr>
77 <tr>
78 <td><a href="#EditorStylesPage.on_annotationsStyleWarningBgButton_clicked">on_annotationsStyleWarningBgButton_clicked</a></td>
79 <td>Private slot to set the background colour of the style annotations.</td>
80 </tr>
81 <tr>
82 <td><a href="#EditorStylesPage.on_annotationsStyleWarningFgButton_clicked">on_annotationsStyleWarningFgButton_clicked</a></td>
83 <td>Private slot to set the foreground colour of the style annotations.</td>
84 </tr>
85 <tr>
86 <td><a href="#EditorStylesPage.on_annotationsWarningBgButton_clicked">on_annotationsWarningBgButton_clicked</a></td>
87 <td>Private slot to set the background colour of the warning annotations.</td>
88 </tr>
89 <tr>
90 <td><a href="#EditorStylesPage.on_annotationsWarningFgButton_clicked">on_annotationsWarningFgButton_clicked</a></td>
91 <td>Private slot to set the foreground colour of the warning annotations.</td>
92 </tr>
93 <tr>
94 <td><a href="#EditorStylesPage.on_defaultFontButton_clicked">on_defaultFontButton_clicked</a></td>
95 <td>Private method used to select the default font for the editor.</td>
96 </tr>
97 <tr>
98 <td><a href="#EditorStylesPage.on_linenumbersFontButton_clicked">on_linenumbersFontButton_clicked</a></td>
99 <td>Private method used to select the font for the editor margins.</td>
100 </tr>
101 <tr>
102 <td><a href="#EditorStylesPage.on_monospacedFontButton_clicked">on_monospacedFontButton_clicked</a></td>
103 <td>Private method used to select the font to be used as the monospaced font.</td>
104 </tr>
105 <tr>
106 <td><a href="#EditorStylesPage.polishPage">polishPage</a></td>
107 <td>Public slot to perform some polishing actions.</td>
108 </tr>
109 <tr>
110 <td><a href="#EditorStylesPage.save">save</a></td>
111 <td>Public slot to save the Editor Styles configuration.</td>
112 </tr>
113 </table>
114 <h3>Static Methods</h3>
115
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119
120 <a NAME="EditorStylesPage.__init__" ID="EditorStylesPage.__init__"></a>
121 <h4>EditorStylesPage (Constructor)</h4>
122 <b>EditorStylesPage</b>(<i></i>)
123
124 <p>
125 Constructor
126 </p>
127 <a NAME="EditorStylesPage.__setSampleStyleSheet" ID="EditorStylesPage.__setSampleStyleSheet"></a>
128 <h4>EditorStylesPage.__setSampleStyleSheet</h4>
129 <b>__setSampleStyleSheet</b>(<i>sampleLineEdit, color, background</i>)
130
131 <p>
132 Private method to colorize a sample with given foreground and
133 background colors.
134 </p>
135 <dl>
136
137 <dt><i>sampleLineEdit</i> (QLineEdit)</dt>
138 <dd>
139 line edit element to be colorized
140 </dd>
141 <dt><i>color</i> (QColor)</dt>
142 <dd>
143 text color to be shown
144 </dd>
145 <dt><i>background</i> (QColor)</dt>
146 <dd>
147 background color to be shown
148 </dd>
149 </dl>
150 <a NAME="EditorStylesPage.on_annotationsErrorBgButton_clicked" ID="EditorStylesPage.on_annotationsErrorBgButton_clicked"></a>
151 <h4>EditorStylesPage.on_annotationsErrorBgButton_clicked</h4>
152 <b>on_annotationsErrorBgButton_clicked</b>(<i></i>)
153
154 <p>
155 Private slot to set the background colour of the error annotations.
156 </p>
157 <a NAME="EditorStylesPage.on_annotationsErrorFgButton_clicked" ID="EditorStylesPage.on_annotationsErrorFgButton_clicked"></a>
158 <h4>EditorStylesPage.on_annotationsErrorFgButton_clicked</h4>
159 <b>on_annotationsErrorFgButton_clicked</b>(<i></i>)
160
161 <p>
162 Private slot to set the foreground colour of the error annotations.
163 </p>
164 <a NAME="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningBgButton_clicked"></a>
165 <h4>EditorStylesPage.on_annotationsStyleWarningBgButton_clicked</h4>
166 <b>on_annotationsStyleWarningBgButton_clicked</b>(<i></i>)
167
168 <p>
169 Private slot to set the background colour of the style annotations.
170 </p>
171 <a NAME="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsStyleWarningFgButton_clicked"></a>
172 <h4>EditorStylesPage.on_annotationsStyleWarningFgButton_clicked</h4>
173 <b>on_annotationsStyleWarningFgButton_clicked</b>(<i></i>)
174
175 <p>
176 Private slot to set the foreground colour of the style annotations.
177 </p>
178 <a NAME="EditorStylesPage.on_annotationsWarningBgButton_clicked" ID="EditorStylesPage.on_annotationsWarningBgButton_clicked"></a>
179 <h4>EditorStylesPage.on_annotationsWarningBgButton_clicked</h4>
180 <b>on_annotationsWarningBgButton_clicked</b>(<i></i>)
181
182 <p>
183 Private slot to set the background colour of the warning annotations.
184 </p>
185 <a NAME="EditorStylesPage.on_annotationsWarningFgButton_clicked" ID="EditorStylesPage.on_annotationsWarningFgButton_clicked"></a>
186 <h4>EditorStylesPage.on_annotationsWarningFgButton_clicked</h4>
187 <b>on_annotationsWarningFgButton_clicked</b>(<i></i>)
188
189 <p>
190 Private slot to set the foreground colour of the warning annotations.
191 </p>
192 <a NAME="EditorStylesPage.on_defaultFontButton_clicked" ID="EditorStylesPage.on_defaultFontButton_clicked"></a>
193 <h4>EditorStylesPage.on_defaultFontButton_clicked</h4>
194 <b>on_defaultFontButton_clicked</b>(<i></i>)
195
196 <p>
197 Private method used to select the default font for the editor.
198 </p>
199 <a NAME="EditorStylesPage.on_linenumbersFontButton_clicked" ID="EditorStylesPage.on_linenumbersFontButton_clicked"></a>
200 <h4>EditorStylesPage.on_linenumbersFontButton_clicked</h4>
201 <b>on_linenumbersFontButton_clicked</b>(<i></i>)
202
203 <p>
204 Private method used to select the font for the editor margins.
205 </p>
206 <a NAME="EditorStylesPage.on_monospacedFontButton_clicked" ID="EditorStylesPage.on_monospacedFontButton_clicked"></a>
207 <h4>EditorStylesPage.on_monospacedFontButton_clicked</h4>
208 <b>on_monospacedFontButton_clicked</b>(<i></i>)
209
210 <p>
211 Private method used to select the font to be used as the monospaced
212 font.
213 </p>
214 <a NAME="EditorStylesPage.polishPage" ID="EditorStylesPage.polishPage"></a>
215 <h4>EditorStylesPage.polishPage</h4>
216 <b>polishPage</b>(<i></i>)
217
218 <p>
219 Public slot to perform some polishing actions.
220 </p>
221 <a NAME="EditorStylesPage.save" ID="EditorStylesPage.save"></a>
222 <h4>EditorStylesPage.save</h4>
223 <b>save</b>(<i></i>)
224
225 <p>
226 Public slot to save the Editor Styles configuration.
227 </p>
228 <div align="right"><a href="#top">Up</a></div>
229 <hr />
230 <hr />
231 <a NAME="create" ID="create"></a>
232 <h2>create</h2>
233 <b>create</b>(<i>dlg</i>)
234
235 <p>
236 Module function to create the configuration page.
237 </p>
238 <dl>
239
240 <dt><i>dlg</i></dt>
241 <dd>
242 reference to the configuration dialog
243 </dd>
244 </dl>
245 <dl>
246 <dt>Return:</dt>
247 <dd>
248 reference to the instantiated page (ConfigurationPageBase)
249 </dd>
250 </dl>
251 <div align="right"><a href="#top">Up</a></div>
252 <hr />
253 </body></html>

eric ide

mercurial