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