VcsBase Namespace

The VcsBase namespace contains classes for the VcsBase plugin. More...

Header: #include <VcsBase>

Namespaces

namespace Constants

Classes

Types

enum CheckMode { Unchecked, Checked, Uncheckable }
enum EditorContentType { RegularCommandOutput, LogOutput, AnnotateOutput, DiffOutput }

Functions

bool operator!=(const VcsBaseClientSettings &s1, const VcsBaseClientSettings &s2)
bool operator!=(const VcsBasePluginState &s1, const VcsBasePluginState &s2)
VCSBASE_EXPORT operator<<(QDebug in, const VcsBasePluginState &state)
bool operator==(const VcsBaseClientSettings &s1, const VcsBaseClientSettings &s2)
bool operator==(const VcsBasePluginState &s1, const VcsBasePluginState &s2)

Detailed Description

The VcsBase namespace contains classes for the VcsBase plugin.

Namespaces

namespace VcsBase::Constants

Classes

class BaseAnnotationHighlighter

The BaseAnnotationHighlighter class is the base class for a highlighter for annotation lines of the form 'changenumber:XXXX'. More...

class CleanDialog

The CleanDialog class provides a file selector dialog for files not under version control. More...

class DiffAndLogHighlighter

The DiffAndLogHighlighter class provides a highlighter for diffs and log editors. More...

class DiffChunk

The DiffChunk class provides a diff chunk consisting of file name and chunk data. More...

class SubmitEditorWidget

The SubmitEditorWidget class presents a VCS commit message in a text editor and a checkable list of modified files in a list window. More...

class SubmitFieldWidget

The SubmitFieldWidget class is a widget for editing submit message fields like "reviewed-by:", "signed-off-by:". More...

class SubmitFileModel

The SubmitFileModel class is a 2-column (checkable, state, file name) model to be used to list the files in the submit editor. More...

class VcsBaseClient

The VcsBaseClient class is the base class for Mercurial and Bazaar 'clients'. More...

class VcsBaseClientImpl

class VcsBaseClientSettings

The VcsBaseClientSettings class contains settings used in VcsBaseClient. More...

class VcsBaseDiffEditorController

class VcsBaseEditor

The VcsBaseEditor class implements an editor with no support for duplicates. More...

class VcsBaseEditorConfig

The VcsBaseEditorConfig is a widget/action aggregator for use with VcsBase::VcsBaseEditor, influencing for example the generation of VCS diff output. More...

class VcsBaseEditorParameters

The VcsBaseEditorParameters class is a helper class used to parametrize an editor with MIME type, context and id. More...

class VcsBaseEditorWidget

The VcsBaseEditorWidget class is the base class for editors showing version control system output of the type enumerated by EditorContentType. More...

class VcsBaseOptionsPage

The VcsBaseOptionsPage class is the base class for VCS options pages providing a common category and icon. More...

class VcsBasePlugin

The VcsBasePlugin class is the base class for all version control plugins. More...

class VcsBasePluginState

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

class VcsBaseSubmitEditor

The VcsBaseSubmitEditor class is the base class for a submit editor based on the SubmitEditorWidget. More...

class VcsBaseSubmitEditorParameters

The VcsBaseSubmitEditorParameters class is a utility class to parametrize a VcsBaseSubmitEditor. More...

class VcsClientOptionsPage

class VcsClientOptionsPageWidget

class VcsCommand

class VcsConfigurationPage

class VcsEditorFactory

class VcsOutputWindow

class VcsSubmitEditorFactory

Type Documentation

enum VcsBase::CheckMode

enum VcsBase::EditorContentType

This enum describes the contents of a VcsBaseEditor and its interaction.

ConstantValueDescription
VcsBase::RegularCommandOutput?No special handling.
VcsBase::LogOutput0Log of a file under revision control. Provide a description of the change that users can click to view detailed information about the change and Annotate for the log of a single file.
VcsBase::AnnotateOutput1Color contents per change number and provide a clickable change description. Context menu offers annotate previous version functionality. Expected format:

  <change description>: file line

VcsBase::DiffOutput2Diff output. Might include describe output, which consists of a header and diffs. Double-clicking the chunk opens the file. The context menu offers the functionality to revert the chunk.

See also VcsBase::VcsBaseEditorWidget.

Function Documentation

bool VcsBase::operator!=(const VcsBaseClientSettings &s1, const VcsBaseClientSettings &s2)

bool VcsBase::operator!=(const VcsBasePluginState &s1, const VcsBasePluginState &s2)

VCSBASE_EXPORT VcsBase::operator<<(QDebug in, const VcsBasePluginState &state)

bool VcsBase::operator==(const VcsBaseClientSettings &s1, const VcsBaseClientSettings &s2)

bool VcsBase::operator==(const VcsBasePluginState &s1, const VcsBasePluginState &s2)