Extending Qt Creator Manual | TextEditor Namespace

Extending Qt Creator Manual 4.7.1

# TextEditor Namespace

(Debugger::TextEditor)

The TextEditor namespace contains the base text editor and several classes which provide supporting functionality like snippets, highlighting, code assist, indentation and style, and others. More...

Header: | #include <TextEditor>

## Namespaces

namespace | Constants
namespace | Constants
namespace | Internal
namespace | SemanticHighlighter
namespace | Ui

## Classes

class | BaseTextEditor
class | BaseTextEditor
class | BehaviorSettingsPage
class | BehaviorSettingsPageParameters
class | BlockRange
class | BlockRange
class | CodeAssistant
class | ColorScheme
class | ColorScheme
class | DisplaySettingsPage
class | DisplaySettingsPageParameters
class | FontSettings
class | FontSettings
class | Format
class | Format
class | Highlighter
class | HighlighterSettings
class | HighlighterSettingsPage
class | SnippetsSettings
class | TextDocument
class | TextDocument
class | TextDocumentManipulator
class | TextEditorFactory
class | TextEditorFactory
class | TextEditorLinkLabel
class | TextEditorLinkLabel
class | TextEditorSettings
class | TextEditorSettings
class | TextEditorWidget
class | TextEditorWidget
class | TextStyles
class | TextStyles

## Types

enum | AnnotationAlignment { NextToContent, NextToMargin, RightSide, BetweenLines }
enum | AssistKind { Completion, QuickFix, FollowSymbol }
enum | AssistKind { Completion, QuickFix, FollowSymbol }
enum | AssistReason { IdleEditor, ActivationCharacter, ExplicitlyInvoked }
enum | AssistReason { IdleEditor, ActivationCharacter, ExplicitlyInvoked }
enum | CaseSensitivity { CaseInsensitive, CaseSensitive, FirstLetterCaseSensitive }
enum | CompletionTrigger { ManualCompletion, TriggeredCompletion, AutomaticCompletion }
typedef | FormatDescriptions
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | MixinTextStyles
typedef | Parentheses
typedef | QuickFixInterface
typedef | QuickFixOperations
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactorMarkers
typedef | RefactoringFilePtr
typedef | TextDocumentPtr
typedef | TextDocumentPtr
enum | TextMarkRequestKind { BreakpointRequest, BookmarkRequest, TaskMarkRequest }
enum | TextMarkRequestKind { BreakpointRequest, BookmarkRequest, TaskMarkRequest }
typedef | TextMarks
typedef | TextMarks
enum | TextPositionOperation { CurrentPosition, EndOfLinePosition, StartOfLinePosition, AnchorPosition, EndOfDocPosition }
enum | TextPositionOperation { CurrentPosition, EndOfLinePosition, StartOfLinePosition, AnchorPosition, EndOfDocPosition }
enum | TextStyle { C_TEXT, C_LINK, C_SELECTION, C_LINE_NUMBER, ..., C_LAST_STYLE_SENTINEL }
enum | TextStyle { C_TEXT, C_LINK, C_SELECTION, C_LINE_NUMBER, ..., C_LAST_STYLE_SENTINEL }

## Functions

void | setMimeTypeForHighlighter(TextEditor::Highlighter *highlighter, const Utils::MimeType &mimeType, const int &filePath, int *foundDefinitionId = nullptr)
bool | operator!=(const Debugger::TextEditor::Format &f1, const Debugger::TextEditor::Format &f2)
bool | operator!=(const Debugger::TextEditor::ColorScheme &cs1, const Debugger::TextEditor::ColorScheme &cs2)
bool | operator!=(const Debugger::TextEditor::FontSettings &f1, const Debugger::TextEditor::FontSettings &f2)
bool | operator!=(const TextEditor::Format &f1, const TextEditor::Format &f2)
bool | operator!=(const TextEditor::CommentsSettings &a, const TextEditor::CommentsSettings &b)
bool | operator!=(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)
bool | operator!=(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)
bool | operator!=(const TextEditor::DisplaySettings &t1, const TextEditor::DisplaySettings &t2)
bool | operator!=(const TextEditor::CompletionSettings &t1, const TextEditor::CompletionSettings &t2)
bool | operator!=(const TextEditor::MarginSettings &one, const TextEditor::MarginSettings &two)
bool | operator!=(const TextEditor::TabSettings &t1, const TextEditor::TabSettings &t2)
bool | operator!=(const TextEditor::ExtraEncodingSettings &a, const TextEditor::ExtraEncodingSettings &b)
bool | operator!=(const TextEditor::StorageSettings &t1, const TextEditor::StorageSettings &t2)
bool | operator!=(const TextEditor::TypingSettings &t1, const TextEditor::TypingSettings &t2)
bool | operator!=(const TextEditor::FontSettings &f1, const TextEditor::FontSettings &f2)
bool | operator!=(const TextEditor::BehaviorSettings &t1, const TextEditor::BehaviorSettings &t2)
bool | operator!=(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)
bool | operator!=(const int &f1, const int &f2)
TextEditor::QuickFixOperations & | operator<<(TextEditor::QuickFixOperations &list, int *op)
bool | operator==(const Debugger::TextEditor::Format &f1, const Debugger::TextEditor::Format &f2)
bool | operator==(const Debugger::TextEditor::ColorScheme &cs1, const Debugger::TextEditor::ColorScheme &cs2)
bool | operator==(const Debugger::TextEditor::FontSettings &f1, const Debugger::TextEditor::FontSettings &f2)
bool | operator==(const TextEditor::Format &f1, const TextEditor::Format &f2)
bool | operator==(const TextEditor::CommentsSettings &a, const TextEditor::CommentsSettings &b)
bool | operator==(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)
bool | operator==(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)
bool | operator==(const TextEditor::DisplaySettings &t1, const TextEditor::DisplaySettings &t2)
bool | operator==(const TextEditor::CompletionSettings &t1, const TextEditor::CompletionSettings &t2)
bool | operator==(const TextEditor::MarginSettings &one, const TextEditor::MarginSettings &two)
bool | operator==(const TextEditor::TabSettings &t1, const TextEditor::TabSettings &t2)
bool | operator==(const TextEditor::ExtraEncodingSettings &a, const TextEditor::ExtraEncodingSettings &b)
bool | operator==(const TextEditor::StorageSettings &t1, const TextEditor::StorageSettings &t2)
bool | operator==(const TextEditor::TypingSettings &t1, const TextEditor::TypingSettings &t2)
bool | operator==(const TextEditor::FontSettings &f1, const TextEditor::FontSettings &f2)
bool | operator==(const TextEditor::BehaviorSettings &t1, const TextEditor::BehaviorSettings &t2)
bool | operator==(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)
bool | operator==(const int &f1, const int &f2)

## Detailed Description

The TextEditor namespace contains the base text editor and several classes which provide supporting functionality like snippets, highlighting, code assist, indentation and style, and others.

## Namespaces

### namespace TextEditor::Constants

### namespace TextEditor::Internal

### namespace TextEditor::SemanticHighlighter

### namespace TextEditor::Ui

## Classes

### class TextEditor::BaseTextEditor

### class BaseTextEditor

The BaseTextEditor class is base implementation for QPlainTextEdit-based text editors. It can use the Kate text highlighting definitions, and some basic auto indentation. More...

### class TextEditor::BehaviorSettingsPage

### class TextEditor::BehaviorSettingsPageParameters

### class TextEditor::BlockRange

### class BlockRange

### class TextEditor::CodeAssistant

### class TextEditor::ColorScheme

### class ColorScheme

### class TextEditor::DisplaySettingsPage

### class TextEditor::DisplaySettingsPageParameters

### class TextEditor::FontSettings

### class FontSettings

### class TextEditor::Format

### class Format

### class TextEditor::Highlighter

### class TextEditor::HighlighterSettings

### class TextEditor::HighlighterSettingsPage

### class TextEditor::SnippetsSettings

### class TextEditor::TextDocument

### class TextDocument

### class TextEditor::TextDocumentManipulator

### class TextEditor::TextEditorFactory

### class TextEditorFactory

### class TextEditor::TextEditorLinkLabel

### class TextEditorLinkLabel

### class TextEditor::TextEditorSettings

### class TextEditorSettings

### class TextEditor::TextEditorWidget

### class TextEditorWidget

### class TextEditor::TextStyles

### class TextStyles

## Type Documentation

### enum TextEditor::AnnotationAlignment

### enum TextEditor::AssistKind

### enum TextEditor::AssistReason

### enum TextEditor::CaseSensitivity

### enum TextEditor::CompletionTrigger

### typedef TextEditor::FormatDescriptions

### typedef TextEditor::MixinTextStyles

### typedef TextEditor::Parentheses

### typedef TextEditor::QuickFixInterface

### typedef TextEditor::QuickFixOperations

### typedef TextEditor::RefactorMarkers

