KTextEditor::EditorPrivate

#include <kateglobal.h>

Inheritance diagram for KTextEditor::EditorPrivate:

Signals

void clipboardHistoryChanged ()
 
- Signals inherited from KTextEditor::Editor
void configChanged (KTextEditor::Editor *editor)
 
void documentCreated (KTextEditor::Editor *editor, KTextEditor::Document *document)
 

Public Member Functions

 ~EditorPrivate ()
 
const KAboutDataaboutData () const override
 
KTextEditor::Applicationapplication () const override
 
const QStringListclipboardHistory () const
 
KateCmd * cmdManager ()
 
QStringList commandList () const override
 
QList< KTextEditor::Command * > commands () const override
 
void configDialog (QWidget *parent) override
 
KTextEditor::ConfigPageconfigPage (int number, QWidget *parent) override
 
int configPages () const override
 
void copyToClipboard (const QString &text)
 
KTextEditor::DocumentcreateDocument (QObject *parent) override
 
void deregisterDocument (KTextEditor::DocumentPrivate *doc)
 
void deregisterView (KTextEditor::ViewPrivate *view)
 
KDirWatchdirWatch ()
 
KateDocumentConfig * documentConfig ()
 
QList< KTextEditor::Document * > documents () override
 
KTextEditor::MainWindowdummyMainWindow ()
 
KateHlManager * hlManager ()
 
QList< KateAbstractInputModeFactory * > inputModeFactories ()
 
QList< KTextEditor::DocumentPrivate * > kateDocuments ()
 
KateKeywordCompletionModelkeywordCompletionModel ()
 
KateModeManager * modeManager ()
 
KTextEditor::CommandqueryCommand (const QString &cmd) const override
 
void registerDocument (KTextEditor::DocumentPrivate *doc)
 
void registerView (KTextEditor::ViewPrivate *view)
 
KateRendererConfig * rendererConfig ()
 
QStringListModelreplaceHistoryModel ()
 
void saveSearchReplaceHistoryModels ()
 
KateScriptManagerscriptManager ()
 
QStringListModelsearchHistoryModel ()
 
void setApplication (KTextEditor::Application *application) override
 
KateSpellCheckManager * spellCheckManager ()
 
void triggerConfigChanged ()
 
KateVariableExpansionManagervariableExpansionManager ()
 
KateViewConfig * viewConfig ()
 
QList< KTextEditor::ViewPrivate * > views ()
 
KateWordCompletionModel * wordCompletionModel ()
 
- Public Member Functions inherited from KTextEditor::Editor
void addVariableExpansion (const QVector< QWidget * > &widgets, const QStringList &variables=QStringList()) const
 
QString defaultEncoding () const
 
void expandText (const QString &text, KTextEditor::View *view, QString &output) const
 
bool expandVariable (const QString &variable, KTextEditor::View *view, QString &output) const
 
bool registerVariableMatch (const QString &name, const QString &description, ExpandFunction expansionFunc)
 
bool registerVariablePrefix (const QString &prefix, const QString &description, ExpandFunction expansionFunc)
 
KSyntaxHighlighting::Theme theme () const
 
bool unregisterVariableMatch (const QString &variable)
 
bool unregisterVariablePrefix (const QString &variable)
 
- 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)
 
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 KSharedConfigPtr config ()
 
static void enableUnitTestMode ()
 
static KTextEditor::EditorPrivateself ()
 
static bool unitTestMode ()
 
- Static Public Member Functions inherited from KTextEditor::Editor
static Editorinstance ()
 
- 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)
 

Protected Member Functions

bool eventFilter (QObject *, QEvent *) override
 
- Protected Member Functions inherited from KTextEditor::Editor
 Editor (EditorPrivate *impl)
 
virtual ~Editor ()
 
- 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)
 

Additional Inherited Members

- Public Types inherited from KTextEditor::Editor
using ExpandFunction = QString(*)(const QStringView &text, KTextEditor::View *view)
 
- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

KTextEditor::EditorPrivate One instance of this class is hold alive during a kate part session, as long as any factory, document or view stay around, here is the place to put things which are needed and shared by all this objects ;)

Definition at line 64 of file kateglobal.h.

Constructor & Destructor Documentation

KTextEditor::EditorPrivate::~EditorPrivate ( )

Destructor.

Definition at line 228 of file kateglobal.cpp.

Member Function Documentation

