Extending Qt Creator Manual | TextEditor Namespace

Extending Qt Creator Manual 4.8.1

# TextEditor Namespace

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 | SemanticHighlighter
namespace | Ui

## Classes

class | BehaviorSettingsPage
class | BehaviorSettingsPageParameters
class | BlockRange
class | CodeAssistant
class | ColorScheme
class | DisplaySettingsPage
class | DisplaySettingsPageParameters
class | HighlighterSettings
class | HighlighterSettingsPage
class | SnippetsSettings
class | TextDocumentManipulator

## Types

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

## Functions

TextEditor::Q_DECL_IMPORT | formatCurrentFile(const int &command, int startPos = -1, int endPos = 0)
TextEditor::Q_DECL_IMPORT | formatEditor(TextEditor::TextEditorWidget *editor, const int &command, int startPos = -1, int endPos = 0)
TextEditor::Q_DECL_IMPORT | formatEditorAsync(TextEditor::TextEditorWidget *editor, const int &command, int startPos = -1, int endPos = 0)
void | setMimeTypeForHighlighter(TextEditor::Highlighter *highlighter, const Utils::MimeType &mimeType, const int &filePath, int *foundDefinitionId = nullptr)
bool | operator!=(const int &t1, const int &t2)
bool | operator!=(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)
bool | operator!=(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)
bool | operator!=(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)
TextEditor::QuickFixOperations & | operator<<(TextEditor::QuickFixOperations &list, int *op)
bool | operator==(const int &t1, const int &t2)
bool | operator==(const TextEditor::ColorScheme &cs1, const TextEditor::ColorScheme &cs2)
bool | operator==(const TextEditor::HighlighterSettings &a, const TextEditor::HighlighterSettings &b)
bool | operator==(const TextEditor::SnippetsSettings &a, const TextEditor::SnippetsSettings &b)

## 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::SemanticHighlighter

### namespace TextEditor::Ui

## Classes

### class BehaviorSettingsPage

### class BehaviorSettingsPageParameters

### class BlockRange

### class CodeAssistant

### class ColorScheme

### class DisplaySettingsPage

### class DisplaySettingsPageParameters

### class HighlighterSettings

### class HighlighterSettingsPage

### class SnippetsSettings

### class TextDocumentManipulator

## Type Documentation

### enum TextEditor::AnnotationAlignment

### enum TextEditor::AssistKind

### enum TextEditor::AssistReason

### enum TextEditor::CaseSensitivity

### enum TextEditor::CompletionTrigger

### typedef TextEditor::FormatDescriptions

### 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

## Variable Documentation

## Static Variables

## Function Documentation

### TextEditor::Q_DECL_IMPORT TextEditor::formatCurrentFile(const int &command, int startPos = -1, int endPos = 0)

### TextEditor::Q_DECL_IMPORT TextEditor::formatEditor(TextEditor::TextEditorWidget *editor, const int &command, int startPos = -1, int endPos = 0)

### TextEditor::Q_DECL_IMPORT TextEditor::formatEditorAsync(TextEditor::TextEditorWidget *editor, const int &command, int startPos = -1, int endPos = 0)

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

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

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

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

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

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

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

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

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

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

## Macro Documentation