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

kdevplatform/vcs

  • sources
  • kfour-appscomplete
  • kdevelop
  • kdevplatform
  • vcs
vcsannotation.h
Go to the documentation of this file.
1 /* This file is part of KDevelop
2  *
3  * Copyright 2007 Andreas Pakulat <[email protected]>
4  * Copyright 2007 Matthew Woehlke <[email protected]>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  * 02110-1301, USA.
20  */
21 
22 #ifndef KDEVPLATFORM_VCSANNOTATION_H
23 #define KDEVPLATFORM_VCSANNOTATION_H
24 
25 #include "vcsexport.h"
26 #include <QMetaType>
27 #include <QSharedDataPointer>
28 
29 class QString;
30 class QDateTime;
31 class QUrl;
32 
33 namespace KDevelop
34 {
35 class VcsRevision;
36 
40 class KDEVPLATFORMVCS_EXPORT VcsAnnotationLine
41 {
42 public:
43  VcsAnnotationLine();
44  VcsAnnotationLine( const VcsAnnotationLine& );
45  virtual ~VcsAnnotationLine();
49  int lineNumber() const;
53  QString text() const;
57  QString author() const;
61  VcsRevision revision() const;
65  QDateTime date() const;
69  QString commitMessage() const;
74  void setLineNumber( int lineno );
79  void setText( const QString& text );
84  void setAuthor( const QString& author );
89  void setRevision( const VcsRevision& revision );
94  void setDate( const QDateTime& date );
100  void setCommitMessage( const QString& msg );
101 
102  VcsAnnotationLine& operator=( const VcsAnnotationLine& rhs);
103 
104 private:
105  QSharedDataPointer<class VcsAnnotationLinePrivate> d;
106 };
107 
115 class KDEVPLATFORMVCS_EXPORT VcsAnnotation
116 {
117 public:
118  VcsAnnotation();
119  VcsAnnotation(const VcsAnnotation&);
120  virtual ~VcsAnnotation();
124  QUrl location() const;
128  int lineCount() const;
129 
133  VcsAnnotationLine line( int linenumber ) const;
134 
143  void insertLine( int lineno, const VcsAnnotationLine& line );
144 
148  void setLocation( const QUrl& location );
149 
150  bool containsLine( int lineno ) const;
151 
152  VcsAnnotation& operator=( const VcsAnnotation& rhs);
153 
154 private:
155  QSharedDataPointer<class VcsAnnotationPrivate> d;
156 };
157 
158 }
159 
160 Q_DECLARE_METATYPE( KDevelop::VcsAnnotation )
161 Q_DECLARE_TYPEINFO( KDevelop::VcsAnnotation, Q_MOVABLE_TYPE );
162 Q_DECLARE_METATYPE( KDevelop::VcsAnnotationLine )
163 Q_DECLARE_TYPEINFO( KDevelop::VcsAnnotationLine, Q_MOVABLE_TYPE);
164 
165 #endif
166 
QUrl
QSharedDataPointer< class VcsAnnotationLinePrivate >
KDevelop::VcsRevision
Encapsulates a vcs revision number, date or range of revisions.
Definition: vcsrevision.h:66
QString
Q_DECLARE_TYPEINFO
Q_DECLARE_TYPEINFO(KDevelop::VcsAnnotation, Q_MOVABLE_TYPE)
KDevelop::VcsAnnotationLine
Annotation information for a line of a version controlled file.
Definition: vcsannotation.h:40
KDevelop::VcsAnnotation
Annotations for a local file.
Definition: vcsannotation.h:115
KDevelop
Definition: dvcsevent.h:33
QDateTime
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