QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsInputControllerManager Class Reference

Manages input control devices. More...

#include <qgsinputcontrollermanager.h>

Inheritance diagram for QgsInputControllerManager:
Inheritance graph
[legend]

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.
 
QgsAbstract2DMapControllercreate2DMapController (const QString &deviceId) const
 Returns a new instance of the 2D map controller with the specified deviceId.
 
QgsAbstract3DMapControllercreate3DMapController (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.
 

Detailed Description

Manages input control devices.

QgsInputControllerManager is not usually directly created, but rather accessed through QgsGui::inputControllerManager().

Since
QGIS 3.34

Definition at line 39 of file qgsinputcontrollermanager.h.

Constructor & Destructor Documentation

◆ QgsInputControllerManager()

QgsInputControllerManager::QgsInputControllerManager ( QObject *  parent = nullptr)

Constructor for QgsInputControllerManager, with the specified parent object.

Note
QgsInputControllerManager is not usually directly created, but rather accessed through QgsGui::inputControllerManager().

Definition at line 35 of file qgsinputcontrollermanager.cpp.

◆ ~QgsInputControllerManager()

QgsInputControllerManager::~QgsInputControllerManager ( )
override

Definition at line 41 of file qgsinputcontrollermanager.cpp.

Member Function Documentation

◆ available2DMapControllers()

QStringList QgsInputControllerManager::available2DMapControllers ( ) const

Returns a list of the device IDs of available 2D map controllers.

See also
create2DMapController()
register2DMapController()

Definition at line 77 of file qgsinputcontrollermanager.cpp.

◆ available3DMapControllers()

QStringList QgsInputControllerManager::available3DMapControllers ( ) const

Returns a list of the device IDs of available 3D map controllers.

See also
create3DMapController()
register3DMapController()

Definition at line 111 of file qgsinputcontrollermanager.cpp.

◆ create2DMapController()

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.

See also
available2DMapControllers()

Definition at line 92 of file qgsinputcontrollermanager.cpp.

◆ create3DMapController()

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.

See also
available3DMapControllers()

Definition at line 126 of file qgsinputcontrollermanager.cpp.

◆ register2DMapController()

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).

See also
available2DMapControllers()

Definition at line 47 of file qgsinputcontrollermanager.cpp.

◆ register3DMapController()

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).

See also
available3DMapControllers()

Definition at line 62 of file qgsinputcontrollermanager.cpp.


The documentation for this class was generated from the following files: