Class: QgsInputControllerManager¶
- class qgis.gui.QgsInputControllerManager¶
Bases:
PyQt5.QtCore.QObject
Manages input control devices.
QgsInputControllerManager
is not usually directly created, but rather accessed throughQgsGui.inputControllerManager()
.Added in version 3.34.
QgsInputControllerManager(parent: Optional[QObject] = None) Constructor for
QgsInputControllerManager
, with the specifiedparent
object.Note
QgsInputControllerManager
is not usually directly created, but rather accessed throughQgsGui.inputControllerManager()
.Methods
Returns a list of the device IDs of available 2D map controllers.
Returns a list of the device IDs of available 3D map controllers.
Returns a new instance of the 2D map controller with the specified
deviceId
.Returns a new instance of the 3D map controller with the specified
deviceId
.Registers a new 2D map
controller
.Registers a new 3D map
controller
.- available2DMapControllers(self) List[str] ¶
Returns a list of the device IDs of available 2D map controllers.
See also
See also
- Return type:
List[str]
- available3DMapControllers(self) List[str] ¶
Returns a list of the device IDs of available 3D map controllers.
See also
See also
- Return type:
List[str]
- childEvent(self, a0: QChildEvent | None)¶
- connectNotify(self, signal: QMetaMethod)¶
- create2DMapController(self, deviceId: str | None) QgsAbstract2DMapController | None ¶
Returns a new instance of the 2D map controller with the specified
deviceId
.The caller takes ownership of the returned object.
Will return
None
if no matching controller is found.See also
- Parameters:
deviceId (Optional[str])
- Return type:
Optional[QgsAbstract2DMapController]
- create3DMapController(self, deviceId: str | None) QgsAbstract3DMapController | None ¶
Returns a new instance of the 3D map controller with the specified
deviceId
.The caller takes ownership of the returned object.
Will return
None
if no matching controller is found.See also
- Parameters:
deviceId (Optional[str])
- Return type:
Optional[QgsAbstract3DMapController]
- customEvent(self, a0: QEvent | None)¶
- disconnectNotify(self, signal: QMetaMethod)¶
- isSignalConnected(self, signal: QMetaMethod) bool ¶
- receivers(self, signal: PYQT_SIGNAL) int ¶
- register2DMapController(self, controller: QgsAbstract2DMapController | None) bool ¶
Registers a new 2D map
controller
.Ownership of
controller
is transferred to the manager.Returns
True
if the controller was successfully registered, orFalse
if it could not be registered (e.g. if a controller with matching deviceId has already been registered).See also
- Parameters:
controller (Optional[QgsAbstract2DMapController])
- Return type:
bool
- register3DMapController(self, controller: QgsAbstract3DMapController | None) bool ¶
Registers a new 3D map
controller
.Ownership of
controller
is transferred to the manager.Returns
True
if the controller was successfully registered, orFalse
if it could not be registered (e.g. if a controller with matching deviceId has already been registered).See also
- Parameters:
controller (Optional[QgsAbstract3DMapController])
- Return type:
bool
- sender(self) QObject | None ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, a0: QTimerEvent | None)¶