KTextEditor::EditorPrivate
#include <kateglobal.h>
Classes | |
struct | ClipboardEntry |
Signals | |
void | clipboardHistoryChanged () |
Signals inherited from KTextEditor::Editor | |
void | configChanged (KTextEditor::Editor *editor) |
void | documentCreated (KTextEditor::Editor *editor, KTextEditor::Document *document) |
void | repositoryReloaded (KTextEditor::Editor *editor) |
Public Member Functions | |
~EditorPrivate () override | |
const KAboutData & | aboutData () const override |
KTextEditor::Application * | application () const override |
const QList< ClipboardEntry > & | clipboardHistory () const |
KateCmd * | cmdManager () |
QStringList | commandList () const override |
QList< KTextEditor::Command * > | commands () const override |
void | configDialog (QWidget *parent) override |
KTextEditor::ConfigPage * | configPage (int number, QWidget *parent) override |
int | configPages () const override |
void | copyToClipboard (const QString &text, const QString &fileName) |
void | copyToMulticursorClipboard (const QStringList &texts) |
KTextEditor::Document * | createDocument (QObject *parent) override |
void | deregisterDocument (KTextEditor::DocumentPrivate *doc) |
void | deregisterView (KTextEditor::ViewPrivate *view) |
KDirWatch * | dirWatch () |
KateDocumentConfig * | documentConfig () |
QList< KTextEditor::Document * > | documents () override |
KTextEditor::MainWindow * | dummyMainWindow () |
KateHlManager * | hlManager () |
const std::array< std::unique_ptr< KateAbstractInputModeFactory >, KTextEditor::View::ViInputMode+1 > & | inputModeFactories () |
KateKeywordCompletionModel * | keywordCompletionModel () |
KateModeManager * | modeManager () |
QStringList | multicursorClipboard () const |
KTextEditor::Command * | queryCommand (const QString &cmd) const override |
void | registerDocument (KTextEditor::DocumentPrivate *doc) |
void | registerView (KTextEditor::ViewPrivate *view) |
KateRendererConfig * | rendererConfig () |
QStringListModel * | replaceHistoryModel () |
void | saveSearchReplaceHistoryModels () |
KateScriptManager * | scriptManager () |
QStringListModel * | searchHistoryModel () |
void | setApplication (KTextEditor::Application *application) override |
QTextToSpeech * | speechEngine (KTextEditor::ViewPrivate *view) |
KateSpellCheckManager * | spellCheckManager () |
void | triggerConfigChanged () |
KateVariableExpansionManager * | variableExpansionManager () |
KateViewConfig * | viewConfig () |
const std::vector< KTextEditor::ViewPrivate * > & | views () |
KateWordCompletionModel * | wordCompletionModel () |
Public Member Functions inherited from KTextEditor::Editor | |
void | addVariableExpansion (const QList< QWidget * > &widgets, const QStringList &variables=QStringList()) const |
QString | defaultEncoding () const |
QString | expandText (const QString &text, KTextEditor::View *view) const |
bool | expandVariable (const QString &variable, KTextEditor::View *view, QString &output) const |
QFont | font () const |
bool | registerVariableMatch (const QString &name, const QString &description, ExpandFunction expansionFunc) |
bool | registerVariablePrefix (const QString &prefix, const QString &description, ExpandFunction expansionFunc) |
const KSyntaxHighlighting::Repository & | repository () const |
KSyntaxHighlighting::Theme | theme () const |
bool | unregisterVariable (const QString &variableName) |
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) |
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 KSharedConfigPtr | config () |
static KTextEditor::EditorPrivate * | self () |
Static Public Member Functions inherited from KTextEditor::Editor | |
static Editor * | instance () |
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 | |
bool | eventFilter (QObject *, QEvent *) override |
Protected Member Functions inherited from KTextEditor::Editor | |
Editor (EditorPrivate *impl) | |
~Editor () override | |
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) |
Additional Inherited Members | |
Public Types inherited from KTextEditor::Editor | |
using | ExpandFunction = QString (*)(const QStringView &text, KTextEditor::View *view) |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties inherited from QObject | |
objectName | |
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
◆ ~EditorPrivate()
|
override |
Destructor.
Definition at line 212 of file kateglobal.cpp.
Member Function Documentation
◆ aboutData()
|
inlineoverridevirtual |
General Information about this editor.
return the about data
- Returns
- about data of this editor part
Implements KTextEditor::Editor.
Definition at line 133 of file kateglobal.h.
◆ application()
|
inlineoverridevirtual |
Current hosting application, if any set.
- Returns
- current application object or nullptr
Implements KTextEditor::Editor.
Definition at line 120 of file kateglobal.h.
◆ clipboardHistory()
|
inline |
Clipboard history, filled with text we ever copied to clipboard via copyToClipboard.
Definition at line 365 of file kateglobal.h.
◆ clipboardHistoryChanged
|
signal |
Emitted if the history of clipboard changes via copyToClipboard.
◆ cmdManager()
|
inline |
◆ commandList()
|
overridevirtual |
Get a list of available commandline strings.
- Returns
- commandline strings
Implements KTextEditor::Editor.
Definition at line 442 of file kateglobal.cpp.
◆ commands()
|
overridevirtual |
Get a list of all registered commands.
- Returns
- list of all commands
Implements KTextEditor::Editor.
Definition at line 437 of file kateglobal.cpp.
◆ config()
|
static |
The global configuration of katepart, e.g.
katepartrc
- Returns
- global shared access to katepartrc config
Definition at line 526 of file kateglobal.cpp.
◆ configDialog()
|
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 324 of file kateglobal.cpp.
◆ configPage()
|
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 350 of file kateglobal.cpp.
◆ configPages()
|
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 345 of file kateglobal.cpp.
◆ copyToClipboard()
Copy text to clipboard an remember it in the history.
- Parameters
-
text text to copy to clipboard, does nothing if empty! fileName fileName of the text to copy, used for highlighting
Definition at line 462 of file kateglobal.cpp.
◆ copyToMulticursorClipboard()
void KTextEditor::EditorPrivate::copyToMulticursorClipboard | ( | const QStringList & | texts | ) |
Definition at line 562 of file kateglobal.cpp.
◆ createDocument()
|
overridevirtual |
Create a new document object.
- Parameters
-
parent parent object
- Returns
- created KTextEditor::Document
Implements KTextEditor::Editor.
Definition at line 241 of file kateglobal.cpp.
◆ deregisterDocument()
void KTextEditor::EditorPrivate::deregisterDocument | ( | KTextEditor::DocumentPrivate * | doc | ) |
unregister document at the factory
- Parameters
-
doc document to register
Definition at line 412 of file kateglobal.cpp.
◆ deregisterView()
void KTextEditor::EditorPrivate::deregisterView | ( | KTextEditor::ViewPrivate * | view | ) |
unregister view at the factory
- Parameters
-
view view to unregister
Definition at line 425 of file kateglobal.cpp.
◆ dirWatch()
|
inline |
◆ documentConfig()
|
inline |
fallback document config
- Returns
- default config for all documents
Definition at line 238 of file kateglobal.h.
◆ documents()
|
inlineoverridevirtual |
Returns a list of all documents of this editor.
- Returns
- list of all existing documents
Implements KTextEditor::Editor.
Definition at line 99 of file kateglobal.h.
◆ dummyMainWindow()
|
inline |
Dummy main window to be null safe.
- Returns
- dummy main window
Definition at line 374 of file kateglobal.h.
◆ eventFilter()
|
overrideprotectedvirtual |
Reimplemented from QObject.
Definition at line 485 of file kateglobal.cpp.
◆ hlManager()
|
inline |
◆ inputModeFactories()
|
inline |
- Returns
- list of available input mode factories
Definition at line 382 of file kateglobal.h.
◆ keywordCompletionModel()
|
inline |
Global instance of the language-aware keyword completion model.
- Returns
- global instance of the keyword completion model
Definition at line 309 of file kateglobal.h.
◆ modeManager()
|
inline |
global mode manager used to manage the modes centrally
- Returns
- mode manager
Definition at line 229 of file kateglobal.h.
◆ multicursorClipboard()
QStringList KTextEditor::EditorPrivate::multicursorClipboard | ( | ) | const |
Definition at line 573 of file kateglobal.cpp.
◆ queryCommand()
|
overridevirtual |
query for command
- Parameters
-
cmd name of command to query for
- Returns
- found command or 0
Implements KTextEditor::Editor.
Definition at line 432 of file kateglobal.cpp.
◆ registerDocument()
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
-
doc document to register
Definition at line 406 of file kateglobal.cpp.
◆ registerView()
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
-
view view to register
Definition at line 419 of file kateglobal.cpp.
◆ rendererConfig()
|
inline |
fallback renderer config
- Returns
- default config for all renderers
Definition at line 256 of file kateglobal.h.
◆ replaceHistoryModel()
QStringListModel * KTextEditor::EditorPrivate::replaceHistoryModel | ( | ) |
Replace pattern history shared among simple/power search instances.
Definition at line 505 of file kateglobal.cpp.
◆ saveSearchReplaceHistoryModels()
void KTextEditor::EditorPrivate::saveSearchReplaceHistoryModels | ( | ) |
Call this function to store the history models to the application config.
Definition at line 515 of file kateglobal.cpp.
◆ scriptManager()
|
inline |
Global script collection.
Definition at line 264 of file kateglobal.h.
◆ searchHistoryModel()
QStringListModel * KTextEditor::EditorPrivate::searchHistoryModel | ( | ) |
Search pattern history shared among simple/power search instances.
Definition at line 495 of file kateglobal.cpp.
◆ self()
|
static |
Kate Part Internal stuff ;)
singleton accessor
- Returns
- instance of the factory
Definition at line 381 of file kateglobal.cpp.
◆ setApplication()
|
inlineoverridevirtual |
Set the global application object.
This will allow the editor component to access the hosting application.
- Parameters
-
application application object
Implements KTextEditor::Editor.
Definition at line 110 of file kateglobal.h.
◆ speechEngine()
QTextToSpeech * KTextEditor::EditorPrivate::speechEngine | ( | KTextEditor::ViewPrivate * | view | ) |
text to speech engine to be use by the view actions, constructed on demand.
- Parameters
-
view the view that want to use it
Definition at line 578 of file kateglobal.cpp.
◆ spellCheckManager()
|
inline |
◆ triggerConfigChanged()
void KTextEditor::EditorPrivate::triggerConfigChanged | ( | ) |
Trigger delayed emission of config changed.
Definition at line 546 of file kateglobal.cpp.
◆ variableExpansionManager()
KateVariableExpansionManager * KTextEditor::EditorPrivate::variableExpansionManager | ( | ) |
Returns the variable expansion manager.
Definition at line 447 of file kateglobal.cpp.
◆ viewConfig()
|
inline |
fallback view config
- Returns
- default config for all views
Definition at line 247 of file kateglobal.h.
◆ views()
|
inline |
return a list of all registered views
- Returns
- all known views
Definition at line 204 of file kateglobal.h.
◆ wordCompletionModel()
|
inline |
global instance of the simple word completion mode
- Returns
- global instance of the simple word completion mode
Definition at line 300 of file kateglobal.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:05:19 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.