eric4.VCS.StatusMonitorThread

Module implementing the VCS status monitor thread base class.

Classes

VcsStatusMonitorThread Class implementing the VCS status monitor thread base class.

Functions

None


VcsStatusMonitorThread

Class implementing the VCS status monitor thread base class.

Signals

vcsStatusMonitorData(QStringList)
emitted to update the VCS status
vcsStatusMonitorStatus(QString, QString)
emitted to signal the status of the monitoring thread (ok, nok, op) and a status message

Derived from

QThread

Methods

VcsStatusMonitorThread Constructor
_performMonitor Protected method implementing the real monitoring action.
checkStatus Public method to wake up the status monitor thread.
clearCachedState Public method to clear the cached VCS state of a file/directory.
getInterval Public method to get the monitor interval.
run Protected method implementing the tasks action.
setInterval Public method to change the monitor interval.
stop Public method to stop the monitor thread.

VcsStatusMonitorThread (Constructor)

VcsStatusMonitorThread(interval, projectDir, parent = None)

Constructor

interval
new interval in seconds (integer)
projectDir
project directory to monitor (string or QString)
parent
reference to the parent object (QObject)

VcsStatusMonitorThread._performMonitor

_performMonitor()

Protected method implementing the real monitoring action.

This method must be overridden and populate the statusList member variable with a list of strings giving the status in the first column and the path relative to the project directory starting with the third column. The allowed status flags are:

  • Returns:
    tuple of flag indicating successful operation (boolean) and a status message in case of non successful operation (QString)

    VcsStatusMonitorThread.checkStatus

    checkStatus()

    Public method to wake up the status monitor thread.

    VcsStatusMonitorThread.clearCachedState

    clearCachedState(name)

    Public method to clear the cached VCS state of a file/directory.

    name
    name of the entry to be cleared (QString or string)

    VcsStatusMonitorThread.getInterval

    getInterval()

    Public method to get the monitor interval.

    Returns:
    interval in seconds (integer)

    VcsStatusMonitorThread.run

    run()

    Protected method implementing the tasks action.

    VcsStatusMonitorThread.setInterval

    setInterval(interval)

    Public method to change the monitor interval.

    interval
    new interval in seconds (integer)

    VcsStatusMonitorThread.stop

    stop()

    Public method to stop the monitor thread.

    Up