const KAboutData& KTextEditor::EditorPrivate::aboutData ( ) const
inlineoverridevirtual

General Information about this editor.

return the about data

Returns
about data of this editor part

Implements KTextEditor::Editor.

Definition at line 145 of file kateglobal.h.

KTextEditor::Application* KTextEditor::EditorPrivate::application ( ) const
inlineoverridevirtual

Current hosting application, if any set.

Returns
current application object or nullptr

Implements KTextEditor::Editor.

Definition at line 132 of file kateglobal.h.

const QStringList& KTextEditor::EditorPrivate::clipboardHistory ( ) const
inline

Clipboard history, filled with text we ever copied to clipboard via copyToClipboard.

Definition at line 355 of file kateglobal.h.

void KTextEditor::EditorPrivate::clipboardHistoryChanged ( )
signal

Emitted if the history of clipboard changes via copyToClipboard.

KateCmd* KTextEditor::EditorPrivate::cmdManager ( )
inline

command manager

Returns
command manager

Definition at line 294 of file kateglobal.h.

QStringList KTextEditor::EditorPrivate::commandList ( ) const
overridevirtual

Get a list of available commandline strings.

Returns
commandline strings

Implements KTextEditor::Editor.

Definition at line 415 of file kateglobal.cpp.

QList< KTextEditor::Command * > KTextEditor::EditorPrivate::commands ( ) const
overridevirtual

Get a list of all registered commands.

Returns
list of all commands

Implements KTextEditor::Editor.

Definition at line 410 of file kateglobal.cpp.

KSharedConfigPtr KTextEditor::EditorPrivate::config ( )
static

The global configuration of katepart, e.g.

katepartrc

Returns
global shared access to katepartrc config

Definition at line 503 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::configDialog ( QWidget parent)
overridevirtual

Configuration management.

Shows a config dialog for the part, changes will be applied to the editor, but not saved anywhere automagically, call writeConfig to save them

Implements KTextEditor::Editor.

Definition at line 275 of file kateglobal.cpp.

KTextEditor::ConfigPage * KTextEditor::EditorPrivate::configPage ( int  number,
QWidget parent 
)
overridevirtual

returns config page with the given number, config pages from 0 to configPages()-1 are available if configPages() > 0

Implements KTextEditor::Editor.

Definition at line 325 of file kateglobal.cpp.

int KTextEditor::EditorPrivate::configPages ( ) const
overridevirtual

Number of available config pages If the editor returns a number < 1, it doesn't support this and the embedding app should use the configDialog () instead.

Returns
number of config pages

Implements KTextEditor::Editor.

Definition at line 320 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::copyToClipboard ( const QString text)

Copy text to clipboard an remember it in the history.

Parameters
texttext to copy to clipboard, does nothing if empty!

Definition at line 435 of file kateglobal.cpp.

KTextEditor::Document * KTextEditor::EditorPrivate::createDocument ( QObject parent)
overridevirtual

Create a new document object.

Parameters
parentparent object
Returns
created KTextEditor::Document

Implements KTextEditor::Editor.

Definition at line 264 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::deregisterDocument ( KTextEditor::DocumentPrivate *  doc)

unregister document at the factory

Parameters
docdocument to register

Definition at line 387 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::deregisterView ( KTextEditor::ViewPrivate *  view)

unregister view at the factory

Parameters
viewview to unregister

Definition at line 399 of file kateglobal.cpp.

KDirWatch* KTextEditor::EditorPrivate::dirWatch ( )
inline

global dirwatch

Returns
dirwatch instance

Definition at line 225 of file kateglobal.h.

KateDocumentConfig* KTextEditor::EditorPrivate::documentConfig ( )
inline

fallback document config

Returns
default config for all documents

Definition at line 250 of file kateglobal.h.

QList<KTextEditor::Document *> KTextEditor::EditorPrivate::documents ( )
inlineoverridevirtual

Returns a list of all documents of this editor.

Returns
list of all existing documents

Implements KTextEditor::Editor.

Definition at line 111 of file kateglobal.h.

KTextEditor::MainWindow* KTextEditor::EditorPrivate::dummyMainWindow ( )
inline

Dummy main window to be null safe.

Returns
dummy main window

Definition at line 373 of file kateglobal.h.

void KTextEditor::EditorPrivate::enableUnitTestMode ( )
static

Calling this function internally sets a flag such that unitTestMode() returns true.

Definition at line 54 of file kateglobal.cpp.

KateHlManager* KTextEditor::EditorPrivate::hlManager ( )
inline

hl manager

Returns
hl manager

Definition at line 285 of file kateglobal.h.

QList< KateAbstractInputModeFactory * > KTextEditor::EditorPrivate::inputModeFactories ( )
Returns
list of available input mode factories

Definition at line 467 of file kateglobal.cpp.

QList<KTextEditor::DocumentPrivate *> KTextEditor::EditorPrivate::kateDocuments ( )
inline

return a list of all registered docs

Returns
all known documents

Definition at line 364 of file kateglobal.h.

KateKeywordCompletionModel* KTextEditor::EditorPrivate::keywordCompletionModel ( )
inline

Global instance of the language-aware keyword completion model.

Returns
global instance of the keyword completion model

Definition at line 321 of file kateglobal.h.

KateModeManager* KTextEditor::EditorPrivate::modeManager ( )
inline

global mode manager used to manage the modes centrally

Returns
mode manager

Definition at line 241 of file kateglobal.h.

KTextEditor::Command * KTextEditor::EditorPrivate::queryCommand ( const QString cmd) const
overridevirtual

query for command

Parameters
cmdname of command to query for
Returns
found command or 0

Implements KTextEditor::Editor.

Definition at line 405 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::registerDocument ( KTextEditor::DocumentPrivate *  doc)

register document at the factory this allows us to loop over all docs for example on config changes

Parameters
docdocument to register

Definition at line 381 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::registerView ( KTextEditor::ViewPrivate *  view)

register view at the factory this allows us to loop over all views for example on config changes

Parameters
viewview to register

Definition at line 393 of file kateglobal.cpp.

KateRendererConfig* KTextEditor::EditorPrivate::rendererConfig ( )
inline

fallback renderer config

Returns
default config for all renderers

Definition at line 268 of file kateglobal.h.

QStringListModel * KTextEditor::EditorPrivate::replaceHistoryModel ( )

Replace pattern history shared among simple/power search instances.

Definition at line 482 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::saveSearchReplaceHistoryModels ( )

Call this function to store the history models to the application config.

Definition at line 492 of file kateglobal.cpp.

KateScriptManager* KTextEditor::EditorPrivate::scriptManager ( )
inline

Global script collection.

Definition at line 276 of file kateglobal.h.

QStringListModel * KTextEditor::EditorPrivate::searchHistoryModel ( )

Search pattern history shared among simple/power search instances.

Definition at line 472 of file kateglobal.cpp.

KTextEditor::EditorPrivate * KTextEditor::EditorPrivate::self ( )
static

Kate Part Internal stuff ;)

singleton accessor

Returns
instance of the factory

Definition at line 356 of file kateglobal.cpp.

void KTextEditor::EditorPrivate::setApplication ( KTextEditor::Application application)
inlineoverridevirtual

Set the global application object.

This will allow the editor component to access the hosting application.

Parameters
applicationapplication object

Implements KTextEditor::Editor.

Definition at line 122 of file kateglobal.h.

KateSpellCheckManager* KTextEditor::EditorPrivate::spellCheckManager ( )
inline

spell check manager

Returns
spell check manager

Definition at line 303 of file kateglobal.h.

void KTextEditor::EditorPrivate::triggerConfigChanged ( )

Trigger delayed emission of config changed.

Definition at line 523 of file kateglobal.cpp.

bool KTextEditor::EditorPrivate::unitTestMode ( )
static

Returns true, if the unit test mode was enabled through a call of enableUnitTestMode(), otherwise false.

Definition at line 59 of file kateglobal.cpp.

KateVariableExpansionManager * KTextEditor::EditorPrivate::variableExpansionManager ( )

Returns the variable expansion manager.

Definition at line 420 of file kateglobal.cpp.

KateViewConfig* KTextEditor::EditorPrivate::viewConfig ( )
inline

fallback view config

Returns
default config for all views

Definition at line 259 of file kateglobal.h.

QList<KTextEditor::ViewPrivate *> KTextEditor::EditorPrivate::views ( )
inline

return a list of all registered views

Returns
all known views

Definition at line 216 of file kateglobal.h.

KateWordCompletionModel* KTextEditor::EditorPrivate::wordCompletionModel ( )
inline

global instance of the simple word completion mode

Returns
global instance of the simple word completion mode

Definition at line 312 of file kateglobal.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Jan 18 2021 22:59:59 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.