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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7319
49ea50a9a61e
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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.EditorFilePage</h1> 23 <h1>eric6.Preferences.ConfigurationPages.EditorFilePage</h1>
24
23 <p> 25 <p>
24 Module implementing the Editor File Handling configuration page. 26 Module implementing the Editor File Handling 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="#EditorFilePage">EditorFilePage</a></td> 38 <td><a href="#EditorFilePage">EditorFilePage</a></td>
34 <td>Class implementing the Editor File Handling configuration page.</td> 39 <td>Class implementing the Editor File Handling 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="EditorFilePage" ID="EditorFilePage"></a> 53 <a NAME="EditorFilePage" ID="EditorFilePage"></a>
46 <h2>EditorFilePage</h2> 54 <h2>EditorFilePage</h2>
55
47 <p> 56 <p>
48 Class implementing the Editor File Handling configuration page. 57 Class implementing the Editor File Handling configuration page.
49 </p> 58 </p>
50 <h3>Derived from</h3> 59 <h3>Derived from</h3>
51 ConfigurationPageBase, Ui_EditorFilePage 60 ConfigurationPageBase, Ui_EditorFilePage
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="#EditorFilePage.__init__">EditorFilePage</a></td> 76 <td><a href="#EditorFilePage.__init__">EditorFilePage</a></td>
64 <td>Constructor</td> 77 <td>Constructor</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#EditorFilePage.__checkFileFilter">__checkFileFilter</a></td> 80 <td><a href="#EditorFilePage.__checkFileFilter">__checkFileFilter</a></td>
67 <td>Private method to check a file filter for validity.</td> 81 <td>Private method to check a file filter for validity.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#EditorFilePage.__extractFileFilters">__extractFileFilters</a></td> 84 <td><a href="#EditorFilePage.__extractFileFilters">__extractFileFilters</a></td>
70 <td>Private method to extract the file filters.</td> 85 <td>Private method to extract the file filters.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#EditorFilePage.__setDefaultFiltersLists">__setDefaultFiltersLists</a></td> 88 <td><a href="#EditorFilePage.__setDefaultFiltersLists">__setDefaultFiltersLists</a></td>
73 <td>Private slot to set the default file filter combo boxes.</td> 89 <td>Private slot to set the default file filter combo boxes.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#EditorFilePage.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td> 92 <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> 93 <td>Private slot to add a file filter to the list.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#EditorFilePage.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td> 96 <td><a href="#EditorFilePage.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td>
79 <td>Private slot called to delete a file filter entry.</td> 97 <td>Private slot called to delete a file filter entry.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#EditorFilePage.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td> 100 <td><a href="#EditorFilePage.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td>
82 <td>Private slot called to edit a file filter entry.</td> 101 <td>Private slot called to edit a file filter entry.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#EditorFilePage.on_fileFiltersList_currentItemChanged">on_fileFiltersList_currentItemChanged</a></td> 104 <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> 105 <td>Private slot to set the state of the edit and delete buttons.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#EditorFilePage.on_openFiltersButton_toggled">on_openFiltersButton_toggled</a></td> 108 <td><a href="#EditorFilePage.on_openFiltersButton_toggled">on_openFiltersButton_toggled</a></td>
88 <td>Private slot to switch the list of file filters.</td> 109 <td>Private slot to switch the list of file filters.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#EditorFilePage.save">save</a></td> 112 <td><a href="#EditorFilePage.save">save</a></td>
91 <td>Public slot to save the Editor File Handling configuration.</td> 113 <td>Public slot to save the Editor File Handling configuration.</td>
92 </tr> 114 </tr>
93 </table> 115 </table>
94 <h3>Static Methods</h3> 116 <h3>Static Methods</h3>
95 <table> 117
96 <tr><td>None</td></tr> 118 <table>
97 </table> 119 <tr><td>None</td></tr>
120 </table>
121
98 <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a> 122 <a NAME="EditorFilePage.__init__" ID="EditorFilePage.__init__"></a>
99 <h4>EditorFilePage (Constructor)</h4> 123 <h4>EditorFilePage (Constructor)</h4>
100 <b>EditorFilePage</b>(<i></i>) 124 <b>EditorFilePage</b>(<i></i>)
125
101 <p> 126 <p>
102 Constructor 127 Constructor
103 </p><a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a> 128 </p>
129 <a NAME="EditorFilePage.__checkFileFilter" ID="EditorFilePage.__checkFileFilter"></a>
104 <h4>EditorFilePage.__checkFileFilter</h4> 130 <h4>EditorFilePage.__checkFileFilter</h4>
105 <b>__checkFileFilter</b>(<i>fileFilter</i>) 131 <b>__checkFileFilter</b>(<i>fileFilter</i>)
132
106 <p> 133 <p>
107 Private method to check a file filter for validity. 134 Private method to check a file filter for validity.
108 </p><dl> 135 </p>
136 <dl>
137
109 <dt><i>fileFilter</i></dt> 138 <dt><i>fileFilter</i></dt>
110 <dd> 139 <dd>
111 file filter pattern to check (string) 140 file filter pattern to check (string)
112 </dd> 141 </dd>
113 </dl><dl> 142 </dl>
143 <dl>
114 <dt>Returns:</dt> 144 <dt>Returns:</dt>
115 <dd> 145 <dd>
116 flag indicating validity (boolean) 146 flag indicating validity (boolean)
117 </dd> 147 </dd>
118 </dl><a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a> 148 </dl>
149 <a NAME="EditorFilePage.__extractFileFilters" ID="EditorFilePage.__extractFileFilters"></a>
119 <h4>EditorFilePage.__extractFileFilters</h4> 150 <h4>EditorFilePage.__extractFileFilters</h4>
120 <b>__extractFileFilters</b>(<i></i>) 151 <b>__extractFileFilters</b>(<i></i>)
152
121 <p> 153 <p>
122 Private method to extract the file filters. 154 Private method to extract the file filters.
123 </p><a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a> 155 </p>
156 <a NAME="EditorFilePage.__setDefaultFiltersLists" ID="EditorFilePage.__setDefaultFiltersLists"></a>
124 <h4>EditorFilePage.__setDefaultFiltersLists</h4> 157 <h4>EditorFilePage.__setDefaultFiltersLists</h4>
125 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>) 158 <b>__setDefaultFiltersLists</b>(<i>keepSelection=False</i>)
159
126 <p> 160 <p>
127 Private slot to set the default file filter combo boxes. 161 Private slot to set the default file filter combo boxes.
128 </p><dl> 162 </p>
163 <dl>
164
129 <dt><i>keepSelection</i></dt> 165 <dt><i>keepSelection</i></dt>
130 <dd> 166 <dd>
131 flag indicating to keep the current selection 167 flag indicating to keep the current selection
132 if possible (boolean) 168 if possible (boolean)
133 </dd> 169 </dd>
134 </dl><a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a> 170 </dl>
171 <a NAME="EditorFilePage.on_addFileFilterButton_clicked" ID="EditorFilePage.on_addFileFilterButton_clicked"></a>
135 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4> 172 <h4>EditorFilePage.on_addFileFilterButton_clicked</h4>
136 <b>on_addFileFilterButton_clicked</b>(<i></i>) 173 <b>on_addFileFilterButton_clicked</b>(<i></i>)
174
137 <p> 175 <p>
138 Private slot to add a file filter to the list. 176 Private slot to add a file filter to the list.
139 </p><a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a> 177 </p>
178 <a NAME="EditorFilePage.on_deleteFileFilterButton_clicked" ID="EditorFilePage.on_deleteFileFilterButton_clicked"></a>
140 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4> 179 <h4>EditorFilePage.on_deleteFileFilterButton_clicked</h4>
141 <b>on_deleteFileFilterButton_clicked</b>(<i></i>) 180 <b>on_deleteFileFilterButton_clicked</b>(<i></i>)
181
142 <p> 182 <p>
143 Private slot called to delete a file filter entry. 183 Private slot called to delete a file filter entry.
144 </p><a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a> 184 </p>
185 <a NAME="EditorFilePage.on_editFileFilterButton_clicked" ID="EditorFilePage.on_editFileFilterButton_clicked"></a>
145 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4> 186 <h4>EditorFilePage.on_editFileFilterButton_clicked</h4>
146 <b>on_editFileFilterButton_clicked</b>(<i></i>) 187 <b>on_editFileFilterButton_clicked</b>(<i></i>)
188
147 <p> 189 <p>
148 Private slot called to edit a file filter entry. 190 Private slot called to edit a file filter entry.
149 </p><a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a> 191 </p>
192 <a NAME="EditorFilePage.on_fileFiltersList_currentItemChanged" ID="EditorFilePage.on_fileFiltersList_currentItemChanged"></a>
150 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4> 193 <h4>EditorFilePage.on_fileFiltersList_currentItemChanged</h4>
151 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>) 194 <b>on_fileFiltersList_currentItemChanged</b>(<i>current, previous</i>)
195
152 <p> 196 <p>
153 Private slot to set the state of the edit and delete buttons. 197 Private slot to set the state of the edit and delete buttons.
154 </p><dl> 198 </p>
199 <dl>
200
155 <dt><i>current</i></dt> 201 <dt><i>current</i></dt>
156 <dd> 202 <dd>
157 new current item (QListWidgetItem) 203 new current item (QListWidgetItem)
158 </dd><dt><i>previous</i></dt> 204 </dd>
205 <dt><i>previous</i></dt>
159 <dd> 206 <dd>
160 previous current item (QListWidgetItem) 207 previous current item (QListWidgetItem)
161 </dd> 208 </dd>
162 </dl><a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a> 209 </dl>
210 <a NAME="EditorFilePage.on_openFiltersButton_toggled" ID="EditorFilePage.on_openFiltersButton_toggled"></a>
163 <h4>EditorFilePage.on_openFiltersButton_toggled</h4> 211 <h4>EditorFilePage.on_openFiltersButton_toggled</h4>
164 <b>on_openFiltersButton_toggled</b>(<i>checked</i>) 212 <b>on_openFiltersButton_toggled</b>(<i>checked</i>)
213
165 <p> 214 <p>
166 Private slot to switch the list of file filters. 215 Private slot to switch the list of file filters.
167 </p><dl> 216 </p>
217 <dl>
218
168 <dt><i>checked</i></dt> 219 <dt><i>checked</i></dt>
169 <dd> 220 <dd>
170 flag indicating the check state of the button (boolean) 221 flag indicating the check state of the button (boolean)
171 </dd> 222 </dd>
172 </dl><a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a> 223 </dl>
224 <a NAME="EditorFilePage.save" ID="EditorFilePage.save"></a>
173 <h4>EditorFilePage.save</h4> 225 <h4>EditorFilePage.save</h4>
174 <b>save</b>(<i></i>) 226 <b>save</b>(<i></i>)
227
175 <p> 228 <p>
176 Public slot to save the Editor File Handling configuration. 229 Public slot to save the Editor File Handling configuration.
177 </p> 230 </p>
178 <div align="right"><a href="#top">Up</a></div> 231 <div align="right"><a href="#top">Up</a></div>
179 <hr /><hr /> 232 <hr />
233 <hr />
180 <a NAME="create" ID="create"></a> 234 <a NAME="create" ID="create"></a>
181 <h2>create</h2> 235 <h2>create</h2>
182 <b>create</b>(<i>dlg</i>) 236 <b>create</b>(<i>dlg</i>)
237
183 <p> 238 <p>
184 Module function to create the configuration page. 239 Module function to create the configuration page.
185 </p><dl> 240 </p>
241 <dl>
242
186 <dt><i>dlg</i></dt> 243 <dt><i>dlg</i></dt>
187 <dd> 244 <dd>
188 reference to the configuration dialog 245 reference to the configuration dialog
189 </dd> 246 </dd>
190 </dl><dl> 247 </dl>
248 <dl>
191 <dt>Returns:</dt> 249 <dt>Returns:</dt>
192 <dd> 250 <dd>
193 reference to the instantiated page (ConfigurationPageBase) 251 reference to the instantiated page (ConfigurationPageBase)
194 </dd> 252 </dd>
195 </dl> 253 </dl>

eric ide

mercurial