src/scripttools/debugging/qscriptdebuggerconsolecommand.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/scripttools/debugging/qscriptdebuggerconsolecommand.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,147 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtSCriptTools module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qscriptdebuggerconsolecommand_p.h"
+#include "qscriptdebuggerconsolecommand_p_p.h"
+
+#include <QtCore/qstringlist.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+  \since 4.5
+  \class QScriptDebuggerConsoleCommand
+  \internal
+
+  \brief The QScriptDebuggerConsoleCommand class is the base class of console commands.
+
+  \sa QScriptDebuggerConsoleCommandManager
+*/
+
+QScriptDebuggerConsoleCommandPrivate::QScriptDebuggerConsoleCommandPrivate()
+{
+}
+
+QScriptDebuggerConsoleCommandPrivate::~QScriptDebuggerConsoleCommandPrivate()
+{
+}
+
+QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand()
+    : d_ptr(new QScriptDebuggerConsoleCommandPrivate)
+{
+    d_ptr->q_ptr = this;
+}
+
+QScriptDebuggerConsoleCommand::~QScriptDebuggerConsoleCommand()
+{
+}
+
+QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand(QScriptDebuggerConsoleCommandPrivate &dd)
+    : d_ptr(&dd)
+{
+    d_ptr->q_ptr = this;
+}
+
+/*!
+  \fn QString QScriptDebuggerConsoleCommand::name() const
+
+  Returns the name of this console command.
+*/
+
+/*!
+  \fn QString QScriptDebuggerConsoleCommand::group() const
+
+  Returns the group that this console command belongs to.
+*/
+
+/*!
+  \fn QString QScriptDebuggerConsoleCommand::shortDescription() const
+
+  Returns a short (one line) description of the command.
+*/
+
+/*!
+  \fn QString QScriptDebuggerConsoleCommand::longDescription() const
+
+  Returns a detailed description of how to use the command.
+*/
+
+/*!
+  \fn QScriptDebuggerConsoleCommandJob *QScriptDebuggerConsoleCommand::createJob(
+        const QStringList &arguments,
+        QScriptDebuggerConsole *console,
+        QScriptMessageHandlerInterface *messageHandler,
+        QScriptDebuggerCommandSchedulerInterface *scheduler) = 0
+
+  Creates a job that will execute this command with the given \a
+  arguments. If the command cannot be executed (e.g. because one or
+  more arguments are invalid), a suitable error message should be
+  output to the \a messageHandler, and 0 should be returned.
+*/
+
+/*!
+  Returns a list of names of commands that may also be of interest to
+  users of this command.
+*/
+QStringList QScriptDebuggerConsoleCommand::seeAlso() const
+{
+    return QStringList();
+}
+
+/*!
+  Returns a list of aliases for this command.
+*/
+QStringList QScriptDebuggerConsoleCommand::aliases() const
+{
+    return QStringList();
+}
+
+QStringList QScriptDebuggerConsoleCommand::argumentTypes() const
+{
+    return QStringList();
+}
+
+QStringList QScriptDebuggerConsoleCommand::subCommands() const
+{
+    return QStringList();
+}
+
+QT_END_NAMESPACE