VcsBasePluginState Class | Extending Qt Creator Manual

Extending Qt Creator Manual | VcsBasePluginState

Extending Qt Creator Manual 4.3.0

# VcsBasePluginState Class

(VcsBase::VcsBasePluginState)

The VcsBasePluginState class provides relevant state information about the VCS plugins. More...

Header: | #include <VcsBasePluginState>

- List of all members, including inherited members

## Public Functions

| VcsBasePluginState()
| VcsBasePluginState(const VcsBasePluginState &)
| ~VcsBasePluginState()
void | clear()
QString | currentFile() const
QString | currentFileDirectory() const
QString | currentFileName() const
QString | currentFileTopLevel() const
QString | currentPatchFile() const
QString | currentPatchFileDisplayName() const
QString | currentProjectName() const
QString | currentProjectPath() const
QString | currentProjectTopLevel() const
bool | equals(const VcsBasePluginState &rhs) const
bool | hasFile() const
bool | hasPatchFile() const
bool | hasProject() const
bool | hasTopLevel() const
bool | isEmpty() const
QString | relativeCurrentFile() const
QString | relativeCurrentProject() const
QString | topLevel() const
VcsBasePluginState & | operator=(const VcsBasePluginState &)

## Detailed Description

The VcsBasePluginState class provides relevant state information about the VCS plugins.

Qt Creator's state relevant to VCS plugins is a tuple of

- Current file and it's version system control/top level
- Current project and it's version system control/top level

See also VcsBase::VcsBasePlugin.

## Member Function Documentation

### VcsBasePluginState::VcsBasePluginState()

Default constructs an instance of VcsBasePluginState.

### VcsBasePluginState::VcsBasePluginState(const VcsBasePluginState &)

Copy constructor.

### VcsBasePluginState::~VcsBasePluginState()

Destroys the instance of VcsBasePluginState.

### void VcsBasePluginState::clear()

### QString VcsBasePluginState::currentFile() const

### QString VcsBasePluginState::currentFileDirectory() const

### QString VcsBasePluginState::currentFileName() const

### QString VcsBasePluginState::currentFileTopLevel() const

### QString VcsBasePluginState::currentPatchFile() const

### QString VcsBasePluginState::currentPatchFileDisplayName() const

### QString VcsBasePluginState::currentProjectName() const

### QString VcsBasePluginState::currentProjectPath() const

### QString VcsBasePluginState::currentProjectTopLevel() const

### bool VcsBasePluginState::equals(const VcsBasePluginState &rhs) const

### bool VcsBasePluginState::hasFile() const

### bool VcsBasePluginState::hasPatchFile() const

### bool VcsBasePluginState::hasProject() const

### bool VcsBasePluginState::hasTopLevel() const

### bool VcsBasePluginState::isEmpty() const

### QString VcsBasePluginState::relativeCurrentFile() const

### QString VcsBasePluginState::relativeCurrentProject() const

### QString VcsBasePluginState::topLevel() const

### VcsBasePluginState &VcsBasePluginState::operator=(const VcsBasePluginState &)

Copy-assignment operator.