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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9530
c30f02ea1b27
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.FiletypeAssociationDialog</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.Project.FiletypeAssociationDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter filetype associations for the project.
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="#FiletypeAssociationDialog">FiletypeAssociationDialog</a></td>
25 <td>Class implementing a dialog to enter filetype associations for the project.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="FiletypeAssociationDialog" ID="FiletypeAssociationDialog"></a>
36 <h2>FiletypeAssociationDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter filetype associations for the project.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_FiletypeAssociationDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#FiletypeAssociationDialog.__init__">FiletypeAssociationDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#FiletypeAssociationDialog.__createItem">__createItem</a></td>
63 <td>Private slot to create a new entry in the association list.</td>
64 </tr>
65 <tr>
66 <td><a href="#FiletypeAssociationDialog.__reformat">__reformat</a></td>
67 <td>Private method to reformat the tree.</td>
68 </tr>
69 <tr>
70 <td><a href="#FiletypeAssociationDialog.__resort">__resort</a></td>
71 <td>Private method to resort the tree.</td>
72 </tr>
73 <tr>
74 <td><a href="#FiletypeAssociationDialog.on_addAssociationButton_clicked">on_addAssociationButton_clicked</a></td>
75 <td>Private slot to add the association displayed to the list.</td>
76 </tr>
77 <tr>
78 <td><a href="#FiletypeAssociationDialog.on_deleteAssociationButton_clicked">on_deleteAssociationButton_clicked</a></td>
79 <td>Private slot to delete the currently selected association of the listbox.</td>
80 </tr>
81 <tr>
82 <td><a href="#FiletypeAssociationDialog.on_filePatternEdit_textChanged">on_filePatternEdit_textChanged</a></td>
83 <td>Private slot to handle the textChanged signal of the pattern lineedit.</td>
84 </tr>
85 <tr>
86 <td><a href="#FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged">on_filetypeAssociationList_currentItemChanged</a></td>
87 <td>Private slot to handle the currentItemChanged signal of the association list.</td>
88 </tr>
89 <tr>
90 <td><a href="#FiletypeAssociationDialog.transferData">transferData</a></td>
91 <td>Public slot to transfer the associations into the projects data structure.</td>
92 </tr>
93 </table>
94 <h3>Static Methods</h3>
95
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99
100 <a NAME="FiletypeAssociationDialog.__init__" ID="FiletypeAssociationDialog.__init__"></a>
101 <h4>FiletypeAssociationDialog (Constructor)</h4>
102 <b>FiletypeAssociationDialog</b>(<i>project, parent=None</i>)
103
104 <p>
105 Constructor
106 </p>
107 <dl>
108
109 <dt><i>project</i></dt>
110 <dd>
111 reference to the project object
112 </dd>
113 <dt><i>parent</i></dt>
114 <dd>
115 reference to the parent widget (QWidget)
116 </dd>
117 </dl>
118 <a NAME="FiletypeAssociationDialog.__createItem" ID="FiletypeAssociationDialog.__createItem"></a>
119 <h4>FiletypeAssociationDialog.__createItem</h4>
120 <b>__createItem</b>(<i>pattern, filetype</i>)
121
122 <p>
123 Private slot to create a new entry in the association list.
124 </p>
125 <dl>
126
127 <dt><i>pattern</i></dt>
128 <dd>
129 pattern of the entry (string)
130 </dd>
131 <dt><i>filetype</i></dt>
132 <dd>
133 file type of the entry (string)
134 </dd>
135 </dl>
136 <dl>
137 <dt>Return:</dt>
138 <dd>
139 reference to the newly generated entry (QTreeWidgetItem)
140 </dd>
141 </dl>
142 <a NAME="FiletypeAssociationDialog.__reformat" ID="FiletypeAssociationDialog.__reformat"></a>
143 <h4>FiletypeAssociationDialog.__reformat</h4>
144 <b>__reformat</b>(<i></i>)
145
146 <p>
147 Private method to reformat the tree.
148 </p>
149 <a NAME="FiletypeAssociationDialog.__resort" ID="FiletypeAssociationDialog.__resort"></a>
150 <h4>FiletypeAssociationDialog.__resort</h4>
151 <b>__resort</b>(<i></i>)
152
153 <p>
154 Private method to resort the tree.
155 </p>
156 <a NAME="FiletypeAssociationDialog.on_addAssociationButton_clicked" ID="FiletypeAssociationDialog.on_addAssociationButton_clicked"></a>
157 <h4>FiletypeAssociationDialog.on_addAssociationButton_clicked</h4>
158 <b>on_addAssociationButton_clicked</b>(<i></i>)
159
160 <p>
161 Private slot to add the association displayed to the list.
162 </p>
163 <a NAME="FiletypeAssociationDialog.on_deleteAssociationButton_clicked" ID="FiletypeAssociationDialog.on_deleteAssociationButton_clicked"></a>
164 <h4>FiletypeAssociationDialog.on_deleteAssociationButton_clicked</h4>
165 <b>on_deleteAssociationButton_clicked</b>(<i></i>)
166
167 <p>
168 Private slot to delete the currently selected association of the
169 listbox.
170 </p>
171 <a NAME="FiletypeAssociationDialog.on_filePatternEdit_textChanged" ID="FiletypeAssociationDialog.on_filePatternEdit_textChanged"></a>
172 <h4>FiletypeAssociationDialog.on_filePatternEdit_textChanged</h4>
173 <b>on_filePatternEdit_textChanged</b>(<i>txt</i>)
174
175 <p>
176 Private slot to handle the textChanged signal of the pattern lineedit.
177 </p>
178 <dl>
179
180 <dt><i>txt</i></dt>
181 <dd>
182 text of the lineedit (string)
183 </dd>
184 </dl>
185 <a NAME="FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged" ID="FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged"></a>
186 <h4>FiletypeAssociationDialog.on_filetypeAssociationList_currentItemChanged</h4>
187 <b>on_filetypeAssociationList_currentItemChanged</b>(<i>itm, prevItm</i>)
188
189 <p>
190 Private slot to handle the currentItemChanged signal of the
191 association list.
192 </p>
193 <dl>
194
195 <dt><i>itm</i></dt>
196 <dd>
197 reference to the new current item (QTreeWidgetItem)
198 </dd>
199 <dt><i>prevItm</i></dt>
200 <dd>
201 reference to the previous current item (QTreeWidgetItem)
202 </dd>
203 </dl>
204 <a NAME="FiletypeAssociationDialog.transferData" ID="FiletypeAssociationDialog.transferData"></a>
205 <h4>FiletypeAssociationDialog.transferData</h4>
206 <b>transferData</b>(<i></i>)
207
208 <p>
209 Public slot to transfer the associations into the projects data
210 structure.
211 </p>
212 <div align="right"><a href="#top">Up</a></div>
213 <hr />
214 </body></html>

eric ide

mercurial