src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorGeneralPage.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.EditorGeneralPage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.EditorGeneralPage</h1>
10
11 <p> 10 <p>
12 Module implementing the Editor General configuration page. 11 Module implementing the Editor General configuration page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#EditorGeneralPage">EditorGeneralPage</a></td> 22 <td><a href="#EditorGeneralPage">EditorGeneralPage</a></td>
25 <td>Class implementing the Editor General configuration page.</td> 23 <td>Class implementing the Editor General 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="EditorGeneralPage" ID="EditorGeneralPage"></a> 37 <a NAME="EditorGeneralPage" ID="EditorGeneralPage"></a>
40 <h2>EditorGeneralPage</h2> 38 <h2>EditorGeneralPage</h2>
41
42 <p> 39 <p>
43 Class implementing the Editor General configuration page. 40 Class implementing the Editor General configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorGeneralPage 44 ConfigurationPageBase, Ui_EditorGeneralPage
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48 46 <table>
49 <table> 47 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 48 </table>
51 </table> 49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53 51 <table>
54 <table> 52 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 53 </table>
56 </table> 54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#EditorGeneralPage.__init__">EditorGeneralPage</a></td> 58 <td><a href="#EditorGeneralPage.__init__">EditorGeneralPage</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
105 <tr> 101 <tr>
106 <td><a href="#EditorGeneralPage.setMode">setMode</a></td> 102 <td><a href="#EditorGeneralPage.setMode">setMode</a></td>
107 <td>Public method to perform mode dependent setups.</td> 103 <td>Public method to perform mode dependent setups.</td>
108 </tr> 104 </tr>
109 </table> 105 </table>
106
110 <h3>Static Methods</h3> 107 <h3>Static Methods</h3>
111 108 <table>
112 <table> 109 <tr><td>None</td></tr>
113 <tr><td>None</td></tr> 110 </table>
114 </table> 111
115 112
116 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a> 113 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a>
117 <h4>EditorGeneralPage (Constructor)</h4> 114 <h4>EditorGeneralPage (Constructor)</h4>
118 <b>EditorGeneralPage</b>(<i></i>) 115 <b>EditorGeneralPage</b>(<i></i>)
119
120 <p> 116 <p>
121 Constructor 117 Constructor
122 </p> 118 </p>
119
123 <a NAME="EditorGeneralPage.__createOverrideItem" ID="EditorGeneralPage.__createOverrideItem"></a> 120 <a NAME="EditorGeneralPage.__createOverrideItem" ID="EditorGeneralPage.__createOverrideItem"></a>
124 <h4>EditorGeneralPage.__createOverrideItem</h4> 121 <h4>EditorGeneralPage.__createOverrideItem</h4>
125 <b>__createOverrideItem</b>(<i>language, tabWidth, indentWidth</i>) 122 <b>__createOverrideItem</b>(<i>language, tabWidth, indentWidth</i>)
126
127 <p> 123 <p>
128 Private method to create an entry for a language override. 124 Private method to create an entry for a language override.
129 </p> 125 </p>
126
130 <dl> 127 <dl>
131 128
132 <dt><i>language</i> (str)</dt> 129 <dt><i>language</i> (str)</dt>
133 <dd> 130 <dd>
134 name of the language 131 name of the language
143 </dd> 140 </dd>
144 </dl> 141 </dl>
145 <a NAME="EditorGeneralPage.__populateLanguageOverrideWidget" ID="EditorGeneralPage.__populateLanguageOverrideWidget"></a> 142 <a NAME="EditorGeneralPage.__populateLanguageOverrideWidget" ID="EditorGeneralPage.__populateLanguageOverrideWidget"></a>
146 <h4>EditorGeneralPage.__populateLanguageOverrideWidget</h4> 143 <h4>EditorGeneralPage.__populateLanguageOverrideWidget</h4>
147 <b>__populateLanguageOverrideWidget</b>(<i></i>) 144 <b>__populateLanguageOverrideWidget</b>(<i></i>)
148
149 <p> 145 <p>
150 Private method to populate the language specific indentation and tab 146 Private method to populate the language specific indentation and tab
151 width override widget. 147 width override widget.
152 </p> 148 </p>
149
153 <a NAME="EditorGeneralPage.__resizeOverrideColumns" ID="EditorGeneralPage.__resizeOverrideColumns"></a> 150 <a NAME="EditorGeneralPage.__resizeOverrideColumns" ID="EditorGeneralPage.__resizeOverrideColumns"></a>
154 <h4>EditorGeneralPage.__resizeOverrideColumns</h4> 151 <h4>EditorGeneralPage.__resizeOverrideColumns</h4>
155 <b>__resizeOverrideColumns</b>(<i></i>) 152 <b>__resizeOverrideColumns</b>(<i></i>)
156
157 <p> 153 <p>
158 Private method to resize the list columns. 154 Private method to resize the list columns.
159 </p> 155 </p>
156
160 <a NAME="EditorGeneralPage.__saveLanguageOverrides" ID="EditorGeneralPage.__saveLanguageOverrides"></a> 157 <a NAME="EditorGeneralPage.__saveLanguageOverrides" ID="EditorGeneralPage.__saveLanguageOverrides"></a>
161 <h4>EditorGeneralPage.__saveLanguageOverrides</h4> 158 <h4>EditorGeneralPage.__saveLanguageOverrides</h4>
162 <b>__saveLanguageOverrides</b>(<i></i>) 159 <b>__saveLanguageOverrides</b>(<i></i>)
163
164 <p> 160 <p>
165 Private method to save the language specific indentation and tab width 161 Private method to save the language specific indentation and tab width
166 overrides. 162 overrides.
167 </p> 163 </p>
164
168 <a NAME="EditorGeneralPage.on_addButton_clicked" ID="EditorGeneralPage.on_addButton_clicked"></a> 165 <a NAME="EditorGeneralPage.on_addButton_clicked" ID="EditorGeneralPage.on_addButton_clicked"></a>
169 <h4>EditorGeneralPage.on_addButton_clicked</h4> 166 <h4>EditorGeneralPage.on_addButton_clicked</h4>
170 <b>on_addButton_clicked</b>(<i></i>) 167 <b>on_addButton_clicked</b>(<i></i>)
171
172 <p> 168 <p>
173 Private slot to add a new override entry. 169 Private slot to add a new override entry.
174 </p> 170 </p>
171
175 <a NAME="EditorGeneralPage.on_deleteButton_clicked" ID="EditorGeneralPage.on_deleteButton_clicked"></a> 172 <a NAME="EditorGeneralPage.on_deleteButton_clicked" ID="EditorGeneralPage.on_deleteButton_clicked"></a>
176 <h4>EditorGeneralPage.on_deleteButton_clicked</h4> 173 <h4>EditorGeneralPage.on_deleteButton_clicked</h4>
177 <b>on_deleteButton_clicked</b>(<i></i>) 174 <b>on_deleteButton_clicked</b>(<i></i>)
178
179 <p> 175 <p>
180 Private slot to delete the selected override entries. 176 Private slot to delete the selected override entries.
181 </p> 177 </p>
178
182 <a NAME="EditorGeneralPage.on_editButton_clicked" ID="EditorGeneralPage.on_editButton_clicked"></a> 179 <a NAME="EditorGeneralPage.on_editButton_clicked" ID="EditorGeneralPage.on_editButton_clicked"></a>
183 <h4>EditorGeneralPage.on_editButton_clicked</h4> 180 <h4>EditorGeneralPage.on_editButton_clicked</h4>
184 <b>on_editButton_clicked</b>(<i></i>) 181 <b>on_editButton_clicked</b>(<i></i>)
185
186 <p> 182 <p>
187 Private slot to edit the selected override entry. 183 Private slot to edit the selected override entry.
188 </p> 184 </p>
185
189 <a NAME="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged" ID="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged"></a> 186 <a NAME="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged" ID="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged"></a>
190 <h4>EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged</h4> 187 <h4>EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged</h4>
191 <b>on_languageOverrideWidget_itemSelectionChanged</b>(<i></i>) 188 <b>on_languageOverrideWidget_itemSelectionChanged</b>(<i></i>)
192
193 <p> 189 <p>
194 Private slot handling a change of the override selection. 190 Private slot handling a change of the override selection.
195 </p> 191 </p>
192
196 <a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a> 193 <a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a>
197 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4> 194 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4>
198 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>) 195 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>)
199
200 <p> 196 <p>
201 Private slot used to set the tab conversion check box. 197 Private slot used to set the tab conversion check box.
202 </p> 198 </p>
199
203 <dl> 200 <dl>
204 201
205 <dt><i>checked</i> (bool)</dt> 202 <dt><i>checked</i> (bool)</dt>
206 <dd> 203 <dd>
207 flag received from the signal 204 flag received from the signal
208 </dd> 205 </dd>
209 </dl> 206 </dl>
210 <a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a> 207 <a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a>
211 <h4>EditorGeneralPage.save</h4> 208 <h4>EditorGeneralPage.save</h4>
212 <b>save</b>(<i></i>) 209 <b>save</b>(<i></i>)
213
214 <p> 210 <p>
215 Public slot to save the Editor General configuration. 211 Public slot to save the Editor General configuration.
216 </p> 212 </p>
213
217 <a NAME="EditorGeneralPage.setMode" ID="EditorGeneralPage.setMode"></a> 214 <a NAME="EditorGeneralPage.setMode" ID="EditorGeneralPage.setMode"></a>
218 <h4>EditorGeneralPage.setMode</h4> 215 <h4>EditorGeneralPage.setMode</h4>
219 <b>setMode</b>(<i>displayMode</i>) 216 <b>setMode</b>(<i>displayMode</i>)
220
221 <p> 217 <p>
222 Public method to perform mode dependent setups. 218 Public method to perform mode dependent setups.
223 </p> 219 </p>
220
224 <dl> 221 <dl>
225 222
226 <dt><i>displayMode</i> (ConfigurationMode)</dt> 223 <dt><i>displayMode</i> (ConfigurationMode)</dt>
227 <dd> 224 <dd>
228 mode of the configuration dialog 225 mode of the configuration dialog
232 <hr /> 229 <hr />
233 <hr /> 230 <hr />
234 <a NAME="create" ID="create"></a> 231 <a NAME="create" ID="create"></a>
235 <h2>create</h2> 232 <h2>create</h2>
236 <b>create</b>(<i>dlg</i>) 233 <b>create</b>(<i>dlg</i>)
237
238 <p> 234 <p>
239 Module function to create the configuration page. 235 Module function to create the configuration page.
240 </p> 236 </p>
237
241 <dl> 238 <dl>
242 239
243 <dt><i>dlg</i> (ConfigurationDialog)</dt> 240 <dt><i>dlg</i> (ConfigurationDialog)</dt>
244 <dd> 241 <dd>
245 reference to the configuration dialog 242 reference to the configuration dialog

eric ide

mercurial