eric7.Plugins.VcsPlugins.vcsGit.GitWorktreeDialog

Module implementing a dialog to offer the worktree management functionality.

Global Attributes

None

Classes

GitWorktreeDialog Class implementing a dialog to offer the worktree management functionality.

Functions

None


GitWorktreeDialog

Class implementing a dialog to offer the worktree management functionality.

Derived from

QWidget, Ui_GitWorktreeDialog

Class Attributes

StatusRole

Class Methods

None

Methods

GitWorktreeDialog Constructor
__finish Private slot called when the process finished or the user pressed the button.
__generateItem Private method to generate a worktree entry with the given data.
__initActionsMenu Private method to initialize the actions menu.
__procFinished Private slot connected to the finished signal.
__readStderr Private slot to handle the readyReadStandardError signal.
__readStdout Private slot to handle the readyReadStandardOutput signal.
__refreshButtonClicked Private slot to refresh the worktree display.
__resizeColumns Private method to resize the list columns.
__resort Private method to resort the tree.
__showActionsMenu Private slot to prepare the actions button menu before it is shown.
__worktreeAdd Private slot to add a linked worktree.
__worktreeLock Private slot to lock a worktree.
__worktreeMove Private slot to move a worktree to a new location.
__worktreePrune Private slot to prune worktree information.
__worktreeRemove Private slot to remove a linked worktree.
__worktreeRemoveForced Private slot to remove a linked worktree forcefully.
__worktreeRepair Private slot to repair worktree administrative files.
__worktreeRepairMultiple Private slot to repair worktree administrative files for multiple worktree paths.
__worktreeUnlock Private slot to unlock a worktree.
closeEvent Protected slot implementing a close event handler.
on_buttonBox_clicked Private slot called by a button of the button box clicked.
on_expireCheckBox_toggled Private slot to handle a change of the expire checkbox.
on_expireDateTimeEdit_dateTimeChanged Private slot to handle a change of the expire date and time.
show Public slot to show the dialog.
start Public slot to start the git worktree list command.

Static Methods

None

GitWorktreeDialog (Constructor)

GitWorktreeDialog(vcs, parent=None)

Constructor

vcs (Git)
reference to the vcs object
parent (QWidget (optional))
reference to the parent widget (defaults to None)

GitWorktreeDialog.__finish

__finish()

Private slot called when the process finished or the user pressed the button.

GitWorktreeDialog.__generateItem

__generateItem(dataLines)

Private method to generate a worktree entry with the given data.

dataLines (list of str)
lines extracted from the git worktree list output with porcelain format

GitWorktreeDialog.__initActionsMenu

__initActionsMenu()

Private method to initialize the actions menu.

GitWorktreeDialog.__procFinished

__procFinished(_exitCode, _exitStatus)

Private slot connected to the finished signal.

_exitCode (int)
exit code of the process (unused)
_exitStatus (QProcess.ExitStatus)
exit status of the process (unused)

GitWorktreeDialog.__readStderr

__readStderr()

Private slot to handle the readyReadStandardError signal.

It reads the error output of the process and inserts it into the error pane.

GitWorktreeDialog.__readStdout

__readStdout()

Private slot to handle the readyReadStandardOutput signal.

It reads the output of the process, formats it and inserts it into the contents pane.

GitWorktreeDialog.__refreshButtonClicked

__refreshButtonClicked()

Private slot to refresh the worktree display.

GitWorktreeDialog.__resizeColumns

__resizeColumns()

Private method to resize the list columns.

GitWorktreeDialog.__resort

__resort()

Private method to resort the tree.

GitWorktreeDialog.__showActionsMenu

__showActionsMenu()

Private slot to prepare the actions button menu before it is shown.

GitWorktreeDialog.__worktreeAdd

__worktreeAdd()

Private slot to add a linked worktree.

GitWorktreeDialog.__worktreeLock

__worktreeLock()

Private slot to lock a worktree.

GitWorktreeDialog.__worktreeMove

__worktreeMove()

Private slot to move a worktree to a new location.

GitWorktreeDialog.__worktreePrune

__worktreePrune()

Private slot to prune worktree information.

GitWorktreeDialog.__worktreeRemove

__worktreeRemove(force=False)

Private slot to remove a linked worktree.

force (bool (optional)
flag indicating a forceful remove (defaults to False)

GitWorktreeDialog.__worktreeRemoveForced

__worktreeRemoveForced()

Private slot to remove a linked worktree forcefully.

GitWorktreeDialog.__worktreeRepair

__worktreeRepair(worktreePaths=None)

Private slot to repair worktree administrative files.

worktreePaths (list of str (optional))
list of worktree paths to be repaired (defaults to None)

GitWorktreeDialog.__worktreeRepairMultiple

__worktreeRepairMultiple()

Private slot to repair worktree administrative files for multiple worktree paths.

GitWorktreeDialog.__worktreeUnlock

__worktreeUnlock()

Private slot to unlock a worktree.

GitWorktreeDialog.closeEvent

closeEvent(e)

Protected slot implementing a close event handler.

e (QCloseEvent)
close event

GitWorktreeDialog.on_buttonBox_clicked

on_buttonBox_clicked(button)

Private slot called by a button of the button box clicked.

button (QAbstractButton)
button that was clicked

GitWorktreeDialog.on_expireCheckBox_toggled

on_expireCheckBox_toggled(checked)

Private slot to handle a change of the expire checkbox.

checked (bool)
state of the checkbox

GitWorktreeDialog.on_expireDateTimeEdit_dateTimeChanged

on_expireDateTimeEdit_dateTimeChanged(dateTime)

Private slot to handle a change of the expire date and time.

dateTime (QDateTime)
DESCRIPTION

GitWorktreeDialog.show

show()

Public slot to show the dialog.

GitWorktreeDialog.start

start(projectDir)

Public slot to start the git worktree list command.

projectDir (str)
name of the project directory
Up