File: qgsrendereditemresults.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; 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: 154
file content (103 lines) | stat: -rw-r--r-- 3,387 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
92
93
94
95
96
97
98
99
100
101
102
103
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/maprenderer/qgsrendereditemresults.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsRenderedItemResults
{
%Docstring(signature="appended")
Stores collated details of rendered items during a map rendering
operation.

.. versionadded:: 3.22
%End

%TypeHeaderCode
#include "qgsrendereditemresults.h"
%End
  public:

    QgsRenderedItemResults( const QgsRectangle &extent = QgsRectangle() );
%Docstring
Constructor for QgsRenderedItemResults.

The ``extent`` argument can be used to specify an expected maximal
extent for items which will be stored in the results. This helps to
optimise the spatial indices used by the object.
%End
    ~QgsRenderedItemResults();


    QList< QgsRenderedItemDetails * > renderedItems() const;
%Docstring
Returns a list of all rendered items.
%End

    QList<const QgsRenderedAnnotationItemDetails *> renderedAnnotationItemsInBounds( const QgsRectangle &bounds ) const;
%Docstring
Returns a list with details of the rendered annotation items within the
specified ``bounds``.

.. versionadded:: 3.22
%End

    void appendResults( const QList< QgsRenderedItemDetails * > &results /Transfer/, const QgsRenderContext &context );
%Docstring
Appends rendered item details to the results object.

Ownership of ``results`` is transferred to the this object.

The render ``context`` argument is used to specify the render context
used to render the items. It will be used to transform the details to
the destination map CRS.
%End

    void transferResults( QgsRenderedItemResults *other, const QStringList &layerIds );
%Docstring
Transfers all results from an ``other`` QgsRenderedItemResults object
where the items have layer IDs matching the specified list.

Items are removed from ``other`` and transferred to this object.

.. warning::

   After calling this method the ``other`` results will be left in an undefined state.
%End

    void transferResults( QgsRenderedItemResults *other );
%Docstring
Transfers all results from an ``other`` QgsRenderedItemResults object to
this one.

Items are removed from ``other`` and transferred to this object.

.. warning::

   After calling this method the ``other`` results will be left in an undefined state.
%End

    void eraseResultsFromLayers( const QStringList &layerIds );
%Docstring
Erases results from layers matching those in the specified list of
layers IDs.
%End

  private:
    QgsRenderedItemResults( const QgsRenderedItemResults & );
};

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