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

branch
maintenance
changeset 7286
7eb04391adf7
parent 7278
1820a0344b62
child 7989
a21d673a8f99
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Preferences.ConfigurationPages.EditorGeneralPage</h1> 23 <h1>eric6.Preferences.ConfigurationPages.EditorGeneralPage</h1>
24
23 <p> 25 <p>
24 Module implementing the Editor General configuration page. 26 Module implementing the Editor General configuration page.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#EditorGeneralPage">EditorGeneralPage</a></td> 38 <td><a href="#EditorGeneralPage">EditorGeneralPage</a></td>
34 <td>Class implementing the Editor General configuration page.</td> 39 <td>Class implementing the Editor General configuration page.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#create">create</a></td> 47 <td><a href="#create">create</a></td>
41 <td>Module function to create the configuration page.</td> 48 <td>Module function to create the configuration page.</td>
42 </tr> 49 </tr>
43 </table> 50 </table>
44 <hr /><hr /> 51 <hr />
52 <hr />
45 <a NAME="EditorGeneralPage" ID="EditorGeneralPage"></a> 53 <a NAME="EditorGeneralPage" ID="EditorGeneralPage"></a>
46 <h2>EditorGeneralPage</h2> 54 <h2>EditorGeneralPage</h2>
55
47 <p> 56 <p>
48 Class implementing the Editor General configuration page. 57 Class implementing the Editor General configuration page.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_EditorGeneralPage 60 ConfigurationPageBase, Ui_EditorGeneralPage
52 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
62
53 <table> 63 <table>
54 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
55 </table> 65 </table>
56 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67
57 <table> 68 <table>
58 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
59 </table> 70 </table>
60 <h3>Methods</h3> 71 <h3>Methods</h3>
61 <table> 72
73 <table>
74
62 <tr> 75 <tr>
63 <td><a href="#EditorGeneralPage.__init__">EditorGeneralPage</a></td> 76 <td><a href="#EditorGeneralPage.__init__">EditorGeneralPage</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 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>
66 <td><a href="#EditorGeneralPage.on_tabforindentationCheckBox_toggled">on_tabforindentationCheckBox_toggled</a></td> 112 <td><a href="#EditorGeneralPage.on_tabforindentationCheckBox_toggled">on_tabforindentationCheckBox_toggled</a></td>
67 <td>Private slot used to set the tab conversion check box.</td> 113 <td>Private slot used to set the tab conversion check box.</td>
68 </tr><tr> 114 </tr>
115 <tr>
69 <td><a href="#EditorGeneralPage.save">save</a></td> 116 <td><a href="#EditorGeneralPage.save">save</a></td>
70 <td>Public slot to save the Editor General configuration.</td> 117 <td>Public slot to save the Editor General configuration.</td>
71 </tr> 118 </tr>
72 </table> 119 </table>
73 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
74 <table> 121
75 <tr><td>None</td></tr> 122 <table>
76 </table> 123 <tr><td>None</td></tr>
124 </table>
125
77 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a> 126 <a NAME="EditorGeneralPage.__init__" ID="EditorGeneralPage.__init__"></a>
78 <h4>EditorGeneralPage (Constructor)</h4> 127 <h4>EditorGeneralPage (Constructor)</h4>
79 <b>EditorGeneralPage</b>(<i></i>) 128 <b>EditorGeneralPage</b>(<i></i>)
129
80 <p> 130 <p>
81 Constructor 131 Constructor
82 </p><a NAME="EditorGeneralPage.on_tabforindentationCheckBox_toggled" ID="EditorGeneralPage.on_tabforindentationCheckBox_toggled"></a> 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>
83 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4> 207 <h4>EditorGeneralPage.on_tabforindentationCheckBox_toggled</h4>
84 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>) 208 <b>on_tabforindentationCheckBox_toggled</b>(<i>checked</i>)
209
85 <p> 210 <p>
86 Private slot used to set the tab conversion check box. 211 Private slot used to set the tab conversion check box.
87 </p><dl> 212 </p>
213 <dl>
214
88 <dt><i>checked</i></dt> 215 <dt><i>checked</i></dt>
89 <dd> 216 <dd>
90 flag received from the signal (boolean) 217 flag received from the signal (boolean)
91 </dd> 218 </dd>
92 </dl><a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a> 219 </dl>
220 <a NAME="EditorGeneralPage.save" ID="EditorGeneralPage.save"></a>
93 <h4>EditorGeneralPage.save</h4> 221 <h4>EditorGeneralPage.save</h4>
94 <b>save</b>(<i></i>) 222 <b>save</b>(<i></i>)
223
95 <p> 224 <p>
96 Public slot to save the Editor General configuration. 225 Public slot to save the Editor General configuration.
97 </p> 226 </p>
98 <div align="right"><a href="#top">Up</a></div> 227 <div align="right"><a href="#top">Up</a></div>
99 <hr /><hr /> 228 <hr />
229 <hr />
100 <a NAME="create" ID="create"></a> 230 <a NAME="create" ID="create"></a>
101 <h2>create</h2> 231 <h2>create</h2>
102 <b>create</b>(<i>dlg</i>) 232 <b>create</b>(<i>dlg</i>)
233
103 <p> 234 <p>
104 Module function to create the configuration page. 235 Module function to create the configuration page.
105 </p><dl> 236 </p>
237 <dl>
238
106 <dt><i>dlg</i></dt> 239 <dt><i>dlg</i></dt>
107 <dd> 240 <dd>
108 reference to the configuration dialog 241 reference to the configuration dialog
109 </dd> 242 </dd>
110 </dl><dl> 243 </dl>
244 <dl>
111 <dt>Returns:</dt> 245 <dt>Returns:</dt>
112 <dd> 246 <dd>
113 reference to the instantiated page (ConfigurationPageBase) 247 reference to the instantiated page (ConfigurationPageBase)
114 </dd> 248 </dd>
115 </dl> 249 </dl>

eric ide

mercurial