mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-25 03:12:53 +00:00
108 lines
3.8 KiB
C++
108 lines
3.8 KiB
C++
/* 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 <QtCore/QSet>
|
|
#include <KDE/KUrl>
|
|
#include "../languageexport.h"
|
|
#include <KDE/KLineEdit>
|
|
|
|
class QStringList;
|
|
|
|
namespace KDevelop
|
|
{
|
|
|
|
class QuickOpenDataProviderBase;
|
|
class IndexedString;
|
|
|
|
class KDEVPLATFORMLANGUAGE_EXPORT IQuickOpenLine : public KLineEdit
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
/**
|
|
* Returns a non-zero declaration if it has been explicitly selected
|
|
* and executed through the quickopen line
|
|
* \code IndexedDeclaration selectedDeclaration() = 0; \endcode
|
|
*
|
|
* Returns a non-empty string if the file has been explicitly selected
|
|
* and executed through the quickopen line
|
|
* \code IndexedString selectedFile() = 0; \endcode
|
|
*/
|
|
virtual void setDefaultText(const QString& text) = 0;
|
|
|
|
Q_SIGNALS:
|
|
void itemSelected();
|
|
};
|
|
|
|
/**
|
|
* 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 scope 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 IQuickOpenLine* createQuickOpenLine(const QStringList& scopes, const QStringList& types,
|
|
QuickOpenType type = Standard) = 0;
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_INTERFACE(KDevelop::IQuickOpen, "org.kdevelop.IQuickOpen")
|
|
|
|
#endif // KDEVPLATFORM_IQUICKOPEN_H
|