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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.EditorGeneralPage</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.EditorGeneralPage</h1>
10
11 <p>
12 Module implementing the Editor General 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="#EditorGeneralPage">EditorGeneralPage</a></td>
25 <td>Class implementing the Editor General 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="EditorGeneralPage" ID="EditorGeneralPage"></a>
40 <h2>EditorGeneralPage</h2>
41
42 <p>
43 Class implementing the Editor General configuration page.
44 </p>
45 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorGeneralPage
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="#EditorGeneralPage.__init__">EditorGeneralPage</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#EditorGeneralPage.__createOverrideItem">__createOverrideItem</a></td>
67 <td>Private method to create an entry for a language override.</td>
68 </tr>
69 <tr>
70 <td><a href="#EditorGeneralPage.__populateLanguageOverrideWidget">__populateLanguageOverrideWidget</a></td>
71 <td>Private method to populate the language specific indentation and tab width override widget.</td>
72 </tr>
73 <tr>
74 <td><a href="#EditorGeneralPage.__resizeOverrideColumns">__resizeOverrideColumns</a></td>
75 <td>Private method to resize the list columns.</td>
76 </tr>
77 <tr>
78 <td><a href="#EditorGeneralPage.__saveLanguageOverrides">__saveLanguageOverrides</a></td>
79 <td>Private method to save the language specific indentation and tab width overrides.</td>
80 </tr>
81 <tr>
82 <td><a href="#EditorGeneralPage.on_addButton_clicked">on_addButton_clicked</a></td>
83 <td>Private slot to add a new override entry.</td>
84 </tr>
85 <tr>
86 <td><a href="#EditorGeneralPage.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
87 <td>Private slot to delete the selected override entries.</td>
88 </tr>
89 <tr>
90 <td><a href="#EditorGeneralPage.on_editButton_clicked">on_editButton_clicked</a></td>
91 <td>Private slot to edit the selected override entry.</td>
92 </tr>
93 <tr>
94 <td><a href="#EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged">on_languageOverrideWidget_itemSelectionChanged</a></td>
95 <td>Private slot handling a change of the override selection.</td>
96 </tr>
97 <tr>
98 <td><a href="#EditorGeneralPage.on_tabforindentationCheckBox_toggled">on_tabforindentationCheckBox_toggled</a></td>
99 <td>Private slot used to set the tab conversion check box.</td>
100 </tr>
101 <tr>
102 <td><a href="#EditorGeneralPage.save">save</a></td>
103 <td>Public slot to save the Editor General configuration.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107
108 <table>
109 <tr><td>None</td></tr>
110 </table>
111
112 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a>
113 <h4>EditorGeneralPage (Constructor)</h4>
114 <b>EditorGeneralPage</b>(<i></i>)
115
116 <p>
117 Constructor
118 </p>
119 <a NAME="EditorGeneralPage.__createOverrideItem" ID="EditorGeneralPage.__createOverrideItem"></a>
120 <h4>EditorGeneralPage.__createOverrideItem</h4>
121 <b>__createOverrideItem</b>(<i>language, tabWidth, indentWidth</i>)
122
123 <p>
124 Private method to create an entry for a language override.
125 </p>
126 <dl>
127
128 <dt><i>language</i> (str)</dt>
129 <dd>
130 name of the language
131 </dd>
132 <dt><i>tabWidth</i> (int)</dt>
133 <dd>
134 tabulator width
135 </dd>
136 <dt><i>indentWidth</i> (int)</dt>
137 <dd>
138 indentation width
139 </dd>
140 </dl>
141 <a NAME="EditorGeneralPage.__populateLanguageOverrideWidget" ID="EditorGeneralPage.__populateLanguageOverrideWidget"></a>
142 <h4>EditorGeneralPage.__populateLanguageOverrideWidget</h4>
143 <b>__populateLanguageOverrideWidget</b>(<i></i>)
144
145 <p>
146 Private method to populate the language specific indentation and tab
147 width override widget.
148 </p>
149 <a NAME="EditorGeneralPage.__resizeOverrideColumns" ID="EditorGeneralPage.__resizeOverrideColumns"></a>
150 <h4>EditorGeneralPage.__resizeOverrideColumns</h4>
151 <b>__resizeOverrideColumns</b>(<i></i>)
152
153 <p>
154 Private method to resize the list columns.
155 </p>
156 <a NAME="EditorGeneralPage.__saveLanguageOverrides" ID="EditorGeneralPage.__saveLanguageOverrides"></a>
157 <h4>EditorGeneralPage.__saveLanguageOverrides</h4>
158 <b>__saveLanguageOverrides</b>(<i></i>)
159
160 <p>
161 Private method to save the language specific indentation and tab width
162 overrides.
163 </p>
164 <a NAME="EditorGeneralPage.on_addButton_clicked" ID="EditorGeneralPage.on_addButton_clicked"></a>
165 <h4>EditorGeneralPage.on_addButton_clicked</h4>
166 <b>on_addButton_clicked</b>(<i></i>)
167
168 <p>
169 Private slot to add a new override entry.
170 </p>
171 <a NAME="EditorGeneralPage.on_deleteButton_clicked" ID="EditorGeneralPage.on_deleteButton_clicked"></a>
172 <h4>EditorGeneralPage.on_deleteButton_clicked</h4>
173 <b>on_deleteButton_clicked</b>(<i></i>)
174
175 <p>
176 Private slot to delete the selected override entries.
177 </p>
178 <a NAME="EditorGeneralPage.on_editButton_clicked" ID="EditorGeneralPage.on_editButton_clicked"></a>
179 <h4>EditorGeneralPage.on_editButton_clicked</h4>
180 <b>on_editButton_clicked</b>(<i></i>)
181
182 <p>
183 Private slot to edit the selected override entry.
184 </p>
185 <a NAME="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged" ID="EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged"></a>
186 <h4>EditorGeneralPage.on_languageOverrideWidget_itemSelectionChanged</h4>
187 <b>on_languageOverrideWidget_itemSelectionChanged</b>(<i></i>)
188
189 <p>
190 Private slot handling a change of the override selection.
191 </p>
192 <a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a>
193 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4>
194 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>)
195
196 <p>
197 Private slot used to set the tab conversion check box.
198 </p>
199 <dl>
200
201 <dt><i>checked</i></dt>
202 <dd>
203 flag received from the signal (boolean)
204 </dd>
205 </dl>
206 <a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a>
207 <h4>EditorGeneralPage.save</h4>
208 <b>save</b>(<i></i>)
209
210 <p>
211 Public slot to save the Editor General configuration.
212 </p>
213 <div align="right"><a href="#top">Up</a></div>
214 <hr />
215 <hr />
216 <a NAME="create" ID="create"></a>
217 <h2>create</h2>
218 <b>create</b>(<i>dlg</i>)
219
220 <p>
221 Module function to create the configuration page.
222 </p>
223 <dl>
224
225 <dt><i>dlg</i></dt>
226 <dd>
227 reference to the configuration dialog
228 </dd>
229 </dl>
230 <dl>
231 <dt>Return:</dt>
232 <dd>
233 reference to the instantiated page (ConfigurationPageBase)
234 </dd>
235 </dl>
236 <div align="right"><a href="#top">Up</a></div>
237 <hr />
238 </body></html>

eric ide

mercurial