1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSCriptTools module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSCRIPTDEBUGGERCONSOLECOMMAND_P_H
41#define QSCRIPTDEBUGGERCONSOLECOMMAND_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/qobjectdefs.h>
55#include <QtCore/qscopedpointer.h>
56#include <QtCore/qlist.h>
57
58QT_BEGIN_NAMESPACE
59
60class QString;
61class QStringList;
62class QScriptDebuggerConsole;
63class QScriptDebuggerConsoleCommandJob;
64class QScriptMessageHandlerInterface;
65class QScriptDebuggerCommandSchedulerInterface;
66
67class QScriptDebuggerConsoleCommandPrivate;
68class Q_AUTOTEST_EXPORT QScriptDebuggerConsoleCommand
69{
70public:
71 QScriptDebuggerConsoleCommand();
72 virtual ~QScriptDebuggerConsoleCommand();
73
74 virtual QString name() const = 0;
75 virtual QString group() const = 0;
76 virtual QString shortDescription() const = 0;
77 virtual QString longDescription() const = 0;
78 virtual QStringList seeAlso() const;
79 virtual QStringList aliases() const;
80
81 virtual QStringList argumentTypes() const;
82
83 virtual QStringList subCommands() const;
84 virtual QScriptDebuggerConsoleCommandJob *createJob(
85 const QStringList &arguments,
86 QScriptDebuggerConsole *console,
87 QScriptMessageHandlerInterface *messageHandler,
88 QScriptDebuggerCommandSchedulerInterface *scheduler) = 0;
89
90protected:
91 QScriptDebuggerConsoleCommand(QScriptDebuggerConsoleCommandPrivate &dd);
92 QScopedPointer<QScriptDebuggerConsoleCommandPrivate> d_ptr;
93
94private:
95 Q_DECLARE_PRIVATE(QScriptDebuggerConsoleCommand)
96 Q_DISABLE_COPY(QScriptDebuggerConsoleCommand)
97};
98
99typedef QList<QScriptDebuggerConsoleCommand*> QScriptDebuggerConsoleCommandList;
100
101QT_END_NAMESPACE
102
103#endif
104

source code of qtscript/src/scripttools/debugging/qscriptdebuggerconsolecommand_p.h