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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/* This file is part of the KDE project
Copyright 2006 David Nolden <david.nolden.kde@art-master.de>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_IQUICKOPEN_H
#define KDEVPLATFORM_IQUICKOPEN_H
#include <QSet>
#include <QLineEdit>
#include <language/languageexport.h>
class QStringList;
namespace KDevelop {
class QuickOpenDataProviderBase;
class IndexedString;
/**
* Interface to quickopen
*/
class KDEVPLATFORMLANGUAGE_EXPORT IQuickOpen
{
public:
virtual ~IQuickOpen();
/**
* Shows the quickopen dialog with the entries of specified types
* Default types are: Files, Functions, Classes
* There might be other quick open providers with custom items.
* Note, the item name has to be translated, for example i18n("Files") should be passed.
*/
virtual void showQuickOpen(const QStringList& types) = 0;
/**
* Registers a new provider under a specified name.
* There may be multiple providers with the same type/scope, they will be used simultaneously in that case.
* type and scope will be shown in the GUI, so they should be translated.
* @param scopes Different scopes supported by this data-provider, Examples: "Project", "Imports", etc.
* @param type Types of the provided data, Examples: "Files", "Functions", "Classes", etc.
* @param provider The provider. It does not need to be explicitly removed before its destruction.
*/
virtual void registerProvider(const QStringList& scopes, const QStringList& type,
QuickOpenDataProviderBase* provider) = 0;
/**
* Remove provider.
* @param provider The provider to remove
* @return Whether a provider was removed. If false, the provider was not attached.
*/
virtual bool removeProvider(QuickOpenDataProviderBase* provider) = 0;
/**
* Queries a set of files merged from all active data-providers that implement QuickOpenFileSetInterface.
* This should not be queried by data-providers that implement QuickOpenFileSetInterface during their
* initialization(set() and enableData())
*/
virtual QSet<KDevelop::IndexedString> fileSet() const = 0;
enum QuickOpenType {
Standard,
Outline
};
virtual QLineEdit* createQuickOpenLine(const QStringList& scopes, const QStringList& types,
QuickOpenType type = Standard) = 0;
};
}
Q_DECLARE_INTERFACE(KDevelop::IQuickOpen, "org.kdevelop.IQuickOpen")
#endif // KDEVPLATFORM_IQUICKOPEN_H
|
