Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html

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

branch
eric7
changeset 10479
856476537696
parent 10472
3aecfec97f7c
child 10679
4d3e0ce54322
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.ProjectBrowserModel</h1> 9 <h1>eric7.Project.ProjectBrowserModel</h1>
10
11 <p> 10 <p>
12 Module implementing the browser model. 11 Module implementing the browser model.
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="#ProjectBrowserDirectoryItem">ProjectBrowserDirectoryItem</a></td> 22 <td><a href="#ProjectBrowserDirectoryItem">ProjectBrowserDirectoryItem</a></td>
25 <td>Class implementing the data structure for project browser directory items.</td> 23 <td>Class implementing the data structure for project browser directory items.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
39 <tr> 37 <tr>
40 <td><a href="#ProjectBrowserSimpleDirectoryItem">ProjectBrowserSimpleDirectoryItem</a></td> 38 <td><a href="#ProjectBrowserSimpleDirectoryItem">ProjectBrowserSimpleDirectoryItem</a></td>
41 <td>Class implementing the data structure for project browser simple directory items.</td> 39 <td>Class implementing the data structure for project browser simple directory items.</td>
42 </tr> 40 </tr>
43 </table> 41 </table>
42
44 <h3>Functions</h3> 43 <h3>Functions</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <hr /> 48 <hr />
50 <hr /> 49 <hr />
51 <a NAME="ProjectBrowserDirectoryItem" ID="ProjectBrowserDirectoryItem"></a> 50 <a NAME="ProjectBrowserDirectoryItem" ID="ProjectBrowserDirectoryItem"></a>
52 <h2>ProjectBrowserDirectoryItem</h2> 51 <h2>ProjectBrowserDirectoryItem</h2>
53
54 <p> 52 <p>
55 Class implementing the data structure for project browser directory items. 53 Class implementing the data structure for project browser directory items.
56 </p> 54 </p>
55
57 <h3>Derived from</h3> 56 <h3>Derived from</h3>
58 BrowserDirectoryItem, ProjectBrowserItemMixin 57 BrowserDirectoryItem, ProjectBrowserItemMixin
59 <h3>Class Attributes</h3> 58 <h3>Class Attributes</h3>
60 59 <table>
61 <table> 60 <tr><td>None</td></tr>
62 <tr><td>None</td></tr> 61 </table>
63 </table> 62
64 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
65 64 <table>
66 <table> 65 <tr><td>None</td></tr>
67 <tr><td>None</td></tr> 66 </table>
68 </table> 67
69 <h3>Methods</h3> 68 <h3>Methods</h3>
70 69 <table>
71 <table>
72
73 <tr> 70 <tr>
74 <td><a href="#ProjectBrowserDirectoryItem.__init__">ProjectBrowserDirectoryItem</a></td> 71 <td><a href="#ProjectBrowserDirectoryItem.__init__">ProjectBrowserDirectoryItem</a></td>
75 <td>Constructor</td> 72 <td>Constructor</td>
76 </tr> 73 </tr>
77 </table> 74 </table>
75
78 <h3>Static Methods</h3> 76 <h3>Static Methods</h3>
79 77 <table>
80 <table> 78 <tr><td>None</td></tr>
81 <tr><td>None</td></tr> 79 </table>
82 </table> 80
83 81
84 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a> 82 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a>
85 <h4>ProjectBrowserDirectoryItem (Constructor)</h4> 83 <h4>ProjectBrowserDirectoryItem (Constructor)</h4>
86 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>) 84 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>)
87
88 <p> 85 <p>
89 Constructor 86 Constructor
90 </p> 87 </p>
88
91 <dl> 89 <dl>
92 90
93 <dt><i>parent</i> (BrowserItem)</dt> 91 <dt><i>parent</i> (BrowserItem)</dt>
94 <dd> 92 <dd>
95 parent item 93 parent item
114 <div align="right"><a href="#top">Up</a></div> 112 <div align="right"><a href="#top">Up</a></div>
115 <hr /> 113 <hr />
116 <hr /> 114 <hr />
117 <a NAME="ProjectBrowserFileItem" ID="ProjectBrowserFileItem"></a> 115 <a NAME="ProjectBrowserFileItem" ID="ProjectBrowserFileItem"></a>
118 <h2>ProjectBrowserFileItem</h2> 116 <h2>ProjectBrowserFileItem</h2>
119
120 <p> 117 <p>
121 Class implementing the data structure for project browser file items. 118 Class implementing the data structure for project browser file items.
122 </p> 119 </p>
120
123 <h3>Derived from</h3> 121 <h3>Derived from</h3>
124 BrowserFileItem, ProjectBrowserItemMixin 122 BrowserFileItem, ProjectBrowserItemMixin
125 <h3>Class Attributes</h3> 123 <h3>Class Attributes</h3>
126 124 <table>
127 <table> 125 <tr><td>None</td></tr>
128 <tr><td>None</td></tr> 126 </table>
129 </table> 127
130 <h3>Class Methods</h3> 128 <h3>Class Methods</h3>
131 129 <table>
132 <table> 130 <tr><td>None</td></tr>
133 <tr><td>None</td></tr> 131 </table>
134 </table> 132
135 <h3>Methods</h3> 133 <h3>Methods</h3>
136 134 <table>
137 <table>
138
139 <tr> 135 <tr>
140 <td><a href="#ProjectBrowserFileItem.__init__">ProjectBrowserFileItem</a></td> 136 <td><a href="#ProjectBrowserFileItem.__init__">ProjectBrowserFileItem</a></td>
141 <td>Constructor</td> 137 <td>Constructor</td>
142 </tr> 138 </tr>
143 </table> 139 </table>
140
144 <h3>Static Methods</h3> 141 <h3>Static Methods</h3>
145 142 <table>
146 <table> 143 <tr><td>None</td></tr>
147 <tr><td>None</td></tr> 144 </table>
148 </table> 145
149 146
150 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a> 147 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a>
151 <h4>ProjectBrowserFileItem (Constructor)</h4> 148 <h4>ProjectBrowserFileItem (Constructor)</h4>
152 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>) 149 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>)
153
154 <p> 150 <p>
155 Constructor 151 Constructor
156 </p> 152 </p>
153
157 <dl> 154 <dl>
158 155
159 <dt><i>parent</i> (BrowserItem)</dt> 156 <dt><i>parent</i> (BrowserItem)</dt>
160 <dd> 157 <dd>
161 parent item 158 parent item
184 <div align="right"><a href="#top">Up</a></div> 181 <div align="right"><a href="#top">Up</a></div>
185 <hr /> 182 <hr />
186 <hr /> 183 <hr />
187 <a NAME="ProjectBrowserItemMixin" ID="ProjectBrowserItemMixin"></a> 184 <a NAME="ProjectBrowserItemMixin" ID="ProjectBrowserItemMixin"></a>
188 <h2>ProjectBrowserItemMixin</h2> 185 <h2>ProjectBrowserItemMixin</h2>
189
190 <p> 186 <p>
191 Class implementing common methods of project browser items. 187 Class implementing common methods of project browser items.
192 </p> 188 </p>
193 <p> 189 <p>
194 It is meant to be used as a mixin class. 190 It is meant to be used as a mixin class.
195 </p> 191 </p>
192
196 <h3>Derived from</h3> 193 <h3>Derived from</h3>
197 None 194 None
198 <h3>Class Attributes</h3> 195 <h3>Class Attributes</h3>
199 196 <table>
200 <table> 197 <tr><td>None</td></tr>
201 <tr><td>None</td></tr> 198 </table>
202 </table> 199
203 <h3>Class Methods</h3> 200 <h3>Class Methods</h3>
204 201 <table>
205 <table> 202 <tr><td>None</td></tr>
206 <tr><td>None</td></tr> 203 </table>
207 </table> 204
208 <h3>Methods</h3> 205 <h3>Methods</h3>
209 206 <table>
210 <table>
211
212 <tr> 207 <tr>
213 <td><a href="#ProjectBrowserItemMixin.__init__">ProjectBrowserItemMixin</a></td> 208 <td><a href="#ProjectBrowserItemMixin.__init__">ProjectBrowserItemMixin</a></td>
214 <td>Constructor</td> 209 <td>Constructor</td>
215 </tr> 210 </tr>
216 <tr> 211 <tr>
236 <tr> 231 <tr>
237 <td><a href="#ProjectBrowserItemMixin.setVcsStatus">setVcsStatus</a></td> 232 <td><a href="#ProjectBrowserItemMixin.setVcsStatus">setVcsStatus</a></td>
238 <td>Public method to set the VCS status.</td> 233 <td>Public method to set the VCS status.</td>
239 </tr> 234 </tr>
240 </table> 235 </table>
236
241 <h3>Static Methods</h3> 237 <h3>Static Methods</h3>
242 238 <table>
243 <table> 239 <tr><td>None</td></tr>
244 <tr><td>None</td></tr> 240 </table>
245 </table> 241
246 242
247 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a> 243 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a>
248 <h4>ProjectBrowserItemMixin (Constructor)</h4> 244 <h4>ProjectBrowserItemMixin (Constructor)</h4>
249 <b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>) 245 <b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>)
250
251 <p> 246 <p>
252 Constructor 247 Constructor
253 </p> 248 </p>
249
254 <dl> 250 <dl>
255 251
256 <dt><i>type_</i> (str)</dt> 252 <dt><i>type_</i> (str)</dt>
257 <dd> 253 <dd>
258 type of file/directory in the project 254 type of file/directory in the project
263 </dd> 259 </dd>
264 </dl> 260 </dl>
265 <a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a> 261 <a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a>
266 <h4>ProjectBrowserItemMixin.addProjectType</h4> 262 <h4>ProjectBrowserItemMixin.addProjectType</h4>
267 <b>addProjectType</b>(<i>type_</i>) 263 <b>addProjectType</b>(<i>type_</i>)
268
269 <p> 264 <p>
270 Public method to add a type to the list. 265 Public method to add a type to the list.
271 </p> 266 </p>
267
272 <dl> 268 <dl>
273 269
274 <dt><i>type_</i> (str)</dt> 270 <dt><i>type_</i> (str)</dt>
275 <dd> 271 <dd>
276 type to add to the list 272 type to add to the list
277 </dd> 273 </dd>
278 </dl> 274 </dl>
279 <a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a> 275 <a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a>
280 <h4>ProjectBrowserItemMixin.addVcsStatus</h4> 276 <h4>ProjectBrowserItemMixin.addVcsStatus</h4>
281 <b>addVcsStatus</b>(<i>vcsStatus</i>) 277 <b>addVcsStatus</b>(<i>vcsStatus</i>)
282
283 <p> 278 <p>
284 Public method to add the VCS status. 279 Public method to add the VCS status.
285 </p> 280 </p>
281
286 <dl> 282 <dl>
287 283
288 <dt><i>vcsStatus</i> (str)</dt> 284 <dt><i>vcsStatus</i> (str)</dt>
289 <dd> 285 <dd>
290 VCS status text 286 VCS status text
291 </dd> 287 </dd>
292 </dl> 288 </dl>
293 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a> 289 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a>
294 <h4>ProjectBrowserItemMixin.getProjectTypes</h4> 290 <h4>ProjectBrowserItemMixin.getProjectTypes</h4>
295 <b>getProjectTypes</b>(<i></i>) 291 <b>getProjectTypes</b>(<i></i>)
296
297 <p> 292 <p>
298 Public method to get the project type. 293 Public method to get the project type.
299 </p> 294 </p>
295
300 <dl> 296 <dl>
301 <dt>Return:</dt> 297 <dt>Return:</dt>
302 <dd> 298 <dd>
303 project type 299 project type
304 </dd> 300 </dd>
310 </dd> 306 </dd>
311 </dl> 307 </dl>
312 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a> 308 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a>
313 <h4>ProjectBrowserItemMixin.getTextColor</h4> 309 <h4>ProjectBrowserItemMixin.getTextColor</h4>
314 <b>getTextColor</b>(<i></i>) 310 <b>getTextColor</b>(<i></i>)
315
316 <p> 311 <p>
317 Public method to get the items text color. 312 Public method to get the items text color.
318 </p> 313 </p>
314
319 <dl> 315 <dl>
320 <dt>Return:</dt> 316 <dt>Return:</dt>
321 <dd> 317 <dd>
322 text color 318 text color
323 </dd> 319 </dd>
329 </dd> 325 </dd>
330 </dl> 326 </dl>
331 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a> 327 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a>
332 <h4>ProjectBrowserItemMixin.setVcsState</h4> 328 <h4>ProjectBrowserItemMixin.setVcsState</h4>
333 <b>setVcsState</b>(<i>state</i>) 329 <b>setVcsState</b>(<i>state</i>)
334
335 <p> 330 <p>
336 Public method to set the items VCS state. 331 Public method to set the items VCS state.
337 </p> 332 </p>
333
338 <dl> 334 <dl>
339 335
340 <dt><i>state</i> (str)</dt> 336 <dt><i>state</i> (str)</dt>
341 <dd> 337 <dd>
342 VCS state (one of A, C, M, U or " ") 338 VCS state (one of A, C, M, U or " ")
343 </dd> 339 </dd>
344 </dl> 340 </dl>
345 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a> 341 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a>
346 <h4>ProjectBrowserItemMixin.setVcsStatus</h4> 342 <h4>ProjectBrowserItemMixin.setVcsStatus</h4>
347 <b>setVcsStatus</b>(<i>vcsStatus</i>) 343 <b>setVcsStatus</b>(<i>vcsStatus</i>)
348
349 <p> 344 <p>
350 Public method to set the VCS status. 345 Public method to set the VCS status.
351 </p> 346 </p>
347
352 <dl> 348 <dl>
353 349
354 <dt><i>vcsStatus</i> (str)</dt> 350 <dt><i>vcsStatus</i> (str)</dt>
355 <dd> 351 <dd>
356 VCS status text 352 VCS status text
359 <div align="right"><a href="#top">Up</a></div> 355 <div align="right"><a href="#top">Up</a></div>
360 <hr /> 356 <hr />
361 <hr /> 357 <hr />
362 <a NAME="ProjectBrowserModel" ID="ProjectBrowserModel"></a> 358 <a NAME="ProjectBrowserModel" ID="ProjectBrowserModel"></a>
363 <h2>ProjectBrowserModel</h2> 359 <h2>ProjectBrowserModel</h2>
364
365 <p> 360 <p>
366 Class implementing the project browser model. 361 Class implementing the project browser model.
367 </p> 362 </p>
363
368 <h3>Signals</h3> 364 <h3>Signals</h3>
369 <dl> 365 <dl>
370 366
371 <dt>vcsStateChanged(str)</dt> 367 <dt>vcsStateChanged(str)</dt>
372 <dd> 368 <dd>
374 </dd> 370 </dd>
375 </dl> 371 </dl>
376 <h3>Derived from</h3> 372 <h3>Derived from</h3>
377 BrowserModel 373 BrowserModel
378 <h3>Class Attributes</h3> 374 <h3>Class Attributes</h3>
379 375 <table>
380 <table> 376 <tr><td>None</td></tr>
381 <tr><td>None</td></tr> 377 </table>
382 </table> 378
383 <h3>Class Methods</h3> 379 <h3>Class Methods</h3>
384 380 <table>
385 <table> 381 <tr><td>None</td></tr>
386 <tr><td>None</td></tr> 382 </table>
387 </table> 383
388 <h3>Methods</h3> 384 <h3>Methods</h3>
389 385 <table>
390 <table>
391
392 <tr> 386 <tr>
393 <td><a href="#ProjectBrowserModel.__init__">ProjectBrowserModel</a></td> 387 <td><a href="#ProjectBrowserModel.__init__">ProjectBrowserModel</a></td>
394 <td>Constructor</td> 388 <td>Constructor</td>
395 </tr> 389 </tr>
396 <tr> 390 <tr>
492 <tr> 486 <tr>
493 <td><a href="#ProjectBrowserModel.updateVCSStatus">updateVCSStatus</a></td> 487 <td><a href="#ProjectBrowserModel.updateVCSStatus">updateVCSStatus</a></td>
494 <td>Public method used to update the vcs status of a node.</td> 488 <td>Public method used to update the vcs status of a node.</td>
495 </tr> 489 </tr>
496 </table> 490 </table>
491
497 <h3>Static Methods</h3> 492 <h3>Static Methods</h3>
498 493 <table>
499 <table> 494 <tr><td>None</td></tr>
500 <tr><td>None</td></tr> 495 </table>
501 </table> 496
502 497
503 <a NAME="ProjectBrowserModel.__init__" ID="ProjectBrowserModel.__init__"></a> 498 <a NAME="ProjectBrowserModel.__init__" ID="ProjectBrowserModel.__init__"></a>
504 <h4>ProjectBrowserModel (Constructor)</h4> 499 <h4>ProjectBrowserModel (Constructor)</h4>
505 <b>ProjectBrowserModel</b>(<i>parent</i>) 500 <b>ProjectBrowserModel</b>(<i>parent</i>)
506
507 <p> 501 <p>
508 Constructor 502 Constructor
509 </p> 503 </p>
504
510 <dl> 505 <dl>
511 506
512 <dt><i>parent</i> (Project.Project)</dt> 507 <dt><i>parent</i> (Project.Project)</dt>
513 <dd> 508 <dd>
514 reference to parent object 509 reference to parent object
515 </dd> 510 </dd>
516 </dl> 511 </dl>
517 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a> 512 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a>
518 <h4>ProjectBrowserModel.__addVCSStatus</h4> 513 <h4>ProjectBrowserModel.__addVCSStatus</h4>
519 <b>__addVCSStatus</b>(<i>item, name</i>) 514 <b>__addVCSStatus</b>(<i>item, name</i>)
520
521 <p> 515 <p>
522 Private method used to set the vcs status of a node. 516 Private method used to set the vcs status of a node.
523 </p> 517 </p>
518
524 <dl> 519 <dl>
525 520
526 <dt><i>item</i> (BrowserItem)</dt> 521 <dt><i>item</i> (BrowserItem)</dt>
527 <dd> 522 <dd>
528 item to work on 523 item to work on
533 </dd> 528 </dd>
534 </dl> 529 </dl>
535 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a> 530 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a>
536 <h4>ProjectBrowserModel.__changeParentsVCSState</h4> 531 <h4>ProjectBrowserModel.__changeParentsVCSState</h4>
537 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>) 532 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>)
538
539 <p> 533 <p>
540 Private method to recursively change the parents VCS state. 534 Private method to recursively change the parents VCS state.
541 </p> 535 </p>
536
542 <dl> 537 <dl>
543 538
544 <dt><i>path</i> (str)</dt> 539 <dt><i>path</i> (str)</dt>
545 <dd> 540 <dd>
546 pathname of parent item 541 pathname of parent item
552 </dd> 547 </dd>
553 </dl> 548 </dl>
554 <a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a> 549 <a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a>
555 <h4>ProjectBrowserModel.__updateVCSStatus</h4> 550 <h4>ProjectBrowserModel.__updateVCSStatus</h4>
556 <b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>) 551 <b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>)
557
558 <p> 552 <p>
559 Private method used to update the vcs status of a node. 553 Private method used to update the vcs status of a node.
560 </p> 554 </p>
555
561 <dl> 556 <dl>
562 557
563 <dt><i>item</i> (BrowserItem)</dt> 558 <dt><i>item</i> (BrowserItem)</dt>
564 <dd> 559 <dd>
565 item to work on 560 item to work on
574 </dd> 569 </dd>
575 </dl> 570 </dl>
576 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a> 571 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a>
577 <h4>ProjectBrowserModel.addNewItem</h4> 572 <h4>ProjectBrowserModel.addNewItem</h4>
578 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>) 573 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>)
579
580 <p> 574 <p>
581 Public method to add a new item to the model. 575 Public method to add a new item to the model.
582 </p> 576 </p>
577
583 <dl> 578 <dl>
584 579
585 <dt><i>typeString</i> (str)</dt> 580 <dt><i>typeString</i> (str)</dt>
586 <dd> 581 <dd>
587 string denoting the type of the new item 582 string denoting the type of the new item
596 </dd> 591 </dd>
597 </dl> 592 </dl>
598 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a> 593 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a>
599 <h4>ProjectBrowserModel.changeVCSStates</h4> 594 <h4>ProjectBrowserModel.changeVCSStates</h4>
600 <b>changeVCSStates</b>(<i>statesList</i>) 595 <b>changeVCSStates</b>(<i>statesList</i>)
601
602 <p> 596 <p>
603 Public slot to record the (non normal) VCS states. 597 Public slot to record the (non normal) VCS states.
604 </p> 598 </p>
599
605 <dl> 600 <dl>
606 601
607 <dt><i>statesList</i> (list of str)</dt> 602 <dt><i>statesList</i> (list of str)</dt>
608 <dd> 603 <dd>
609 list of VCS state entries giving the states in the 604 list of VCS state entries giving the states in the
621 </dd> 616 </dd>
622 </dl> 617 </dl>
623 <a NAME="ProjectBrowserModel.data" ID="ProjectBrowserModel.data"></a> 618 <a NAME="ProjectBrowserModel.data" ID="ProjectBrowserModel.data"></a>
624 <h4>ProjectBrowserModel.data</h4> 619 <h4>ProjectBrowserModel.data</h4>
625 <b>data</b>(<i>index, role</i>) 620 <b>data</b>(<i>index, role</i>)
626
627 <p> 621 <p>
628 Public method to get data of an item. 622 Public method to get data of an item.
629 </p> 623 </p>
624
630 <dl> 625 <dl>
631 626
632 <dt><i>index</i> (QModelIndex)</dt> 627 <dt><i>index</i> (QModelIndex)</dt>
633 <dd> 628 <dd>
634 index of the data to retrieve 629 index of the data to retrieve
651 </dd> 646 </dd>
652 </dl> 647 </dl>
653 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a> 648 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a>
654 <h4>ProjectBrowserModel.directoryChanged</h4> 649 <h4>ProjectBrowserModel.directoryChanged</h4>
655 <b>directoryChanged</b>(<i>path</i>) 650 <b>directoryChanged</b>(<i>path</i>)
656
657 <p> 651 <p>
658 Public slot to handle the directoryChanged signal of the watcher. 652 Public slot to handle the directoryChanged signal of the watcher.
659 </p> 653 </p>
654
660 <dl> 655 <dl>
661 656
662 <dt><i>path</i> (str)</dt> 657 <dt><i>path</i> (str)</dt>
663 <dd> 658 <dd>
664 path of the directory 659 path of the directory
665 </dd> 660 </dd>
666 </dl> 661 </dl>
667 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a> 662 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a>
668 <h4>ProjectBrowserModel.findChildItem</h4> 663 <h4>ProjectBrowserModel.findChildItem</h4>
669 <b>findChildItem</b>(<i>text, column, parentItem=None</i>) 664 <b>findChildItem</b>(<i>text, column, parentItem=None</i>)
670
671 <p> 665 <p>
672 Public method to find a child item given some text. 666 Public method to find a child item given some text.
673 </p> 667 </p>
668
674 <dl> 669 <dl>
675 670
676 <dt><i>text</i> (str)</dt> 671 <dt><i>text</i> (str)</dt>
677 <dd> 672 <dd>
678 text to search for 673 text to search for
699 </dd> 694 </dd>
700 </dl> 695 </dl>
701 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a> 696 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a>
702 <h4>ProjectBrowserModel.findItem</h4> 697 <h4>ProjectBrowserModel.findItem</h4>
703 <b>findItem</b>(<i>name</i>) 698 <b>findItem</b>(<i>name</i>)
704
705 <p> 699 <p>
706 Public method to find an item given its name. 700 Public method to find an item given its name.
707 </p> 701 </p>
702
708 <dl> 703 <dl>
709 704
710 <dt><i>name</i> (str)</dt> 705 <dt><i>name</i> (str)</dt>
711 <dd> 706 <dd>
712 name of the item 707 name of the item
725 </dd> 720 </dd>
726 </dl> 721 </dl>
727 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a> 722 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a>
728 <h4>ProjectBrowserModel.findParentItemByName</h4> 723 <h4>ProjectBrowserModel.findParentItemByName</h4>
729 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>) 724 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>)
730
731 <p> 725 <p>
732 Public method to find an item given its name. 726 Public method to find an item given its name.
733 </p> 727 </p>
734 <p> 728 <p>
735 <b>Note</b>: This method creates all necessary parent items, if they 729 <b>Note</b>: This method creates all necessary parent items, if they
736 don't exist. 730 don't exist.
737 </p> 731 </p>
732
738 <dl> 733 <dl>
739 734
740 <dt><i>type_</i> (str)</dt> 735 <dt><i>type_</i> (str)</dt>
741 <dd> 736 <dd>
742 type of the item 737 type of the item
763 </dd> 758 </dd>
764 </dl> 759 </dl>
765 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a> 760 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a>
766 <h4>ProjectBrowserModel.itemIndexByName</h4> 761 <h4>ProjectBrowserModel.itemIndexByName</h4>
767 <b>itemIndexByName</b>(<i>name</i>) 762 <b>itemIndexByName</b>(<i>name</i>)
768
769 <p> 763 <p>
770 Public method to find an item's index given its name. 764 Public method to find an item's index given its name.
771 </p> 765 </p>
766
772 <dl> 767 <dl>
773 768
774 <dt><i>name</i> (str)</dt> 769 <dt><i>name</i> (str)</dt>
775 <dd> 770 <dd>
776 name of the item 771 name of the item
789 </dd> 784 </dd>
790 </dl> 785 </dl>
791 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a> 786 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a>
792 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4> 787 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4>
793 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>) 788 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>)
794
795 <p> 789 <p>
796 Public method to find an item's index given its name. 790 Public method to find an item's index given its name.
797 </p> 791 </p>
792
798 <dl> 793 <dl>
799 794
800 <dt><i>name</i> (str)</dt> 795 <dt><i>name</i> (str)</dt>
801 <dd> 796 <dd>
802 name of the item 797 name of the item
819 </dd> 814 </dd>
820 </dl> 815 </dl>
821 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a> 816 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a>
822 <h4>ProjectBrowserModel.populateItem</h4> 817 <h4>ProjectBrowserModel.populateItem</h4>
823 <b>populateItem</b>(<i>parentItem, repopulate=False</i>) 818 <b>populateItem</b>(<i>parentItem, repopulate=False</i>)
824
825 <p> 819 <p>
826 Public method to populate an item's subtree. 820 Public method to populate an item's subtree.
827 </p> 821 </p>
822
828 <dl> 823 <dl>
829 824
830 <dt><i>parentItem</i> (BrowserItem)</dt> 825 <dt><i>parentItem</i> (BrowserItem)</dt>
831 <dd> 826 <dd>
832 reference to the item to be populated 827 reference to the item to be populated
837 </dd> 832 </dd>
838 </dl> 833 </dl>
839 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a> 834 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a>
840 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4> 835 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4>
841 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>) 836 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>)
842
843 <p> 837 <p>
844 Public method to populate a directory item's subtree. 838 Public method to populate a directory item's subtree.
845 </p> 839 </p>
840
846 <dl> 841 <dl>
847 842
848 <dt><i>parentItem</i> (BrowserItem)</dt> 843 <dt><i>parentItem</i> (BrowserItem)</dt>
849 <dd> 844 <dd>
850 reference to the directory item to be populated 845 reference to the directory item to be populated
855 </dd> 850 </dd>
856 </dl> 851 </dl>
857 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a> 852 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a>
858 <h4>ProjectBrowserModel.preferencesChanged</h4> 853 <h4>ProjectBrowserModel.preferencesChanged</h4>
859 <b>preferencesChanged</b>(<i></i>) 854 <b>preferencesChanged</b>(<i></i>)
860
861 <p> 855 <p>
862 Public method used to handle a change in preferences. 856 Public method used to handle a change in preferences.
863 </p> 857 </p>
858
864 <a NAME="ProjectBrowserModel.projectClosed" ID="ProjectBrowserModel.projectClosed"></a> 859 <a NAME="ProjectBrowserModel.projectClosed" ID="ProjectBrowserModel.projectClosed"></a>
865 <h4>ProjectBrowserModel.projectClosed</h4> 860 <h4>ProjectBrowserModel.projectClosed</h4>
866 <b>projectClosed</b>(<i></i>) 861 <b>projectClosed</b>(<i></i>)
867
868 <p> 862 <p>
869 Public method called after a project has been closed. 863 Public method called after a project has been closed.
870 </p> 864 </p>
865
871 <a NAME="ProjectBrowserModel.projectOpened" ID="ProjectBrowserModel.projectOpened"></a> 866 <a NAME="ProjectBrowserModel.projectOpened" ID="ProjectBrowserModel.projectOpened"></a>
872 <h4>ProjectBrowserModel.projectOpened</h4> 867 <h4>ProjectBrowserModel.projectOpened</h4>
873 <b>projectOpened</b>(<i></i>) 868 <b>projectOpened</b>(<i></i>)
874
875 <p> 869 <p>
876 Public method used to populate the model after a project has been 870 Public method used to populate the model after a project has been
877 opened. 871 opened.
878 </p> 872 </p>
873
879 <a NAME="ProjectBrowserModel.projectPropertiesChanged" ID="ProjectBrowserModel.projectPropertiesChanged"></a> 874 <a NAME="ProjectBrowserModel.projectPropertiesChanged" ID="ProjectBrowserModel.projectPropertiesChanged"></a>
880 <h4>ProjectBrowserModel.projectPropertiesChanged</h4> 875 <h4>ProjectBrowserModel.projectPropertiesChanged</h4>
881 <b>projectPropertiesChanged</b>(<i></i>) 876 <b>projectPropertiesChanged</b>(<i></i>)
882
883 <p> 877 <p>
884 Public method to react on a change of the project properties. 878 Public method to react on a change of the project properties.
885 </p> 879 </p>
880
886 <a NAME="ProjectBrowserModel.removeItem" ID="ProjectBrowserModel.removeItem"></a> 881 <a NAME="ProjectBrowserModel.removeItem" ID="ProjectBrowserModel.removeItem"></a>
887 <h4>ProjectBrowserModel.removeItem</h4> 882 <h4>ProjectBrowserModel.removeItem</h4>
888 <b>removeItem</b>(<i>name</i>) 883 <b>removeItem</b>(<i>name</i>)
889
890 <p> 884 <p>
891 Public method to remove a named item. 885 Public method to remove a named item.
892 </p> 886 </p>
887
893 <dl> 888 <dl>
894 889
895 <dt><i>name</i> (str)</dt> 890 <dt><i>name</i> (str)</dt>
896 <dd> 891 <dd>
897 file or directory name of the item 892 file or directory name of the item
898 </dd> 893 </dd>
899 </dl> 894 </dl>
900 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a> 895 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a>
901 <h4>ProjectBrowserModel.renameItem</h4> 896 <h4>ProjectBrowserModel.renameItem</h4>
902 <b>renameItem</b>(<i>name, newFilename</i>) 897 <b>renameItem</b>(<i>name, newFilename</i>)
903
904 <p> 898 <p>
905 Public method to rename an item. 899 Public method to rename an item.
906 </p> 900 </p>
901
907 <dl> 902 <dl>
908 903
909 <dt><i>name</i> (str)</dt> 904 <dt><i>name</i> (str)</dt>
910 <dd> 905 <dd>
911 the old display name 906 the old display name
916 </dd> 911 </dd>
917 </dl> 912 </dl>
918 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a> 913 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a>
919 <h4>ProjectBrowserModel.repopulateItem</h4> 914 <h4>ProjectBrowserModel.repopulateItem</h4>
920 <b>repopulateItem</b>(<i>name</i>) 915 <b>repopulateItem</b>(<i>name</i>)
921
922 <p> 916 <p>
923 Public method to repopulate an item. 917 Public method to repopulate an item.
924 </p> 918 </p>
919
925 <dl> 920 <dl>
926 921
927 <dt><i>name</i> (str)</dt> 922 <dt><i>name</i> (str)</dt>
928 <dd> 923 <dd>
929 name of the file relative to the project root 924 name of the file relative to the project root
930 </dd> 925 </dd>
931 </dl> 926 </dl>
932 <a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a> 927 <a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a>
933 <h4>ProjectBrowserModel.setProjectBrowserReference</h4> 928 <h4>ProjectBrowserModel.setProjectBrowserReference</h4>
934 <b>setProjectBrowserReference</b>(<i>projectBrowser</i>) 929 <b>setProjectBrowserReference</b>(<i>projectBrowser</i>)
935
936 <p> 930 <p>
937 Public method to set a reference to the project browser instance. 931 Public method to set a reference to the project browser instance.
938 </p> 932 </p>
933
939 <dl> 934 <dl>
940 935
941 <dt><i>projectBrowser</i> (ProjectBrowser)</dt> 936 <dt><i>projectBrowser</i> (ProjectBrowser)</dt>
942 <dd> 937 <dd>
943 reference to the project browser instance 938 reference to the project browser instance
944 </dd> 939 </dd>
945 </dl> 940 </dl>
946 <a NAME="ProjectBrowserModel.startFileSystemMonitoring" ID="ProjectBrowserModel.startFileSystemMonitoring"></a> 941 <a NAME="ProjectBrowserModel.startFileSystemMonitoring" ID="ProjectBrowserModel.startFileSystemMonitoring"></a>
947 <h4>ProjectBrowserModel.startFileSystemMonitoring</h4> 942 <h4>ProjectBrowserModel.startFileSystemMonitoring</h4>
948 <b>startFileSystemMonitoring</b>(<i></i>) 943 <b>startFileSystemMonitoring</b>(<i></i>)
949
950 <p> 944 <p>
951 Public method to (re)start monitoring the project file system. 945 Public method to (re)start monitoring the project file system.
952 </p> 946 </p>
947
953 <a NAME="ProjectBrowserModel.stopFileSystemMonitoring" ID="ProjectBrowserModel.stopFileSystemMonitoring"></a> 948 <a NAME="ProjectBrowserModel.stopFileSystemMonitoring" ID="ProjectBrowserModel.stopFileSystemMonitoring"></a>
954 <h4>ProjectBrowserModel.stopFileSystemMonitoring</h4> 949 <h4>ProjectBrowserModel.stopFileSystemMonitoring</h4>
955 <b>stopFileSystemMonitoring</b>(<i></i>) 950 <b>stopFileSystemMonitoring</b>(<i></i>)
956
957 <p> 951 <p>
958 Public method to stop monitoring the project file system. 952 Public method to stop monitoring the project file system.
959 </p> 953 </p>
954
960 <a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a> 955 <a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a>
961 <h4>ProjectBrowserModel.updateVCSStatus</h4> 956 <h4>ProjectBrowserModel.updateVCSStatus</h4>
962 <b>updateVCSStatus</b>(<i>name, recursive=True</i>) 957 <b>updateVCSStatus</b>(<i>name, recursive=True</i>)
963
964 <p> 958 <p>
965 Public method used to update the vcs status of a node. 959 Public method used to update the vcs status of a node.
966 </p> 960 </p>
961
967 <dl> 962 <dl>
968 963
969 <dt><i>name</i> (str)</dt> 964 <dt><i>name</i> (str)</dt>
970 <dd> 965 <dd>
971 filename belonging to this item 966 filename belonging to this item
978 <div align="right"><a href="#top">Up</a></div> 973 <div align="right"><a href="#top">Up</a></div>
979 <hr /> 974 <hr />
980 <hr /> 975 <hr />
981 <a NAME="ProjectBrowserSimpleDirectoryItem" ID="ProjectBrowserSimpleDirectoryItem"></a> 976 <a NAME="ProjectBrowserSimpleDirectoryItem" ID="ProjectBrowserSimpleDirectoryItem"></a>
982 <h2>ProjectBrowserSimpleDirectoryItem</h2> 977 <h2>ProjectBrowserSimpleDirectoryItem</h2>
983
984 <p> 978 <p>
985 Class implementing the data structure for project browser simple directory 979 Class implementing the data structure for project browser simple directory
986 items. 980 items.
987 </p> 981 </p>
982
988 <h3>Derived from</h3> 983 <h3>Derived from</h3>
989 BrowserSimpleDirectoryItem, ProjectBrowserItemMixin 984 BrowserSimpleDirectoryItem, ProjectBrowserItemMixin
990 <h3>Class Attributes</h3> 985 <h3>Class Attributes</h3>
991 986 <table>
992 <table> 987 <tr><td>None</td></tr>
993 <tr><td>None</td></tr> 988 </table>
994 </table> 989
995 <h3>Class Methods</h3> 990 <h3>Class Methods</h3>
996 991 <table>
997 <table> 992 <tr><td>None</td></tr>
998 <tr><td>None</td></tr> 993 </table>
999 </table> 994
1000 <h3>Methods</h3> 995 <h3>Methods</h3>
1001 996 <table>
1002 <table>
1003
1004 <tr> 997 <tr>
1005 <td><a href="#ProjectBrowserSimpleDirectoryItem.__init__">ProjectBrowserSimpleDirectoryItem</a></td> 998 <td><a href="#ProjectBrowserSimpleDirectoryItem.__init__">ProjectBrowserSimpleDirectoryItem</a></td>
1006 <td>Constructor</td> 999 <td>Constructor</td>
1007 </tr> 1000 </tr>
1008 </table> 1001 </table>
1002
1009 <h3>Static Methods</h3> 1003 <h3>Static Methods</h3>
1010 1004 <table>
1011 <table> 1005 <tr><td>None</td></tr>
1012 <tr><td>None</td></tr> 1006 </table>
1013 </table> 1007
1014 1008
1015 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a> 1009 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a>
1016 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4> 1010 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4>
1017 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>) 1011 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>)
1018
1019 <p> 1012 <p>
1020 Constructor 1013 Constructor
1021 </p> 1014 </p>
1015
1022 <dl> 1016 <dl>
1023 1017
1024 <dt><i>parent</i> (BrowserItem)</dt> 1018 <dt><i>parent</i> (BrowserItem)</dt>
1025 <dd> 1019 <dd>
1026 parent item 1020 parent item

Mercurial Repository: eric

eric ide

mercurial