KTextEditor

kateglobal.cpp
1/*
2 SPDX-FileCopyrightText: 2001-2010 Christoph Cullmann <cullmann@kde.org>
3 SPDX-FileCopyrightText: 2009 Erlend Hamberg <ehamberg@gmail.com>
4
5 For the addScrollablePage original
6 SPDX-FileCopyrightText: 2003 Benjamin C Meyer <ben+kdelibs at meyerhome dot net>
7 SPDX-FileCopyrightText: 2003 Waldo Bastian <bastian@kde.org>
8 SPDX-FileCopyrightText: 2004 Michael Brade <brade@kde.org>
9 SPDX-FileCopyrightText: 2021 Ahmad Samir <a.samirh78@gmail.com>
10
11 SPDX-License-Identifier: LGPL-2.0-or-later
12*/
13
14#include "kateglobal.h"
15
16#include <ktexteditor_version.h>
17
18#include "katebuffer.h"
19#include "katecmd.h"
20#include "katecmds.h"
21#include "kateconfig.h"
22#include "katedialogs.h"
23#include "katedocument.h"
24#include "katehighlightingcmds.h"
25#include "katekeywordcompletion.h"
26#include "katemodemanager.h"
27#include "katescriptmanager.h"
28#include "katesedcmd.h"
29#include "katesyntaxmanager.h"
30#include "katethemeconfig.h"
31#include "katevariableexpansionmanager.h"
32#include "kateview.h"
33#include "katewordcompletion.h"
34#include "spellcheck/spellcheck.h"
35
36#include "katenormalinputmodefactory.h"
37#include "kateviinputmodefactory.h"
38
39#include <KConfigGroup>
40#include <KDirWatch>
41#include <KLocalizedString>
42#include <KPageDialog>
43
44#include <QApplication>
45#include <QBoxLayout>
46#include <QClipboard>
47#include <QFrame>
48#include <QPushButton>
49#include <QScreen>
50#include <QScrollArea>
51#include <QScrollBar>
52#include <QStringListModel>
53#include <QTextToSpeech>
54#include <QTimer>
55
56KTextEditor::EditorPrivate::EditorPrivate(QPointer<KTextEditor::EditorPrivate> &staticInstance)
57 : KTextEditor::Editor(this)
58 , m_aboutData(QStringLiteral("katepart"),
59 i18n("Kate Part"),
60 QStringLiteral(KTEXTEDITOR_VERSION_STRING),
61 i18n("Embeddable editor component"),
62 KAboutLicense::LGPL_V2,
63 i18n("(c) 2000-2022 The Kate Authors"),
64 QString(),
65 QStringLiteral("https://kate-editor.org"))
66 , m_dummyApplication(nullptr)
67 , m_application(&m_dummyApplication)
68 , m_dummyMainWindow(nullptr)
69 , m_searchHistoryModel(nullptr)
70 , m_replaceHistoryModel(nullptr)
71{
72 // remember this
73 staticInstance = this;
74
75 // register some datatypes
76 qRegisterMetaType<KTextEditor::Cursor>("KTextEditor::Cursor");
77 qRegisterMetaType<KTextEditor::Document *>("KTextEditor::Document*");
78 qRegisterMetaType<KTextEditor::View *>("KTextEditor::View*");
79
80 //
81 // fill about data
82 //
83 m_aboutData.addAuthor(i18n("Christoph Cullmann"), i18n("Maintainer"), QStringLiteral("cullmann@kde.org"), QStringLiteral("https://cullmann.io"));
84 m_aboutData.addAuthor(i18n("Dominik Haumann"), i18n("Core Developer"), QStringLiteral("dhaumann@kde.org"));
85 m_aboutData.addAuthor(i18n("Milian Wolff"), i18n("Core Developer"), QStringLiteral("mail@milianw.de"), QStringLiteral("https://milianw.de/"));
86 m_aboutData.addAuthor(i18n("Joseph Wenninger"),
87 i18n("Core Developer"),
88 QStringLiteral("jowenn@kde.org"),
89 QStringLiteral("http://stud3.tuwien.ac.at/~e9925371"));
90 m_aboutData.addAuthor(i18n("Erlend Hamberg"), i18n("Vi Input Mode"), QStringLiteral("ehamberg@gmail.com"), QStringLiteral("https://hamberg.no/erlend"));
91 m_aboutData.addAuthor(i18n("Bernhard Beschow"),
92 i18n("Developer"),
93 QStringLiteral("bbeschow@cs.tu-berlin.de"),
94 QStringLiteral("https://user.cs.tu-berlin.de/~bbeschow"));
95 m_aboutData.addAuthor(i18n("Anders Lund"), i18n("Core Developer"), QStringLiteral("anders@alweb.dk"), QStringLiteral("https://alweb.dk"));
96 m_aboutData.addAuthor(i18n("Michel Ludwig"), i18n("On-the-fly spell checking"), QStringLiteral("michel.ludwig@kdemail.net"));
97 m_aboutData.addAuthor(i18n("Pascal Létourneau"), i18n("Large scale bug fixing"), QStringLiteral("pascal.letourneau@gmail.com"));
98 m_aboutData.addAuthor(i18n("Hamish Rodda"), i18n("Core Developer"), QStringLiteral("rodda@kde.org"));
99 m_aboutData.addAuthor(i18n("Waldo Bastian"), i18n("The cool buffersystem"), QStringLiteral("bastian@kde.org"));
100 m_aboutData.addAuthor(i18n("Charles Samuels"), i18n("The Editing Commands"), QStringLiteral("charles@kde.org"));
101 m_aboutData.addAuthor(i18n("Matt Newell"), i18n("Testing, ..."), QStringLiteral("newellm@proaxis.com"));
102 m_aboutData.addAuthor(i18n("Michael Bartl"), i18n("Former Core Developer"), QStringLiteral("michael.bartl1@chello.at"));
103 m_aboutData.addAuthor(i18n("Michael McCallum"), i18n("Core Developer"), QStringLiteral("gholam@xtra.co.nz"));
104 m_aboutData.addAuthor(i18n("Michael Koch"), i18n("KWrite port to KParts"), QStringLiteral("koch@kde.org"));
105 m_aboutData.addAuthor(i18n("Christian Gebauer"), QString(), QStringLiteral("gebauer@kde.org"));
106 m_aboutData.addAuthor(i18n("Simon Hausmann"), QString(), QStringLiteral("hausmann@kde.org"));
107 m_aboutData.addAuthor(i18n("Glen Parker"), i18n("KWrite Undo History, Kspell integration"), QStringLiteral("glenebob@nwlink.com"));
108 m_aboutData.addAuthor(i18n("Scott Manson"), i18n("KWrite XML Syntax highlighting support"), QStringLiteral("sdmanson@alltel.net"));
109 m_aboutData.addAuthor(i18n("John Firebaugh"), i18n("Patches and more"), QStringLiteral("jfirebaugh@kde.org"));
110 m_aboutData.addAuthor(i18n("Andreas Kling"), i18n("Developer"), QStringLiteral("kling@impul.se"));
111 m_aboutData.addAuthor(i18n("Mirko Stocker"), i18n("Various bugfixes"), QStringLiteral("me@misto.ch"), QStringLiteral("https://misto.ch/"));
112 m_aboutData.addAuthor(i18n("Matthew Woehlke"), i18n("Selection, KColorScheme integration"), QStringLiteral("mw_triad@users.sourceforge.net"));
113 m_aboutData.addAuthor(i18n("Sebastian Pipping"),
114 i18n("Search bar back- and front-end"),
115 QStringLiteral("webmaster@hartwork.org"),
116 QStringLiteral("https://hartwork.org/"));
117 m_aboutData.addAuthor(i18n("Jochen Wilhelmy"), i18n("Original KWrite Author"), QStringLiteral("digisnap@cs.tu-berlin.de"));
118 m_aboutData.addAuthor(i18n("Gerald Senarclens de Grancy"),
119 i18n("QA and Scripting"),
120 QStringLiteral("oss@senarclens.eu"),
121 QStringLiteral("http://find-santa.eu/"));
122
123 m_aboutData.addCredit(i18n("Matteo Merli"), i18n("Highlighting for RPM Spec-Files, Perl, Diff and more"), QStringLiteral("merlim@libero.it"));
124 m_aboutData.addCredit(i18n("Rocky Scaletta"), i18n("Highlighting for VHDL"), QStringLiteral("rocky@purdue.edu"));
125 m_aboutData.addCredit(i18n("Yury Lebedev"), i18n("Highlighting for SQL"), QString());
126 m_aboutData.addCredit(i18n("Chris Ross"), i18n("Highlighting for Ferite"), QString());
127 m_aboutData.addCredit(i18n("Nick Roux"), i18n("Highlighting for ILERPG"), QString());
128 m_aboutData.addCredit(i18n("Carsten Niehaus"), i18n("Highlighting for LaTeX"), QString());
129 m_aboutData.addCredit(i18n("Per Wigren"), i18n("Highlighting for Makefiles, Python"), QString());
130 m_aboutData.addCredit(i18n("Jan Fritz"), i18n("Highlighting for Python"), QString());
131 m_aboutData.addCredit(i18n("Daniel Naber"));
132 m_aboutData.addCredit(i18n("Roland Pabel"), i18n("Highlighting for Scheme"), QString());
133 m_aboutData.addCredit(i18n("Cristi Dumitrescu"), i18n("PHP Keyword/Datatype list"), QString());
134 m_aboutData.addCredit(i18n("Carsten Pfeiffer"), i18n("Very nice help"), QString());
135 m_aboutData.addCredit(i18n("Bruno Massa"), i18n("Highlighting for Lua"), QStringLiteral("brmassa@gmail.com"));
136
137 m_aboutData.addCredit(i18n("All people who have contributed and I have forgotten to mention"));
138
139 m_aboutData.setTranslator(i18nc("NAME OF TRANSLATORS", "Your names"), i18nc("EMAIL OF TRANSLATORS", "Your emails"));
140
141 // set proper Kate icon for our about dialog
142 m_aboutData.setProgramLogo(QIcon(QStringLiteral(":/ktexteditor/kate.svg")));
143
144 //
145 // dir watch
146 //
147 m_dirWatch = new KDirWatch();
148
149 //
150 // command manager
151 //
152 m_cmdManager = new KateCmd();
153
154 //
155 // variable expansion manager
156 //
157 m_variableExpansionManager = new KateVariableExpansionManager(this);
158
159 //
160 // hl manager
161 //
162 m_hlManager = new KateHlManager();
163
164 //
165 // mode man
166 //
167 m_modeManager = new KateModeManager();
168
169 //
170 // input mode factories
171 //
172 Q_ASSERT(m_inputModeFactories.size() == KTextEditor::View::ViInputMode + 1);
173 m_inputModeFactories[KTextEditor::View::NormalInputMode].reset(new KateNormalInputModeFactory());
174 m_inputModeFactories[KTextEditor::View::ViInputMode].reset(new KateViInputModeFactory());
175
176 //
177 // spell check manager
178 //
179 m_spellCheckManager = new KateSpellCheckManager();
180
181 // config objects
182 m_globalConfig = new KateGlobalConfig();
183 m_documentConfig = new KateDocumentConfig();
184 m_viewConfig = new KateViewConfig();
185 m_rendererConfig = new KateRendererConfig();
186
187 // create script manager (search scripts)
188 m_scriptManager = KateScriptManager::self();
189
190 //
191 // init the cmds
192 //
193 m_cmds = {
194 KateCommands::CoreCommands::self(),
195 KateCommands::Character::self(),
196 KateCommands::Date::self(),
197 KateCommands::SedReplace::self(),
198 KateCommands::Highlighting::self(),
199 KateCommands::EditingCommands::self(),
200 };
201
202 // global word completion model
203 m_wordCompletionModel = new KateWordCompletionModel(this);
204
205 // global keyword completion model
206 m_keywordCompletionModel = new KateKeywordCompletionModel(this);
207
208 // tap to QApplication object for color palette changes
209 qApp->installEventFilter(this);
210}
211
213{
214 delete m_globalConfig;
215 delete m_documentConfig;
216 delete m_viewConfig;
217 delete m_rendererConfig;
218
219 delete m_modeManager;
220
221 delete m_dirWatch;
222
223 // cu managers
224 delete m_scriptManager;
225 delete m_hlManager;
226
227 delete m_spellCheckManager;
228
229 // cu model
230 delete m_wordCompletionModel;
231
232 // delete variable expansion manager
233 delete m_variableExpansionManager;
234 m_variableExpansionManager = nullptr;
235
236 // delete the commands before we delete the cmd manager
237 qDeleteAll(m_cmds);
238 delete m_cmdManager;
239}
240
242{
243 KTextEditor::DocumentPrivate *doc = new KTextEditor::DocumentPrivate(false, false, nullptr, parent);
244
245 Q_EMIT documentCreated(this, doc);
246
247 return doc;
248}
249
250// END KTextEditor::Editor config stuff
251
252// config dialog with improved sizing and that allows scrolling
253class KTextEditorConfigDialog : public KPageDialog
254{
255public:
256 std::vector<KTextEditor::ConfigPage *> editorPages;
257
258 KTextEditorConfigDialog(KTextEditor::EditorPrivate *editor, QWidget *parent)
259 : KPageDialog(parent)
260 {
261 setWindowTitle(i18n("Configure"));
262 setFaceType(KPageDialog::List);
264
265 // create pages already in construct to have proper layout for sizeHint
266 editorPages.reserve(editor->configPages());
267 for (int i = 0; i < editor->configPages(); ++i) {
268 KTextEditor::ConfigPage *page = editor->configPage(i, this);
269 KPageWidgetItem *item = addScrollablePage(page, page->name());
270 item->setHeader(page->fullName());
271 item->setIcon(page->icon());
272
274 editorPages.push_back(page);
275 }
276 }
277
278 QSize sizeHint() const override
279 {
280 // start with a bit enlarged default size hint to minimize changes of useless scrollbars
281 QSize size = KPageDialog::sizeHint() * 1.3;
282
283 // enlarge it to half of the main window size, if that is larger
284 if (parentWidget() && parentWidget()->window()) {
285 size = size.expandedTo(parentWidget()->window()->size() * 0.5);
286 }
287
288 // return bounded size to available real screen space
289 return size.boundedTo(screen()->availableSize() * 0.9);
290 }
291
292 KPageWidgetItem *addScrollablePage(QWidget *page, const QString &itemName)
293 {
294 // inspired by KPageWidgetItem *KConfigDialogPrivate::addPageInternal(QWidget *page, const QString &itemName, const QString &pixmapName, const QString
295 // &header)
296 QWidget *frame = new QWidget;
297 QVBoxLayout *boxLayout = new QVBoxLayout(frame);
298 boxLayout->setContentsMargins(0, 0, 0, 0);
299 boxLayout->setContentsMargins(0, 0, 0, 0);
300
301 QScrollArea *scroll = new QScrollArea;
305 scroll->setWidget(page);
306 scroll->setWidgetResizable(true);
308
309 if (page->minimumSizeHint().height() > scroll->sizeHint().height() - 2) {
310 if (page->sizeHint().width() < scroll->sizeHint().width() + 2) {
311 // QScrollArea is planning only a vertical scroll bar,
312 // try to avoid the horizontal one by reserving space for the vertical one.
313 // Currently KPageViewPrivate::_k_modelChanged() queries the minimumSizeHint().
314 // We can only set the minimumSize(), so this approach relies on QStackedWidget size calculation.
315 scroll->setMinimumWidth(scroll->sizeHint().width() + qBound(0, scroll->verticalScrollBar()->sizeHint().width(), 200) + 4);
316 }
317 }
318
319 boxLayout->addWidget(scroll);
320 return addPage(frame, itemName);
321 }
322};
323
325{
326 QPointer<KTextEditorConfigDialog> kd = new KTextEditorConfigDialog(this, parent);
327 if (kd->exec() && kd) {
328 KateGlobalConfig::global()->configStart();
329 KateDocumentConfig::global()->configStart();
330 KateViewConfig::global()->configStart();
331 KateRendererConfig::global()->configStart();
332
333 for (auto *page : kd->editorPages) {
334 page->apply();
335 }
336
337 KateGlobalConfig::global()->configEnd();
338 KateDocumentConfig::global()->configEnd();
339 KateViewConfig::global()->configEnd();
340 KateRendererConfig::global()->configEnd();
341 }
342 delete kd;
343}
344
346{
347 return 4;
348}
349
351{
352 switch (number) {
353 case 0:
354 return new KateViewDefaultsConfig(parent);
355
356 case 1:
357 return new KateThemeConfigPage(parent);
358
359 case 2:
360 return new KateEditConfigTab(parent);
361
362 case 3:
363 return new KateSaveConfigTab(parent);
364
365 default:
366 break;
367 }
368
369 return nullptr;
370}
371
372/**
373 * Cleanup the KTextEditor::EditorPrivate during QCoreApplication shutdown
374 */
375static void cleanupGlobal()
376{
377 // delete if there
379}
380
382{
383 // remember the static instance in a QPointer
384 static bool inited = false;
385 static QPointer<KTextEditor::EditorPrivate> staticInstance;
386
387 // just return it, if already inited
388 if (inited) {
389 return staticInstance.data();
390 }
391
392 // start init process
393 inited = true;
394
395 // now create the object and store it
396 new KTextEditor::EditorPrivate(staticInstance);
397
398 // register cleanup
399 // let use be deleted during QCoreApplication shutdown
400 qAddPostRoutine(cleanupGlobal);
401
402 // return instance
403 return staticInstance.data();
404}
405
407{
408 Q_ASSERT(!m_documents.contains(doc));
409 m_documents.push_back(doc);
410}
411
413{
414 int i = m_documents.indexOf(doc);
415 Q_ASSERT(i != -1);
416 m_documents.removeAt(i);
417}
418
419void KTextEditor::EditorPrivate::registerView(KTextEditor::ViewPrivate *view)
420{
421 Q_ASSERT(std::find(m_views.begin(), m_views.end(), view) == m_views.end());
422 m_views.push_back(view);
423}
424
425void KTextEditor::EditorPrivate::deregisterView(KTextEditor::ViewPrivate *view)
426{
427 auto it = std::find(m_views.begin(), m_views.end(), view);
428 Q_ASSERT(it != m_views.end());
429 m_views.erase(it);
430}
431
433{
434 return m_cmdManager->queryCommand(cmd);
435}
436
438{
439 return m_cmdManager->commands();
440}
441
443{
444 return m_cmdManager->commandList();
445}
446
451
452void KTextEditor::EditorPrivate::updateColorPalette()
453{
454 // reload the global schema (triggers reload for every view as well)
455 // might trigger selection of better matching theme for new palette
456 m_rendererConfig->reloadSchema();
457
458 // force full update of all view caches and colors
459 m_rendererConfig->updateConfig();
460}
461
463{
464 // empty => nop
465 if (text.isEmpty()) {
466 return;
467 }
468
469 // move to clipboard
471
472 // LRU, kill potential duplicated, move new entry to top
473 // cut after X entries
474 auto entry = ClipboardEntry{.text = text, .fileName = fileName};
475 m_clipboardHistory.removeOne(entry);
476 m_clipboardHistory.prepend(entry);
477 if (m_clipboardHistory.size() > m_viewConfig->clipboardHistoryEntries()) {
478 m_clipboardHistory.removeLast();
479 }
480
481 // notify about change
482 Q_EMIT clipboardHistoryChanged();
483}
484
485bool KTextEditor::EditorPrivate::eventFilter(QObject *obj, QEvent *event)
486{
487 if (obj == qApp && event->type() == QEvent::ApplicationPaletteChange) {
488 // only update the color once for the event that belongs to the qApp
489 updateColorPalette();
490 }
491
492 return false; // always continue processing
493}
494
496{
497 if (!m_searchHistoryModel) {
498 KConfigGroup cg(KSharedConfig::openConfig(), QStringLiteral("KTextEditor::Search"));
499 const QStringList history = cg.readEntry(QStringLiteral("Search History"), QStringList());
500 m_searchHistoryModel = new QStringListModel(history, this);
501 }
502 return m_searchHistoryModel;
503}
504
506{
507 if (!m_replaceHistoryModel) {
508 KConfigGroup cg(KSharedConfig::openConfig(), QStringLiteral("KTextEditor::Search"));
509 const QStringList history = cg.readEntry(QStringLiteral("Replace History"), QStringList());
510 m_replaceHistoryModel = new QStringListModel(history, this);
511 }
512 return m_replaceHistoryModel;
513}
514
516{
517 KConfigGroup cg(KSharedConfig::openConfig(), QStringLiteral("KTextEditor::Search"));
518 if (m_searchHistoryModel) {
519 cg.writeEntry(QStringLiteral("Search History"), m_searchHistoryModel->stringList());
520 }
521 if (m_replaceHistoryModel) {
522 cg.writeEntry(QStringLiteral("Replace History"), m_replaceHistoryModel->stringList());
523 }
524}
525
527{
528 // use dummy config for unit tests!
529 if (QStandardPaths::isTestModeEnabled()) {
530 return KSharedConfig::openConfig(QStringLiteral("katepartrc-unittest"), KConfig::SimpleConfig, QStandardPaths::TempLocation);
531 }
532
533 // else: use application configuration, but try to transfer global settings on first use
534 auto applicationConfig = KSharedConfig::openConfig();
535 if (!KConfigGroup(applicationConfig, QStringLiteral("KTextEditor Editor")).exists()) {
536 auto globalConfig = KSharedConfig::openConfig(QStringLiteral("katepartrc"));
537 for (const auto &group : {QStringLiteral("Editor"), QStringLiteral("Document"), QStringLiteral("View"), QStringLiteral("Renderer")}) {
538 KConfigGroup origin(globalConfig, group);
539 KConfigGroup destination(applicationConfig, QStringLiteral("KTextEditor ") + group);
540 origin.copyTo(&destination);
541 }
542 }
543 return applicationConfig;
544}
545
547{
548 // trigger delayed emission, will collapse multiple events to one signal emission
549 m_configWasChanged = true;
550 QTimer::singleShot(0, this, &KTextEditor::EditorPrivate::emitConfigChanged);
551}
552
553void KTextEditor::EditorPrivate::emitConfigChanged()
554{
555 // emit only once, if still needed
556 if (m_configWasChanged) {
557 m_configWasChanged = false;
558 Q_EMIT configChanged(this);
559 }
560}
561
562QTextToSpeech *KTextEditor::EditorPrivate::speechEngine(KTextEditor::ViewPrivate *view)
563{
564 Q_ASSERT(view);
565 if (!m_speechEngine) {
566 m_speechEngine = new QTextToSpeech(this);
567
568 // error handler for errors happening during speech output
569 connect(m_speechEngine, &QTextToSpeech::errorOccurred, this, [this](QTextToSpeech::ErrorReason, const QString &errorString) {
570 if (m_speechEngineLastUser) {
571 speechError(m_speechEngineLastUser, errorString);
572 }
573 });
574
575 // handle init errors, that will not emit errorOccurred later
576 if (m_speechEngine->errorReason() != QTextToSpeech::ErrorReason::NoError) {
577 speechError(view, m_speechEngine->errorString());
578 }
579 }
580
581 // register current view, handle error output and stopping of the speaking
582 if (view != m_speechEngineLastUser) {
583 if (m_speechEngineLastUser) {
584 disconnect(m_speechEngineLastUser, &QObject::destroyed, this, &KTextEditor::EditorPrivate::speechEngineUserDestoyed);
585 }
586 m_speechEngineLastUser = view;
587 connect(m_speechEngineLastUser, &QObject::destroyed, this, &KTextEditor::EditorPrivate::speechEngineUserDestoyed);
588 }
589
590 return m_speechEngine;
591}
592
593void KTextEditor::EditorPrivate::speechEngineUserDestoyed()
594{
595 Q_ASSERT(m_speechEngine);
596 m_speechEngine->stop();
597}
598
599void KTextEditor::EditorPrivate::speechError(KTextEditor::ViewPrivate *view, const QString &errorString)
600{
601 Q_ASSERT(view);
602 auto message = new KTextEditor::Message(errorString, Message::Error);
603 message->setPosition(KTextEditor::Message::TopInView);
604 message->setView(view);
605 view->document()->postMessage(message);
606}
607
608#include "moc_kateglobal.cpp"
void writeEntry(const char *key, const char *value, WriteConfigFlags pFlags=Normal)
QString readEntry(const char *key, const char *aDefault=nullptr) const
void copyTo(KConfigBase *other, WriteConfigFlags pFlags=Normal) const
void setIcon(const QIcon &icon)
void setHeader(const QString &header)
static KSharedConfig::Ptr openConfig(const QString &fileName=QString(), OpenFlags mode=FullConfig, QStandardPaths::StandardLocation type=QStandardPaths::GenericConfigLocation)
An Editor command line command.
Config page interface for the Editor and Plugins.
Definition configpage.h:44
virtual QString fullName() const
Get a readable full name for the config page.
virtual QIcon icon() const
Get an icon for the config page.
virtual void apply()=0
This slot is called whenever the button Apply or OK was clicked.
virtual QString name() const =0
Get a readable name for the config page.
Backend of KTextEditor::Document related public KTextEditor interfaces.
A KParts derived class representing a text document.
Definition document.h:284
virtual bool postMessage(Message *message)=0
Post message to the Document and its Views.
KTextEditor::EditorPrivate One instance of this class is hold alive during a kate part session,...
Definition kateglobal.h:65
void copyToClipboard(const QString &text, const QString &fileName)
Copy text to clipboard an remember it in the history.
void saveSearchReplaceHistoryModels()
Call this function to store the history models to the application config.
KTextEditor::ConfigPage * configPage(int number, QWidget *parent) override
returns config page with the given number, config pages from 0 to configPages()-1 are available if co...
QStringListModel * replaceHistoryModel()
Replace pattern history shared among simple/power search instances.
void deregisterDocument(KTextEditor::DocumentPrivate *doc)
unregister document at the factory
KTextEditor::Command * queryCommand(const QString &cmd) const override
query for command
KTextEditor::Document * createDocument(QObject *parent) override
Create a new document object.
int configPages() const override
Number of available config pages If the editor returns a number < 1, it doesn't support this and the ...
void deregisterView(KTextEditor::ViewPrivate *view)
unregister view at the factory
static KSharedConfigPtr config()
The global configuration of katepart, e.g.
QTextToSpeech * speechEngine(KTextEditor::ViewPrivate *view)
text to speech engine to be use by the view actions, constructed on demand.
void triggerConfigChanged()
Trigger delayed emission of config changed.
QStringList commandList() const override
Get a list of available commandline strings.
void registerDocument(KTextEditor::DocumentPrivate *doc)
register document at the factory this allows us to loop over all docs for example on config changes
void configDialog(QWidget *parent) override
Configuration management.
QStringListModel * searchHistoryModel()
Search pattern history shared among simple/power search instances.
void registerView(KTextEditor::ViewPrivate *view)
register view at the factory this allows us to loop over all views for example on config changes
static KTextEditor::EditorPrivate * self()
Kate Part Internal stuff ;)
QList< KTextEditor::Command * > commands() const override
Get a list of all registered commands.
KateVariableExpansionManager * variableExpansionManager()
Returns the variable expansion manager.
~EditorPrivate() override
Destructor.
This class holds a Message to display in Views.
Definition message.h:94
@ TopInView
show message as view overlay in the top right corner.
Definition message.h:123
@ Error
error message type
Definition message.h:110
@ ViInputMode
Vi mode.
Definition view.h:288
@ NormalInputMode
Normal Mode.
Definition view.h:287
void configEnd()
End a config change transaction, update the concerned KateDocumentConfig/KateDocumentConfig/KateDocum...
void configStart()
Start some config changes.
Highlighting-file based keyword completion for the editor.
Manager class for variable expansion.
QString i18nc(const char *context, const char *text, const TYPE &arg...)
QString i18n(const char *text, const TYPE &arg...)
QWidget * window(QObject *job)
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
void clicked(bool checked)
void setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy)
QScrollBar * verticalScrollBar() const const
void setVerticalScrollBarPolicy(Qt::ScrollBarPolicy)
void addWidget(QWidget *widget, int stretch, Qt::Alignment alignment)
void setText(const QString &text, Mode mode)
ApplicationPaletteChange
void setFrameShape(Shape)
QClipboard * clipboard()
void setContentsMargins(const QMargins &margins)
void destroyed(QObject *obj)
T * data() const const
void setWidget(QWidget *widget)
virtual QSize sizeHint() const const override
void setWidgetResizable(bool resizable)
virtual QSize sizeHint() const const override
QSize boundedTo(const QSize &otherSize) const const
QSize expandedTo(const QSize &otherSize) const const
int height() const const
int width() const const
bool isEmpty() const const
ScrollBarAsNeeded
void setMinimumWidth(int minw)
void setSizePolicy(QSizePolicy)
A clipboard entry stores the copied text and the filename of the copied text.
Definition kateglobal.h:344
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 27 2024 11:53:39 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.