Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Project.ProjectBrowserModel.html

eric6/Documentation/Source/eric6.Project.ProjectBrowserModel.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7518
6dea4abd3097
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.Project.ProjectBrowserModel</h1> 23 <h1>eric6.Project.ProjectBrowserModel</h1>
24
23 <p> 25 <p>
24 Module implementing the browser model. 26 Module implementing the browser model.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>ProjectBrowserFormType</td></tr><tr><td>ProjectBrowserInterfaceType</td></tr><tr><td>ProjectBrowserItemDirectory</td></tr><tr><td>ProjectBrowserItemFile</td></tr><tr><td>ProjectBrowserItemSimpleDirectory</td></tr><tr><td>ProjectBrowserNoType</td></tr><tr><td>ProjectBrowserOthersType</td></tr><tr><td>ProjectBrowserProtocolsType</td></tr><tr><td>ProjectBrowserResourceType</td></tr><tr><td>ProjectBrowserSourceType</td></tr><tr><td>ProjectBrowserTranslationType</td></tr> 31 <tr><td>ProjectBrowserFormType</td></tr><tr><td>ProjectBrowserInterfaceType</td></tr><tr><td>ProjectBrowserItemDirectory</td></tr><tr><td>ProjectBrowserItemFile</td></tr><tr><td>ProjectBrowserItemSimpleDirectory</td></tr><tr><td>ProjectBrowserNoType</td></tr><tr><td>ProjectBrowserOthersType</td></tr><tr><td>ProjectBrowserProtocolsType</td></tr><tr><td>ProjectBrowserResourceType</td></tr><tr><td>ProjectBrowserSourceType</td></tr><tr><td>ProjectBrowserTranslationType</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="#ProjectBrowserDirectoryItem">ProjectBrowserDirectoryItem</a></td> 38 <td><a href="#ProjectBrowserDirectoryItem">ProjectBrowserDirectoryItem</a></td>
34 <td>Class implementing the data structure for project browser directory items.</td> 39 <td>Class implementing the data structure for project browser directory items.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#ProjectBrowserFileItem">ProjectBrowserFileItem</a></td> 42 <td><a href="#ProjectBrowserFileItem">ProjectBrowserFileItem</a></td>
37 <td>Class implementing the data structure for project browser file items.</td> 43 <td>Class implementing the data structure for project browser file items.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#ProjectBrowserItemMixin">ProjectBrowserItemMixin</a></td> 46 <td><a href="#ProjectBrowserItemMixin">ProjectBrowserItemMixin</a></td>
40 <td>Class implementing common methods of project browser items.</td> 47 <td>Class implementing common methods of project browser items.</td>
41 </tr><tr> 48 </tr>
49 <tr>
42 <td><a href="#ProjectBrowserModel">ProjectBrowserModel</a></td> 50 <td><a href="#ProjectBrowserModel">ProjectBrowserModel</a></td>
43 <td>Class implementing the project browser model.</td> 51 <td>Class implementing the project browser model.</td>
44 </tr><tr> 52 </tr>
53 <tr>
45 <td><a href="#ProjectBrowserSimpleDirectoryItem">ProjectBrowserSimpleDirectoryItem</a></td> 54 <td><a href="#ProjectBrowserSimpleDirectoryItem">ProjectBrowserSimpleDirectoryItem</a></td>
46 <td>Class implementing the data structure for project browser simple directory items.</td> 55 <td>Class implementing the data structure for project browser simple directory items.</td>
47 </tr> 56 </tr>
48 </table> 57 </table>
49 <h3>Functions</h3> 58 <h3>Functions</h3>
50 <table> 59
51 <tr><td>None</td></tr> 60 <table>
52 </table> 61 <tr><td>None</td></tr>
53 <hr /><hr /> 62 </table>
63 <hr />
64 <hr />
54 <a NAME="ProjectBrowserDirectoryItem" ID="ProjectBrowserDirectoryItem"></a> 65 <a NAME="ProjectBrowserDirectoryItem" ID="ProjectBrowserDirectoryItem"></a>
55 <h2>ProjectBrowserDirectoryItem</h2> 66 <h2>ProjectBrowserDirectoryItem</h2>
67
56 <p> 68 <p>
57 Class implementing the data structure for project browser directory items. 69 Class implementing the data structure for project browser directory items.
58 </p> 70 </p>
59 <h3>Derived from</h3> 71 <h3>Derived from</h3>
60 BrowserDirectoryItem, ProjectBrowserItemMixin 72 BrowserDirectoryItem, ProjectBrowserItemMixin
61 <h3>Class Attributes</h3> 73 <h3>Class Attributes</h3>
74
62 <table> 75 <table>
63 <tr><td>None</td></tr> 76 <tr><td>None</td></tr>
64 </table> 77 </table>
65 <h3>Class Methods</h3> 78 <h3>Class Methods</h3>
79
66 <table> 80 <table>
67 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
68 </table> 82 </table>
69 <h3>Methods</h3> 83 <h3>Methods</h3>
70 <table> 84
85 <table>
86
71 <tr> 87 <tr>
72 <td><a href="#ProjectBrowserDirectoryItem.__init__">ProjectBrowserDirectoryItem</a></td> 88 <td><a href="#ProjectBrowserDirectoryItem.__init__">ProjectBrowserDirectoryItem</a></td>
73 <td>Constructor</td> 89 <td>Constructor</td>
74 </tr> 90 </tr>
75 </table> 91 </table>
76 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
77 <table> 93
78 <tr><td>None</td></tr> 94 <table>
79 </table> 95 <tr><td>None</td></tr>
96 </table>
97
80 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a> 98 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a>
81 <h4>ProjectBrowserDirectoryItem (Constructor)</h4> 99 <h4>ProjectBrowserDirectoryItem (Constructor)</h4>
82 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>) 100 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>)
101
83 <p> 102 <p>
84 Constructor 103 Constructor
85 </p><dl> 104 </p>
105 <dl>
106
86 <dt><i>parent</i></dt> 107 <dt><i>parent</i></dt>
87 <dd> 108 <dd>
88 parent item 109 parent item
89 </dd><dt><i>dinfo</i></dt> 110 </dd>
111 <dt><i>dinfo</i></dt>
90 <dd> 112 <dd>
91 dinfo is the string for the directory (string) 113 dinfo is the string for the directory (string)
92 </dd><dt><i>projectType</i></dt> 114 </dd>
115 <dt><i>projectType</i></dt>
93 <dd> 116 <dd>
94 type of file/directory in the project 117 type of file/directory in the project
95 </dd><dt><i>full</i></dt> 118 </dd>
119 <dt><i>full</i></dt>
96 <dd> 120 <dd>
97 flag indicating full pathname should be displayed (boolean) 121 flag indicating full pathname should be displayed (boolean)
98 </dd><dt><i>bold</i></dt> 122 </dd>
123 <dt><i>bold</i></dt>
99 <dd> 124 <dd>
100 flag indicating a highlighted font (boolean) 125 flag indicating a highlighted font (boolean)
101 </dd> 126 </dd>
102 </dl> 127 </dl>
103 <div align="right"><a href="#top">Up</a></div> 128 <div align="right"><a href="#top">Up</a></div>
104 <hr /><hr /> 129 <hr />
130 <hr />
105 <a NAME="ProjectBrowserFileItem" ID="ProjectBrowserFileItem"></a> 131 <a NAME="ProjectBrowserFileItem" ID="ProjectBrowserFileItem"></a>
106 <h2>ProjectBrowserFileItem</h2> 132 <h2>ProjectBrowserFileItem</h2>
133
107 <p> 134 <p>
108 Class implementing the data structure for project browser file items. 135 Class implementing the data structure for project browser file items.
109 </p> 136 </p>
110 <h3>Derived from</h3> 137 <h3>Derived from</h3>
111 BrowserFileItem, ProjectBrowserItemMixin 138 BrowserFileItem, ProjectBrowserItemMixin
112 <h3>Class Attributes</h3> 139 <h3>Class Attributes</h3>
140
113 <table> 141 <table>
114 <tr><td>None</td></tr> 142 <tr><td>None</td></tr>
115 </table> 143 </table>
116 <h3>Class Methods</h3> 144 <h3>Class Methods</h3>
145
117 <table> 146 <table>
118 <tr><td>None</td></tr> 147 <tr><td>None</td></tr>
119 </table> 148 </table>
120 <h3>Methods</h3> 149 <h3>Methods</h3>
121 <table> 150
151 <table>
152
122 <tr> 153 <tr>
123 <td><a href="#ProjectBrowserFileItem.__init__">ProjectBrowserFileItem</a></td> 154 <td><a href="#ProjectBrowserFileItem.__init__">ProjectBrowserFileItem</a></td>
124 <td>Constructor</td> 155 <td>Constructor</td>
125 </tr> 156 </tr>
126 </table> 157 </table>
127 <h3>Static Methods</h3> 158 <h3>Static Methods</h3>
128 <table> 159
129 <tr><td>None</td></tr> 160 <table>
130 </table> 161 <tr><td>None</td></tr>
162 </table>
163
131 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a> 164 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a>
132 <h4>ProjectBrowserFileItem (Constructor)</h4> 165 <h4>ProjectBrowserFileItem (Constructor)</h4>
133 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>) 166 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>)
167
134 <p> 168 <p>
135 Constructor 169 Constructor
136 </p><dl> 170 </p>
171 <dl>
172
137 <dt><i>parent</i></dt> 173 <dt><i>parent</i></dt>
138 <dd> 174 <dd>
139 parent item 175 parent item
140 </dd><dt><i>finfo</i></dt> 176 </dd>
177 <dt><i>finfo</i></dt>
141 <dd> 178 <dd>
142 the string for the file (string) 179 the string for the file (string)
143 </dd><dt><i>projectType</i></dt> 180 </dd>
181 <dt><i>projectType</i></dt>
144 <dd> 182 <dd>
145 type of file/directory in the project 183 type of file/directory in the project
146 </dd><dt><i>full</i></dt> 184 </dd>
185 <dt><i>full</i></dt>
147 <dd> 186 <dd>
148 flag indicating full pathname should be displayed (boolean) 187 flag indicating full pathname should be displayed (boolean)
149 </dd><dt><i>bold</i></dt> 188 </dd>
189 <dt><i>bold</i></dt>
150 <dd> 190 <dd>
151 flag indicating a highlighted font (boolean) 191 flag indicating a highlighted font (boolean)
152 </dd><dt><i>sourceLanguage</i></dt> 192 </dd>
193 <dt><i>sourceLanguage</i></dt>
153 <dd> 194 <dd>
154 source code language of the project (string) 195 source code language of the project (string)
155 </dd> 196 </dd>
156 </dl> 197 </dl>
157 <div align="right"><a href="#top">Up</a></div> 198 <div align="right"><a href="#top">Up</a></div>
158 <hr /><hr /> 199 <hr />
200 <hr />
159 <a NAME="ProjectBrowserItemMixin" ID="ProjectBrowserItemMixin"></a> 201 <a NAME="ProjectBrowserItemMixin" ID="ProjectBrowserItemMixin"></a>
160 <h2>ProjectBrowserItemMixin</h2> 202 <h2>ProjectBrowserItemMixin</h2>
203
161 <p> 204 <p>
162 Class implementing common methods of project browser items. 205 Class implementing common methods of project browser items.
163 </p><p> 206 </p>
207 <p>
164 It is meant to be used as a mixin class. 208 It is meant to be used as a mixin class.
165 </p> 209 </p>
166 <h3>Derived from</h3> 210 <h3>Derived from</h3>
167 object 211 object
168 <h3>Class Attributes</h3> 212 <h3>Class Attributes</h3>
213
169 <table> 214 <table>
170 <tr><td>None</td></tr> 215 <tr><td>None</td></tr>
171 </table> 216 </table>
172 <h3>Class Methods</h3> 217 <h3>Class Methods</h3>
218
173 <table> 219 <table>
174 <tr><td>None</td></tr> 220 <tr><td>None</td></tr>
175 </table> 221 </table>
176 <h3>Methods</h3> 222 <h3>Methods</h3>
177 <table> 223
224 <table>
225
178 <tr> 226 <tr>
179 <td><a href="#ProjectBrowserItemMixin.__init__">ProjectBrowserItemMixin</a></td> 227 <td><a href="#ProjectBrowserItemMixin.__init__">ProjectBrowserItemMixin</a></td>
180 <td>Constructor</td> 228 <td>Constructor</td>
181 </tr><tr> 229 </tr>
230 <tr>
182 <td><a href="#ProjectBrowserItemMixin.addProjectType">addProjectType</a></td> 231 <td><a href="#ProjectBrowserItemMixin.addProjectType">addProjectType</a></td>
183 <td>Public method to add a type to the list.</td> 232 <td>Public method to add a type to the list.</td>
184 </tr><tr> 233 </tr>
234 <tr>
185 <td><a href="#ProjectBrowserItemMixin.addVcsStatus">addVcsStatus</a></td> 235 <td><a href="#ProjectBrowserItemMixin.addVcsStatus">addVcsStatus</a></td>
186 <td>Public method to add the VCS status.</td> 236 <td>Public method to add the VCS status.</td>
187 </tr><tr> 237 </tr>
238 <tr>
188 <td><a href="#ProjectBrowserItemMixin.getProjectTypes">getProjectTypes</a></td> 239 <td><a href="#ProjectBrowserItemMixin.getProjectTypes">getProjectTypes</a></td>
189 <td>Public method to get the project type.</td> 240 <td>Public method to get the project type.</td>
190 </tr><tr> 241 </tr>
242 <tr>
191 <td><a href="#ProjectBrowserItemMixin.getTextColor">getTextColor</a></td> 243 <td><a href="#ProjectBrowserItemMixin.getTextColor">getTextColor</a></td>
192 <td>Public method to get the items text color.</td> 244 <td>Public method to get the items text color.</td>
193 </tr><tr> 245 </tr>
246 <tr>
194 <td><a href="#ProjectBrowserItemMixin.setVcsState">setVcsState</a></td> 247 <td><a href="#ProjectBrowserItemMixin.setVcsState">setVcsState</a></td>
195 <td>Public method to set the items VCS state.</td> 248 <td>Public method to set the items VCS state.</td>
196 </tr><tr> 249 </tr>
250 <tr>
197 <td><a href="#ProjectBrowserItemMixin.setVcsStatus">setVcsStatus</a></td> 251 <td><a href="#ProjectBrowserItemMixin.setVcsStatus">setVcsStatus</a></td>
198 <td>Public method to set the VCS status.</td> 252 <td>Public method to set the VCS status.</td>
199 </tr> 253 </tr>
200 </table> 254 </table>
201 <h3>Static Methods</h3> 255 <h3>Static Methods</h3>
202 <table> 256
203 <tr><td>None</td></tr> 257 <table>
204 </table> 258 <tr><td>None</td></tr>
259 </table>
260
205 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a> 261 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a>
206 <h4>ProjectBrowserItemMixin (Constructor)</h4> 262 <h4>ProjectBrowserItemMixin (Constructor)</h4>
207 <b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>) 263 <b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>)
264
208 <p> 265 <p>
209 Constructor 266 Constructor
210 </p><dl> 267 </p>
268 <dl>
269
211 <dt><i>type_</i></dt> 270 <dt><i>type_</i></dt>
212 <dd> 271 <dd>
213 type of file/directory in the project 272 type of file/directory in the project
214 </dd><dt><i>bold</i></dt> 273 </dd>
274 <dt><i>bold</i></dt>
215 <dd> 275 <dd>
216 flag indicating a highlighted font 276 flag indicating a highlighted font
217 </dd> 277 </dd>
218 </dl><a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a> 278 </dl>
279 <a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a>
219 <h4>ProjectBrowserItemMixin.addProjectType</h4> 280 <h4>ProjectBrowserItemMixin.addProjectType</h4>
220 <b>addProjectType</b>(<i>type_</i>) 281 <b>addProjectType</b>(<i>type_</i>)
282
221 <p> 283 <p>
222 Public method to add a type to the list. 284 Public method to add a type to the list.
223 </p><dl> 285 </p>
286 <dl>
287
224 <dt><i>type_</i></dt> 288 <dt><i>type_</i></dt>
225 <dd> 289 <dd>
226 type to add to the list 290 type to add to the list
227 </dd> 291 </dd>
228 </dl><a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a> 292 </dl>
293 <a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a>
229 <h4>ProjectBrowserItemMixin.addVcsStatus</h4> 294 <h4>ProjectBrowserItemMixin.addVcsStatus</h4>
230 <b>addVcsStatus</b>(<i>vcsStatus</i>) 295 <b>addVcsStatus</b>(<i>vcsStatus</i>)
296
231 <p> 297 <p>
232 Public method to add the VCS status. 298 Public method to add the VCS status.
233 </p><dl> 299 </p>
300 <dl>
301
234 <dt><i>vcsStatus</i></dt> 302 <dt><i>vcsStatus</i></dt>
235 <dd> 303 <dd>
236 VCS status text (string) 304 VCS status text (string)
237 </dd> 305 </dd>
238 </dl><a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a> 306 </dl>
307 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a>
239 <h4>ProjectBrowserItemMixin.getProjectTypes</h4> 308 <h4>ProjectBrowserItemMixin.getProjectTypes</h4>
240 <b>getProjectTypes</b>(<i></i>) 309 <b>getProjectTypes</b>(<i></i>)
310
241 <p> 311 <p>
242 Public method to get the project type. 312 Public method to get the project type.
243 </p><dl> 313 </p>
314 <dl>
244 <dt>Returns:</dt> 315 <dt>Returns:</dt>
245 <dd> 316 <dd>
246 project type 317 project type
247 </dd> 318 </dd>
248 </dl><a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a> 319 </dl>
320 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a>
249 <h4>ProjectBrowserItemMixin.getTextColor</h4> 321 <h4>ProjectBrowserItemMixin.getTextColor</h4>
250 <b>getTextColor</b>(<i></i>) 322 <b>getTextColor</b>(<i></i>)
323
251 <p> 324 <p>
252 Public method to get the items text color. 325 Public method to get the items text color.
253 </p><dl> 326 </p>
327 <dl>
254 <dt>Returns:</dt> 328 <dt>Returns:</dt>
255 <dd> 329 <dd>
256 text color (QColor) 330 text color (QColor)
257 </dd> 331 </dd>
258 </dl><a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a> 332 </dl>
333 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a>
259 <h4>ProjectBrowserItemMixin.setVcsState</h4> 334 <h4>ProjectBrowserItemMixin.setVcsState</h4>
260 <b>setVcsState</b>(<i>state</i>) 335 <b>setVcsState</b>(<i>state</i>)
336
261 <p> 337 <p>
262 Public method to set the items VCS state. 338 Public method to set the items VCS state.
263 </p><dl> 339 </p>
340 <dl>
341
264 <dt><i>state</i></dt> 342 <dt><i>state</i></dt>
265 <dd> 343 <dd>
266 VCS state (one of A, C, M, U or " ") (string) 344 VCS state (one of A, C, M, U or " ") (string)
267 </dd> 345 </dd>
268 </dl><a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a> 346 </dl>
347 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a>
269 <h4>ProjectBrowserItemMixin.setVcsStatus</h4> 348 <h4>ProjectBrowserItemMixin.setVcsStatus</h4>
270 <b>setVcsStatus</b>(<i>vcsStatus</i>) 349 <b>setVcsStatus</b>(<i>vcsStatus</i>)
350
271 <p> 351 <p>
272 Public method to set the VCS status. 352 Public method to set the VCS status.
273 </p><dl> 353 </p>
354 <dl>
355
274 <dt><i>vcsStatus</i></dt> 356 <dt><i>vcsStatus</i></dt>
275 <dd> 357 <dd>
276 VCS status text (string) 358 VCS status text (string)
277 </dd> 359 </dd>
278 </dl> 360 </dl>
279 <div align="right"><a href="#top">Up</a></div> 361 <div align="right"><a href="#top">Up</a></div>
280 <hr /><hr /> 362 <hr />
363 <hr />
281 <a NAME="ProjectBrowserModel" ID="ProjectBrowserModel"></a> 364 <a NAME="ProjectBrowserModel" ID="ProjectBrowserModel"></a>
282 <h2>ProjectBrowserModel</h2> 365 <h2>ProjectBrowserModel</h2>
366
283 <p> 367 <p>
284 Class implementing the project browser model. 368 Class implementing the project browser model.
285 </p><h3>Signals</h3> 369 </p>
286 <dl> 370 <h3>Signals</h3>
371 <dl>
372
287 <dt>vcsStateChanged(str)</dt> 373 <dt>vcsStateChanged(str)</dt>
288 <dd> 374 <dd>
289 emitted after the VCS state has changed 375 emitted after the VCS state has changed
290 </dd> 376 </dd>
291 </dl> 377 </dl>
292 <h3>Derived from</h3> 378 <h3>Derived from</h3>
293 BrowserModel 379 BrowserModel
294 <h3>Class Attributes</h3> 380 <h3>Class Attributes</h3>
381
295 <table> 382 <table>
296 <tr><td>None</td></tr> 383 <tr><td>None</td></tr>
297 </table> 384 </table>
298 <h3>Class Methods</h3> 385 <h3>Class Methods</h3>
386
299 <table> 387 <table>
300 <tr><td>None</td></tr> 388 <tr><td>None</td></tr>
301 </table> 389 </table>
302 <h3>Methods</h3> 390 <h3>Methods</h3>
303 <table> 391
392 <table>
393
304 <tr> 394 <tr>
305 <td><a href="#ProjectBrowserModel.__init__">ProjectBrowserModel</a></td> 395 <td><a href="#ProjectBrowserModel.__init__">ProjectBrowserModel</a></td>
306 <td>Constructor</td> 396 <td>Constructor</td>
307 </tr><tr> 397 </tr>
398 <tr>
308 <td><a href="#ProjectBrowserModel.__addVCSStatus">__addVCSStatus</a></td> 399 <td><a href="#ProjectBrowserModel.__addVCSStatus">__addVCSStatus</a></td>
309 <td>Private method used to set the vcs status of a node.</td> 400 <td>Private method used to set the vcs status of a node.</td>
310 </tr><tr> 401 </tr>
402 <tr>
311 <td><a href="#ProjectBrowserModel.__changeParentsVCSState">__changeParentsVCSState</a></td> 403 <td><a href="#ProjectBrowserModel.__changeParentsVCSState">__changeParentsVCSState</a></td>
312 <td>Private method to recursively change the parents VCS state.</td> 404 <td>Private method to recursively change the parents VCS state.</td>
313 </tr><tr> 405 </tr>
406 <tr>
314 <td><a href="#ProjectBrowserModel.__updateVCSStatus">__updateVCSStatus</a></td> 407 <td><a href="#ProjectBrowserModel.__updateVCSStatus">__updateVCSStatus</a></td>
315 <td>Private method used to update the vcs status of a node.</td> 408 <td>Private method used to update the vcs status of a node.</td>
316 </tr><tr> 409 </tr>
410 <tr>
317 <td><a href="#ProjectBrowserModel.addNewItem">addNewItem</a></td> 411 <td><a href="#ProjectBrowserModel.addNewItem">addNewItem</a></td>
318 <td>Public method to add a new item to the model.</td> 412 <td>Public method to add a new item to the model.</td>
319 </tr><tr> 413 </tr>
414 <tr>
320 <td><a href="#ProjectBrowserModel.changeVCSStates">changeVCSStates</a></td> 415 <td><a href="#ProjectBrowserModel.changeVCSStates">changeVCSStates</a></td>
321 <td>Public slot to record the (non normal) VCS states.</td> 416 <td>Public slot to record the (non normal) VCS states.</td>
322 </tr><tr> 417 </tr>
418 <tr>
323 <td><a href="#ProjectBrowserModel.data">data</a></td> 419 <td><a href="#ProjectBrowserModel.data">data</a></td>
324 <td>Public method to get data of an item.</td> 420 <td>Public method to get data of an item.</td>
325 </tr><tr> 421 </tr>
422 <tr>
326 <td><a href="#ProjectBrowserModel.directoryChanged">directoryChanged</a></td> 423 <td><a href="#ProjectBrowserModel.directoryChanged">directoryChanged</a></td>
327 <td>Public slot to handle the directoryChanged signal of the watcher.</td> 424 <td>Public slot to handle the directoryChanged signal of the watcher.</td>
328 </tr><tr> 425 </tr>
426 <tr>
329 <td><a href="#ProjectBrowserModel.findChildItem">findChildItem</a></td> 427 <td><a href="#ProjectBrowserModel.findChildItem">findChildItem</a></td>
330 <td>Public method to find a child item given some text.</td> 428 <td>Public method to find a child item given some text.</td>
331 </tr><tr> 429 </tr>
430 <tr>
332 <td><a href="#ProjectBrowserModel.findItem">findItem</a></td> 431 <td><a href="#ProjectBrowserModel.findItem">findItem</a></td>
333 <td>Public method to find an item given its name.</td> 432 <td>Public method to find an item given its name.</td>
334 </tr><tr> 433 </tr>
434 <tr>
335 <td><a href="#ProjectBrowserModel.findParentItemByName">findParentItemByName</a></td> 435 <td><a href="#ProjectBrowserModel.findParentItemByName">findParentItemByName</a></td>
336 <td>Public method to find an item given its name.</td> 436 <td>Public method to find an item given its name.</td>
337 </tr><tr> 437 </tr>
438 <tr>
338 <td><a href="#ProjectBrowserModel.itemIndexByName">itemIndexByName</a></td> 439 <td><a href="#ProjectBrowserModel.itemIndexByName">itemIndexByName</a></td>
339 <td>Public method to find an item's index given its name.</td> 440 <td>Public method to find an item's index given its name.</td>
340 </tr><tr> 441 </tr>
442 <tr>
341 <td><a href="#ProjectBrowserModel.itemIndexByNameAndLine">itemIndexByNameAndLine</a></td> 443 <td><a href="#ProjectBrowserModel.itemIndexByNameAndLine">itemIndexByNameAndLine</a></td>
342 <td>Public method to find an item's index given its name.</td> 444 <td>Public method to find an item's index given its name.</td>
343 </tr><tr> 445 </tr>
446 <tr>
344 <td><a href="#ProjectBrowserModel.populateItem">populateItem</a></td> 447 <td><a href="#ProjectBrowserModel.populateItem">populateItem</a></td>
345 <td>Public method to populate an item's subtree.</td> 448 <td>Public method to populate an item's subtree.</td>
346 </tr><tr> 449 </tr>
450 <tr>
347 <td><a href="#ProjectBrowserModel.populateProjectDirectoryItem">populateProjectDirectoryItem</a></td> 451 <td><a href="#ProjectBrowserModel.populateProjectDirectoryItem">populateProjectDirectoryItem</a></td>
348 <td>Public method to populate a directory item's subtree.</td> 452 <td>Public method to populate a directory item's subtree.</td>
349 </tr><tr> 453 </tr>
454 <tr>
350 <td><a href="#ProjectBrowserModel.preferencesChanged">preferencesChanged</a></td> 455 <td><a href="#ProjectBrowserModel.preferencesChanged">preferencesChanged</a></td>
351 <td>Public method used to handle a change in preferences.</td> 456 <td>Public method used to handle a change in preferences.</td>
352 </tr><tr> 457 </tr>
458 <tr>
353 <td><a href="#ProjectBrowserModel.projectClosed">projectClosed</a></td> 459 <td><a href="#ProjectBrowserModel.projectClosed">projectClosed</a></td>
354 <td>Public method called after a project has been closed.</td> 460 <td>Public method called after a project has been closed.</td>
355 </tr><tr> 461 </tr>
462 <tr>
356 <td><a href="#ProjectBrowserModel.projectOpened">projectOpened</a></td> 463 <td><a href="#ProjectBrowserModel.projectOpened">projectOpened</a></td>
357 <td>Public method used to populate the model after a project has been opened.</td> 464 <td>Public method used to populate the model after a project has been opened.</td>
358 </tr><tr> 465 </tr>
466 <tr>
359 <td><a href="#ProjectBrowserModel.projectPropertiesChanged">projectPropertiesChanged</a></td> 467 <td><a href="#ProjectBrowserModel.projectPropertiesChanged">projectPropertiesChanged</a></td>
360 <td>Public method to react on a change of the project properties.</td> 468 <td>Public method to react on a change of the project properties.</td>
361 </tr><tr> 469 </tr>
470 <tr>
362 <td><a href="#ProjectBrowserModel.removeItem">removeItem</a></td> 471 <td><a href="#ProjectBrowserModel.removeItem">removeItem</a></td>
363 <td>Public method to remove a named item.</td> 472 <td>Public method to remove a named item.</td>
364 </tr><tr> 473 </tr>
474 <tr>
365 <td><a href="#ProjectBrowserModel.renameItem">renameItem</a></td> 475 <td><a href="#ProjectBrowserModel.renameItem">renameItem</a></td>
366 <td>Public method to rename an item.</td> 476 <td>Public method to rename an item.</td>
367 </tr><tr> 477 </tr>
478 <tr>
368 <td><a href="#ProjectBrowserModel.repopulateItem">repopulateItem</a></td> 479 <td><a href="#ProjectBrowserModel.repopulateItem">repopulateItem</a></td>
369 <td>Public method to repopulate an item.</td> 480 <td>Public method to repopulate an item.</td>
370 </tr><tr> 481 </tr>
482 <tr>
371 <td><a href="#ProjectBrowserModel.updateVCSStatus">updateVCSStatus</a></td> 483 <td><a href="#ProjectBrowserModel.updateVCSStatus">updateVCSStatus</a></td>
372 <td>Public method used to update the vcs status of a node.</td> 484 <td>Public method used to update the vcs status of a node.</td>
373 </tr> 485 </tr>
374 </table> 486 </table>
375 <h3>Static Methods</h3> 487 <h3>Static Methods</h3>
376 <table> 488
377 <tr><td>None</td></tr> 489 <table>
378 </table> 490 <tr><td>None</td></tr>
491 </table>
492
379 <a NAME="ProjectBrowserModel.__init__" ID="ProjectBrowserModel.__init__"></a> 493 <a NAME="ProjectBrowserModel.__init__" ID="ProjectBrowserModel.__init__"></a>
380 <h4>ProjectBrowserModel (Constructor)</h4> 494 <h4>ProjectBrowserModel (Constructor)</h4>
381 <b>ProjectBrowserModel</b>(<i>parent</i>) 495 <b>ProjectBrowserModel</b>(<i>parent</i>)
496
382 <p> 497 <p>
383 Constructor 498 Constructor
384 </p><dl> 499 </p>
500 <dl>
501
385 <dt><i>parent</i></dt> 502 <dt><i>parent</i></dt>
386 <dd> 503 <dd>
387 reference to parent object (Project.Project) 504 reference to parent object (Project.Project)
388 </dd> 505 </dd>
389 </dl><a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a> 506 </dl>
507 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a>
390 <h4>ProjectBrowserModel.__addVCSStatus</h4> 508 <h4>ProjectBrowserModel.__addVCSStatus</h4>
391 <b>__addVCSStatus</b>(<i>item, name</i>) 509 <b>__addVCSStatus</b>(<i>item, name</i>)
510
392 <p> 511 <p>
393 Private method used to set the vcs status of a node. 512 Private method used to set the vcs status of a node.
394 </p><dl> 513 </p>
514 <dl>
515
395 <dt><i>item</i></dt> 516 <dt><i>item</i></dt>
396 <dd> 517 <dd>
397 item to work on 518 item to work on
398 </dd><dt><i>name</i></dt> 519 </dd>
520 <dt><i>name</i></dt>
399 <dd> 521 <dd>
400 filename belonging to this item (string) 522 filename belonging to this item (string)
401 </dd> 523 </dd>
402 </dl><a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a> 524 </dl>
525 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a>
403 <h4>ProjectBrowserModel.__changeParentsVCSState</h4> 526 <h4>ProjectBrowserModel.__changeParentsVCSState</h4>
404 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>) 527 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>)
528
405 <p> 529 <p>
406 Private method to recursively change the parents VCS state. 530 Private method to recursively change the parents VCS state.
407 </p><dl> 531 </p>
532 <dl>
533
408 <dt><i>path</i></dt> 534 <dt><i>path</i></dt>
409 <dd> 535 <dd>
410 pathname of parent item (string) 536 pathname of parent item (string)
411 </dd><dt><i>itemCache</i></dt> 537 </dd>
538 <dt><i>itemCache</i></dt>
412 <dd> 539 <dd>
413 reference to the item cache used to store 540 reference to the item cache used to store
414 references to named items 541 references to named items
415 </dd> 542 </dd>
416 </dl><a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a> 543 </dl>
544 <a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a>
417 <h4>ProjectBrowserModel.__updateVCSStatus</h4> 545 <h4>ProjectBrowserModel.__updateVCSStatus</h4>
418 <b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>) 546 <b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>)
547
419 <p> 548 <p>
420 Private method used to update the vcs status of a node. 549 Private method used to update the vcs status of a node.
421 </p><dl> 550 </p>
551 <dl>
552
422 <dt><i>item</i></dt> 553 <dt><i>item</i></dt>
423 <dd> 554 <dd>
424 item to work on 555 item to work on
425 </dd><dt><i>name</i></dt> 556 </dd>
557 <dt><i>name</i></dt>
426 <dd> 558 <dd>
427 filename belonging to this item (string) 559 filename belonging to this item (string)
428 </dd><dt><i>recursive=</i></dt> 560 </dd>
561 <dt><i>recursive=</i></dt>
429 <dd> 562 <dd>
430 flag indicating a recursive update (boolean) 563 flag indicating a recursive update (boolean)
431 </dd> 564 </dd>
432 </dl><a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a> 565 </dl>
566 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a>
433 <h4>ProjectBrowserModel.addNewItem</h4> 567 <h4>ProjectBrowserModel.addNewItem</h4>
434 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>) 568 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>)
569
435 <p> 570 <p>
436 Public method to add a new item to the model. 571 Public method to add a new item to the model.
437 </p><dl> 572 </p>
573 <dl>
574
438 <dt><i>typeString</i></dt> 575 <dt><i>typeString</i></dt>
439 <dd> 576 <dd>
440 string denoting the type of the new item (string) 577 string denoting the type of the new item (string)
441 </dd><dt><i>name</i></dt> 578 </dd>
579 <dt><i>name</i></dt>
442 <dd> 580 <dd>
443 name of the new item (string) 581 name of the new item (string)
444 </dd><dt><i>additionalTypeStrings</i></dt> 582 </dd>
583 <dt><i>additionalTypeStrings</i></dt>
445 <dd> 584 <dd>
446 names of additional types (list of string) 585 names of additional types (list of string)
447 </dd> 586 </dd>
448 </dl><a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a> 587 </dl>
588 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a>
449 <h4>ProjectBrowserModel.changeVCSStates</h4> 589 <h4>ProjectBrowserModel.changeVCSStates</h4>
450 <b>changeVCSStates</b>(<i>statesList</i>) 590 <b>changeVCSStates</b>(<i>statesList</i>)
591
451 <p> 592 <p>
452 Public slot to record the (non normal) VCS states. 593 Public slot to record the (non normal) VCS states.
453 </p><dl> 594 </p>
595 <dl>
596
454 <dt><i>statesList</i></dt> 597 <dt><i>statesList</i></dt>
455 <dd> 598 <dd>
456 list of VCS state entries (list of strings) giving 599 list of VCS state entries (list of strings) giving
457 the states in the first column and the path relative to the project 600 the states in the first column and the path relative to the project
458 directory starting with the third column. The allowed status flags 601 directory starting with the third column. The allowed status flags
465 <li>"U" path needs an update</li> 608 <li>"U" path needs an update</li>
466 <li>"Z" path contains a conflict</li> 609 <li>"Z" path contains a conflict</li>
467 <li>" " path is back at normal</li> 610 <li>" " path is back at normal</li>
468 </ul> 611 </ul>
469 </dd> 612 </dd>
470 </dl><a NAME="ProjectBrowserModel.data" ID="ProjectBrowserModel.data"></a> 613 </dl>
614 <a NAME="ProjectBrowserModel.data" ID="ProjectBrowserModel.data"></a>
471 <h4>ProjectBrowserModel.data</h4> 615 <h4>ProjectBrowserModel.data</h4>
472 <b>data</b>(<i>index, role</i>) 616 <b>data</b>(<i>index, role</i>)
617
473 <p> 618 <p>
474 Public method to get data of an item. 619 Public method to get data of an item.
475 </p><dl> 620 </p>
621 <dl>
622
476 <dt><i>index</i></dt> 623 <dt><i>index</i></dt>
477 <dd> 624 <dd>
478 index of the data to retrieve (QModelIndex) 625 index of the data to retrieve (QModelIndex)
479 </dd><dt><i>role</i></dt> 626 </dd>
627 <dt><i>role</i></dt>
480 <dd> 628 <dd>
481 role of data (Qt.ItemDataRole) 629 role of data (Qt.ItemDataRole)
482 </dd> 630 </dd>
483 </dl><dl> 631 </dl>
632 <dl>
484 <dt>Returns:</dt> 633 <dt>Returns:</dt>
485 <dd> 634 <dd>
486 requested data 635 requested data
487 </dd> 636 </dd>
488 </dl><a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a> 637 </dl>
638 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a>
489 <h4>ProjectBrowserModel.directoryChanged</h4> 639 <h4>ProjectBrowserModel.directoryChanged</h4>
490 <b>directoryChanged</b>(<i>path</i>) 640 <b>directoryChanged</b>(<i>path</i>)
641
491 <p> 642 <p>
492 Public slot to handle the directoryChanged signal of the watcher. 643 Public slot to handle the directoryChanged signal of the watcher.
493 </p><dl> 644 </p>
645 <dl>
646
494 <dt><i>path</i></dt> 647 <dt><i>path</i></dt>
495 <dd> 648 <dd>
496 path of the directory (string) 649 path of the directory (string)
497 </dd> 650 </dd>
498 </dl><a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a> 651 </dl>
652 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a>
499 <h4>ProjectBrowserModel.findChildItem</h4> 653 <h4>ProjectBrowserModel.findChildItem</h4>
500 <b>findChildItem</b>(<i>text, column, parentItem=None</i>) 654 <b>findChildItem</b>(<i>text, column, parentItem=None</i>)
655
501 <p> 656 <p>
502 Public method to find a child item given some text. 657 Public method to find a child item given some text.
503 </p><dl> 658 </p>
659 <dl>
660
504 <dt><i>text</i></dt> 661 <dt><i>text</i></dt>
505 <dd> 662 <dd>
506 text to search for (string) 663 text to search for (string)
507 </dd><dt><i>column</i></dt> 664 </dd>
665 <dt><i>column</i></dt>
508 <dd> 666 <dd>
509 column to search in (integer) 667 column to search in (integer)
510 </dd><dt><i>parentItem</i></dt> 668 </dd>
669 <dt><i>parentItem</i></dt>
511 <dd> 670 <dd>
512 reference to parent item 671 reference to parent item
513 </dd> 672 </dd>
514 </dl><dl> 673 </dl>
674 <dl>
515 <dt>Returns:</dt> 675 <dt>Returns:</dt>
516 <dd> 676 <dd>
517 reference to the item found 677 reference to the item found
518 </dd> 678 </dd>
519 </dl><a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a> 679 </dl>
680 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a>
520 <h4>ProjectBrowserModel.findItem</h4> 681 <h4>ProjectBrowserModel.findItem</h4>
521 <b>findItem</b>(<i>name</i>) 682 <b>findItem</b>(<i>name</i>)
683
522 <p> 684 <p>
523 Public method to find an item given its name. 685 Public method to find an item given its name.
524 </p><dl> 686 </p>
687 <dl>
688
525 <dt><i>name</i></dt> 689 <dt><i>name</i></dt>
526 <dd> 690 <dd>
527 name of the item (string) 691 name of the item (string)
528 </dd> 692 </dd>
529 </dl><dl> 693 </dl>
694 <dl>
530 <dt>Returns:</dt> 695 <dt>Returns:</dt>
531 <dd> 696 <dd>
532 reference to the item found 697 reference to the item found
533 </dd> 698 </dd>
534 </dl><a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a> 699 </dl>
700 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a>
535 <h4>ProjectBrowserModel.findParentItemByName</h4> 701 <h4>ProjectBrowserModel.findParentItemByName</h4>
536 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>) 702 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>)
703
537 <p> 704 <p>
538 Public method to find an item given its name. 705 Public method to find an item given its name.
539 </p><p> 706 </p>
707 <p>
540 <b>Note</b>: This method creates all necessary parent items, if they 708 <b>Note</b>: This method creates all necessary parent items, if they
541 don't exist. 709 don't exist.
542 </p><dl> 710 </p>
711 <dl>
712
543 <dt><i>type_</i></dt> 713 <dt><i>type_</i></dt>
544 <dd> 714 <dd>
545 type of the item 715 type of the item
546 </dd><dt><i>name</i></dt> 716 </dd>
717 <dt><i>name</i></dt>
547 <dd> 718 <dd>
548 name of the item (string) 719 name of the item (string)
549 </dd><dt><i>dontSplit</i></dt> 720 </dd>
721 <dt><i>dontSplit</i></dt>
550 <dd> 722 <dd>
551 flag indicating the name should not be split (boolean) 723 flag indicating the name should not be split (boolean)
552 </dd> 724 </dd>
553 </dl><dl> 725 </dl>
726 <dl>
554 <dt>Returns:</dt> 727 <dt>Returns:</dt>
555 <dd> 728 <dd>
556 reference to the item found and the new display name (string) 729 reference to the item found and the new display name (string)
557 </dd> 730 </dd>
558 </dl><a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a> 731 </dl>
732 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a>
559 <h4>ProjectBrowserModel.itemIndexByName</h4> 733 <h4>ProjectBrowserModel.itemIndexByName</h4>
560 <b>itemIndexByName</b>(<i>name</i>) 734 <b>itemIndexByName</b>(<i>name</i>)
735
561 <p> 736 <p>
562 Public method to find an item's index given its name. 737 Public method to find an item's index given its name.
563 </p><dl> 738 </p>
739 <dl>
740
564 <dt><i>name</i></dt> 741 <dt><i>name</i></dt>
565 <dd> 742 <dd>
566 name of the item (string) 743 name of the item (string)
567 </dd> 744 </dd>
568 </dl><dl> 745 </dl>
746 <dl>
569 <dt>Returns:</dt> 747 <dt>Returns:</dt>
570 <dd> 748 <dd>
571 index of the item found (QModelIndex) 749 index of the item found (QModelIndex)
572 </dd> 750 </dd>
573 </dl><a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a> 751 </dl>
752 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a>
574 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4> 753 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4>
575 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>) 754 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>)
755
576 <p> 756 <p>
577 Public method to find an item's index given its name. 757 Public method to find an item's index given its name.
578 </p><dl> 758 </p>
759 <dl>
760
579 <dt><i>name</i></dt> 761 <dt><i>name</i></dt>
580 <dd> 762 <dd>
581 name of the item (string) 763 name of the item (string)
582 </dd><dt><i>lineno</i></dt> 764 </dd>
765 <dt><i>lineno</i></dt>
583 <dd> 766 <dd>
584 one based line number of the item (integer) 767 one based line number of the item (integer)
585 </dd> 768 </dd>
586 </dl><dl> 769 </dl>
770 <dl>
587 <dt>Returns:</dt> 771 <dt>Returns:</dt>
588 <dd> 772 <dd>
589 index of the item found (QModelIndex) 773 index of the item found (QModelIndex)
590 </dd> 774 </dd>
591 </dl><a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a> 775 </dl>
776 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a>
592 <h4>ProjectBrowserModel.populateItem</h4> 777 <h4>ProjectBrowserModel.populateItem</h4>
593 <b>populateItem</b>(<i>parentItem, repopulate=False</i>) 778 <b>populateItem</b>(<i>parentItem, repopulate=False</i>)
779
594 <p> 780 <p>
595 Public method to populate an item's subtree. 781 Public method to populate an item's subtree.
596 </p><dl> 782 </p>
783 <dl>
784
597 <dt><i>parentItem</i></dt> 785 <dt><i>parentItem</i></dt>
598 <dd> 786 <dd>
599 reference to the item to be populated 787 reference to the item to be populated
600 </dd><dt><i>repopulate</i></dt> 788 </dd>
789 <dt><i>repopulate</i></dt>
601 <dd> 790 <dd>
602 flag indicating a repopulation (boolean) 791 flag indicating a repopulation (boolean)
603 </dd> 792 </dd>
604 </dl><a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a> 793 </dl>
794 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a>
605 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4> 795 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4>
606 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>) 796 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>)
797
607 <p> 798 <p>
608 Public method to populate a directory item's subtree. 799 Public method to populate a directory item's subtree.
609 </p><dl> 800 </p>
801 <dl>
802
610 <dt><i>parentItem</i></dt> 803 <dt><i>parentItem</i></dt>
611 <dd> 804 <dd>
612 reference to the directory item to be populated 805 reference to the directory item to be populated
613 </dd><dt><i>repopulate</i></dt> 806 </dd>
807 <dt><i>repopulate</i></dt>
614 <dd> 808 <dd>
615 flag indicating a repopulation (boolean) 809 flag indicating a repopulation (boolean)
616 </dd> 810 </dd>
617 </dl><a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a> 811 </dl>
812 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a>
618 <h4>ProjectBrowserModel.preferencesChanged</h4> 813 <h4>ProjectBrowserModel.preferencesChanged</h4>
619 <b>preferencesChanged</b>(<i></i>) 814 <b>preferencesChanged</b>(<i></i>)
815
620 <p> 816 <p>
621 Public method used to handle a change in preferences. 817 Public method used to handle a change in preferences.
622 </p><a NAME="ProjectBrowserModel.projectClosed" ID="ProjectBrowserModel.projectClosed"></a> 818 </p>
819 <a NAME="ProjectBrowserModel.projectClosed" ID="ProjectBrowserModel.projectClosed"></a>
623 <h4>ProjectBrowserModel.projectClosed</h4> 820 <h4>ProjectBrowserModel.projectClosed</h4>
624 <b>projectClosed</b>(<i></i>) 821 <b>projectClosed</b>(<i></i>)
822
625 <p> 823 <p>
626 Public method called after a project has been closed. 824 Public method called after a project has been closed.
627 </p><a NAME="ProjectBrowserModel.projectOpened" ID="ProjectBrowserModel.projectOpened"></a> 825 </p>
826 <a NAME="ProjectBrowserModel.projectOpened" ID="ProjectBrowserModel.projectOpened"></a>
628 <h4>ProjectBrowserModel.projectOpened</h4> 827 <h4>ProjectBrowserModel.projectOpened</h4>
629 <b>projectOpened</b>(<i></i>) 828 <b>projectOpened</b>(<i></i>)
829
630 <p> 830 <p>
631 Public method used to populate the model after a project has been 831 Public method used to populate the model after a project has been
632 opened. 832 opened.
633 </p><a NAME="ProjectBrowserModel.projectPropertiesChanged" ID="ProjectBrowserModel.projectPropertiesChanged"></a> 833 </p>
834 <a NAME="ProjectBrowserModel.projectPropertiesChanged" ID="ProjectBrowserModel.projectPropertiesChanged"></a>
634 <h4>ProjectBrowserModel.projectPropertiesChanged</h4> 835 <h4>ProjectBrowserModel.projectPropertiesChanged</h4>
635 <b>projectPropertiesChanged</b>(<i></i>) 836 <b>projectPropertiesChanged</b>(<i></i>)
837
636 <p> 838 <p>
637 Public method to react on a change of the project properties. 839 Public method to react on a change of the project properties.
638 </p><a NAME="ProjectBrowserModel.removeItem" ID="ProjectBrowserModel.removeItem"></a> 840 </p>
841 <a NAME="ProjectBrowserModel.removeItem" ID="ProjectBrowserModel.removeItem"></a>
639 <h4>ProjectBrowserModel.removeItem</h4> 842 <h4>ProjectBrowserModel.removeItem</h4>
640 <b>removeItem</b>(<i>name</i>) 843 <b>removeItem</b>(<i>name</i>)
844
641 <p> 845 <p>
642 Public method to remove a named item. 846 Public method to remove a named item.
643 </p><dl> 847 </p>
848 <dl>
849
644 <dt><i>name</i></dt> 850 <dt><i>name</i></dt>
645 <dd> 851 <dd>
646 file or directory name of the item (string). 852 file or directory name of the item (string).
647 </dd> 853 </dd>
648 </dl><a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a> 854 </dl>
855 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a>
649 <h4>ProjectBrowserModel.renameItem</h4> 856 <h4>ProjectBrowserModel.renameItem</h4>
650 <b>renameItem</b>(<i>name, newFilename</i>) 857 <b>renameItem</b>(<i>name, newFilename</i>)
858
651 <p> 859 <p>
652 Public method to rename an item. 860 Public method to rename an item.
653 </p><dl> 861 </p>
862 <dl>
863
654 <dt><i>name</i></dt> 864 <dt><i>name</i></dt>
655 <dd> 865 <dd>
656 the old display name (string) 866 the old display name (string)
657 </dd><dt><i>newFilename</i></dt> 867 </dd>
868 <dt><i>newFilename</i></dt>
658 <dd> 869 <dd>
659 new filename of the item (string) 870 new filename of the item (string)
660 </dd> 871 </dd>
661 </dl><a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a> 872 </dl>
873 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a>
662 <h4>ProjectBrowserModel.repopulateItem</h4> 874 <h4>ProjectBrowserModel.repopulateItem</h4>
663 <b>repopulateItem</b>(<i>name</i>) 875 <b>repopulateItem</b>(<i>name</i>)
876
664 <p> 877 <p>
665 Public method to repopulate an item. 878 Public method to repopulate an item.
666 </p><dl> 879 </p>
880 <dl>
881
667 <dt><i>name</i></dt> 882 <dt><i>name</i></dt>
668 <dd> 883 <dd>
669 name of the file relative to the project root (string) 884 name of the file relative to the project root (string)
670 </dd> 885 </dd>
671 </dl><a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a> 886 </dl>
887 <a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a>
672 <h4>ProjectBrowserModel.updateVCSStatus</h4> 888 <h4>ProjectBrowserModel.updateVCSStatus</h4>
673 <b>updateVCSStatus</b>(<i>name, recursive=True</i>) 889 <b>updateVCSStatus</b>(<i>name, recursive=True</i>)
890
674 <p> 891 <p>
675 Public method used to update the vcs status of a node. 892 Public method used to update the vcs status of a node.
676 </p><dl> 893 </p>
894 <dl>
895
677 <dt><i>name</i></dt> 896 <dt><i>name</i></dt>
678 <dd> 897 <dd>
679 filename belonging to this item (string) 898 filename belonging to this item (string)
680 </dd><dt><i>recursive</i></dt> 899 </dd>
900 <dt><i>recursive</i></dt>
681 <dd> 901 <dd>
682 flag indicating a recursive update (boolean) 902 flag indicating a recursive update (boolean)
683 </dd> 903 </dd>
684 </dl> 904 </dl>
685 <div align="right"><a href="#top">Up</a></div> 905 <div align="right"><a href="#top">Up</a></div>
686 <hr /><hr /> 906 <hr />
907 <hr />
687 <a NAME="ProjectBrowserSimpleDirectoryItem" ID="ProjectBrowserSimpleDirectoryItem"></a> 908 <a NAME="ProjectBrowserSimpleDirectoryItem" ID="ProjectBrowserSimpleDirectoryItem"></a>
688 <h2>ProjectBrowserSimpleDirectoryItem</h2> 909 <h2>ProjectBrowserSimpleDirectoryItem</h2>
910
689 <p> 911 <p>
690 Class implementing the data structure for project browser simple directory 912 Class implementing the data structure for project browser simple directory
691 items. 913 items.
692 </p> 914 </p>
693 <h3>Derived from</h3> 915 <h3>Derived from</h3>
694 BrowserItem, ProjectBrowserItemMixin 916 BrowserItem, ProjectBrowserItemMixin
695 <h3>Class Attributes</h3> 917 <h3>Class Attributes</h3>
918
696 <table> 919 <table>
697 <tr><td>None</td></tr> 920 <tr><td>None</td></tr>
698 </table> 921 </table>
699 <h3>Class Methods</h3> 922 <h3>Class Methods</h3>
923
700 <table> 924 <table>
701 <tr><td>None</td></tr> 925 <tr><td>None</td></tr>
702 </table> 926 </table>
703 <h3>Methods</h3> 927 <h3>Methods</h3>
704 <table> 928
929 <table>
930
705 <tr> 931 <tr>
706 <td><a href="#ProjectBrowserSimpleDirectoryItem.__init__">ProjectBrowserSimpleDirectoryItem</a></td> 932 <td><a href="#ProjectBrowserSimpleDirectoryItem.__init__">ProjectBrowserSimpleDirectoryItem</a></td>
707 <td>Constructor</td> 933 <td>Constructor</td>
708 </tr><tr> 934 </tr>
935 <tr>
709 <td><a href="#ProjectBrowserSimpleDirectoryItem.dirName">dirName</a></td> 936 <td><a href="#ProjectBrowserSimpleDirectoryItem.dirName">dirName</a></td>
710 <td>Public method returning the directory name.</td> 937 <td>Public method returning the directory name.</td>
711 </tr><tr> 938 </tr>
939 <tr>
712 <td><a href="#ProjectBrowserSimpleDirectoryItem.lessThan">lessThan</a></td> 940 <td><a href="#ProjectBrowserSimpleDirectoryItem.lessThan">lessThan</a></td>
713 <td>Public method to check, if the item is less than the other one.</td> 941 <td>Public method to check, if the item is less than the other one.</td>
714 </tr><tr> 942 </tr>
943 <tr>
715 <td><a href="#ProjectBrowserSimpleDirectoryItem.name">name</a></td> 944 <td><a href="#ProjectBrowserSimpleDirectoryItem.name">name</a></td>
716 <td>Public method to return the name of the item.</td> 945 <td>Public method to return the name of the item.</td>
717 </tr><tr> 946 </tr>
947 <tr>
718 <td><a href="#ProjectBrowserSimpleDirectoryItem.setName">setName</a></td> 948 <td><a href="#ProjectBrowserSimpleDirectoryItem.setName">setName</a></td>
719 <td>Public method to set the directory name.</td> 949 <td>Public method to set the directory name.</td>
720 </tr> 950 </tr>
721 </table> 951 </table>
722 <h3>Static Methods</h3> 952 <h3>Static Methods</h3>
723 <table> 953
724 <tr><td>None</td></tr> 954 <table>
725 </table> 955 <tr><td>None</td></tr>
956 </table>
957
726 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a> 958 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a>
727 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4> 959 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4>
728 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>) 960 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>)
961
729 <p> 962 <p>
730 Constructor 963 Constructor
731 </p><dl> 964 </p>
965 <dl>
966
732 <dt><i>parent</i></dt> 967 <dt><i>parent</i></dt>
733 <dd> 968 <dd>
734 parent item 969 parent item
735 </dd><dt><i>projectType</i></dt> 970 </dd>
971 <dt><i>projectType</i></dt>
736 <dd> 972 <dd>
737 type of file/directory in the project 973 type of file/directory in the project
738 </dd><dt><i>text</i></dt> 974 </dd>
975 <dt><i>text</i></dt>
739 <dd> 976 <dd>
740 text to be displayed (string) 977 text to be displayed (string)
741 </dd><dt><i>path</i></dt> 978 </dd>
979 <dt><i>path</i></dt>
742 <dd> 980 <dd>
743 path of the directory (string) 981 path of the directory (string)
744 </dd> 982 </dd>
745 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.dirName" ID="ProjectBrowserSimpleDirectoryItem.dirName"></a> 983 </dl>
984 <a NAME="ProjectBrowserSimpleDirectoryItem.dirName" ID="ProjectBrowserSimpleDirectoryItem.dirName"></a>
746 <h4>ProjectBrowserSimpleDirectoryItem.dirName</h4> 985 <h4>ProjectBrowserSimpleDirectoryItem.dirName</h4>
747 <b>dirName</b>(<i></i>) 986 <b>dirName</b>(<i></i>)
987
748 <p> 988 <p>
749 Public method returning the directory name. 989 Public method returning the directory name.
750 </p><dl> 990 </p>
991 <dl>
751 <dt>Returns:</dt> 992 <dt>Returns:</dt>
752 <dd> 993 <dd>
753 directory name (string) 994 directory name (string)
754 </dd> 995 </dd>
755 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.lessThan" ID="ProjectBrowserSimpleDirectoryItem.lessThan"></a> 996 </dl>
997 <a NAME="ProjectBrowserSimpleDirectoryItem.lessThan" ID="ProjectBrowserSimpleDirectoryItem.lessThan"></a>
756 <h4>ProjectBrowserSimpleDirectoryItem.lessThan</h4> 998 <h4>ProjectBrowserSimpleDirectoryItem.lessThan</h4>
757 <b>lessThan</b>(<i>other, column, order</i>) 999 <b>lessThan</b>(<i>other, column, order</i>)
1000
758 <p> 1001 <p>
759 Public method to check, if the item is less than the other one. 1002 Public method to check, if the item is less than the other one.
760 </p><dl> 1003 </p>
1004 <dl>
1005
761 <dt><i>other</i></dt> 1006 <dt><i>other</i></dt>
762 <dd> 1007 <dd>
763 reference to item to compare against (BrowserItem) 1008 reference to item to compare against (BrowserItem)
764 </dd><dt><i>column</i></dt> 1009 </dd>
1010 <dt><i>column</i></dt>
765 <dd> 1011 <dd>
766 column number to use for the comparison (integer) 1012 column number to use for the comparison (integer)
767 </dd><dt><i>order</i></dt> 1013 </dd>
1014 <dt><i>order</i></dt>
768 <dd> 1015 <dd>
769 sort order (Qt.SortOrder) (for special sorting) 1016 sort order (Qt.SortOrder) (for special sorting)
770 </dd> 1017 </dd>
771 </dl><dl> 1018 </dl>
1019 <dl>
772 <dt>Returns:</dt> 1020 <dt>Returns:</dt>
773 <dd> 1021 <dd>
774 true, if this item is less than other (boolean) 1022 true, if this item is less than other (boolean)
775 </dd> 1023 </dd>
776 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.name" ID="ProjectBrowserSimpleDirectoryItem.name"></a> 1024 </dl>
1025 <a NAME="ProjectBrowserSimpleDirectoryItem.name" ID="ProjectBrowserSimpleDirectoryItem.name"></a>
777 <h4>ProjectBrowserSimpleDirectoryItem.name</h4> 1026 <h4>ProjectBrowserSimpleDirectoryItem.name</h4>
778 <b>name</b>(<i></i>) 1027 <b>name</b>(<i></i>)
1028
779 <p> 1029 <p>
780 Public method to return the name of the item. 1030 Public method to return the name of the item.
781 </p><dl> 1031 </p>
1032 <dl>
782 <dt>Returns:</dt> 1033 <dt>Returns:</dt>
783 <dd> 1034 <dd>
784 name of the item (string) 1035 name of the item (string)
785 </dd> 1036 </dd>
786 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.setName" ID="ProjectBrowserSimpleDirectoryItem.setName"></a> 1037 </dl>
1038 <a NAME="ProjectBrowserSimpleDirectoryItem.setName" ID="ProjectBrowserSimpleDirectoryItem.setName"></a>
787 <h4>ProjectBrowserSimpleDirectoryItem.setName</h4> 1039 <h4>ProjectBrowserSimpleDirectoryItem.setName</h4>
788 <b>setName</b>(<i>dinfo, full=True</i>) 1040 <b>setName</b>(<i>dinfo, full=True</i>)
1041
789 <p> 1042 <p>
790 Public method to set the directory name. 1043 Public method to set the directory name.
791 </p><dl> 1044 </p>
1045 <dl>
1046
792 <dt><i>dinfo</i></dt> 1047 <dt><i>dinfo</i></dt>
793 <dd> 1048 <dd>
794 dinfo is the string for the directory (string) 1049 dinfo is the string for the directory (string)
795 </dd><dt><i>full</i></dt> 1050 </dd>
1051 <dt><i>full</i></dt>
796 <dd> 1052 <dd>
797 flag indicating full pathname should be displayed (boolean) 1053 flag indicating full pathname should be displayed (boolean)
798 </dd> 1054 </dd>
799 </dl> 1055 </dl>
800 <div align="right"><a href="#top">Up</a></div> 1056 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial