QGIS/python/gui/auto_generated/inputcontroller/qgsinputcontrollermanager.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

119 lines
3.7 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/inputcontroller/qgsinputcontrollermanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsInputControllerManager : QObject
{
%Docstring(signature="appended")
Manages input control devices.
:py:class:`QgsInputControllerManager` is not usually directly created,
but rather accessed through :py:func:`QgsGui.inputControllerManager()`.
.. versionadded:: 3.34
%End
%TypeHeaderCode
#include "qgsinputcontrollermanager.h"
%End
public:
QgsInputControllerManager( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsInputControllerManager, with the specified ``parent``
object.
.. note::
QgsInputControllerManager is not usually directly created, but rather accessed through
:py:func:`QgsGui.inputControllerManager()`.
%End
~QgsInputControllerManager();
QStringList available2DMapControllers() const;
%Docstring
Returns a list of the device IDs of available 2D map controllers.
.. seealso:: :py:func:`create2DMapController`
.. seealso:: :py:func:`register2DMapController`
%End
QgsAbstract2DMapController *create2DMapController( const QString &deviceId ) const /TransferBack/;
%Docstring
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.
.. seealso:: :py:func:`available2DMapControllers`
%End
bool register2DMapController( QgsAbstract2DMapController *controller /Transfer/ );
%Docstring
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).
.. seealso:: :py:func:`available2DMapControllers`
%End
QStringList available3DMapControllers() const;
%Docstring
Returns a list of the device IDs of available 3D map controllers.
.. seealso:: :py:func:`create3DMapController`
.. seealso:: :py:func:`register3DMapController`
%End
QgsAbstract3DMapController *create3DMapController( const QString &deviceId ) const /TransferBack/;
%Docstring
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.
.. seealso:: :py:func:`available3DMapControllers`
%End
bool register3DMapController( QgsAbstract3DMapController *controller /Transfer/ );
%Docstring
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).
.. seealso:: :py:func:`available3DMapControllers`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/inputcontroller/qgsinputcontrollermanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/