src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorFilePage.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.EditorFilePage</h1> 9 <h1>eric7.Preferences.ConfigurationPages.EditorFilePage</h1>
10
11 <p> 10 <p>
12 Module implementing the Editor File Handling configuration page. 11 Module implementing the Editor File Handling 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="#EditorFilePage">EditorFilePage</a></td> 22 <td><a href="#EditorFilePage">EditorFilePage</a></td>
25 <td>Class implementing the Editor File Handling configuration page.</td> 23 <td>Class implementing the Editor File Handling 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="EditorFilePage" ID="EditorFilePage"></a> 37 <a NAME="EditorFilePage" ID="EditorFilePage"></a>
40 <h2>EditorFilePage</h2> 38 <h2>EditorFilePage</h2>
41
42 <p> 39 <p>
43 Class implementing the Editor File Handling configuration page. 40 Class implementing the Editor File Handling configuration page.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 ConfigurationPageBase, Ui_EditorFilePage 44 ConfigurationPageBase, Ui_EditorFilePage
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="#EditorFilePage.__init__">EditorFilePage</a></td> 58 <td><a href="#EditorFilePage.__init__">EditorFilePage</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="#EditorFilePage.save">save</a></td> 102 <td><a href="#EditorFilePage.save">save</a></td>
107 <td>Public slot to save the Editor File Handling configuration.</td> 103 <td>Public slot to save the Editor File Handling configuration.</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="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a> 113 <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a>
117 <h4>EditorFilePage (Constructor)</h4> 114 <h4>EditorFilePage (Constructor)</h4>
118 <b>EditorFilePage</b>(<i></i>) 115 <b>EditorFilePage</b>(<i></i>)
119
120 <p> 116 <p>
121 Constructor 117 Constructor
122 </p> 118 </p>
119
123 <a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a> 120 <a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a>
124 <h4>EditorFilePage.__checkFileFilter</h4> 121 <h4>EditorFilePage.__checkFileFilter</h4>
125 <b>__checkFileFilter</b>(<i>fileFilter</i>) 122 <b>__checkFileFilter</b>(<i>fileFilter</i>)
126
127 <p> 123 <p>
128 Private method to check a file filter for validity. 124 Private method to check a file filter for validity.
129 </p> 125 </p>
126
130 <dl> 127 <dl>
131 128
132 <dt><i>fileFilter</i> (str)</dt> 129 <dt><i>fileFilter</i> (str)</dt>
133 <dd> 130 <dd>
134 file filter pattern to check 131 file filter pattern to check
147 </dd> 144 </dd>
148 </dl> 145 </dl>
149 <a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a> 146 <a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a>
150 <h4>EditorFilePage.__extractFileFilters</h4> 147 <h4>EditorFilePage.__extractFileFilters</h4>
151 <b>__extractFileFilters</b>(<i></i>) 148 <b>__extractFileFilters</b>(<i></i>)
152
153 <p> 149 <p>
154 Private method to extract the file filters. 150 Private method to extract the file filters.
155 </p> 151 </p>
152
156 <a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a> 153 <a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a>
157 <h4>EditorFilePage.__setDefaultFiltersLists</h4> 154 <h4>EditorFilePage.__setDefaultFiltersLists</h4>
158 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>) 155 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>)
159
160 <p> 156 <p>
161 Private slot to set the default file filter combo boxes. 157 Private slot to set the default file filter combo boxes.
162 </p> 158 </p>
159
163 <dl> 160 <dl>
164 161
165 <dt><i>keepSelection</i> (bool)</dt> 162 <dt><i>keepSelection</i> (bool)</dt>
166 <dd> 163 <dd>
167 flag indicating to keep the current selection 164 flag indicating to keep the current selection
169 </dd> 166 </dd>
170 </dl> 167 </dl>
171 <a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a> 168 <a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a>
172 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4> 169 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4>
173 <b>on_addFileFilterButton_clicked</b>(<i></i>) 170 <b>on_addFileFilterButton_clicked</b>(<i></i>)
174
175 <p> 171 <p>
176 Private slot to add a file filter to the list. 172 Private slot to add a file filter to the list.
177 </p> 173 </p>
174
178 <a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a> 175 <a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a>
179 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4> 176 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4>
180 <b>on_deleteFileFilterButton_clicked</b>(<i></i>) 177 <b>on_deleteFileFilterButton_clicked</b>(<i></i>)
181
182 <p> 178 <p>
183 Private slot called to delete a file filter entry. 179 Private slot called to delete a file filter entry.
184 </p> 180 </p>
181
185 <a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a> 182 <a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a>
186 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4> 183 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4>
187 <b>on_editFileFilterButton_clicked</b>(<i></i>) 184 <b>on_editFileFilterButton_clicked</b>(<i></i>)
188
189 <p> 185 <p>
190 Private slot called to edit a file filter entry. 186 Private slot called to edit a file filter entry.
191 </p> 187 </p>
188
192 <a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a> 189 <a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a>
193 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4> 190 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4>
194 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>) 191 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>)
195
196 <p> 192 <p>
197 Private slot to set the state of the edit and delete buttons. 193 Private slot to set the state of the edit and delete buttons.
198 </p> 194 </p>
195
199 <dl> 196 <dl>
200 197
201 <dt><i>current</i> (QListWidgetItem)</dt> 198 <dt><i>current</i> (QListWidgetItem)</dt>
202 <dd> 199 <dd>
203 new current item 200 new current item
208 </dd> 205 </dd>
209 </dl> 206 </dl>
210 <a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a> 207 <a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a>
211 <h4>EditorFilePage.on_openFiltersButton_toggled</h4> 208 <h4>EditorFilePage.on_openFiltersButton_toggled</h4>
212 <b>on_openFiltersButton_toggled</b>(<i>checked</i>) 209 <b>on_openFiltersButton_toggled</b>(<i>checked</i>)
213
214 <p> 210 <p>
215 Private slot to switch the list of file filters. 211 Private slot to switch the list of file filters.
216 </p> 212 </p>
213
217 <dl> 214 <dl>
218 215
219 <dt><i>checked</i> (bool)</dt> 216 <dt><i>checked</i> (bool)</dt>
220 <dd> 217 <dd>
221 flag indicating the check state of the button 218 flag indicating the check state of the button
222 </dd> 219 </dd>
223 </dl> 220 </dl>
224 <a NAME="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked" ID="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked"></a> 221 <a NAME="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked" ID="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked"></a>
225 <h4>EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked</h4> 222 <h4>EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked</h4>
226 <b>on_previewMarkdownPyMdownInstallPushButton_clicked</b>(<i></i>) 223 <b>on_previewMarkdownPyMdownInstallPushButton_clicked</b>(<i></i>)
227
228 <p> 224 <p>
229 Private slot to install the pymdown extensions package via pip. 225 Private slot to install the pymdown extensions package via pip.
230 </p> 226 </p>
227
231 <a NAME="EditorFilePage.polishPage" ID="EditorFilePage.polishPage"></a> 228 <a NAME="EditorFilePage.polishPage" ID="EditorFilePage.polishPage"></a>
232 <h4>EditorFilePage.polishPage</h4> 229 <h4>EditorFilePage.polishPage</h4>
233 <b>polishPage</b>(<i></i>) 230 <b>polishPage</b>(<i></i>)
234
235 <p> 231 <p>
236 Public slot to perform some polishing actions. 232 Public slot to perform some polishing actions.
237 </p> 233 </p>
234
238 <a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a> 235 <a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a>
239 <h4>EditorFilePage.save</h4> 236 <h4>EditorFilePage.save</h4>
240 <b>save</b>(<i></i>) 237 <b>save</b>(<i></i>)
241
242 <p> 238 <p>
243 Public slot to save the Editor File Handling configuration. 239 Public slot to save the Editor File Handling configuration.
244 </p> 240 </p>
241
245 <div align="right"><a href="#top">Up</a></div> 242 <div align="right"><a href="#top">Up</a></div>
246 <hr /> 243 <hr />
247 <hr /> 244 <hr />
248 <a NAME="create" ID="create"></a> 245 <a NAME="create" ID="create"></a>
249 <h2>create</h2> 246 <h2>create</h2>
250 <b>create</b>(<i>dlg</i>) 247 <b>create</b>(<i>dlg</i>)
251
252 <p> 248 <p>
253 Module function to create the configuration page. 249 Module function to create the configuration page.
254 </p> 250 </p>
251
255 <dl> 252 <dl>
256 253
257 <dt><i>dlg</i> (ConfigurationDialog)</dt> 254 <dt><i>dlg</i> (ConfigurationDialog)</dt>
258 <dd> 255 <dd>
259 reference to the configuration dialog 256 reference to the configuration dialog

eric ide

mercurial