### typedef TextEditor::RefactoringFilePtr

### typedef TextEditor::TextDocumentPtr

### enum TextEditor::TextMarkRequestKind

### typedef TextEditor::TextMarks

### enum TextEditor::TextPositionOperation

### enum TextEditor::TextStyle

## Function Documentation

### void TextEditor::setMimeTypeForHighlighter(TextEditor::Highlighter *highlighter, const Utils::MimeType &mimeType, const int &filePath, int *foundDefinitionId = nullptr)

### bool TextEditor::operator!=(const Debugger::TextEditor::Format &f1, const Debugger::TextEditor::Format &f2)

### bool TextEditor::operator!=(const Debugger::TextEditor::ColorScheme &cs1, const Debugger::TextEditor::ColorScheme &cs2)

### bool TextEditor::operator!=(const Debugger::TextEditor::FontSettings &f1, const Debugger::TextEditor::FontSettings &f2)

### bool TextEditor::operator!=(const TextEditor::Format &f1, const TextEditor::Format &f2)

### bool TextEditor::operator!=(const TextEditor::CommentsSettings &a, const TextEditor::CommentsSettings &b)

### bool TextEditor::operator!=(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)

### bool TextEditor::operator!=(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)

### bool TextEditor::operator!=(const TextEditor::DisplaySettings &t1, const TextEditor::DisplaySettings &t2)

### bool TextEditor::operator!=(const TextEditor::CompletionSettings &t1, const TextEditor::CompletionSettings &t2)

### bool TextEditor::operator!=(const TextEditor::MarginSettings &one, const TextEditor::MarginSettings &two)

### bool TextEditor::operator!=(const TextEditor::TabSettings &t1, const TextEditor::TabSettings &t2)

### bool TextEditor::operator!=(const TextEditor::ExtraEncodingSettings &a, const TextEditor::ExtraEncodingSettings &b)

### bool TextEditor::operator!=(const TextEditor::StorageSettings &t1, const TextEditor::StorageSettings &t2)

### bool TextEditor::operator!=(const TextEditor::TypingSettings &t1, const TextEditor::TypingSettings &t2)

### bool TextEditor::operator!=(const TextEditor::FontSettings &f1, const TextEditor::FontSettings &f2)

### bool TextEditor::operator!=(const TextEditor::BehaviorSettings &t1, const TextEditor::BehaviorSettings &t2)

### bool TextEditor::operator!=(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)

### bool TextEditor::operator!=(const int &f1, const int &f2)

### TextEditor::QuickFixOperations &TextEditor::operator<<(TextEditor::QuickFixOperations &list, int *op)

### bool TextEditor::operator==(const Debugger::TextEditor::Format &f1, const Debugger::TextEditor::Format &f2)

### bool TextEditor::operator==(const Debugger::TextEditor::ColorScheme &cs1, const Debugger::TextEditor::ColorScheme &cs2)

### bool TextEditor::operator==(const Debugger::TextEditor::FontSettings &f1, const Debugger::TextEditor::FontSettings &f2)

### bool TextEditor::operator==(const TextEditor::Format &f1, const TextEditor::Format &f2)

### bool TextEditor::operator==(const TextEditor::CommentsSettings &a, const TextEditor::CommentsSettings &b)

### bool TextEditor::operator==(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)

### bool TextEditor::operator==(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)

### bool TextEditor::operator==(const TextEditor::DisplaySettings &t1, const TextEditor::DisplaySettings &t2)

### bool TextEditor::operator==(const TextEditor::CompletionSettings &t1, const TextEditor::CompletionSettings &t2)

### bool TextEditor::operator==(const TextEditor::MarginSettings &one, const TextEditor::MarginSettings &two)

### bool TextEditor::operator==(const TextEditor::TabSettings &t1, const TextEditor::TabSettings &t2)

### bool TextEditor::operator==(const TextEditor::ExtraEncodingSettings &a, const TextEditor::ExtraEncodingSettings &b)

### bool TextEditor::operator==(const TextEditor::StorageSettings &t1, const TextEditor::StorageSettings &t2)

### bool TextEditor::operator==(const TextEditor::TypingSettings &t1, const TextEditor::TypingSettings &t2)

### bool TextEditor::operator==(const TextEditor::FontSettings &f1, const TextEditor::FontSettings &f2)

### bool TextEditor::operator==(const TextEditor::BehaviorSettings &t1, const TextEditor::BehaviorSettings &t2)

### bool TextEditor::operator==(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)

### bool TextEditor::operator==(const int &f1, const int &f2)