SnippetProvider Class
(TextEditor::SnippetProvider)The SnippetProvider class acts as an interface for providing groups of snippets. More...
Header: | #include <SnippetProvider> |
Inherits: | QObject |
Public Functions
void | decorateEditor(TextEditorWidget *editor) const |
QString | displayName() const |
EditorDecorator | editorDecorator() const |
QString | groupId() const |
- 32 public functions inherited from QObject
Static Public Members
void | registerGroup(const QString &groupId, const QString &displayName, EditorDecorator editorDecorator = EditorDecorator()) |
- 10 static public members inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject
Detailed Description
The SnippetProvider class acts as an interface for providing groups of snippets.
Member Function Documentation
void SnippetProvider::decorateEditor(TextEditorWidget *editor) const
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.
EditorDecorator SnippetProvider::editorDecorator() const
EditorDecorator is a hook which allows you to apply customizations such as highlighting or indentation to the snippet editor.
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.