KateCommandLineScript Class Reference

#include <katecommandlinescript.h>

Inheritance diagram for KateCommandLineScript:

Public Member Functions
	KateCommandLineScript (const QString &url, const KateCommandLineScriptHeader &header)
bool	callFunction (const QString &cmd, const QStringList &args, QString &errorMessage)
const KateCommandLineScriptHeader &	commandHeader ()
bool	exec (KTextEditor::View *view, const QString &cmd, QString &msg, const KTextEditor::Range &range=KTextEditor::Range::invalid()) override
bool	help (KTextEditor::View *view, const QString &cmd, QString &msg) override
bool	supportsRange (const QString &cmd) override
Public Member Functions inherited from KateScript
	KateScript (const QString &urlOrScript, enum InputType inputType=InputURL)
void	clearExceptions ()
void	displayBacktrace (const QJSValue &error, const QString &header=QString())
const QString &	errorMessage ()
QJSValue	evaluate (const QString &program, const FieldMap &env=FieldMap())
QJSValue	function (const QString &name)
KateScriptHeader &	generalHeader ()
QJSValue	global (const QString &name)
bool	load ()
void	setGeneralHeader (const KateScriptHeader &generalHeader)
bool	setView (KTextEditor::ViewPrivate *view)
const QString &	url ()
Public Member Functions inherited from KTextEditor::Command
	Command (const QStringList &cmds, QObject *parent=nullptr)
	~Command () override
const QStringList &	cmds () const
virtual KCompletion *	completionObject (KTextEditor::View *view, const QString &cmdname)
virtual void	processText (KTextEditor::View *view, const QString &text)
virtual bool	wantsToProcessText (const QString &cmdname)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from KateScript
typedef QMap< QString, QJSValue >	FieldMap
enum	InputType { InputURL , InputSCRIPT }
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from KateScript
static QString	backtrace (const QJSValue &error, const QString &header=QString())
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from KateScript
bool	hasException (const QJSValue &object, const QString &file)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)
Protected Attributes inherited from KateScript
QJSEngine *	m_engine = nullptr

Detailed Description

A specialized class for scripts that are of type ScriptType::Indentation.

Definition at line 54 of file katecommandlinescript.h.

Constructor & Destructor Documentation

KateCommandLineScript()

KateCommandLineScript::KateCommandLineScript	(	const QString &	url,
		const KateCommandLineScriptHeader &	header )

Definition at line 20 of file katecommandlinescript.cpp.

Member Function Documentation

callFunction()

bool KateCommandLineScript::callFunction	(	const QString &	cmd,
		const QStringList &	args,
		QString &	errorMessage )

Definition at line 32 of file katecommandlinescript.cpp.

commandHeader()

const KateCommandLineScriptHeader & KateCommandLineScript::commandHeader

(

)

Definition at line 27 of file katecommandlinescript.cpp.

exec()

bool KateCommandLineScript::exec ( KTextEditor::View * view, const QString & cmd, QString & msg, const KTextEditor::Range & range = KTextEditor::Range::invalid() )

overridevirtual

Execute the command for the given view and cmd string.

Return the success value and a msg for status. As example we consider a replace command. The replace command would return the number of replaced strings as msg, like "16 replacements made." If an error occurred in the usage it would return false and set the msg to something like "missing argument." or such.

If a non-invalid range is given, the command shall be executed on that range. supportsRange() tells if the command supports that.

Returns

true on success, otherwise false

Implements KTextEditor::Command.

Definition at line 58 of file katecommandlinescript.cpp.

help()

bool KateCommandLineScript::help ( KTextEditor::View * view, const QString & cmd, QString & msg )

overridevirtual

Shows help for the given view and cmd string.

If your command has a help text for cmd you have to return true and set the msg to a meaningful text. The help text is embedded by the Editor in a Qt::RichText enabled widget, e.g. a QToolTip.

Returns

true if your command has a help text, otherwise false

Implements KTextEditor::Command.

Definition at line 97 of file katecommandlinescript.cpp.

supportsRange()

bool KateCommandLineScript::supportsRange ( const QString & cmd )

overridevirtual

Find out if a given command can act on a range.

This is used for checking if a command should be called when the user also gave a range or if an error should be raised.

Returns

true if command supports acting on a range of lines, false not. The default implementation returns false.

Reimplemented from KTextEditor::Command.

Definition at line 92 of file katecommandlinescript.cpp.

---

The documentation for this class was generated from the following files:

• katecommandlinescript.h
• katecommandlinescript.cpp