• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDevelop Platform Libraries
  • Sitemap
  • Contact Us
 

vcs

KDevelop::VcsLocation

KDevelop::VcsLocation Class Reference

#include <vcslocation.h>

List of all members.

Detailed Description

Denotes a local or repository location for a Vcs system.

For the RepositoryLocation type most of the informations are vcs specific

Definition at line 38 of file vcslocation.h.


Public Types

enum  LocationType { LocalLocation = 0, RepositoryLocation = 1 }

Public Member Functions

bool isValid () const
KUrl 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 KUrl &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 &)
VcsLocation::LocationType type () const
QVariant userData () const
 VcsLocation (const VcsLocation &)
 VcsLocation (const QString &)
 VcsLocation (const KUrl &)

Member Enumeration Documentation

enum KDevelop::VcsLocation::LocationType

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

Definition at line 41 of file vcslocation.h.

Member Function Documentation

KUrl KDevelop::VcsLocation::localUrl (  )  const

Returns:
Local url if this location is a LocalLocation

Definition at line 94 of file vcslocation.cpp.

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 156 of file vcslocation.cpp.

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 146 of file vcslocation.cpp.

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 161 of file vcslocation.cpp.

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 98 of file vcslocation.cpp.

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 151 of file vcslocation.cpp.

void KDevelop::VcsLocation::setLocalUrl ( const KUrl &  url  ) 

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

Parameters:
url the local url

Definition at line 116 of file vcslocation.cpp.

void KDevelop::VcsLocation::setRepositoryBranch ( const QString &  branch  ) 

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

Definition at line 173 of file vcslocation.cpp.

void KDevelop::VcsLocation::setRepositoryModule ( const QString &  module  ) 

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

Definition at line 166 of file vcslocation.cpp.

void KDevelop::VcsLocation::setRepositoryPath ( const QString &  path  ) 

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

Definition at line 187 of file vcslocation.cpp.

void KDevelop::VcsLocation::setRepositoryServer ( const QString &  location  ) 

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

Definition at line 126 of file vcslocation.cpp.

void KDevelop::VcsLocation::setRepositoryTag ( const QString &  tag  ) 

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

Definition at line 180 of file vcslocation.cpp.

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 200 of file vcslocation.cpp.

VcsLocation::LocationType KDevelop::VcsLocation::type (  )  const

Returns:
the type of this location

Definition at line 103 of file vcslocation.cpp.

QVariant KDevelop::VcsLocation::userData (  )  const

retrieve vcs-specific data

Definition at line 195 of file vcslocation.cpp.

The documentation for this class was generated from the following files:
  • vcslocation.h
  • vcslocation.cpp

vcs

Skip menu "vcs"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDevelop Platform Libraries

Skip menu "KDevelop Platform Libraries"
  • interfaces
  • language
  •   codegen
  •   duchain
  •   editor
  • outputview
  •     interfaces
  • project
  • shell
  • sublime
  • util
  • vcs
Generated for KDevelop Platform Libraries by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal