summaryrefslogtreecommitdiff
path: root/src/plugins/texteditor/snippets/snippetprovider.h
blob: 1bddd2f99bd55cfb47c651699026ff73c32352a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include <texteditor/texteditor_global.h>

#include <QString>

#include <functional>

namespace TextEditor {

class TextEditorWidget;

class TEXTEDITOR_EXPORT SnippetProvider
{
public:
    SnippetProvider() = default;

    using EditorDecorator = std::function<void(TextEditorWidget *)>;

    static const QList<SnippetProvider> &snippetProviders();
    static void registerGroup(const QString &groupId, const QString &displayName,
                              EditorDecorator editorDecorator = EditorDecorator());

    QString groupId() const;
    QString displayName() const;

    static void decorateEditor(TextEditorWidget *editor, const QString &groupId);

private:
    QString m_groupId;
    QString m_displayName;
    EditorDecorator m_editorDecorator;
};

} // TextEditor