File: qgslayertreemapcanvasbridge.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (91 lines) | stat: -rw-r--r-- 3,162 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layertree/qgslayertreemapcanvasbridge.h                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsLayerTreeMapCanvasBridge : QObject
{
%Docstring(signature="appended")
The :py:class:`QgsLayerTreeMapCanvasBridge` class takes care of updates
of layer set for :py:class:`QgsMapCanvas` from a layer tree. The class
listens to the updates in the layer tree and updates the list of layers
for rendering whenever some layers are added, removed, or their
visibility changes.

The update of layers is not done immediately - it is postponed, so a
series of updates to the layer tree will trigger just one update of
canvas layers.

Also allows the client to override the default order of layers. This is
useful in advanced cases where the grouping in layer tree should be
independent from the actual order in the canvas.
%End

%TypeHeaderCode
#include "qgslayertreemapcanvasbridge.h"
%End
  public:
    QgsLayerTreeMapCanvasBridge( QgsLayerTree *root, QgsMapCanvas *canvas, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor: does not take ownership of the layer tree nor canvas
%End

    QgsLayerTree *rootGroup() const;
    QgsMapCanvas *mapCanvas() const;

    void setOverviewCanvas( QgsMapOverviewCanvas *overviewCanvas );
%Docstring
Associates overview canvas with the bridge, so the overview will be
updated whenever main canvas is updated

.. versionadded:: 3.6
%End


    void setOvervewCanvas( QgsMapOverviewCanvas *overviewCanvas ) /Deprecated/; // TODO QGIS 4.0 remove
%MethodCode
    sipCpp->setOverviewCanvas( a0 );
%End

    QgsMapOverviewCanvas *overviewCanvas() const;
%Docstring
Returns associated overview canvas (may be ``None``)
%End

    void setAutoSetupOnFirstLayer( bool enabled );
%Docstring
if enabled, will automatically set full canvas extent and destination
CRS + map units when first layer(s) are added
%End
    bool autoSetupOnFirstLayer() const;

    void setCanvasLayers();
%Docstring
force update of canvas layers from the layer tree. Normally this should
not be needed to be called.
%End

  signals:

    void canvasLayersChanged( const QList<QgsMapLayer *> &layers );
%Docstring
Emitted when the set of layers (or order of layers) visible in the
canvas changes.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/layertree/qgslayertreemapcanvasbridge.h                      *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/