Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorFilePage.html

eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.EditorFilePage.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.EditorFilePage</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.EditorFilePage</h1>
24
25 <p>
26 Module implementing the Editor File Handling 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="#EditorFilePage">EditorFilePage</a></td>
39 <td>Class implementing the Editor File Handling 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="EditorFilePage" ID="EditorFilePage"></a>
54 <h2>EditorFilePage</h2>
55
56 <p>
57 Class implementing the Editor File Handling configuration page.
58 </p>
59 <h3>Derived from</h3>
60 ConfigurationPageBase, Ui_EditorFilePage
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="#EditorFilePage.__init__">EditorFilePage</a></td>
77 <td>Constructor</td>
78 </tr>
79 <tr>
80 <td><a href="#EditorFilePage.__checkFileFilter">__checkFileFilter</a></td>
81 <td>Private method to check a file filter for validity.</td>
82 </tr>
83 <tr>
84 <td><a href="#EditorFilePage.__extractFileFilters">__extractFileFilters</a></td>
85 <td>Private method to extract the file filters.</td>
86 </tr>
87 <tr>
88 <td><a href="#EditorFilePage.__setDefaultFiltersLists">__setDefaultFiltersLists</a></td>
89 <td>Private slot to set the default file filter combo boxes.</td>
90 </tr>
91 <tr>
92 <td><a href="#EditorFilePage.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td>
93 <td>Private slot to add a file filter to the list.</td>
94 </tr>
95 <tr>
96 <td><a href="#EditorFilePage.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td>
97 <td>Private slot called to delete a file filter entry.</td>
98 </tr>
99 <tr>
100 <td><a href="#EditorFilePage.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td>
101 <td>Private slot called to edit a file filter entry.</td>
102 </tr>
103 <tr>
104 <td><a href="#EditorFilePage.on_fileFiltersList_currentItemChanged">on_fileFiltersList_currentItemChanged</a></td>
105 <td>Private slot to set the state of the edit and delete buttons.</td>
106 </tr>
107 <tr>
108 <td><a href="#EditorFilePage.on_openFiltersButton_toggled">on_openFiltersButton_toggled</a></td>
109 <td>Private slot to switch the list of file filters.</td>
110 </tr>
111 <tr>
112 <td><a href="#EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked">on_previewMarkdownPyMdownInstallPushButton_clicked</a></td>
113 <td>Private slot to install the pymdown extensions package via pip.</td>
114 </tr>
115 <tr>
116 <td><a href="#EditorFilePage.polishPage">polishPage</a></td>
117 <td>Public slot to perform some polishing actions.</td>
118 </tr>
119 <tr>
120 <td><a href="#EditorFilePage.save">save</a></td>
121 <td>Public slot to save the Editor File Handling configuration.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125
126 <table>
127 <tr><td>None</td></tr>
128 </table>
129
130 <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a>
131 <h4>EditorFilePage (Constructor)</h4>
132 <b>EditorFilePage</b>(<i></i>)
133
134 <p>
135 Constructor
136 </p>
137 <a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a>
138 <h4>EditorFilePage.__checkFileFilter</h4>
139 <b>__checkFileFilter</b>(<i>fileFilter</i>)
140
141 <p>
142 Private method to check a file filter for validity.
143 </p>
144 <dl>
145
146 <dt><i>fileFilter</i></dt>
147 <dd>
148 file filter pattern to check (string)
149 </dd>
150 </dl>
151 <dl>
152 <dt>Return:</dt>
153 <dd>
154 flag indicating validity (boolean)
155 </dd>
156 </dl>
157 <a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a>
158 <h4>EditorFilePage.__extractFileFilters</h4>
159 <b>__extractFileFilters</b>(<i></i>)
160
161 <p>
162 Private method to extract the file filters.
163 </p>
164 <a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a>
165 <h4>EditorFilePage.__setDefaultFiltersLists</h4>
166 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>)
167
168 <p>
169 Private slot to set the default file filter combo boxes.
170 </p>
171 <dl>
172
173 <dt><i>keepSelection</i></dt>
174 <dd>
175 flag indicating to keep the current selection
176 if possible (boolean)
177 </dd>
178 </dl>
179 <a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a>
180 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4>
181 <b>on_addFileFilterButton_clicked</b>(<i></i>)
182
183 <p>
184 Private slot to add a file filter to the list.
185 </p>
186 <a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a>
187 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4>
188 <b>on_deleteFileFilterButton_clicked</b>(<i></i>)
189
190 <p>
191 Private slot called to delete a file filter entry.
192 </p>
193 <a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a>
194 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4>
195 <b>on_editFileFilterButton_clicked</b>(<i></i>)
196
197 <p>
198 Private slot called to edit a file filter entry.
199 </p>
200 <a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a>
201 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4>
202 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>)
203
204 <p>
205 Private slot to set the state of the edit and delete buttons.
206 </p>
207 <dl>
208
209 <dt><i>current</i></dt>
210 <dd>
211 new current item (QListWidgetItem)
212 </dd>
213 <dt><i>previous</i></dt>
214 <dd>
215 previous current item (QListWidgetItem)
216 </dd>
217 </dl>
218 <a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a>
219 <h4>EditorFilePage.on_openFiltersButton_toggled</h4>
220 <b>on_openFiltersButton_toggled</b>(<i>checked</i>)
221
222 <p>
223 Private slot to switch the list of file filters.
224 </p>
225 <dl>
226
227 <dt><i>checked</i></dt>
228 <dd>
229 flag indicating the check state of the button (boolean)
230 </dd>
231 </dl>
232 <a NAME="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked" ID="EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked"></a>
233 <h4>EditorFilePage.on_previewMarkdownPyMdownInstallPushButton_clicked</h4>
234 <b>on_previewMarkdownPyMdownInstallPushButton_clicked</b>(<i></i>)
235
236 <p>
237 Private slot to install the pymdown extensions package via pip.
238 </p>
239 <a NAME="EditorFilePage.polishPage" ID="EditorFilePage.polishPage"></a>
240 <h4>EditorFilePage.polishPage</h4>
241 <b>polishPage</b>(<i></i>)
242
243 <p>
244 Public slot to perform some polishing actions.
245 </p>
246 <a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a>
247 <h4>EditorFilePage.save</h4>
248 <b>save</b>(<i></i>)
249
250 <p>
251 Public slot to save the Editor File Handling configuration.
252 </p>
253 <div align="right"><a href="#top">Up</a></div>
254 <hr />
255 <hr />
256 <a NAME="create" ID="create"></a>
257 <h2>create</h2>
258 <b>create</b>(<i>dlg</i>)
259
260 <p>
261 Module function to create the configuration page.
262 </p>
263 <dl>
264
265 <dt><i>dlg</i></dt>
266 <dd>
267 reference to the configuration dialog
268 </dd>
269 </dl>
270 <dl>
271 <dt>Return:</dt>
272 <dd>
273 reference to the instantiated page (ConfigurationPageBase)
274 </dd>
275 </dl>
276 <div align="right"><a href="#top">Up</a></div>
277 <hr />
278 </body></html>

Mercurial Repository: eric

eric ide

mercurial