src/eric7/Documentation/Source/eric7.Project.FiletypeAssociationDialog.html

branch
eric7
changeset 10479
856476537696
parent 10430
e440aaf179ce
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.FiletypeAssociationDialog</h1> 9 <h1>eric7.Project.FiletypeAssociationDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter filetype associations for the project. 11 Module implementing a dialog to enter filetype associations for the project.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#FiletypeAssociationDialog">FiletypeAssociationDialog</a></td> 22 <td><a href="#FiletypeAssociationDialog">FiletypeAssociationDialog</a></td>
25 <td>Class implementing a dialog to enter filetype associations for the project.</td> 23 <td>Class implementing a dialog to enter filetype associations for the project.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="FiletypeAssociationDialog" ID="FiletypeAssociationDialog"></a> 34 <a NAME="FiletypeAssociationDialog" ID="FiletypeAssociationDialog"></a>
36 <h2>FiletypeAssociationDialog</h2> 35 <h2>FiletypeAssociationDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter filetype associations for the project. 37 Class implementing a dialog to enter filetype associations for the project.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_FiletypeAssociationDialog 41 QDialog, Ui_FiletypeAssociationDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#FiletypeAssociationDialog.__init__">FiletypeAssociationDialog</a></td> 55 <td><a href="#FiletypeAssociationDialog.__init__">FiletypeAssociationDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
97 <tr> 94 <tr>
98 <td><a href="#FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged">on_filetypeCombo_currentIndexChanged</a></td> 95 <td><a href="#FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged">on_filetypeCombo_currentIndexChanged</a></td>
99 <td>Private slot handling the selection of a file type.</td> 96 <td>Private slot handling the selection of a file type.</td>
100 </tr> 97 </tr>
101 </table> 98 </table>
99
102 <h3>Static Methods</h3> 100 <h3>Static Methods</h3>
103 101 <table>
104 <table> 102 <tr><td>None</td></tr>
105 <tr><td>None</td></tr> 103 </table>
106 </table> 104
107 105
108 <a NAME="FiletypeAssociationDialog.__init__" ID="FiletypeAssociationDialog.__init__"></a> 106 <a NAME="FiletypeAssociationDialog.__init__" ID="FiletypeAssociationDialog.__init__"></a>
109 <h4>FiletypeAssociationDialog (Constructor)</h4> 107 <h4>FiletypeAssociationDialog (Constructor)</h4>
110 <b>FiletypeAssociationDialog</b>(<i>project, fileTypesDict, parent=None</i>) 108 <b>FiletypeAssociationDialog</b>(<i>project, fileTypesDict, parent=None</i>)
111
112 <p> 109 <p>
113 Constructor 110 Constructor
114 </p> 111 </p>
112
115 <dl> 113 <dl>
116 114
117 <dt><i>project</i> (Project)</dt> 115 <dt><i>project</i> (Project)</dt>
118 <dd> 116 <dd>
119 reference to the project object 117 reference to the project object
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="FiletypeAssociationDialog.__createItem" ID="FiletypeAssociationDialog.__createItem"></a> 128 <a NAME="FiletypeAssociationDialog.__createItem" ID="FiletypeAssociationDialog.__createItem"></a>
131 <h4>FiletypeAssociationDialog.__createItem</h4> 129 <h4>FiletypeAssociationDialog.__createItem</h4>
132 <b>__createItem</b>(<i>pattern, filetypeStr, fileCategory</i>) 130 <b>__createItem</b>(<i>pattern, filetypeStr, fileCategory</i>)
133
134 <p> 131 <p>
135 Private slot to create a new entry in the association list. 132 Private slot to create a new entry in the association list.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>pattern</i> (str)</dt> 137 <dt><i>pattern</i> (str)</dt>
140 <dd> 138 <dd>
141 pattern of the entry 139 pattern of the entry
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="FiletypeAssociationDialog.__reformat" ID="FiletypeAssociationDialog.__reformat"></a> 162 <a NAME="FiletypeAssociationDialog.__reformat" ID="FiletypeAssociationDialog.__reformat"></a>
165 <h4>FiletypeAssociationDialog.__reformat</h4> 163 <h4>FiletypeAssociationDialog.__reformat</h4>
166 <b>__reformat</b>(<i></i>) 164 <b>__reformat</b>(<i></i>)
167
168 <p> 165 <p>
169 Private method to reformat the tree. 166 Private method to reformat the tree.
170 </p> 167 </p>
168
171 <a NAME="FiletypeAssociationDialog.__resort" ID="FiletypeAssociationDialog.__resort"></a> 169 <a NAME="FiletypeAssociationDialog.__resort" ID="FiletypeAssociationDialog.__resort"></a>
172 <h4>FiletypeAssociationDialog.__resort</h4> 170 <h4>FiletypeAssociationDialog.__resort</h4>
173 <b>__resort</b>(<i></i>) 171 <b>__resort</b>(<i></i>)
174
175 <p> 172 <p>
176 Private method to resort the tree. 173 Private method to resort the tree.
177 </p> 174 </p>
175
178 <a NAME="FiletypeAssociationDialog.__updateAddButton" ID="FiletypeAssociationDialog.__updateAddButton"></a> 176 <a NAME="FiletypeAssociationDialog.__updateAddButton" ID="FiletypeAssociationDialog.__updateAddButton"></a>
179 <h4>FiletypeAssociationDialog.__updateAddButton</h4> 177 <h4>FiletypeAssociationDialog.__updateAddButton</h4>
180 <b>__updateAddButton</b>(<i></i>) 178 <b>__updateAddButton</b>(<i></i>)
181
182 <p> 179 <p>
183 Private method to update the enabled state of the 'add' button. 180 Private method to update the enabled state of the 'add' button.
184 </p> 181 </p>
182
185 <a NAME="FiletypeAssociationDialog.getData" ID="FiletypeAssociationDialog.getData"></a> 183 <a NAME="FiletypeAssociationDialog.getData" ID="FiletypeAssociationDialog.getData"></a>
186 <h4>FiletypeAssociationDialog.getData</h4> 184 <h4>FiletypeAssociationDialog.getData</h4>
187 <b>getData</b>(<i></i>) 185 <b>getData</b>(<i></i>)
188
189 <p> 186 <p>
190 Public method to get the entered associations into. 187 Public method to get the entered associations into.
191 </p> 188 </p>
189
192 <dl> 190 <dl>
193 <dt>Return:</dt> 191 <dt>Return:</dt>
194 <dd> 192 <dd>
195 dictionary containing the defined file type associations 193 dictionary containing the defined file type associations
196 </dd> 194 </dd>
202 </dd> 200 </dd>
203 </dl> 201 </dl>
204 <a NAME="FiletypeAssociationDialog.on_addAssociationButton_clicked" ID="FiletypeAssociationDialog.on_addAssociationButton_clicked"></a> 202 <a NAME="FiletypeAssociationDialog.on_addAssociationButton_clicked" ID="FiletypeAssociationDialog.on_addAssociationButton_clicked"></a>
205 <h4>FiletypeAssociationDialog.on_addAssociationButton_clicked</h4> 203 <h4>FiletypeAssociationDialog.on_addAssociationButton_clicked</h4>
206 <b>on_addAssociationButton_clicked</b>(<i></i>) 204 <b>on_addAssociationButton_clicked</b>(<i></i>)
207
208 <p> 205 <p>
209 Private slot to add the association displayed to the list. 206 Private slot to add the association displayed to the list.
210 </p> 207 </p>
208
211 <a NAME="FiletypeAssociationDialog.on_deleteAssociationButton_clicked" ID="FiletypeAssociationDialog.on_deleteAssociationButton_clicked"></a> 209 <a NAME="FiletypeAssociationDialog.on_deleteAssociationButton_clicked" ID="FiletypeAssociationDialog.on_deleteAssociationButton_clicked"></a>
212 <h4>FiletypeAssociationDialog.on_deleteAssociationButton_clicked</h4> 210 <h4>FiletypeAssociationDialog.on_deleteAssociationButton_clicked</h4>
213 <b>on_deleteAssociationButton_clicked</b>(<i></i>) 211 <b>on_deleteAssociationButton_clicked</b>(<i></i>)
214
215 <p> 212 <p>
216 Private slot to delete the currently selected association of the 213 Private slot to delete the currently selected association of the
217 listbox. 214 listbox.
218 </p> 215 </p>
216
219 <a NAME="FiletypeAssociationDialog.on_filePatternEdit_textChanged" ID="FiletypeAssociationDialog.on_filePatternEdit_textChanged"></a> 217 <a NAME="FiletypeAssociationDialog.on_filePatternEdit_textChanged" ID="FiletypeAssociationDialog.on_filePatternEdit_textChanged"></a>
220 <h4>FiletypeAssociationDialog.on_filePatternEdit_textChanged</h4> 218 <h4>FiletypeAssociationDialog.on_filePatternEdit_textChanged</h4>
221 <b>on_filePatternEdit_textChanged</b>(<i>txt</i>) 219 <b>on_filePatternEdit_textChanged</b>(<i>txt</i>)
222
223 <p> 220 <p>
224 Private slot to handle the textChanged signal of the pattern lineedit. 221 Private slot to handle the textChanged signal of the pattern lineedit.
225 </p> 222 </p>
223
226 <dl> 224 <dl>
227 225
228 <dt><i>txt</i> (str)</dt> 226 <dt><i>txt</i> (str)</dt>
229 <dd> 227 <dd>
230 text of the line edit 228 text of the line edit
231 </dd> 229 </dd>
232 </dl> 230 </dl>
233 <a NAME="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged" ID="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged"></a> 231 <a NAME="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged" ID="FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged"></a>
234 <h4>FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged</h4> 232 <h4>FiletypeAssociationDialog.on_filetypeAssociationList_itemSelectionChanged</h4>
235 <b>on_filetypeAssociationList_itemSelectionChanged</b>(<i></i>) 233 <b>on_filetypeAssociationList_itemSelectionChanged</b>(<i></i>)
236
237 <p> 234 <p>
238 Private slot to handle a change of the selected item. 235 Private slot to handle a change of the selected item.
239 </p> 236 </p>
237
240 <a NAME="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged" ID="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged"></a> 238 <a NAME="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged" ID="FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged"></a>
241 <h4>FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged</h4> 239 <h4>FiletypeAssociationDialog.on_filetypeCombo_currentIndexChanged</h4>
242 <b>on_filetypeCombo_currentIndexChanged</b>(<i>index</i>) 240 <b>on_filetypeCombo_currentIndexChanged</b>(<i>index</i>)
243
244 <p> 241 <p>
245 Private slot handling the selection of a file type. 242 Private slot handling the selection of a file type.
246 </p> 243 </p>
244
247 <dl> 245 <dl>
248 246
249 <dt><i>index</i> (int)</dt> 247 <dt><i>index</i> (int)</dt>
250 <dd> 248 <dd>
251 index of the selected entry 249 index of the selected entry

eric ide

mercurial