File indexing completed on 2024-05-12 04:38:07

 /*
     SPDX-FileCopyrightText: 2006 David Nolden <david.nolden.kde@art-master.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #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