vcs

KDevelop::VcsStatusInfo

KDevelop::VcsStatusInfo Class Reference

#include <vcsstatusinfo.h>

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 50 of file vcsstatusinfo.h.


Public Types
enum	State { ItemUnknown = 0, ItemUpToDate = 1, ItemAdded = 2, ItemModified = 3, ItemDeleted = 4, ItemAddedIndex = 5, ItemModifiedIndex = 6, ItemDeletedIndex = 7, ItemHasConflicts = 8, ItemUserState = 1000 }
Public Member Functions
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 KUrl &)
VcsStatusInfo::State	state () const
KUrl	url () const
	VcsStatusInfo (const VcsStatusInfo &)

Member Enumeration Documentation

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.
ItemAddedIndex	Item is added to index (DVCS only).
ItemModifiedIndex	Item's modifications are added to index (DVCS only).
ItemDeletedIndex	Item was deleted from the index (DVCS only).
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 56 of file vcsstatusinfo.h.

Member Function Documentation

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

Change the url of this status information item.

Parameters:

url

the url

Definition at line 75 of file vcsstatusinfo.cpp.

KUrl KDevelop::VcsStatusInfo::url ( ) const

retrieves the url of this status information item

Returns:: the url

Definition at line 95 of file vcsstatusinfo.cpp.

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

vcs

KDevelop::VcsStatusInfo Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation

vcs

KDevelop Platform Libraries