KTextEditor Namespace
| Header: | #include <KTextEditor/Editor> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS TextEditor)target_link_libraries(mytarget PRIVATE KF6::TextEditor) |
Classes
| class | Application |
| class | Attribute |
| class | CodeCompletionModel |
| class | CodeCompletionModelControllerInterface |
| class | Command |
| class | ConfigPage |
| class | Cursor |
| class | Document |
| class | DocumentCursor |
| class | Editor |
(since 5.79) class | LineRange |
| class | MainWindow |
(since 4.11) class | Message |
(since 4.5) class | MovingCursor |
(since 4.5) class | MovingRange |
(since 4.5) class | MovingRangeFeedback |
| class | Range |
(since 5.66)) class | View |
Types
| enum | SearchOption { Default, Regex, CaseInsensitive, Backwards, EscapeSequences, WholeWords } |
| flags | SearchOptions |
Functions
| QDebug | operator<<(QDebug s, const KTextEditor::MovingCursor &cursor) |
| QDebug | operator<<(QDebug s, const KTextEditor::MovingRange &range) |
| QDebug | operator<<(QDebug s, const KTextEditor::MovingCursor *cursor) |
| QDebug | operator<<(QDebug s, const KTextEditor::MovingRange *range) |
Detailed Description
The KTextEditor namespace contains all the public API that is required to use the KTextEditor component. Using the KTextEditor interfaces is described in the article index.
Warning: All classes that are not part of the KTextEditor namespace are internal and subject to change. We mean it!
Classes
class Application
This class allows the application that embeds the KTextEditor component to allow it access to application wide information and interactions. More...
class Attribute
A class which provides customized text decorations. More...
class CodeCompletionModel
An item model for providing code completion, and meta information for enhanced presentation. More...
class CodeCompletionModelControllerInterface
Controller interface for a CodeCompletionModel instance. More...
class Command
An Editor command line command. More...
class ConfigPage
Config page interface for the Editor and Plugin%s. More...
class Cursor
The Cursor represents a position in a Document. More...
class Document
A KParts derived class representing a text document. More...
class DocumentCursor
A Cursor which is bound to a specific Document. More...
class Editor
Accessor interface for the KTextEditor framework. More...
class LineRange
An object representing lines from a start line to an end line. More...
class MainWindow
This class allows the application that embeds the KTextEditor component to allow it to access parts of its main window. More...
class Message
This class holds a Message to display in Views. More...
class MovingCursor
A Cursor which is bound to a specific Document, and maintains its position. More...
class MovingRange
A range that is bound to a specific Document, and maintains its position. More...
class MovingRangeFeedback
A class which provides notifications of state changes to a MovingRange. More...
class Range
An object representing a section of text, from one Cursor to another. More...
class View
A text widget with KXMLGUIClient that represents a Document. More...
Type Documentation
enum SearchOption
flags KTextEditor::SearchOptions
Search flags for use with Document::searchText().
| Constant | Value | Description |
|---|---|---|
KTextEditor::Document::Default | 0 | Search for a case-sensitive plaintext pattern, without processing of escape sequences, with "whole words" off, in forward direction, within a non-block-mode text range. |
KTextEditor::Document::Regex | 1 << 1 | Treats the pattern as a regular expression |
KTextEditor::Document::CaseInsensitive | 1 << 4 | Ignores case, e.g. "a" matches "A" |
KTextEditor::Document::Backwards | 1 << 5 | Searches in backward direction |
KTextEditor::Document::EscapeSequences | 1 << 10 | Plaintext mode: processes escape sequences |
KTextEditor::Document::WholeWords | 1 << 11 | Plaintext mode: searches whole words only, e.g. not "amp" in "example" |
The SearchOptions type is a typedef for QFlags<SearchOption>. It stores an OR combination of SearchOption values.
Function Documentation
QDebug operator<<(QDebug s, const KTextEditor::MovingCursor &cursor)
qDebug() stream operator. Writes this cursor to the debug output in a nicely formatted way.
s is the debug stream
cursor is the cursor to print
Returns debug stream
QDebug operator<<(QDebug s, const KTextEditor::MovingRange &range)
qDebug() stream operator. Writes this range to the debug output in a nicely formatted way.
s is the debug stream
range is the range to print
Returns debug stream
QDebug operator<<(QDebug s, const KTextEditor::MovingCursor *cursor)
qDebug() stream operator. Writes this cursor to the debug output in a nicely formatted way.
s is the debug stream
cursor is the cursor to print
Returns debug stream
QDebug operator<<(QDebug s, const KTextEditor::MovingRange *range)
qDebug() stream operator. Writes this range to the debug output in a nicely formatted way.
s is the debug stream
range is the range to print
Returns debug stream