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#include "qscriptdebuggerconsolecommand_p.h"
41#include "qscriptdebuggerconsolecommand_p_p.h"
42
43#include <QtCore/qstringlist.h>
44
45QT_BEGIN_NAMESPACE
46
47/*!
48 \since 4.5
49 \class QScriptDebuggerConsoleCommand
50 \internal
51
52 \brief The QScriptDebuggerConsoleCommand class is the base class of console commands.
53
54 \sa QScriptDebuggerConsoleCommandManager
55*/
56
57QScriptDebuggerConsoleCommandPrivate::QScriptDebuggerConsoleCommandPrivate()
58{
59}
60
61QScriptDebuggerConsoleCommandPrivate::~QScriptDebuggerConsoleCommandPrivate()
62{
63}
64
65QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand()
66 : d_ptr(new QScriptDebuggerConsoleCommandPrivate)
67{
68 d_ptr->q_ptr = this;
69}
70
71QScriptDebuggerConsoleCommand::~QScriptDebuggerConsoleCommand()
72{
73}
74
75QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand(QScriptDebuggerConsoleCommandPrivate &dd)
76 : d_ptr(&dd)
77{
78 d_ptr->q_ptr = this;
79}
80
81/*!
82 \fn QString QScriptDebuggerConsoleCommand::name() const
83
84 Returns the name of this console command.
85*/
86
87/*!
88 \fn QString QScriptDebuggerConsoleCommand::group() const
89
90 Returns the group that this console command belongs to.
91*/
92
93/*!
94 \fn QString QScriptDebuggerConsoleCommand::shortDescription() const
95
96 Returns a short (one line) description of the command.
97*/
98
99/*!
100 \fn QString QScriptDebuggerConsoleCommand::longDescription() const
101
102 Returns a detailed description of how to use the command.
103*/
104
105/*!
106 \fn QScriptDebuggerConsoleCommandJob *QScriptDebuggerConsoleCommand::createJob(
107 const QStringList &arguments,
108 QScriptDebuggerConsole *console,
109 QScriptMessageHandlerInterface *messageHandler,
110 QScriptDebuggerCommandSchedulerInterface *scheduler) = 0
111
112 Creates a job that will execute this command with the given \a
113 arguments. If the command cannot be executed (e.g. because one or
114 more arguments are invalid), a suitable error message should be
115 output to the \a messageHandler, and 0 should be returned.
116*/
117
118/*!
119 Returns a list of names of commands that may also be of interest to
120 users of this command.
121*/
122QStringList QScriptDebuggerConsoleCommand::seeAlso() const
123{
124 return QStringList();
125}
126
127/*!
128 Returns a list of aliases for this command.
129*/
130QStringList QScriptDebuggerConsoleCommand::aliases() const
131{
132 return QStringList();
133}
134
135QStringList QScriptDebuggerConsoleCommand::argumentTypes() const
136{
137 return QStringList();
138}
139
140QStringList QScriptDebuggerConsoleCommand::subCommands() const
141{
142 return QStringList();
143}
144
145QT_END_NAMESPACE
146

source code of qtscript/src/scripttools/debugging/qscriptdebuggerconsolecommand.cpp