VcsBaseClientImpl Class | Extending Qt Creator Manual

Extending Qt Creator Manual | VcsBaseClientImpl

Extending Qt Creator Manual 4.4.1

# VcsBaseClientImpl Class

(VcsBase::VcsBaseClientImpl)

Inherited By: | VcsBase::VcsBaseClient

- List of all members, including inherited members

## Public Types

enum | JobOutputBindMode { NoOutputBind, VcsWindowOutputBind }

## Public Functions

| VcsBaseClientImpl(VcsBaseClientSettings *settings)
| ~VcsBaseClientImpl() override
virtual VcsBaseEditorWidget * | annotate(const QString &workingDir, const QString &file, const QString &revision = QString(), int lineNumber = -1, const QStringList &extraOptions = QStringList()) = 0
VcsCommand * | createCommand(const QString &workingDirectory, VcsBaseEditorWidget *editor = 0, JobOutputBindMode mode = NoOutputBind) const
VcsBaseEditorWidget * | createVcsEditor(Core::Id kind, QString title, const QString &source, QTextCodec *codec, const char *registerDynamicProperty, const QString &dynamicPropertyValue) const
void | enqueueJob(VcsCommand *cmd, const QStringList &args, const QString &workingDirectory = QString(), const Utils::ExitCodeInterpreter &interpreter = Utils::defaultExitCodeInterpreter) const
virtual QProcessEnvironment | processEnvironment() const
VcsBaseClientSettings & | settings() const
virtual Utils::FileName | vcsBinary() const
VcsCommand * | vcsExec(const QString &workingDirectory, const QStringList &arguments, VcsBaseEditorWidget *editor = nullptr, bool useOutputToWindow = false, unsigned additionalFlags = 0, const QVariant &cookie = QVariant()) const
Utils::SynchronousProcessResponse | vcsFullySynchronousExec(const QString &workingDir, const QStringList &args, unsigned flags = 0, int timeoutS = -1, QTextCodec *codec = nullptr) const
Utils::SynchronousProcessResponse | vcsFullySynchronousExec(const QString &workingDir, const Utils::FileName &binary, const QStringList &args, unsigned flags = 0, int timeoutS = -1, QTextCodec *codec = nullptr) const
int | vcsTimeoutS() const

## Static Public Members

QString | commandOutputFromLocal8Bit(const QByteArray &a)
QStringList | commandOutputLinesFromLocal8Bit(const QByteArray &a)
QStringList | splitLines(const QString &s)
QString | stripLastNewline(const QString &in)

## Protected Functions

virtual void | annotateRevisionRequested(const QString &workingDirectory, const QString &file, const QString &change, int line)
void | resetCachedVcsInfo(const QString &workingDir)
Utils::SynchronousProcessResponse | vcsSynchronousExec(const QString &workingDir, const QStringList &args, unsigned flags = 0, QTextCodec *outputCodec = nullptr) const

## Member Type Documentation

### enum VcsBaseClientImpl::JobOutputBindMode

## Member Function Documentation

### VcsBaseClientImpl::VcsBaseClientImpl(VcsBaseClientSettings *settings)

Default constructs an instance of VcsBaseClientImpl.

### VcsBaseClientImpl::~VcsBaseClientImpl()

Destroys the instance of VcsBaseClientImpl.

### `[pure virtual]` VcsBaseEditorWidget *VcsBaseClientImpl::annotate(const QString &workingDir, const QString &file, const QString &revision = QString(), int lineNumber = -1, const QStringList &extraOptions = QStringList())

### `[virtual protected]` void VcsBaseClientImpl::annotateRevisionRequested(const QString &workingDirectory, const QString &file, const QString &change, int line)

### `[static]` QString VcsBaseClientImpl::commandOutputFromLocal8Bit(const QByteArray &a)

### `[static]` QStringList VcsBaseClientImpl::commandOutputLinesFromLocal8Bit(const QByteArray &a)

### VcsCommand *VcsBaseClientImpl::createCommand(const QString &workingDirectory, VcsBaseEditorWidget *editor = 0, JobOutputBindMode mode = NoOutputBind) const

### VcsBaseEditorWidget *VcsBaseClientImpl::createVcsEditor(Core::Id kind, QString title, const QString &source, QTextCodec *codec, const char *registerDynamicProperty, const QString &dynamicPropertyValue) const

### void VcsBaseClientImpl::enqueueJob(VcsCommand *cmd, const QStringList &args, const QString &workingDirectory = QString(), const Utils::ExitCodeInterpreter &interpreter = Utils::defaultExitCodeInterpreter) const

### `[virtual]` QProcessEnvironment VcsBaseClientImpl::processEnvironment() const

### `[protected]` void VcsBaseClientImpl::resetCachedVcsInfo(const QString &workingDir)

### VcsBaseClientSettings &VcsBaseClientImpl::settings() const

### `[static]` QStringList VcsBaseClientImpl::splitLines(const QString &s)

### `[static]` QString VcsBaseClientImpl::stripLastNewline(const QString &in)

### `[virtual]` Utils::FileName VcsBaseClientImpl::vcsBinary() const

### VcsCommand *VcsBaseClientImpl::vcsExec(const QString &workingDirectory, const QStringList &arguments, VcsBaseEditorWidget *editor = nullptr, bool useOutputToWindow = false, unsigned additionalFlags = 0, const QVariant &cookie = QVariant()) const

### Utils::SynchronousProcessResponse VcsBaseClientImpl::vcsFullySynchronousExec(const QString &workingDir, const QStringList &args, unsigned flags = 0, int timeoutS = -1, QTextCodec *codec = nullptr) const

### Utils::SynchronousProcessResponse VcsBaseClientImpl::vcsFullySynchronousExec(const QString &workingDir, const Utils::FileName &binary, const QStringList &args, unsigned flags = 0, int timeoutS = -1, QTextCodec *codec = nullptr) const

### `[protected]` Utils::SynchronousProcessResponse VcsBaseClientImpl::vcsSynchronousExec(const QString &workingDir, const QStringList &args, unsigned flags = 0, QTextCodec *outputCodec = nullptr) const

### int VcsBaseClientImpl::vcsTimeoutS() const