KateScriptManager Class Reference

#include <katescriptmanager.h>

Inheritance diagram for KateScriptManager:

Signals
void	reloaded ()

Public Member Functions
void	collect ()
const QList< KateCommandLineScript * > &	commandLineScripts ()
bool	exec (KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &) override
bool	help (KTextEditor::View *view, const QString &cmd, QString &msg) override
KateIndentScript *	indentationScript (const QString &scriptname)
KateIndentScript *	indentationScriptByIndex (int index)
int	indentationScriptCount ()
KateIndentScript *	indenter (const QString &language)
void	reload ()
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	supportsRange (const QString &cmd)
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

Static Public Member Functions
static KateScriptManager *	self ()
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)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

Manage the scripts on disks – find them and query them.

Provides access to loaded scripts too.

Definition at line 26 of file katescriptmanager.h.

Constructor & Destructor Documentation

~KateScriptManager()

KateScriptManager::~KateScriptManager ( )

override

Definition at line 45 of file katescriptmanager.cpp.

Member Function Documentation

collect()

void KateScriptManager::collect

(

)

Collect all scripts.

Definition at line 96 of file katescriptmanager.cpp.

commandLineScripts()

const QList< KateCommandLineScript * > & KateScriptManager::commandLineScripts ( )

inline

Get all scripts available in the command line.

Definition at line 37 of file katescriptmanager.h.

exec()

bool KateScriptManager::exec ( KTextEditor::View * view, const QString & cmd, QString & errorMsg, const KTextEditor::Range &  )

overridevirtual

execute command

Kate::Command stuff.

Parameters

view	view to use for execution
cmd	cmd string
errorMsg	error to return if no success

Returns

success

Implements KTextEditor::Command.

Definition at line 285 of file katescriptmanager.cpp.

help()

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

overridevirtual

get help for a command

Parameters

view	view to use
cmd	cmd name
msg	help message

Returns

help available or not

Implements KTextEditor::Command.

Definition at line 305 of file katescriptmanager.cpp.

indentationScript()

KateIndentScript * KateScriptManager::indentationScript ( const QString & scriptname )

inline

Definition at line 90 of file katescriptmanager.h.

indentationScriptByIndex()

KateIndentScript * KateScriptManager::indentationScriptByIndex ( int index )

inline

Definition at line 99 of file katescriptmanager.h.

indentationScriptCount()

int KateScriptManager::indentationScriptCount ( )

inline

Definition at line 95 of file katescriptmanager.h.

indenter()

KateIndentScript * KateScriptManager::indenter

(

const QString &

language

)

Get an indentation script for the given language – if there is more than one result, this will return the script with the highest priority.

If both have the same priority, an arbitrary script will be returned. If no scripts are found, 0 is returned.

Definition at line 52 of file katescriptmanager.cpp.

reload()

void KateScriptManager::reload

(

)

explicitly reload all scripts

Definition at line 277 of file katescriptmanager.cpp.

reloaded

void KateScriptManager::reloaded ( )

signal

this signal is emitted when all scripts are deleted and reloaded again.

self()

static KateScriptManager * KateScriptManager::self ( )

inlinestatic

Definition at line 72 of file katescriptmanager.h.

---

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

• katescriptmanager.h
• katescriptmanager.cpp