1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/* This file is part of the KDE project
Copyright (C) 2004 Alexander Dymo <adymo@kdevelop.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVVCSINTEGRATOR_H
#define KDEVVCSINTEGRATOR_H
#include <qobject.h>
/**
@file kdevvcsintegrator.h
The interface to VCS integrators.
*/
class QDomDocument;
class QWidget;
/**
VCS Integration Dialog.
Usually it is created as:
@code
class MyVCSDialog: public QWidget, public VCSDialog {
MyVCSDialog(QWidget *parent = 0, const char *name = 0);
virtual void accept() { ... }
virtual void init(const QString &projectName, const QString &projectLocation) { ... }
virtual QWidget *self() {
return const_cast<MyVCSDialog*>(this);
}
}
@endcode
*/
class VCSDialog {
public:
VCSDialog() { }
/**Implement all integration actions here. Do not use QDialog::accept method
to perform integration actions.*/
virtual void accept() = 0;
/**Init integration dialog with the project name and location.*/
virtual void init(const QString &projectName, const QString &projectLocation) = 0;
/**Reimplement to return an actual integration widget. Use QWidgets for that, not
QDialogs because integrator dialogs are usually have parent containers.*/
virtual QWidget *self() = 0;
};
/**
The interface to VCS integrators.
VCS integrator takes care about setting up VCS for new and existing projects.
It can, for example, perform checkout or import operations.
*/
class KDevVCSIntegrator: public QObject {
Q_OBJECT
public:
KDevVCSIntegrator(QObject *parent = 0, const char *name = 0);
/**Reimplement to return a dialog to fetch the project from VCS.*/
virtual VCSDialog *fetcher(QWidget *parent) = 0;
/**Reimplement to return a dialog to integrate the project into VCS.*/
virtual VCSDialog *integrator(QWidget *parent) = 0;
};
#endif
|
