KateScriptManager

#include <katescriptmanager.h>

Inheritance diagram for KateScriptManager:

Signals

void reloaded ()
 

Public Member Functions

void collect ()
 
const QVector< 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
 
KateIndentScriptindentationScript (const QString &scriptname)
 
KateIndentScriptindentationScriptByIndex (int index)
 
int indentationScriptCount ()
 
KateIndentScriptindenter (const QString &language)
 
void reload ()
 
- Public Member Functions inherited from KTextEditor::Command
 Command (const QStringList &cmds, QObject *parent=nullptr)
 
virtual ~Command ()
 
const QStringListcmds () const
 
virtual KCompletioncompletionObject (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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static KateScriptManagerself ()
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () 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 41 of file katescriptmanager.h.

Member Function Documentation

void KateScriptManager::collect ( )

Collect all scripts.

now, we search all kinds of known scripts

get file basename

only load scripts once, even if multiple installed variants found!

remember the script

open file or skip it

search json header or skip this file

parse json header or skip this file

remember type

Definition at line 108 of file katescriptmanager.cpp.

const QVector<KateCommandLineScript *>& KateScriptManager::commandLineScripts ( )
inline

Get all scripts available in the command line.

Definition at line 52 of file katescriptmanager.h.

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

execute command

Kate::Command stuff.

Parameters
viewview to use for execution
cmdcmd string
errorMsgerror to return if no success
Returns
success

Implements KTextEditor::Command.

Definition at line 309 of file katescriptmanager.cpp.

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

get help for a command

Parameters
viewview to use
cmdcmd name
msghelp message
Returns
help available or not

Implements KTextEditor::Command.

Definition at line 329 of file katescriptmanager.cpp.

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 65 of file katescriptmanager.cpp.

void KateScriptManager::reload ( )

explicitly reload all scripts

Definition at line 301 of file katescriptmanager.cpp.

void KateScriptManager::reloaded ( )
signal

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


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Aug 4 2020 22:56:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.