KTextEditor Namespace Reference

Classes
class	AbstractAnnotationItemDelegate
class	AnnotationModel
class	Application
class	Attribute
class	AttributeBlock
class	CodeCompletionModel
class	CodeCompletionModelControllerInterface
class	Command
class	ConfigPage
class	Cursor
class	Document
class	DocumentCursor
class	DocumentPrivate
class	Editor
class	EditorPrivate
class	FoldingInterface
class	InlineNote
class	InlineNoteProvider
class	LineRange
class	MainWindow
class	Mark
class	Message
class	MovingCursor
class	MovingRange
class	MovingRangeFeedback
class	Plugin
class	Range
class	SessionConfigInterface
class	StyleOptionAnnotationItem
class	TextHintProvider
class	Variable
class	View

Typedefs
typedef QFlags< SearchOption >	SearchOptions

Enumerations
enum class	caretStyles { Line , Block , Underline , Half }
enum	SearchOption {   Default = 0 , Regex = 1 << 1 , CaseInsensitive = 1 << 4 , Backwards = 1 << 5 ,   EscapeSequences = 1 << 10 , WholeWords = 1 << 11 , MaxSearchOption = 1 << 31 }

Functions
KTEXTEDITOR_EXPORT QDebug	operator<< (QDebug s, const MovingCursor &cursor)
KTEXTEDITOR_EXPORT QDebug	operator<< (QDebug s, const MovingCursor *cursor)
KTEXTEDITOR_EXPORT QDebug	operator<< (QDebug s, const MovingRange &range)
KTEXTEDITOR_EXPORT QDebug	operator<< (QDebug s, const MovingRange *range)
KTEXTEDITOR_EXPORT size_t	qHash (KTextEditor::Cursor cursor, size_t seed=0) noexcept
KTEXTEDITOR_EXPORT size_t	qHash (KTextEditor::LineRange range, size_t seed=0) noexcept
KTEXTEDITOR_EXPORT size_t	qHash (KTextEditor::Range range, size_t seed=0) noexcept

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 KTextEditor.

Warning

All classes that are not part of the KTextEditor namespace are internal and subject to change. We mean it!

Typedef Documentation

SearchOptions

typedef QFlags< SearchOption > KTextEditor::SearchOptions

Stores a combination of SearchOption values.

Definition at line 65 of file document.h.

Enumeration Type Documentation

caretStyles

enum class KTextEditor::caretStyles

strong

Definition at line 42 of file katerenderer.h.

SearchOption

enum KTextEditor::SearchOption

Search flags for use with searchText.

Modifies the behavior of searchText. By default it is searched 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.

See also

SearchOptions

Author

Sebastian Pipping <webma.nosp@m.ster.nosp@m.@hart.nosp@m.work.nosp@m..org>

Enumerator
Default	Default settings.
Regex	Treats the pattern as a regular expression.
CaseInsensitive	Ignores cases, e.g. "a" matches "A".
Backwards	Searches in backward direction.
EscapeSequences	Plaintext mode: Processes escape sequences.
WholeWords	Plaintext mode: Whole words only, e.g. not "amp" in "example".
MaxSearchOption	Placeholder for binary compatibility.

Definition at line 47 of file document.h.

Function Documentation

operator<<() [1/4]

QDebug KTextEditor::operator<<	(	QDebug	s,
		const MovingCursor &	cursor )

qDebug() stream operator.

Writes this cursor to the debug output in a nicely formatted way.

Parameters

s	debug stream
cursor	cursor to print

Returns

debug stream

Definition at line 166 of file movingapi.cpp.

operator<<() [2/4]

QDebug KTextEditor::operator<<	(	QDebug	s,
		const MovingCursor *	cursor )

qDebug() stream operator.

Writes this cursor to the debug output in a nicely formatted way.

Parameters

s	debug stream
cursor	cursor to print

Returns

debug stream

Definition at line 156 of file movingapi.cpp.

operator<<() [3/4]

QDebug KTextEditor::operator<<	(	QDebug	s,
		const MovingRange &	range )

qDebug() stream operator.

Writes this range to the debug output in a nicely formatted way.

Parameters

s	debug stream
range	range to print

Returns

debug stream

Definition at line 60 of file movingapi.cpp.

operator<<() [4/4]

QDebug KTextEditor::operator<<	(	QDebug	s,
		const MovingRange *	range )

qDebug() stream operator.

Writes this range to the debug output in a nicely formatted way.

Parameters

s	debug stream
range	range to print

Returns

debug stream

Definition at line 44 of file movingapi.cpp.

qHash() [1/3]

size_t KTextEditor::qHash ( KTextEditor::Cursor cursor, size_t seed = 0 )

noexcept

QHash function for KTextEditor::Cursor.

Returns the hash value for cursor.

Definition at line 76 of file ktexteditor.cpp.

qHash() [2/3]

size_t KTextEditor::qHash ( KTextEditor::LineRange range, size_t seed = 0 )

noexcept

QHash function for KTextEditor::LineRange.

Returns the hash value for range.

Definition at line 130 of file utils/range.cpp.

qHash() [3/3]

size_t KTextEditor::qHash ( KTextEditor::Range range, size_t seed = 0 )

noexcept

QHash function for KTextEditor::Range.

Returns the hash value for range.

Definition at line 135 of file utils/range.cpp.