SnippetProvider Class

(TextEditor::SnippetProvider)

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

Header: #include <SnippetProvider>

Public Functions

SnippetProvider() = default
QString displayName() const
QString groupId() const

Static Public Members

void decorateEditor(TextEditorWidget *editor, const QString &groupId)
void registerGroup(const QString &groupId, const QString &displayName, EditorDecorator editorDecorator = EditorDecorator())
const QList<SnippetProvider> &snippetProviders()

Detailed Description

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

Member Function Documentation

[default] SnippetProvider::SnippetProvider()

Default constructs an instance of SnippetProvider.

[static] void SnippetProvider::decorateEditor(TextEditorWidget *editor, const QString &groupId)

Applies customizations such as highlighting or indentation to the snippet editor.

QString SnippetProvider::displayName() const

Returns the name to be displayed in the user interface for snippets that belong to the group associated with this provider.

QString SnippetProvider::groupId() const

Returns the unique group id to which this provider is associated.

[static] void SnippetProvider::registerGroup(const QString &groupId, const QString &displayName, EditorDecorator editorDecorator = EditorDecorator())

Registers a snippet group with groupId, displayName and editorDecorator.

[static] const QList<SnippetProvider> &SnippetProvider::snippetProviders()