eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.EditorGeneralPage</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationPages.EditorGeneralPage</h1>
24
25 <p>
26 Module implementing the Editor General configuration page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EditorGeneralPage">EditorGeneralPage</a></td>
39 <td>Class implementing the Editor General configuration page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45
46 <tr>
47 <td><a href="#create">create</a></td>
48 <td>Module function to create the configuration page.</td>
49 </tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="EditorGeneralPage" ID="EditorGeneralPage"></a>
54 <h2>EditorGeneralPage</h2>
55
56 <p>
57 Class implementing the Editor General configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_EditorGeneralPage
61 <h3>Class Attributes</h3>
62
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Methods</h3>
72
73 <table>
74
75 <tr>
76 <td><a href="#EditorGeneralPage.__init__">EditorGeneralPage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EditorGeneralPage.__createOverrideItem">__createOverrideItem</a></td>
81 <td>Private method to create an entry for a language override.</td>
82 </tr>
83 <tr>
84 <td><a href="#EditorGeneralPage.__populateLanguageOverrideWidget">__populateLanguageOverrideWidget</a></td>
85 <td>Private method to populate the language specific indentation and tab width override widget.</td>
86 </tr>
87 <tr>
88 <td><a href="#EditorGeneralPage.__resizeOverrideColumns">__resizeOverrideColumns</a></td>
89 <td>Private method to resize the list columns.</td>
90 </tr>
91 <tr>
92 <td><a href="#EditorGeneralPage.__saveLanguageOverrides">__saveLanguageOverrides</a></td>
93 <td>Private method to save the language specific indentation and tab width overrides.</td>
94 </tr>
95 <tr>
96 <td><a href="#EditorGeneralPage.on_addButton_clicked">on_addButton_clicked</a></td>
97 <td>Private slot to add a new override entry.</td>
98 </tr>
99 <tr>
100 <td><a href="#EditorGeneralPage.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
101 <td>Private slot to delete the selected override entries.</td>
102 </tr>
103 <tr>
104 <td><a href="#EditorGeneralPage.on_editButton_clicked">on_editButton_clicked</a></td>
105 <td>Private slot to edit the selected override entry.</td>
106 </tr>
107 <tr>
108 <td><a href="#EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged">on_languageOverrideWidget_itemSelectionChanged</a></td>
109 <td>Private slot handling a change of the override selection.</td>
110 </tr>
111 <tr>
112 <td><a href="#EditorGeneralPage.on_tabforindentationCheckBox_toggled">on_tabforindentationCheckBox_toggled</a></td>
113 <td>Private slot used to set the tab conversion check box.</td>
114 </tr>
115 <tr>
116 <td><a href="#EditorGeneralPage.save">save</a></td>
117 <td>Public slot to save the Editor General configuration.</td>
118 </tr>
119 </table>
120 <h3>Static Methods</h3>
121
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125
126 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a>
127 <h4>EditorGeneralPage (Constructor)</h4>
128 <b>EditorGeneralPage</b>(<i></i>)
129
130 <p>
131 Constructor
132 </p>
133 <a NAME="EditorGeneralPage.__createOverrideItem" ID="EditorGeneralPage.__createOverrideItem"></a>
134 <h4>EditorGeneralPage.__createOverrideItem</h4>
135 <b>__createOverrideItem</b>(<i>language, tabWidth, indentWidth</i>)
136
137 <p>
138 Private method to create an entry for a language override.
139 </p>
140 <dl>
141
142 <dt><i>language</i> (str)</dt>
143 <dd>
144 name of the language
145 </dd>
146 <dt><i>tabWidth</i> (int)</dt>
147 <dd>
148 tabulator width
149 </dd>
150 <dt><i>indentWidth</i> (int)</dt>
151 <dd>
152 indentation width
153 </dd>
154 </dl>
155 <a NAME="EditorGeneralPage.__populateLanguageOverrideWidget" ID="EditorGeneralPage.__populateLanguageOverrideWidget"></a>
156 <h4>EditorGeneralPage.__populateLanguageOverrideWidget</h4>
157 <b>__populateLanguageOverrideWidget</b>(<i></i>)
158
159 <p>
160 Private method to populate the language specific indentation and tab
161 width override widget.
162 </p>
163 <a NAME="EditorGeneralPage.__resizeOverrideColumns" ID="EditorGeneralPage.__resizeOverrideColumns"></a>
164 <h4>EditorGeneralPage.__resizeOverrideColumns</h4>
165 <b>__resizeOverrideColumns</b>(<i></i>)
166
167 <p>
168 Private method to resize the list columns.
169 </p>
170 <a NAME="EditorGeneralPage.__saveLanguageOverrides" ID="EditorGeneralPage.__saveLanguageOverrides"></a>
171 <h4>EditorGeneralPage.__saveLanguageOverrides</h4>
172 <b>__saveLanguageOverrides</b>(<i></i>)
173
174 <p>
175 Private method to save the language specific indentation and tab width
176 overrides.
177 </p>
178 <a NAME="EditorGeneralPage.on_addButton_clicked" ID="EditorGeneralPage.on_addButton_clicked"></a>
179 <h4>EditorGeneralPage.on_addButton_clicked</h4>
180 <b>on_addButton_clicked</b>(<i></i>)
181
182 <p>
183 Private slot to add a new override entry.
184 </p>
185 <a NAME="EditorGeneralPage.on_deleteButton_clicked" ID="EditorGeneralPage.on_deleteButton_clicked"></a>
186 <h4>EditorGeneralPage.on_deleteButton_clicked</h4>
187 <b>on_deleteButton_clicked</b>(<i></i>)
188
189 <p>
190 Private slot to delete the selected override entries.
191 </p>
192 <a NAME="EditorGeneralPage.on_editButton_clicked" ID="EditorGeneralPage.on_editButton_clicked"></a>
193 <h4>EditorGeneralPage.on_editButton_clicked</h4>
194 <b>on_editButton_clicked</b>(<i></i>)
195
196 <p>
197 Private slot to edit the selected override entry.
198 </p>
199 <a NAME="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged" ID="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged"></a>
200 <h4>EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged</h4>
201 <b>on_languageOverrideWidget_itemSelectionChanged</b>(<i></i>)
202
203 <p>
204 Private slot handling a change of the override selection.
205 </p>
206 <a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a>
207 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4>
208 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>)
209
210 <p>
211 Private slot used to set the tab conversion check box.
212 </p>
213 <dl>
214
215 <dt><i>checked</i></dt>
216 <dd>
217 flag received from the signal (boolean)
218 </dd>
219 </dl>
220 <a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a>
221 <h4>EditorGeneralPage.save</h4>
222 <b>save</b>(<i></i>)
223
224 <p>
225 Public slot to save the Editor General configuration.
226 </p>
227 <div align="right"><a href="#top">Up</a></div>
228 <hr />
229 <hr />
230 <a NAME="create" ID="create"></a>
231 <h2>create</h2>
232 <b>create</b>(<i>dlg</i>)
233
234 <p>
235 Module function to create the configuration page.
236 </p>
237 <dl>
238
239 <dt><i>dlg</i></dt>
240 <dd>
241 reference to the configuration dialog
242 </dd>
243 </dl>
244 <dl>
245 <dt>Return:</dt>
246 <dd>
247 reference to the instantiated page (ConfigurationPageBase)
248 </dd>
249 </dl>
250 <div align="right"><a href="#top">Up</a></div>
251 <hr />
252 </body></html>

eric ide

mercurial