qgsauthmethodregistry.h

Go to the documentation of this file.

/***************************************************************************
    qgsauthmethodregistry.h
    ---------------------
    begin                : September 1, 2015
    copyright            : (C) 2015 by Boundless Spatial, Inc. USA
    author               : Larry Shaffer
    email                : lshaffer at boundlessgeo dot 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 QGSAUTHMETHODREGISTRY_H
#define QGSAUTHMETHODREGISTRY_H

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

#include "qgsauthconfig.h"

class QgsAuthMethod;
class QgsAuthMethodMetadata;


class CORE_EXPORT QgsAuthMethodRegistry
{

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

    virtual ~QgsAuthMethodRegistry();

    QString library( const QString & authMethodKey ) const;

    QString pluginList( bool asHtml = false ) const;

    const QDir & libraryDirectory() const;

    void setLibraryDirectory( const QDir & path );

    QgsAuthMethod *authMethod( const QString & authMethodKey );

    // int authMethodCapabilities( const QString& authMethodKey ) const;

    QWidget *editWidget( const QString & authMethodKey, QWidget * parent = nullptr );

#if QT_VERSION >= 0x050000

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

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

    QLibrary *authMethodLibrary( const QString & authMethodKey ) const;

    QStringList authMethodList() const;

    const QgsAuthMethodMetadata* authMethodMetadata( const QString& authMethodKey ) const;

//    void registerGuis( QWidget *widget );

    typedef std::map<QString, QgsAuthMethodMetadata*> AuthMethods;

  private:
    QgsAuthMethodRegistry( const QString& pluginPath );

    AuthMethods mAuthMethods;

    QDir mLibraryDirectory;
};

#endif // QGSAUTHMETHODREGISTRY_H