• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Extension Interfaces Library
 

KDevelop Extension Interfaces Library

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
VCSFileInfo Struct Reference

#include <kdevversioncontrol.h>

Public Types

enum  FileState {
  Unknown, Added, Uptodate, Modified,
  Conflict, Sticky, NeedsPatch, NeedsCheckout,
  Directory, Deleted, Replaced
}
 

Public Member Functions

 VCSFileInfo ()
 
 VCSFileInfo (TQString fn, TQString workRev, TQString repoRev, FileState aState)
 
TQString toString () const
 

Static Public Member Functions

static TQString state2String (FileState state)
 

Public Attributes

TQString fileName
 
TQString workRevision
 
TQString repoRevision
 
FileState state
 

Detailed Description

Info about file state in VCS.

Used, for example in file views to display VCS related information about files.

Definition at line 44 of file kdevversioncontrol.h.

Member Enumeration Documentation

◆ FileState

enum VCSFileInfo::FileState

State of the file.

Enumerator
Unknown 

No VCS information about a file is known.

Added 

File was added to the repository but not commited.

Uptodate 

File was updated or it is already at up to date version.

Modified 

File was modified locally.

Conflict 

Local version conflicts with the one in a repository.

Sticky 

File is sticky.

NeedsPatch 

File needs a patch.

NeedsCheckout 

File needs to be checkout again.

Directory 

This is a directory.

Deleted 

File or Directory is scheduled to be deleted.

Replaced 

File was scheduled for deletion, and then a new file with the same name was scheduled for addition in its place.

Definition at line 47 of file kdevversioncontrol.h.

Constructor & Destructor Documentation

◆ VCSFileInfo() [1/2]

VCSFileInfo::VCSFileInfo ( )
inline

Constructor.

Definition at line 62 of file kdevversioncontrol.h.

◆ VCSFileInfo() [2/2]

VCSFileInfo::VCSFileInfo ( TQString  fn,
TQString  workRev,
TQString  repoRev,
FileState  aState 
)
inline

Constructor.

Parameters
fnThe file name (without a path).
workRevThe current working revision of a file.
repoRevThe last revision of a file in the repository.
aStateThe state of a file.

Definition at line 68 of file kdevversioncontrol.h.

Member Function Documentation

◆ state2String()

static TQString VCSFileInfo::state2String ( FileState  state)
inlinestatic
Returns
A textual VCS state description.

Definition at line 87 of file kdevversioncontrol.h.

◆ toString()

TQString VCSFileInfo::toString ( ) const
inline
Returns
A descriptive string with all VCS related info about the file.

Definition at line 81 of file kdevversioncontrol.h.

Member Data Documentation

◆ fileName

TQString VCSFileInfo::fileName

The file name.

Definition at line 72 of file kdevversioncontrol.h.

◆ repoRevision

TQString VCSFileInfo::repoRevision

The repository revision number.

Definition at line 76 of file kdevversioncontrol.h.

◆ state

FileState VCSFileInfo::state

The state of a file.

Definition at line 78 of file kdevversioncontrol.h.

◆ workRevision

TQString VCSFileInfo::workRevision

The working revision number.

Definition at line 74 of file kdevversioncontrol.h.


The documentation for this struct was generated from the following file:
  • kdevversioncontrol.h

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Extension Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.