• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdevelop API Reference
  • KDE Home
  • Contact Us
 

kdevplatform/vcs

  • KDevelop
  • VcsStatusInfo
Public Types | Public Member Functions | List of all members
KDevelop::VcsStatusInfo Class Reference

#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 54 of file vcsstatusinfo.cpp.

◆ ~VcsStatusInfo()

KDevelop::VcsStatusInfo::~VcsStatusInfo ( )
virtualdefault

◆ VcsStatusInfo() [2/2]

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

Definition at line 62 of file vcsstatusinfo.cpp.

Member Function Documentation

◆ extendedState()

int KDevelop::VcsStatusInfo::extendedState ( ) const

Definition at line 98 of file vcsstatusinfo.cpp.

◆ operator!=()

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

Definition at line 78 of file vcsstatusinfo.cpp.

◆ operator=()

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

Definition at line 67 of file vcsstatusinfo.cpp.

◆ operator==()

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

Definition at line 73 of file vcsstatusinfo.cpp.

◆ setExtendedState()

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

Definition at line 88 of file vcsstatusinfo.cpp.

◆ setState()

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

Definition at line 93 of file vcsstatusinfo.cpp.

◆ setUrl()

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

Change the url of this status information item.

Parameters
urlthe url

Definition at line 83 of file vcsstatusinfo.cpp.

◆ state()

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

Definition at line 108 of file vcsstatusinfo.cpp.

◆ url()

QUrl KDevelop::VcsStatusInfo::url ( ) const

retrieves the url of this status information item

Returns
the url

Definition at line 103 of file vcsstatusinfo.cpp.


The documentation for this class was generated from the following files:
  • vcsstatusinfo.h
  • vcsstatusinfo.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Mar 3 2021 00:38:30 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kdevplatform/vcs

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

kdevelop API Reference

Skip menu "kdevelop API Reference"
  • kdevplatform
  •   debugger
  •   documentation
  •   interfaces
  •   language
  •     assistant
  •     backgroundparser
  •     checks
  •     classmodel
  •     codecompletion
  •     codegen
  •     duchain
  •     editor
  •     highlighting
  •     interfaces
  •     util
  •   outputview
  •   project
  •   serialization
  •   shell
  •   sublime
  •   tests
  •   util
  •   vcs

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal