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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Qt Software Information (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
**
**************************************************************************/
#ifndef VCSBASE_SUBMITEDITOR_H
#define VCSBASE_SUBMITEDITOR_H
#include "vcsbase_global.h"
#include <coreplugin/editormanager/ieditor.h>
#include <QtCore/QList>
#include <QtGui/QAbstractItemView>
QT_BEGIN_NAMESPACE
class QIcon;
class QAbstractItemModel;
class QAction;
QT_END_NAMESPACE
namespace Core {
namespace Utils {
class SubmitEditorWidget;
}
}
namespace VCSBase {
struct VCSBaseSubmitEditorPrivate;
/* Utility struct to parametrize a VCSBaseSubmitEditor. */
struct VCSBASE_EXPORT VCSBaseSubmitEditorParameters {
const char *mimeType;
const char *kind;
const char *context;
};
/* Base class for a submit editor based on the Core::Utils::SubmitEditorWidget
* that presents the commit message in a text editor and an
* checkable list of modified files in a list window. The user can delete
* files from the list by pressing unchecking them or diff the selection
* by doubleclicking.
*
* The action matching the the ids (unless 0) of the parameter struct will be
* registered with the EditorWidget and submit/diff actions will be added to
* a toolbar.
*
* For the given context, there must be only one instance of the editor
* active.
* To start a submit, set the submit template on the editor and the output
* of the VCS status command listing the modified files as fileList and open
* it.
* The submit process is started by listening on the editor close
* signal and then asking the IFile interface of the editor to save the file
* within a IFileManager::blockFileChange() section
* and to launch the submit process. In addition, the action registered
* for submit sho src/libs/utils/submiteditorwidget.h
uld be connected to a slot triggering the close of the
* current editor in the editor manager. */
class VCSBASE_EXPORT VCSBaseSubmitEditor : public Core::IEditor
{
Q_OBJECT
Q_PROPERTY(int fileNameColumn READ fileNameColumn WRITE setFileNameColumn DESIGNABLE false)
Q_PROPERTY(QAbstractItemView::SelectionMode fileListSelectionMode READ fileListSelectionMode WRITE setFileListSelectionMode DESIGNABLE true)
public:
typedef QList<int> Context;
protected:
explicit VCSBaseSubmitEditor(const VCSBaseSubmitEditorParameters *parameters,
Core::Utils::SubmitEditorWidget *editorWidget);
public:
// Register the actions with the submit editor widget.
void registerActions(QAction *editorUndoAction, QAction *editorRedoAction,
QAction *submitAction = 0, QAction *diffAction = 0);
void unregisterActions(QAction *editorUndoAction, QAction *editorRedoAction,
QAction *submitAction = 0, QAction *diffAction = 0);
virtual ~VCSBaseSubmitEditor();
int fileNameColumn() const;
void setFileNameColumn(int c);
QAbstractItemView::SelectionMode fileListSelectionMode() const;
void setFileListSelectionMode(QAbstractItemView::SelectionMode sm);
// Core::IEditor
virtual bool createNew(const QString &contents);
virtual bool open(const QString &fileName);
virtual Core::IFile *file();
virtual QString displayName() const;
virtual void setDisplayName(const QString &title);
virtual bool duplicateSupported() const;
virtual Core::IEditor *duplicate(QWidget * parent);
virtual const char *kind() const;
virtual QToolBar *toolBar();
virtual QList<int> context() const;
virtual QWidget *widget();
virtual QByteArray saveState() const;
virtual bool restoreState(const QByteArray &state);
QStringList checkedFiles() const;
void setFileModel(QAbstractItemModel *m);
QAbstractItemModel *fileModel() const;
// Utilities returning some predefined icons for actions
static QIcon diffIcon();
static QIcon submitIcon();
// Utility returning all project files in case submit lists need to
// be restricted to them
static QStringList currentProjectFiles(bool nativeSeparators, QString *name = 0);
signals:
void diffSelectedFiles(const QStringList &files);
private slots:
void slotDiffSelectedVCSFiles(const QStringList &rawList);
bool save(const QString &fileName);
void slotDescriptionChanged();
protected:
/* These hooks allow for modifying the contents that goes to
* the file. The default implementation uses the text
* of the description editor. */
virtual QString fileContents() const;
virtual bool setFileContents(const QString &contents);
private:
VCSBaseSubmitEditorPrivate *m_d;
};
} // namespace VCSBase
#endif // VCSBASE_SUBMITEDITOR_H
|
