The QScriptDebuggerConsoleCommand class is the base class of console commands. More...

#include <qscriptdebuggerconsolecommand_p.h>

Inheritance diagram for QScriptDebuggerConsoleCommand:

Public Functions
virtual QStringList	aliases () const
	Returns a list of aliases for this command. More...

virtual QStringList	argumentTypes () const

virtual QScriptDebuggerConsoleCommandJob *	createJob (const QStringList &arguments, QScriptDebuggerConsole console, QScriptMessageHandlerInterface messageHandler, QScriptDebuggerCommandSchedulerInterface *scheduler)=0
	Creates a job that will execute this command with the given arguments. More...

virtual QString	group () const =0
	Returns the group that this console command belongs to. More...

virtual QString	longDescription () const =0
	Returns a detailed description of how to use the command. More...

virtual QString	name () const =0
	Returns the name of this console command. More...

	QScriptDebuggerConsoleCommand ()

virtual QStringList	seeAlso () const
	Returns a list of names of commands that may also be of interest to users of this command. More...

virtual QString	shortDescription () const =0
	Returns a short (one line) description of the command. More...

virtual QStringList	subCommands () const

virtual	~QScriptDebuggerConsoleCommand ()

Protected Functions
	QScriptDebuggerConsoleCommand (QScriptDebuggerConsoleCommandPrivate &dd)

Protected Variables
QScopedPointer< QScriptDebuggerConsoleCommandPrivate >	d_ptr

Detailed Description

The QScriptDebuggerConsoleCommand class is the base class of console commands.

Since: 4.5

Warning: This function is not part of the public interface.

See also: QScriptDebuggerConsoleCommandManager

Definition at line 70 of file qscriptdebuggerconsolecommand_p.h.

Constructors and Destructors

◆ QScriptDebuggerConsoleCommand() [1/2]

QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand ( )

Definition at line 70 of file qscriptdebuggerconsolecommand.cpp.

     : d_ptr(new QScriptDebuggerConsoleCommandPrivate)
 {
     d_ptr->q_ptr = this;
 }

◆ ~QScriptDebuggerConsoleCommand()

QScriptDebuggerConsoleCommand::~QScriptDebuggerConsoleCommand ( )

virtual

Definition at line 76 of file qscriptdebuggerconsolecommand.cpp.

77 {

78 }

◆ QScriptDebuggerConsoleCommand() [2/2]

QScriptDebuggerConsoleCommand::QScriptDebuggerConsoleCommand ( QScriptDebuggerConsoleCommandPrivate & dd )

protected

Definition at line 80 of file qscriptdebuggerconsolecommand.cpp.

     : d_ptr(&dd)
 {
     d_ptr->q_ptr = this;
 }

Functions

◆ aliases()

QStringList QScriptDebuggerConsoleCommand::aliases ( ) const

virtual

Returns a list of aliases for this command.

Reimplemented in QScriptDebuggerScriptedConsoleCommand.

Definition at line 147 of file qscriptdebuggerconsolecommand.cpp.

Referenced by consoleCommandToScriptValue(), and QScriptDebuggerConsoleCommandManager::findCommand().

 {
     return QStringList();
 }

◆ argumentTypes()

QStringList QScriptDebuggerConsoleCommand::argumentTypes ( ) const

virtual

Reimplemented in QScriptDebuggerScriptedConsoleCommand.

Definition at line 152 of file qscriptdebuggerconsolecommand.cpp.

Referenced by QScriptDebuggerConsolePrivate::createJob(), and QScriptCompletionTask::start().

 {
     return QStringList();
 }

◆ createJob()

QScriptDebuggerConsoleCommandJob * QScriptDebuggerConsoleCommand::createJob	(	const QStringList &	arguments,
		QScriptDebuggerConsole *	console,
		QScriptMessageHandlerInterface *	messageHandler,
		QScriptDebuggerCommandSchedulerInterface *	scheduler
	)

pure virtual

Creates a job that will execute this command with the given 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 messageHandler, and 0 should be returned.

Implemented in QScriptDebuggerScriptedConsoleCommand.

Referenced by QScriptDebuggerConsolePrivate::createJob().