/usr/include/qgis/qgsauthmethodregistry.h is in libqgis-dev 2.18.17+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | /***************************************************************************
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;
/** \ingroup core
* A registry / canonical manager of authentication methods.
This is a Singleton class that manages authentication method plugin access.
Loaded auth methods may be restricted using QGIS_AUTHMETHOD_FILE environment variable.
QGIS_AUTHMETHOD_FILE is regexp pattern applied to auth method file name (not auth method key).
For example, if the variable is set to basic|pkipaths it will load only auth methods
basic, and pkipaths.
\note not available in Python bindings
*/
class CORE_EXPORT QgsAuthMethodRegistry
{
public:
/** Means of accessing canonical single instance */
static QgsAuthMethodRegistry* instance( const QString& pluginPath = QString::null );
/** Virtual dectructor */
virtual ~QgsAuthMethodRegistry();
/** Return path for the library of the auth method */
QString library( const QString & authMethodKey ) const;
/** Return list of auth method plugins found */
QString pluginList( bool asHtml = false ) const;
/** Return library directory where plugins are found */
const QDir & libraryDirectory() const;
/** Set library directory where to search for plugins */
void setLibraryDirectory( const QDir & path );
/** Create an instance of the auth method
@param authMethodKey identificator of the auth method
@return instance of auth method or nullptr on error
*/
QgsAuthMethod *authMethod( const QString & authMethodKey );
/** Return the auth method capabilities
@param authMethodKey identificator of the auth method
*/
// int authMethodCapabilities( const QString& authMethodKey ) const;
/** Return the GUI edit widget associated with the auth method
* @param parent Parent widget
* @param authMethodKey identificator of the auth method
*/
QWidget *editWidget( const QString & authMethodKey, QWidget * parent = nullptr );
#if QT_VERSION >= 0x050000
/** Get pointer to auth method function
@param authMethodKey identificator of the auth method
@param functionName name of function
@return pointer to function or nullptr on error
*/
QFunctionPointer function( const QString & authMethodKey,
const QString & functionName );
#else
/** Get pointer to auth method function
@param authMethodKey identificator of the auth method
@param functionName name of function
@return pointer to function or nullptr on error
*/
void *function( const QString & authMethodKey,
const QString & functionName );
#endif
/** Return the library object associated with an auth method key */
QLibrary *authMethodLibrary( const QString & authMethodKey ) const;
/** Return list of available auth methods by their keys */
QStringList authMethodList() const;
/** Return metadata of the auth method or nullptr if not found */
const QgsAuthMethodMetadata* authMethodMetadata( const QString& authMethodKey ) const;
// void registerGuis( QWidget *widget );
/** Type for auth method metadata associative container */
typedef std::map<QString, QgsAuthMethodMetadata*> AuthMethods;
private:
/** Ctor private since instance() creates it */
QgsAuthMethodRegistry( const QString& pluginPath );
/** Associative container of auth method metadata handles */
AuthMethods mAuthMethods;
/** Directory in which auth method plugins are installed */
QDir mLibraryDirectory;
};
#endif // QGSAUTHMETHODREGISTRY_H
|