• 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
vcsjob.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_VCSJOB_H
23 #define KDEVPLATFORM_VCSJOB_H
24 
25 #include <outputview/outputjob.h>
26 
27 #include "vcsexport.h"
28 
29 class QVariant;
30 
31 namespace KDevelop
32 {
33 
34 class IPlugin;
35 class VcsJobPrivate;
36 
43 class KDEVPLATFORMVCS_EXPORT VcsJob : public OutputJob
44 {
45  Q_OBJECT
46 public:
47  explicit VcsJob( QObject* parent = nullptr, OutputJobVerbosity verbosity = OutputJob::Verbose);
48  ~VcsJob() override;
55  enum JobType
56  {
57  Unknown = -1 ,
58  Add = 0 ,
59  Remove = 1 ,
60  Copy = 2 ,
61  Move = 3 ,
62  Diff = 4 ,
63  Commit = 5 ,
64  Update = 6 ,
65  Merge = 7 ,
66  Resolve = 8 ,
67  Import = 9 ,
68  Checkout = 10 ,
69  Log = 11 ,
70  Push = 12 ,
71  Pull = 13 ,
72  Annotate = 14 ,
73  Clone = 15 ,
74  Status = 16 ,
75  Revert = 17 ,
76  Cat = 18 ,
77  Reset = 19 ,
78  Apply = 20 ,
79  UserType = 1000
80  };
81 
85  enum JobStatus
86  {
87  JobRunning = 0 ,
88  JobSucceeded = 1 ,
89  JobCanceled = 2 ,
90  JobFailed = 3 ,
91  JobNotStarted = 4
92  };
93 
101  virtual QVariant fetchResults() = 0;
102 
110  virtual JobStatus status() const = 0;
111 
117  JobType type() const;
118 
125  virtual KDevelop::IPlugin* vcsPlugin() const = 0;
126 
130  void setType( JobType );
131 
132 Q_SIGNALS:
138  void resultsReady( KDevelop::VcsJob* );
139 
140 private Q_SLOTS:
141  void delayedModelInitialize();
142 
143 private:
144  const QScopedPointer<class VcsJobPrivate> d_ptr;
145  Q_DECLARE_PRIVATE(VcsJob)
146 };
147 
148 }
149 
150 #endif
151 
IPlugin
QObject
QScopedPointer< class VcsJobPrivate >
OutputJob
KDevelop::VcsJob
This class provides an extension of KJob to get various VCS-specific information about the job.
Definition: vcsjob.h:43
KDevelop::VcsJob::JobType
JobType
To easily check which type of job this is.
Definition: vcsjob.h:55
KDevelop
Definition: dvcsevent.h:33
QVariant
KDevelop::VcsJob::JobStatus
JobStatus
Simple enum to define how the job finished.
Definition: vcsjob.h:85
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Apr 16 2021 23:31:09 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