qgsinputcontrollermanager.h

Go to the documentation of this file.

/***************************************************************************
    qgsinputcontroller.h
    ---------------------
    begin                : March 2023
    copyright            : (C) 2023 by Nyall Dawson
    email                : nyall dot dawson at gmail 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 QGSINPUTCONTROLLER_H
#define QGSINPUTCONTROLLER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgis.h"
 
#include <QObject>
#include <QMap>
 
class QgsAbstract2DMapController;
class QgsAbstract3DMapController;
 
class GUI_EXPORT QgsInputControllerManager : public QObject
{
    Q_OBJECT
 
  public:
    QgsInputControllerManager( QObject *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsInputControllerManager() override;
 
    QStringList available2DMapControllers() const;
 
    /*
     * IMPORTANT: While it seems like /Factory/ would be the correct annotation here, that's not
     * the case.
     * As per Phil Thomson's advice on https://www.riverbankcomputing.com/pipermail/pyqt/2017-July/039450.html:
     *
     * "
     * /Factory/ is used when the instance returned is guaranteed to be new to Python.
     * In this case it isn't because it has already been seen when being returned by QgsProcessingAlgorithm::createInstance()
     * (However for a different sub-class implemented in C++ then it would be the first time it was seen
     * by Python so the /Factory/ on create() would be correct.)
     *
     * You might try using /TransferBack/ on create() instead - that might be the best compromise.
     * "
     */
 
    QgsAbstract2DMapController *create2DMapController( const QString &deviceId ) const SIP_TRANSFERBACK;
 
    bool register2DMapController( QgsAbstract2DMapController *controller SIP_TRANSFER );
 
    QStringList available3DMapControllers() const;
 
    /*
     * IMPORTANT: While it seems like /Factory/ would be the correct annotation here, that's not
     * the case.
     * As per Phil Thomson's advice on https://www.riverbankcomputing.com/pipermail/pyqt/2017-July/039450.html:
     *
     * "
     * /Factory/ is used when the instance returned is guaranteed to be new to Python.
     * In this case it isn't because it has already been seen when being returned by QgsProcessingAlgorithm::createInstance()
     * (However for a different sub-class implemented in C++ then it would be the first time it was seen
     * by Python so the /Factory/ on create() would be correct.)
     *
     * You might try using /TransferBack/ on create() instead - that might be the best compromise.
     * "
     */
 
    QgsAbstract3DMapController *create3DMapController( const QString &deviceId ) const SIP_TRANSFERBACK;
 
    bool register3DMapController( QgsAbstract3DMapController *controller SIP_TRANSFER );
 
  private:
    QMap<QString, QgsAbstract2DMapController *> m2DMapControllers;
    QMap<QString, QgsAbstract3DMapController *> m3DMapControllers;
};
 
#endif // QGSINPUTCONTROLLER_H