src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ProjectBrowserHelper.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 10259
b51dfacef37f
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
176 <p> 176 <p>
177 Constructor 177 Constructor
178 </p> 178 </p>
179 <dl> 179 <dl>
180 180
181 <dt><i>vcsObject</i></dt> 181 <dt><i>vcsObject</i> (Hg)</dt>
182 <dd> 182 <dd>
183 reference to the vcs object 183 reference to the vcs object
184 </dd> 184 </dd>
185 <dt><i>browserObject</i></dt> 185 <dt><i>browserObject</i> (ProjectBaseBrowser)</dt>
186 <dd> 186 <dd>
187 reference to the project browser object 187 reference to the project browser object
188 </dd> 188 </dd>
189 <dt><i>projectObject</i></dt> 189 <dt><i>projectObject</i> (Project)</dt>
190 <dd> 190 <dd>
191 reference to the project object 191 reference to the project object
192 </dd> 192 </dd>
193 <dt><i>isTranslationsBrowser</i></dt> 193 <dt><i>isTranslationsBrowser</i> (bool)</dt>
194 <dd> 194 <dd>
195 flag indicating, the helper is requested 195 flag indicating, the helper is requested
196 for the translations browser (this needs some special treatment) 196 for the translations browser (this needs some special treatment)
197 </dd> 197 </dd>
198 <dt><i>parent</i></dt> 198 <dt><i>parent</i> (QWidget)</dt>
199 <dd> 199 <dd>
200 parent widget (QWidget) 200 parent widget
201 </dd> 201 </dd>
202 <dt><i>name</i></dt> 202 <dt><i>name</i> (str)</dt>
203 <dd> 203 <dd>
204 name of this object (string) 204 name of this object
205 </dd> 205 </dd>
206 </dl> 206 </dl>
207 <a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a> 207 <a NAME="HgProjectBrowserHelper.__HgAnnotate" ID="HgProjectBrowserHelper.__HgAnnotate"></a>
208 <h4>HgProjectBrowserHelper.__HgAnnotate</h4> 208 <h4>HgProjectBrowserHelper.__HgAnnotate</h4>
209 <b>__HgAnnotate</b>(<i></i>) 209 <b>__HgAnnotate</b>(<i></i>)
323 <p> 323 <p>
324 Private method to add an extension menu entry. 324 Private method to add an extension menu entry.
325 </p> 325 </p>
326 <dl> 326 <dl>
327 327
328 <dt><i>menu</i></dt> 328 <dt><i>menu</i> (QMenu)</dt>
329 <dd> 329 <dd>
330 menu to add it to (QMenu) 330 menu to add it to
331 </dd> 331 </dd>
332 <dt><i>key</i></dt> 332 <dt><i>key</i> (str)</dt>
333 <dd> 333 <dd>
334 menu key (string, one of 'mainMenu', 'multiMenu', 334 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
335 'backMenu', 'dirMenu' or 'dirMultiMenu') 335 or 'dirMultiMenu')
336 </dd> 336 </dd>
337 </dl> 337 </dl>
338 <dl> 338 <dl>
339 <dt>Return:</dt> 339 <dt>Return:</dt>
340 <dd> 340 <dd>
341 reference to the menu action (QAction) 341 reference to the menu action
342 </dd>
343 </dl>
344 <dl>
345 <dt>Return Type:</dt>
346 <dd>
347 QAction
342 </dd> 348 </dd>
343 </dl> 349 </dl>
344 <a NAME="HgProjectBrowserHelper.__showExtensionMenu" ID="HgProjectBrowserHelper.__showExtensionMenu"></a> 350 <a NAME="HgProjectBrowserHelper.__showExtensionMenu" ID="HgProjectBrowserHelper.__showExtensionMenu"></a>
345 <h4>HgProjectBrowserHelper.__showExtensionMenu</h4> 351 <h4>HgProjectBrowserHelper.__showExtensionMenu</h4>
346 <b>__showExtensionMenu</b>(<i>key, controlled</i>) 352 <b>__showExtensionMenu</b>(<i>key, controlled</i>)
348 <p> 354 <p>
349 Private slot showing the extensions menu. 355 Private slot showing the extensions menu.
350 </p> 356 </p>
351 <dl> 357 <dl>
352 358
353 <dt><i>key</i></dt> 359 <dt><i>key</i> (str)</dt>
354 <dd> 360 <dd>
355 menu key (string, one of 'mainMenu', 'multiMenu', 361 menu key (one of 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu'
356 'backMenu', 'dirMenu' or 'dirMultiMenu') 362 or 'dirMultiMenu')
357 </dd> 363 </dd>
358 <dt><i>controlled</i></dt> 364 <dt><i>controlled</i> (bool)</dt>
359 <dd> 365 <dd>
360 flag indicating to show the menu for a 366 flag indicating to show the menu for a
361 version controlled entry or a non-version controlled entry 367 version controlled entry or a non-version controlled entry
362 (boolean)
363 </dd> 368 </dd>
364 </dl> 369 </dl>
365 <a NAME="HgProjectBrowserHelper.__skipListFileName" ID="HgProjectBrowserHelper.__skipListFileName"></a> 370 <a NAME="HgProjectBrowserHelper.__skipListFileName" ID="HgProjectBrowserHelper.__skipListFileName"></a>
366 <h4>HgProjectBrowserHelper.__skipListFileName</h4> 371 <h4>HgProjectBrowserHelper.__skipListFileName</h4>
367 <b>__skipListFileName</b>(<i></i>) 372 <b>__skipListFileName</b>(<i></i>)
388 <p> 393 <p>
389 Protected method used to add the VCS menu to all project browsers. 394 Protected method used to add the VCS menu to all project browsers.
390 </p> 395 </p>
391 <dl> 396 <dl>
392 397
393 <dt><i>mainMenu</i></dt> 398 <dt><i>mainMenu</i> (QMenu)</dt>
394 <dd> 399 <dd>
395 reference to the menu to be amended 400 reference to the menu to be amended
396 </dd> 401 </dd>
397 </dl> 402 </dl>
398 <a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a> 403 <a NAME="HgProjectBrowserHelper._addVCSMenuBack" ID="HgProjectBrowserHelper._addVCSMenuBack"></a>
402 <p> 407 <p>
403 Protected method used to add the VCS menu to all project browsers. 408 Protected method used to add the VCS menu to all project browsers.
404 </p> 409 </p>
405 <dl> 410 <dl>
406 411
407 <dt><i>mainMenu</i></dt> 412 <dt><i>mainMenu</i> (QMenu)</dt>
408 <dd> 413 <dd>
409 reference to the menu to be amended 414 reference to the menu to be amended
410 </dd> 415 </dd>
411 </dl> 416 </dl>
412 <a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a> 417 <a NAME="HgProjectBrowserHelper._addVCSMenuDir" ID="HgProjectBrowserHelper._addVCSMenuDir"></a>
416 <p> 421 <p>
417 Protected method used to add the VCS menu to all project browsers. 422 Protected method used to add the VCS menu to all project browsers.
418 </p> 423 </p>
419 <dl> 424 <dl>
420 425
421 <dt><i>mainMenu</i></dt> 426 <dt><i>mainMenu</i> (QMenu)</dt>
422 <dd> 427 <dd>
423 reference to the menu to be amended 428 reference to the menu to be amended
424 </dd> 429 </dd>
425 </dl> 430 </dl>
426 <a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a> 431 <a NAME="HgProjectBrowserHelper._addVCSMenuDirMulti" ID="HgProjectBrowserHelper._addVCSMenuDirMulti"></a>
430 <p> 435 <p>
431 Protected method used to add the VCS menu to all project browsers. 436 Protected method used to add the VCS menu to all project browsers.
432 </p> 437 </p>
433 <dl> 438 <dl>
434 439
435 <dt><i>mainMenu</i></dt> 440 <dt><i>mainMenu</i> (QMenu)</dt>
436 <dd> 441 <dd>
437 reference to the menu to be amended 442 reference to the menu to be amended
438 </dd> 443 </dd>
439 </dl> 444 </dl>
440 <a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a> 445 <a NAME="HgProjectBrowserHelper._addVCSMenuMulti" ID="HgProjectBrowserHelper._addVCSMenuMulti"></a>
445 Protected method used to add the VCS menu for multi selection to all 450 Protected method used to add the VCS menu for multi selection to all
446 project browsers. 451 project browsers.
447 </p> 452 </p>
448 <dl> 453 <dl>
449 454
450 <dt><i>mainMenu</i></dt> 455 <dt><i>mainMenu</i> (QMenu)</dt>
451 <dd> 456 <dd>
452 reference to the menu to be amended 457 reference to the menu to be amended
453 </dd> 458 </dd>
454 </dl> 459 </dl>
455 <a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a> 460 <a NAME="HgProjectBrowserHelper.showContextMenu" ID="HgProjectBrowserHelper.showContextMenu"></a>
463 It enables/disables the VCS menu entries depending on the overall 468 It enables/disables the VCS menu entries depending on the overall
464 VCS status and the file status. 469 VCS status and the file status.
465 </p> 470 </p>
466 <dl> 471 <dl>
467 472
468 <dt><i>menu</i></dt> 473 <dt><i>menu</i> (QMenu)</dt>
469 <dd> 474 <dd>
470 reference to the menu to be shown 475 reference to the menu to be shown
471 </dd> 476 </dd>
472 <dt><i>standardItems</i></dt> 477 <dt><i>standardItems</i> (list of QAction)</dt>
473 <dd> 478 <dd>
474 array of standard items that need 479 array of standard items that need
475 activation/deactivation depending on the overall VCS status 480 activation/deactivation depending on the overall VCS status
476 </dd> 481 </dd>
477 </dl> 482 </dl>
486 It enables/disables the VCS menu entries depending on the overall 491 It enables/disables the VCS menu entries depending on the overall
487 VCS status and the directory status. 492 VCS status and the directory status.
488 </p> 493 </p>
489 <dl> 494 <dl>
490 495
491 <dt><i>menu</i></dt> 496 <dt><i>menu</i> (QMenu)</dt>
492 <dd> 497 <dd>
493 reference to the menu to be shown 498 reference to the menu to be shown
494 </dd> 499 </dd>
495 <dt><i>standardItems</i></dt> 500 <dt><i>standardItems</i> (list of QAction)</dt>
496 <dd> 501 <dd>
497 array of standard items that need 502 array of standard items that need
498 activation/deactivation depending on the overall VCS status 503 activation/deactivation depending on the overall VCS status
499 </dd> 504 </dd>
500 </dl> 505 </dl>
509 It enables/disables the VCS menu entries depending on the overall 514 It enables/disables the VCS menu entries depending on the overall
510 VCS status and the directory status. 515 VCS status and the directory status.
511 </p> 516 </p>
512 <dl> 517 <dl>
513 518
514 <dt><i>menu</i></dt> 519 <dt><i>menu</i> (QMenu)</dt>
515 <dd> 520 <dd>
516 reference to the menu to be shown 521 reference to the menu to be shown
517 </dd> 522 </dd>
518 <dt><i>standardItems</i></dt> 523 <dt><i>standardItems</i> (list of QAction)</dt>
519 <dd> 524 <dd>
520 array of standard items that need 525 list of standard items that need
521 activation/deactivation depending on the overall VCS status 526 activation/deactivation depending on the overall VCS status
522 </dd> 527 </dd>
523 </dl> 528 </dl>
524 <a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a> 529 <a NAME="HgProjectBrowserHelper.showContextMenuMulti" ID="HgProjectBrowserHelper.showContextMenuMulti"></a>
525 <h4>HgProjectBrowserHelper.showContextMenuMulti</h4> 530 <h4>HgProjectBrowserHelper.showContextMenuMulti</h4>
533 It enables/disables the VCS menu entries depending on the overall 538 It enables/disables the VCS menu entries depending on the overall
534 VCS status and the files status. 539 VCS status and the files status.
535 </p> 540 </p>
536 <dl> 541 <dl>
537 542
538 <dt><i>menu</i></dt> 543 <dt><i>menu</i> (QMenu)</dt>
539 <dd> 544 <dd>
540 reference to the menu to be shown 545 reference to the menu to be shown
541 </dd> 546 </dd>
542 <dt><i>standardItems</i></dt> 547 <dt><i>standardItems</i> (list of QAction)</dt>
543 <dd> 548 <dd>
544 array of standard items that need 549 array of standard items that need
545 activation/deactivation depending on the overall VCS status 550 activation/deactivation depending on the overall VCS status
546 </dd> 551 </dd>
547 </dl> 552 </dl>

eric ide

mercurial