Extending Qt Creator Manual | TextEditor Namespace

Extending Qt Creator Manual 4.3.0

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

## Classes

class | AssistInterface
class | AssistProposalItem
class | AssistProposalItemInterface
class | AutoCompleter
class | BaseFileFind
class | BaseHoverHandler
class | BaseTextEditor
class | BehaviorSettings
class | BehaviorSettingsPage
class | BehaviorSettingsPageParameters
class | BehaviorSettingsWidget
class | BlockRange
class | CodeAssistant
class | CodeFormatterData
class | CodeStyleEditor
class | CodeStylePool
class | CodeStyleSelectorWidget
class | ColorPreviewHoverHandler
class | CommentsSettings
class | CompletionAssistProvider
class | CompletionSettings
class | DisplaySettings
class | DisplaySettingsPage
class | DisplaySettingsPageParameters
class | ExtraEncodingSettings
class | FileFindParameters
class | FindInFiles
class | FontSettings
class | FontSettingsPage
class | FormatDescription
class | FunctionHintProposal
class | FunctionHintProposalWidget
class | GenericProposal
class | GenericProposalModel
class | GenericProposalWidget
class | HelpItem
class | Highlighter
class | HighlighterSettings
class | HighlighterSettingsPage
class | HighlightingResult
class | IAssistProcessor
class | IAssistProposal
class | IAssistProposalModel
class | IAssistProposalWidget
class | IAssistProvider
class | ICodeStylePreferences
class | ICodeStylePreferencesFactory
class | IFunctionHintProposalModel
class | IOutlineWidget
class | IOutlineWidgetFactory
class | ISnippetProvider
class | Indenter
class | Keywords
class | KeywordsAssistProposalItem
class | KeywordsCompletionAssistProcessor
class | KeywordsFunctionHintModel
class | MarginSettings
class | NameMangler
class | NormalIndenter
class | Parenthesis
class | PlainTextEditorFactory
class | QuickFixAssistProcessor
class | QuickFixAssistProvider
class | RefactorMarker
class | RefactorOverlay
class | RefactoringChangesData
class | RefactoringFile
class | SearchEngine
class | SimpleCodeStylePreferences
class | SimpleCodeStylePreferencesWidget
class | Snippet
class | SnippetAssistCollector
class | SnippetEditorWidget
class | SnippetsSettings
class | StorageSettings
class | SyntaxHighlighter
class | TabSettings
class | TabSettingsWidget
class | TextBlockUserData
class | TextDocument
class | TextDocumentLayout
class | TextDocumentManipulator
class | TextDocumentManipulatorInterface
class | TextEditorActionHandler
class | TextEditorFactory
class | TextEditorLinkLabel
class | TextEditorOptionsPage
class | TextEditorSettings
class | TextEditorWidget
class | TextMark
class | TextStyles
class | TypingSettings

## Types

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

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

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

### namespace TextEditor::SemanticHighlighter

### namespace TextEditor::Ui

## Classes

### class AssistInterface

The AssistInterface class acts as an interface for providing access to the document from which a proposal is computed. More...

### class AssistProposalItem

The AssistProposalItem class acts as an interface for representing an assist proposal item. More...

### class AssistProposalItemInterface

### class AutoCompleter

### class BaseFileFind

### class BaseHoverHandler

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

### class BehaviorSettingsPage

### class BehaviorSettingsPageParameters

### class BehaviorSettingsWidget

### class BlockRange

### class CodeAssistant

### class CodeFormatterData

### class CodeStyleEditor

### class CodeStylePool

### class CodeStyleSelectorWidget

### class ColorPreviewHoverHandler

### class CommentsSettings

### class CompletionAssistProvider

### class CompletionSettings

### class DisplaySettings

### class DisplaySettingsPage

### class DisplaySettingsPageParameters

### class ExtraEncodingSettings

### class FileFindParameters

### class FindInFiles

### class FontSettings

### class FontSettingsPage

### class FormatDescription

### class FunctionHintProposal

### class FunctionHintProposalWidget

### class GenericProposal

### class GenericProposalModel

### class GenericProposalWidget

### class HelpItem

### class Highlighter

### class HighlighterSettings

### class HighlighterSettingsPage

### class HighlightingResult

### class IAssistProcessor

The IAssistProcessor class acts as an interface that actually computes an assist proposal. More...

### class IAssistProposal

The IAssistProposal class acts as an interface for representing an assist proposal. More...

### class IAssistProposalModel

The IAssistProposalModel class acts as an interface for representing proposals. More...

### class IAssistProposalWidget

The IAssistProposalWidget class acts as an interface for widgets that display assist proposals. More...

### class IAssistProvider

The IAssistProvider class acts as an interface for providing code assist. More...

### class ICodeStylePreferences

### class ICodeStylePreferencesFactory

### class IFunctionHintProposalModel

### class IOutlineWidget

### class IOutlineWidgetFactory

### class ISnippetProvider

The ISnippetProvider class acts as an interface for providing groups of snippets. More...

### class Indenter

### class Keywords

### class KeywordsAssistProposalItem

### class KeywordsCompletionAssistProcessor

### class KeywordsFunctionHintModel

### class MarginSettings

### class NameMangler

### class NormalIndenter

### class Parenthesis

### class PlainTextEditorFactory

### class QuickFixAssistProcessor

### class QuickFixAssistProvider

### class RefactorMarker

### class RefactorOverlay

### class RefactoringChangesData

### class RefactoringFile

### class SearchEngine

### class SimpleCodeStylePreferences

### class SimpleCodeStylePreferencesWidget

### class Snippet

### class SnippetAssistCollector

### class SnippetEditorWidget

The SnippetEditorWidget class is a lightweight editor for code snippets with basic support for syntax highlighting, indentation, and others. More...

### class SnippetsSettings

### class StorageSettings

### class SyntaxHighlighter

### class TabSettings

### class TabSettingsWidget

### class TextBlockUserData

### class TextDocument

### class TextDocumentLayout

### class TextDocumentManipulator

### class TextDocumentManipulatorInterface

### class TextEditorActionHandler

### class TextEditorFactory

### class TextEditorLinkLabel

### class TextEditorOptionsPage

### class TextEditorSettings

### class TextEditorWidget

### class TextMark

### class TextStyles

### class TypingSettings

## Type Documentation

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

### typedef TextEditor::TextDocumentPtr

### enum TextEditor::TextMarkRequestKind

### typedef TextEditor::TextMarks

### enum TextEditor::TextPositionOperation

### enum TextEditor::TextStyle

## Function Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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