File: qgsinputcontrollermanager.sip.in

package info (click to toggle)
qgis 3.40.6%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 1,181,336 kB
  • sloc: cpp: 1,593,302; python: 370,494; xml: 23,474; perl: 3,664; sh: 3,482; ansic: 2,257; sql: 2,133; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 157
file content (118 lines) | stat: -rw-r--r-- 3,809 bytes parent folder | download | duplicates (16)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/************************************************************************
 * 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   *
 ************************************************************************/