KateCommands::CoreCommands

Search for usage in LXR

KateCommands::CoreCommands Class Reference

#include <katecmds.h>

Inheritance diagram for KateCommands::CoreCommands:

Public Member Functions

KCompletioncompletionObject (KTextEditor::View *, const QString &) override
 
bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg)
 
bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &range=KTextEditor::Range(-1, -0, -1, 0)) override
 
bool help (class KTextEditor::View *, const QString &, QString &) override
 
bool supportsRange (const QString &range) override
 
- Public Member Functions inherited from KTextEditor::Command
 Command (const QStringList &cmds, QObject *parent=nullptr)
 
 ~Command () override
 
const QStringListcmds () const
 
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< QStringbindableObjectName ()
 
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 () const const
 
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 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 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_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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

Static Public Member Functions

static CoreCommandsself ()
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This KTextEditor::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc.

it needs to get a kateview pointer, it will cast the kate::view pointer hard to kateview

Definition at line 30 of file katecmds.h.

Constructor & Destructor Documentation

◆ ~CoreCommands()

KateCommands::CoreCommands::~CoreCommands ( )
inlineoverride

Definition at line 67 of file katecmds.h.

Member Function Documentation

◆ completionObject()

KCompletion * KateCommands::CoreCommands::completionObject ( KTextEditor::View * view,
const QString & cmd )
overridevirtual

override from KTextEditor::Command

Reimplemented from KTextEditor::Command.

Definition at line 450 of file katecmds.cpp.

◆ exec() [1/2]

bool KateCommands::CoreCommands::exec ( class KTextEditor::View * view,
const QString & cmd,
QString & errorMsg )

execute command

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

◆ exec() [2/2]

bool KateCommands::CoreCommands::exec ( class KTextEditor::View * view,
const QString & cmd,
QString & errorMsg,
const KTextEditor::Range & range = KTextEditor::Range(-1, -0, -1, 0) )
overridevirtual

execute command on given range

Parameters
viewview to use for execution
cmdcmd string
errorMsgerror to return if no success
rangerange to execute command on
Returns
success

Implements KTextEditor::Command.

Definition at line 206 of file katecmds.cpp.

◆ help()

bool KateCommands::CoreCommands::help ( class KTextEditor::View * ,
const QString & cmd,
QString & msg )
overridevirtual

This command does not have help.

See also
KTextEditor::Command::help

Implements KTextEditor::Command.

Definition at line 48 of file katecmds.cpp.

◆ self()

static CoreCommands * KateCommands::CoreCommands::self ( )
inlinestatic

Definition at line 100 of file katecmds.h.

◆ supportsRange()

bool KateCommands::CoreCommands::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 438 of file katecmds.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:17:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.