Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Preferences.ConfigurationPages.EditorFilePage.html
Documentation/Source/eric6.Preferences.ConfigurationPages.EditorFilePage.html
- changeset 3673
- e26d7d0c1088
- child 5606
- da305d172769
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Preferences.ConfigurationPages.EditorFilePage</h1> | |
| 23 <p> | |
| 24 Module implementing the Editor File Handling configuration page. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#EditorFilePage">EditorFilePage</a></td> | |
| 34 <td>Class implementing the Editor File Handling configuration page.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#create">create</a></td> | |
| 41 <td>Module function to create the configuration page.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="EditorFilePage" ID="EditorFilePage"></a> | |
| 46 <h2>EditorFilePage</h2> | |
| 47 <p> | |
| 48 Class implementing the Editor File Handling configuration page. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 ConfigurationPageBase, Ui_EditorFilePage | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#EditorFilePage.__init__">EditorFilePage</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#EditorFilePage.__checkFileFilter">__checkFileFilter</a></td> | |
| 67 <td>Private method to check a file filter for validity.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#EditorFilePage.__extractFileFilters">__extractFileFilters</a></td> | |
| 70 <td>Private method to extract the file filters.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#EditorFilePage.__setDefaultFiltersLists">__setDefaultFiltersLists</a></td> | |
| 73 <td>Private slot to set the default file filter combo boxes.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#EditorFilePage.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td> | |
| 76 <td>Private slot to add a file filter to the list.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#EditorFilePage.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td> | |
| 79 <td>Private slot called to delete a file filter entry.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#EditorFilePage.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td> | |
| 82 <td>Private slot called to edit a file filter entry.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#EditorFilePage.on_fileFiltersList_currentItemChanged">on_fileFiltersList_currentItemChanged</a></td> | |
| 85 <td>Private slot to set the state of the edit and delete buttons.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#EditorFilePage.on_openFiltersButton_toggled">on_openFiltersButton_toggled</a></td> | |
| 88 <td>Private slot to switch the list of file filters.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#EditorFilePage.save">save</a></td> | |
| 91 <td>Public slot to save the Editor File Handling configuration.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a> | |
| 99 <h4>EditorFilePage (Constructor)</h4> | |
| 100 <b>EditorFilePage</b>(<i></i>) | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p><a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a> | |
| 104 <h4>EditorFilePage.__checkFileFilter</h4> | |
| 105 <b>__checkFileFilter</b>(<i>filter</i>) | |
| 106 <p> | |
| 107 Private method to check a file filter for validity. | |
| 108 </p><dl> | |
| 109 <dt><i>filter</i></dt> | |
| 110 <dd> | |
| 111 file filter pattern to check (string) | |
| 112 </dd> | |
| 113 </dl><dl> | |
| 114 <dt>Returns:</dt> | |
| 115 <dd> | |
| 116 flag indicating validity (boolean) | |
| 117 </dd> | |
| 118 </dl><a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a> | |
| 119 <h4>EditorFilePage.__extractFileFilters</h4> | |
| 120 <b>__extractFileFilters</b>(<i></i>) | |
| 121 <p> | |
| 122 Private method to extract the file filters. | |
| 123 </p><a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a> | |
| 124 <h4>EditorFilePage.__setDefaultFiltersLists</h4> | |
| 125 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>) | |
| 126 <p> | |
| 127 Private slot to set the default file filter combo boxes. | |
| 128 </p><dl> | |
| 129 <dt><i>keepSelection</i></dt> | |
| 130 <dd> | |
| 131 flag indicating to keep the current selection | |
| 132 if possible (boolean) | |
| 133 </dd> | |
| 134 </dl><a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a> | |
| 135 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4> | |
| 136 <b>on_addFileFilterButton_clicked</b>(<i></i>) | |
| 137 <p> | |
| 138 Private slot to add a file filter to the list. | |
| 139 </p><a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a> | |
| 140 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4> | |
| 141 <b>on_deleteFileFilterButton_clicked</b>(<i></i>) | |
| 142 <p> | |
| 143 Private slot called to delete a file filter entry. | |
| 144 </p><a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a> | |
| 145 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4> | |
| 146 <b>on_editFileFilterButton_clicked</b>(<i></i>) | |
| 147 <p> | |
| 148 Private slot called to edit a file filter entry. | |
| 149 </p><a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a> | |
| 150 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4> | |
| 151 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>) | |
| 152 <p> | |
| 153 Private slot to set the state of the edit and delete buttons. | |
| 154 </p><dl> | |
| 155 <dt><i>current</i></dt> | |
| 156 <dd> | |
| 157 new current item (QListWidgetItem) | |
| 158 </dd><dt><i>previous</i></dt> | |
| 159 <dd> | |
| 160 previous current item (QListWidgetItem) | |
| 161 </dd> | |
| 162 </dl><a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a> | |
| 163 <h4>EditorFilePage.on_openFiltersButton_toggled</h4> | |
| 164 <b>on_openFiltersButton_toggled</b>(<i>checked</i>) | |
| 165 <p> | |
| 166 Private slot to switch the list of file filters. | |
| 167 </p><dl> | |
| 168 <dt><i>checked</i></dt> | |
| 169 <dd> | |
| 170 flag indicating the check state of the button (boolean) | |
| 171 </dd> | |
| 172 </dl><a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a> | |
| 173 <h4>EditorFilePage.save</h4> | |
| 174 <b>save</b>(<i></i>) | |
| 175 <p> | |
| 176 Public slot to save the Editor File Handling configuration. | |
| 177 </p> | |
| 178 <div align="right"><a href="#top">Up</a></div> | |
| 179 <hr /><hr /> | |
| 180 <a NAME="create" ID="create"></a> | |
| 181 <h2>create</h2> | |
| 182 <b>create</b>(<i>dlg</i>) | |
| 183 <p> | |
| 184 Module function to create the configuration page. | |
| 185 </p><dl> | |
| 186 <dt><i>dlg</i></dt> | |
| 187 <dd> | |
| 188 reference to the configuration dialog | |
| 189 </dd> | |
| 190 </dl><dl> | |
| 191 <dt>Returns:</dt> | |
| 192 <dd> | |
| 193 reference to the instantiated page (ConfigurationPageBase) | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <div align="right"><a href="#top">Up</a></div> | |
| 197 <hr /> | |
| 198 </body></html> |
