qgsproviderregistry.h

Go to the documentation of this file.

/***************************************************************************
                    qgsproviderregistry.h  -  Singleton class for
                    registering data providers.
                             -------------------
    begin                : Sat Jan 10 2004
    copyright            : (C) 2004 by Gary E.Sherman
    email                : sherman at mrcc.com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSPROVIDERREGISTRY_H
#define QGSPROVIDERREGISTRY_H

#include <map>

#include <QDir>
#include <QLibrary>
#include <QString>


class QgsDataProvider;
class QgsProviderMetadata;
class QgsVectorLayer;
class QgsCoordinateReferenceSystem;


class CORE_EXPORT QgsProviderRegistry
{

  public:

    static QgsProviderRegistry* instance( const QString& pluginPath = QString::null );

    virtual ~QgsProviderRegistry();

    QString library( const QString & providerKey ) const;

    QString pluginList( bool asHtml = false ) const;

    const QDir & libraryDirectory() const;

    void setLibraryDirectory( const QDir & path );

    QgsDataProvider *provider( const QString & providerKey,
                               const QString & dataSource );

    int providerCapabilities( const QString& providerKey ) const;

    QWidget *selectWidget( const QString & providerKey,
                           QWidget * parent = nullptr, const Qt::WindowFlags& fl = Qt::WindowFlags() );

#if QT_VERSION >= 0x050000

    QFunctionPointer function( const QString & providerKey,
                               const QString & functionName );
#else

    void *function( const QString & providerKey,
                    const QString & functionName );
#endif

    QLibrary *providerLibrary( const QString & providerKey ) const;

    QStringList providerList() const;

    const QgsProviderMetadata* providerMetadata( const QString& providerKey ) const;

    virtual QString fileVectorFilters() const;
    virtual QString fileRasterFilters() const;
    virtual QString databaseDrivers() const;
    virtual QString directoryDrivers() const;
    virtual QString protocolDrivers() const;

    void registerGuis( QWidget *widget );

    //QgsDataProvider * openVector( QString const & dataSource, QString const & providerKey );


    typedef std::map<QString, QgsProviderMetadata*> Providers;

  private:
    QgsProviderRegistry( const QString& pluginPath );

    void init();
    void clean();

    Providers mProviders;

    QDir mLibraryDirectory;

    QString mVectorFileFilters;
    QString mRasterFileFilters;
    QString mDatabaseDrivers;
    QString mDirectoryDrivers;
    QString mProtocolDrivers;

}; // class QgsProviderRegistry

#endif //QGSPROVIDERREGISTRY_H