aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/coreplugin/locator/commandlocator.h
blob: f7d82f92861b82ce1ddcc5f527c2062bdfac43ca (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0

#pragma once

#include "ilocatorfilter.h"

namespace Core {

/* Command locators: Provides completion for a set of
 * Core::Command's by sub-string of their action's text. */
class Command;
struct CommandLocatorPrivate;

class CORE_EXPORT CommandLocator : public ILocatorFilter
{
    Q_OBJECT

public:
    CommandLocator(Utils::Id id, const QString &displayName,
                   const QString &shortCutString, QObject *parent = nullptr);
    ~CommandLocator() override;

    void appendCommand(Command *cmd);

    void prepareSearch(const QString &entry) override;
    QList<LocatorFilterEntry> matchesFor(QFutureInterface<LocatorFilterEntry> &future,
                                         const QString &entry) override;
    void accept(const LocatorFilterEntry &selection,
                QString *newText, int *selectionStart, int *selectionLength) const override;

private:
    CommandLocatorPrivate *d = nullptr;
};

} // namespace Core