src/eric7/Documentation/Source/eric7.UI.FindFileFiltersEditDialog.html

branch
eric7
changeset 10493
f795d68d8e09
child 10494
8db0328580d7
equal deleted inserted replaced
10492:53eac4c7d10b 10493:f795d68d8e09
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.UI.FindFileFiltersEditDialog</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.UI.FindFileFiltersEditDialog</h1>
10 <p>
11 Module implementing a dialog to configure the file filters.
12 </p>
13
14 <h3>Global Attributes</h3>
15 <table>
16 <tr><td>None</td></tr>
17 </table>
18
19 <h3>Classes</h3>
20 <table>
21 <tr>
22 <td><a href="#FindFileFiltersEditDialog">FindFileFiltersEditDialog</a></td>
23 <td>Class implementing a dialog to configure the file filters.</td>
24 </tr>
25 </table>
26
27 <h3>Functions</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31
32 <hr />
33 <hr />
34 <a NAME="FindFileFiltersEditDialog" ID="FindFileFiltersEditDialog"></a>
35 <h2>FindFileFiltersEditDialog</h2>
36 <p>
37 Class implementing a dialog to configure the file filters.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_FindFileFiltersEditDialog
42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>FilterPatternRole</td></tr>
45 <tr><td>FilterTextRole</td></tr>
46 </table>
47
48 <h3>Class Methods</h3>
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52
53 <h3>Methods</h3>
54 <table>
55 <tr>
56 <td><a href="#FindFileFiltersEditDialog.__init__">FindFileFiltersEditDialog</a></td>
57 <td>Constructor</td>
58 </tr>
59 <tr>
60 <td><a href="#FindFileFiltersEditDialog.__adjustColumns">__adjustColumns</a></td>
61 <td>Private method to adjust the column widths.</td>
62 </tr>
63 <tr>
64 <td><a href="#FindFileFiltersEditDialog.__getFiltersList">__getFiltersList</a></td>
65 <td>Private method to get the list of defined filter names.</td>
66 </tr>
67 <tr>
68 <td><a href="#FindFileFiltersEditDialog.__populateFilters">__populateFilters</a></td>
69 <td>Private method to populate the filters list.</td>
70 </tr>
71 <tr>
72 <td><a href="#FindFileFiltersEditDialog.getFilters">getFilters</a></td>
73 <td>Public method to retrieve the edited filter list.</td>
74 </tr>
75 <tr>
76 <td><a href="#FindFileFiltersEditDialog.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td>
77 <td>Private slot to add a new filter entry.</td>
78 </tr>
79 <tr>
80 <td><a href="#FindFileFiltersEditDialog.on_defaultFiltersButton_clicked">on_defaultFiltersButton_clicked</a></td>
81 <td>Private slot to create the default list of file filters.</td>
82 </tr>
83 <tr>
84 <td><a href="#FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td>
85 <td>Private slot to delete the selected filter entries.</td>
86 </tr>
87 <tr>
88 <td><a href="#FindFileFiltersEditDialog.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td>
89 <td>Private slot to edit the selected filter entry..</td>
90 </tr>
91 <tr>
92 <td><a href="#FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged">on_fileFiltersList_itemSelectionChanged</a></td>
93 <td>Private slot to handle a change of the selected items.</td>
94 </tr>
95 </table>
96
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101
102
103 <a NAME="FindFileFiltersEditDialog.__init__" ID="FindFileFiltersEditDialog.__init__"></a>
104 <h4>FindFileFiltersEditDialog (Constructor)</h4>
105 <b>FindFileFiltersEditDialog</b>(<i>filters, parent=None</i>)
106 <p>
107 Constructor
108 </p>
109
110 <dl>
111
112 <dt><i>filters</i> (dict)</dt>
113 <dd>
114 dictionary containing the existing file filters
115 </dd>
116 <dt><i>parent</i> (QWidget (optional))</dt>
117 <dd>
118 reference to the parent widget (defaults to None)
119 </dd>
120 </dl>
121 <a NAME="FindFileFiltersEditDialog.__adjustColumns" ID="FindFileFiltersEditDialog.__adjustColumns"></a>
122 <h4>FindFileFiltersEditDialog.__adjustColumns</h4>
123 <b>__adjustColumns</b>(<i></i>)
124 <p>
125 Private method to adjust the column widths.
126 </p>
127
128 <a NAME="FindFileFiltersEditDialog.__getFiltersList" ID="FindFileFiltersEditDialog.__getFiltersList"></a>
129 <h4>FindFileFiltersEditDialog.__getFiltersList</h4>
130 <b>__getFiltersList</b>(<i>forEdit=False</i>)
131 <p>
132 Private method to get the list of defined filter names.
133 </p>
134
135 <dl>
136
137 <dt><i>forEdit</i> (bool (optional))</dt>
138 <dd>
139 flag indicating a list for an edit operation
140 (defaults to False)
141 </dd>
142 </dl>
143 <dl>
144 <dt>Return:</dt>
145 <dd>
146 list of defined filter names
147 </dd>
148 </dl>
149 <dl>
150 <dt>Return Type:</dt>
151 <dd>
152 list of str
153 </dd>
154 </dl>
155 <a NAME="FindFileFiltersEditDialog.__populateFilters" ID="FindFileFiltersEditDialog.__populateFilters"></a>
156 <h4>FindFileFiltersEditDialog.__populateFilters</h4>
157 <b>__populateFilters</b>(<i>filters</i>)
158 <p>
159 Private method to populate the filters list.
160 </p>
161
162 <dl>
163
164 <dt><i>filters</i> (dict)</dt>
165 <dd>
166 dictionary containing the existing file filters
167 </dd>
168 </dl>
169 <a NAME="FindFileFiltersEditDialog.getFilters" ID="FindFileFiltersEditDialog.getFilters"></a>
170 <h4>FindFileFiltersEditDialog.getFilters</h4>
171 <b>getFilters</b>(<i></i>)
172 <p>
173 Public method to retrieve the edited filter list.
174 </p>
175
176 <dl>
177 <dt>Return:</dt>
178 <dd>
179 dictionary containing the defined file filters
180 </dd>
181 </dl>
182 <dl>
183 <dt>Return Type:</dt>
184 <dd>
185 dict
186 </dd>
187 </dl>
188 <a NAME="FindFileFiltersEditDialog.on_addFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_addFileFilterButton_clicked"></a>
189 <h4>FindFileFiltersEditDialog.on_addFileFilterButton_clicked</h4>
190 <b>on_addFileFilterButton_clicked</b>(<i></i>)
191 <p>
192 Private slot to add a new filter entry.
193 </p>
194
195 <a NAME="FindFileFiltersEditDialog.on_defaultFiltersButton_clicked" ID="FindFileFiltersEditDialog.on_defaultFiltersButton_clicked"></a>
196 <h4>FindFileFiltersEditDialog.on_defaultFiltersButton_clicked</h4>
197 <b>on_defaultFiltersButton_clicked</b>(<i></i>)
198 <p>
199 Private slot to create the default list of file filters.
200 </p>
201
202 <a NAME="FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked"></a>
203 <h4>FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked</h4>
204 <b>on_deleteFileFilterButton_clicked</b>(<i></i>)
205 <p>
206 Private slot to delete the selected filter entries.
207 </p>
208
209 <a NAME="FindFileFiltersEditDialog.on_editFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_editFileFilterButton_clicked"></a>
210 <h4>FindFileFiltersEditDialog.on_editFileFilterButton_clicked</h4>
211 <b>on_editFileFilterButton_clicked</b>(<i></i>)
212 <p>
213 Private slot to edit the selected filter entry..
214 </p>
215
216 <a NAME="FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged" ID="FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged"></a>
217 <h4>FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged</h4>
218 <b>on_fileFiltersList_itemSelectionChanged</b>(<i></i>)
219 <p>
220 Private slot to handle a change of the selected items.
221 </p>
222
223 <div align="right"><a href="#top">Up</a></div>
224 <hr />
225 </body></html>

eric ide

mercurial