KDevelop::VcsLocation Class Reference

#include <vcslocation.h>

Public Types
enum	LocationType { LocalLocation = 0, RepositoryLocation = 1 }

Public Member Functions
	VcsLocation ()
	VcsLocation (const QString &)
	VcsLocation (const QUrl &)
	VcsLocation (const VcsLocation &)
	~VcsLocation ()
bool	isValid () const
QUrl	localUrl () const
VcsLocation &	operator= (const VcsLocation &)
bool	operator== (const KDevelop::VcsLocation &)
QString	repositoryBranch () const
QString	repositoryModule () const
QString	repositoryPath () const
QString	repositoryServer () const
QString	repositoryTag () const
void	setLocalUrl (const QUrl &url)
void	setRepositoryBranch (const QString &)
void	setRepositoryModule (const QString &)
void	setRepositoryPath (const QString &)
void	setRepositoryServer (const QString &)
void	setRepositoryTag (const QString &)
void	setUserData (const QVariant &data)
LocationType	type () const
QVariant	userData () const

Detailed Description

Denotes a local or repository location for a Vcs system.

For the RepositoryLocation type, most of the information is vcs-specific.

Definition at line 42 of file vcslocation.h.

Member Enumeration Documentation

LocationType

enum KDevelop::VcsLocation::LocationType

Enumerator
LocalLocation	this is a local location
RepositoryLocation	this is a repository location

Definition at line 45 of file vcslocation.h.

Constructor & Destructor Documentation

VcsLocation() [1/4]

KDevelop::VcsLocation::VcsLocation

(

)

Definition at line 58 of file vcslocation.cpp.

VcsLocation() [2/4]

KDevelop::VcsLocation::VcsLocation ( const QUrl &  u )

explicit

Definition at line 65 of file vcslocation.cpp.

VcsLocation() [3/4]

KDevelop::VcsLocation::VcsLocation ( const QString &  s )

explicit

Definition at line 71 of file vcslocation.cpp.

~VcsLocation()

KDevelop::VcsLocation::~VcsLocation ( )

default

VcsLocation() [4/4]

KDevelop::VcsLocation::VcsLocation

(

const VcsLocation &

rhs

)

Definition at line 79 of file vcslocation.cpp.

Member Function Documentation

isValid()

bool KDevelop::VcsLocation::isValid

(

)

const

Definition at line 104 of file vcslocation.cpp.

localUrl()

QUrl KDevelop::VcsLocation::localUrl

(

)

const

Returns

Local url if this location is a LocalLocation

Definition at line 90 of file vcslocation.cpp.

operator=()

VcsLocation & KDevelop::VcsLocation::operator=

(

const VcsLocation &

rhs

)

Definition at line 84 of file vcslocation.cpp.

operator==()

bool KDevelop::VcsLocation::operator==

(

const KDevelop::VcsLocation &

rhs

)

Definition at line 129 of file vcslocation.cpp.

repositoryBranch()

QString KDevelop::VcsLocation::repositoryBranch

(

)

const

Identifies the branch to which this location belongs to.

Returns

a vcs-implementation-specific string identifying the branch

Definition at line 152 of file vcslocation.cpp.

repositoryModule()

QString KDevelop::VcsLocation::repositoryModule

(

)

const

Returns the module or module path inside the server.

Returns

a vcs-implementation-specific string identifying the module

Definition at line 142 of file vcslocation.cpp.

repositoryPath()

QString KDevelop::VcsLocation::repositoryPath

(

)

const

This can define a path relative to the module.

This is used when identifying a subdirectory or file inside a repository location

Returns

a path relative to module

Definition at line 157 of file vcslocation.cpp.

repositoryServer()

QString KDevelop::VcsLocation::repositoryServer

(

)

const

Returns a string for the repository, usually this identifies the server.

Returns

a vcs-implementation-specific string identifying the server

Definition at line 94 of file vcslocation.cpp.

repositoryTag()

QString KDevelop::VcsLocation::repositoryTag

(

)

const

Identifies the tag which this location belongs to.

Returns

a vcs-implementation-specific string identifying the tag

Definition at line 147 of file vcslocation.cpp.

setLocalUrl()

void KDevelop::VcsLocation::setLocalUrl

(

const QUrl &

url

)

Set the local url for this location, automatically sets the type to LocalLocation.

Parameters

url	the local url

Definition at line 112 of file vcslocation.cpp.

setRepositoryBranch()

void KDevelop::VcsLocation::setRepositoryBranch

(

const QString &

branch

)

Set the branch string for this location, automatically sets the type to RepositoryLocation.

Definition at line 169 of file vcslocation.cpp.

setRepositoryModule()

void KDevelop::VcsLocation::setRepositoryModule

(

const QString &

module

)

Set the module for this location, automatically sets the type to RepositoryLocation.

Definition at line 162 of file vcslocation.cpp.

setRepositoryPath()

void KDevelop::VcsLocation::setRepositoryPath

(

const QString &

path

)

Set the path for this location, automatically sets the type to RepositoryLocation.

Definition at line 183 of file vcslocation.cpp.

setRepositoryServer()

void KDevelop::VcsLocation::setRepositoryServer

(

const QString &

location

)

Set the server string for this location, automatically sets the type to RepositoryLocation.

Definition at line 122 of file vcslocation.cpp.

setRepositoryTag()

void KDevelop::VcsLocation::setRepositoryTag

(

const QString &

tag

)

Set the tag string for this location, automatically sets the type to RepositoryLocation.

Definition at line 176 of file vcslocation.cpp.

setUserData()

void KDevelop::VcsLocation::setUserData

(

const QVariant &

data

)

Allows to add vcs-specific data to this location.

Automatically sets the type to RepositoryLocation

Parameters

data	the vcs-specific data

Definition at line 196 of file vcslocation.cpp.

type()

VcsLocation::LocationType KDevelop::VcsLocation::type

(

)

const

Returns

the type of this location

Definition at line 99 of file vcslocation.cpp.

userData()

QVariant KDevelop::VcsLocation::userData

(

)

const

retrieve vcs-specific data

Definition at line 191 of file vcslocation.cpp.

---

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

• vcslocation.h
• vcslocation.cpp