|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtSCriptTools module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qscriptdebuggerconsolecommand_p.h" |
|
43 #include "qscriptdebuggerconsolecommand_p_p.h" |
|
44 |
|
45 #include <QtCore/qstringlist.h> |
|
46 |
|
47 QT_BEGIN_NAMESPACE |
|
48 |
|
49 /*! |
|
50 \since 4.5 |
|
51 \class QScriptDebuggerConsoleCommand |
|
52 \internal |
|
53 |
|
54 \brief The QScriptDebuggerConsoleCommand class is the base class of console commands. |
|
55 |
|
56 \sa QScriptDebuggerConsoleCommandManager |
|
57 */ |
|
58 |
|
59 QScriptDebuggerConsoleCommandPrivate::QScriptDebuggerConsoleCommandPrivate() |
|
60 { |
|
61 } |
|
62 |
|
63 QScriptDebuggerConsoleCommandPrivate::~QScriptDebuggerConsoleCommandPrivate() |
|
64 { |
|
65 } |
|
66 |
|
67 QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand() |
|
68 : d_ptr(new QScriptDebuggerConsoleCommandPrivate) |
|
69 { |
|
70 d_ptr->q_ptr = this; |
|
71 } |
|
72 |
|
73 QScriptDebuggerConsoleCommand::~QScriptDebuggerConsoleCommand() |
|
74 { |
|
75 } |
|
76 |
|
77 QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand(QScriptDebuggerConsoleCommandPrivate &dd) |
|
78 : d_ptr(&dd) |
|
79 { |
|
80 d_ptr->q_ptr = this; |
|
81 } |
|
82 |
|
83 /*! |
|
84 \fn QString QScriptDebuggerConsoleCommand::name() const |
|
85 |
|
86 Returns the name of this console command. |
|
87 */ |
|
88 |
|
89 /*! |
|
90 \fn QString QScriptDebuggerConsoleCommand::group() const |
|
91 |
|
92 Returns the group that this console command belongs to. |
|
93 */ |
|
94 |
|
95 /*! |
|
96 \fn QString QScriptDebuggerConsoleCommand::shortDescription() const |
|
97 |
|
98 Returns a short (one line) description of the command. |
|
99 */ |
|
100 |
|
101 /*! |
|
102 \fn QString QScriptDebuggerConsoleCommand::longDescription() const |
|
103 |
|
104 Returns a detailed description of how to use the command. |
|
105 */ |
|
106 |
|
107 /*! |
|
108 \fn QScriptDebuggerConsoleCommandJob *QScriptDebuggerConsoleCommand::createJob( |
|
109 const QStringList &arguments, |
|
110 QScriptDebuggerConsole *console, |
|
111 QScriptMessageHandlerInterface *messageHandler, |
|
112 QScriptDebuggerCommandSchedulerInterface *scheduler) = 0 |
|
113 |
|
114 Creates a job that will execute this command with the given \a |
|
115 arguments. If the command cannot be executed (e.g. because one or |
|
116 more arguments are invalid), a suitable error message should be |
|
117 output to the \a messageHandler, and 0 should be returned. |
|
118 */ |
|
119 |
|
120 /*! |
|
121 Returns a list of names of commands that may also be of interest to |
|
122 users of this command. |
|
123 */ |
|
124 QStringList QScriptDebuggerConsoleCommand::seeAlso() const |
|
125 { |
|
126 return QStringList(); |
|
127 } |
|
128 |
|
129 /*! |
|
130 Returns a list of aliases for this command. |
|
131 */ |
|
132 QStringList QScriptDebuggerConsoleCommand::aliases() const |
|
133 { |
|
134 return QStringList(); |
|
135 } |
|
136 |
|
137 QStringList QScriptDebuggerConsoleCommand::argumentTypes() const |
|
138 { |
|
139 return QStringList(); |
|
140 } |
|
141 |
|
142 QStringList QScriptDebuggerConsoleCommand::subCommands() const |
|
143 { |
|
144 return QStringList(); |
|
145 } |
|
146 |
|
147 QT_END_NAMESPACE |