KTextEditor
document.h
57 WholeWords = 1 << 11, ///< Plaintext mode: Whole words only, e.g. @em not "amp" in "example"
400 * This signal should be emitted after a document has been saved to disk or for remote files uploaded.
768 virtual bool insertText(const Cursor &position, const QStringList &text, bool block = false) = 0;
793 * \param block set this to true to remove a text block on the basis of columns, rather than everything inside \p range
856 QVector<KTextEditor::Range> searchText(const KTextEditor::Range &range, const QString &pattern, const SearchOptions options = Default) const;
903 void textInserted(KTextEditor::Document *document, const KTextEditor::Cursor &position, const QString &text);
911 void textRemoved(KTextEditor::Document *document, const KTextEditor::Range &range, const QString &text);
1124 virtual void readSessionConfig(const KConfigGroup &config, const QSet<QString> &flags = QSet<QString>()) = 0;
1134 virtual void writeSessionConfig(KConfigGroup &config, const QSet<QString> &flags = QSet<QString>()) = 0;
Q_OBJECTQ_OBJECT
QString modeSection(int index) const override
Returns the name of the section for a mode given its index in the highlight list (as returned by mode...
bool setHighlightingMode(const QString &name) override
Set the current mode of the document by giving its name.
DefaultStyle
The following lists all valid default styles that are used for the syntax highlighting files in the i...
Definition: attribute.h:28
QStringList highlightingModes() const override
Return a list of the names of all possible modes.
An object representing a section of text, from one Cursor to another.
Definition: include/ktexteditor/range.h:44
Document * document() const
bool documentReload() override
Reloads the current document from disk if possible.
QString highlightingMode() const override
Return the name of the currently used mode.
void writeSessionConfig(KConfigGroup &config, const QSet< QString > &flags=QSet< QString >()) override
Write session settings to the config.
Message
Q_SCRIPTABLE Q_NOREPLY void start()
constexpr static Cursor start() Q_DECL_NOEXCEPT
Returns a cursor representing the start of any document - i.e., line 0, column 0.
Definition: cursor.h:117
KTextEditor::DefaultStyle defaultStyleAt(const KTextEditor::Cursor &position) const override
Get the default style of the character located at position.
QByteArray checksum() const override
Returns a git compatible sha1 checksum of this document on disk.
The KTextEditor namespace contains all the public API that is required to use the KTextEditor compone...
Definition: katetextblock.h:22
QStringList modes() const override
Return a list of the names of all possible modes.
Q_SIGNALSQ_SIGNALS
void textRemoved(KTextEditor::Document *document, const KTextEditor::Range &range, const QString &oldText)
The document emits this signal whenever range was removed, i.e.
void readSessionConfig(const KConfigGroup &config, const QSet< QString > &flags=QSet< QString >()) override
Read session settings from the given config.
QString highlightingModeSection(int index) const override
Returns the name of the section for a highlight given its index in the highlight list (as returned by...
QString mimeType() override
Tries to detect mime-type based on file name and content of buffer.
bool setMode(const QString &name) override
Set the current mode of the document by giving its name.
QObject * parent() const const
QString message
Definition: mainwindow.h:43
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 03:48:12 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Sep 26 2023 03:48:12 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.