QGIS API Documentation 3.39.0-Master (8f4da32b6b8)
|
Manages input control devices. More...
#include <qgsinputcontrollermanager.h>
Public Member Functions | |
QgsInputControllerManager (QObject *parent=nullptr) | |
Constructor for QgsInputControllerManager, with the specified parent object. | |
~QgsInputControllerManager () override | |
QStringList | available2DMapControllers () const |
Returns a list of the device IDs of available 2D map controllers. | |
QStringList | available3DMapControllers () const |
Returns a list of the device IDs of available 3D map controllers. | |
QgsAbstract2DMapController * | create2DMapController (const QString &deviceId) const |
Returns a new instance of the 2D map controller with the specified deviceId. | |
QgsAbstract3DMapController * | create3DMapController (const QString &deviceId) const |
Returns a new instance of the 3D map controller with the specified deviceId. | |
bool | register2DMapController (QgsAbstract2DMapController *controller) |
Registers a new 2D map controller. | |
bool | register3DMapController (QgsAbstract3DMapController *controller) |
Registers a new 3D map controller. | |
Manages input control devices.
QgsInputControllerManager is not usually directly created, but rather accessed through QgsGui::inputControllerManager().
Definition at line 39 of file qgsinputcontrollermanager.h.
QgsInputControllerManager::QgsInputControllerManager | ( | QObject * | parent = nullptr | ) |
Constructor for QgsInputControllerManager, with the specified parent object.
Definition at line 34 of file qgsinputcontrollermanager.cpp.
|
override |
Definition at line 40 of file qgsinputcontrollermanager.cpp.
QStringList QgsInputControllerManager::available2DMapControllers | ( | ) | const |
Returns a list of the device IDs of available 2D map controllers.
Definition at line 76 of file qgsinputcontrollermanager.cpp.
QStringList QgsInputControllerManager::available3DMapControllers | ( | ) | const |
Returns a list of the device IDs of available 3D map controllers.
Definition at line 110 of file qgsinputcontrollermanager.cpp.
QgsAbstract2DMapController * QgsInputControllerManager::create2DMapController | ( | const QString & | deviceId | ) | const |
Returns a new instance of the 2D map controller with the specified deviceId.
The caller takes ownership of the returned object.
Will return nullptr
if no matching controller is found.
Definition at line 91 of file qgsinputcontrollermanager.cpp.
QgsAbstract3DMapController * QgsInputControllerManager::create3DMapController | ( | const QString & | deviceId | ) | const |
Returns a new instance of the 3D map controller with the specified deviceId.
The caller takes ownership of the returned object.
Will return nullptr
if no matching controller is found.
Definition at line 125 of file qgsinputcontrollermanager.cpp.
bool QgsInputControllerManager::register2DMapController | ( | QgsAbstract2DMapController * | controller | ) |
Registers a new 2D map controller.
Ownership of controller is transferred to the manager.
Returns true
if the controller was successfully registered, or false
if it could not be registered (e.g. if a controller with matching deviceId has already been registered).
Definition at line 46 of file qgsinputcontrollermanager.cpp.
bool QgsInputControllerManager::register3DMapController | ( | QgsAbstract3DMapController * | controller | ) |
Registers a new 3D map controller.
Ownership of controller is transferred to the manager.
Returns true
if the controller was successfully registered, or false
if it could not be registered (e.g. if a controller with matching deviceId has already been registered).
Definition at line 61 of file qgsinputcontrollermanager.cpp.