#include <vcsstatusinfo.h>

Public Types
enum	State { ItemUnknown = 0, ItemUpToDate = 1, ItemAdded = 2, ItemModified = 3, ItemDeleted = 4, ItemHasConflicts = 8, ItemUserState = 1000 }

Public Member Functions
	VcsStatusInfo ()

	VcsStatusInfo (const VcsStatusInfo &)

virtual	~VcsStatusInfo ()

int	extendedState () const

bool	operator!= (const KDevelop::VcsStatusInfo &rhs) const

VcsStatusInfo &	operator= (const VcsStatusInfo &rhs)

bool	operator== (const KDevelop::VcsStatusInfo &rhs) const

void	setExtendedState (int)

void	setState (VcsStatusInfo::State)

void	setUrl (const QUrl &url)

VcsStatusInfo::State	state () const

QUrl	url () const

Detailed Description

Class that encapsulates status information for one local url.

The extendedState functions allow to transport extended status information

Note for VCS implementations: If you want to use this class in queued signal/slot connections you should call qRegisterMetaType<KDevelop::VcsStatusInfo>() in the constructor of the plugin class

Definition at line 47 of file vcsstatusinfo.h.

Member Enumeration Documentation

◆ State

enum KDevelop::VcsStatusInfo::State

Status of a local file.

Enumerator
ItemUnknown	No VCS information about a file is known (or file is not under VCS control).
ItemUpToDate	Item was updated or it is already at up to date version.
ItemAdded	Item was added to the repository but not committed.
ItemModified	Item was modified locally.
ItemDeleted	Item is scheduled to be deleted.
ItemHasConflicts	Local version has conflicts that need to be resolved before commit.
ItemUserState	special states for individual vcs implementations should use this as base.

Definition at line 53 of file vcsstatusinfo.h.

Constructor & Destructor Documentation

◆ VcsStatusInfo() [1/2]

KDevelop::VcsStatusInfo::VcsStatusInfo ( )

Definition at line 55 of file vcsstatusinfo.cpp.

◆ ~VcsStatusInfo()

KDevelop::VcsStatusInfo::~VcsStatusInfo ( )

virtualdefault

◆ VcsStatusInfo() [2/2]

KDevelop::VcsStatusInfo::VcsStatusInfo ( const VcsStatusInfo & rhs )

Definition at line 64 of file vcsstatusinfo.cpp.

Member Function Documentation

◆ extendedState()

int KDevelop::VcsStatusInfo::extendedState ( ) const

Returns: the extended state which may be set by individual vcs implementations

Definition at line 100 of file vcsstatusinfo.cpp.

◆ operator!=()

bool KDevelop::VcsStatusInfo::operator!= ( const KDevelop::VcsStatusInfo & rhs ) const

Definition at line 80 of file vcsstatusinfo.cpp.

◆ operator=()

VcsStatusInfo & KDevelop::VcsStatusInfo::operator= ( const VcsStatusInfo & rhs )

Definition at line 69 of file vcsstatusinfo.cpp.

◆ operator==()

bool KDevelop::VcsStatusInfo::operator== ( const KDevelop::VcsStatusInfo & rhs ) const

Definition at line 75 of file vcsstatusinfo.cpp.

◆ setExtendedState()

void KDevelop::VcsStatusInfo::setExtendedState ( int newstate )

Individual vcs implementations may use this function to set a special vcs status.

They should also always set an appropriate basic state, if possible.

Definition at line 90 of file vcsstatusinfo.cpp.

◆ setState()

void KDevelop::VcsStatusInfo::setState ( VcsStatusInfo::State state )

Definition at line 95 of file vcsstatusinfo.cpp.

◆ setUrl()

void KDevelop::VcsStatusInfo::setUrl ( const QUrl & url )

Change the url of this status information item.

Parameters

url the url

Definition at line 85 of file vcsstatusinfo.cpp.

◆ state()

VcsStatusInfo::State KDevelop::VcsStatusInfo::state ( ) const

Definition at line 110 of file vcsstatusinfo.cpp.

◆ url()

QUrl KDevelop::VcsStatusInfo::url ( ) const

retrieves the url of this status information item

Returns: the url

Definition at line 105 of file vcsstatusinfo.cpp.

The documentation for this class was generated from the following files:

kdevplatform/vcs

Public Types

Public Member Functions