File: qgslabelingresults.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 (81 lines) | stat: -rw-r--r-- 2,552 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/labeling/qgslabelingresults.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsLabelingResults
{
%Docstring(signature="appended")
Class that stores computed placement from labeling engine.
%End

%TypeHeaderCode
#include "qgslabelingresults.h"
%End
  public:
    QgsLabelingResults();
    ~QgsLabelingResults();


    QList< QgsLabelPosition > allLabels() const;
%Docstring
Returns a list of all labels generated by the labeling run.

.. versionadded:: 3.20
%End

    QList<QgsLabelPosition> labelsAtPosition( const QgsPointXY &p ) const;
%Docstring
Returns the details of any labels placed at the specified point (in map
coordinates).
%End

    QList<QgsLabelPosition> labelsWithinRect( const QgsRectangle &r ) const;
%Docstring
Returns the details of any labels placed within the specified rectangle
(in map coordinates).
%End

    QList<QgsLabelPosition> groupedLabelPositions( long long groupId ) const;
%Docstring
Returns a list of all label positions sharing the same group ID (i.e.
positions for individual characters in a curved label).

.. versionadded:: 3.26
%End

    QList<QgsCalloutPosition> calloutsWithinRectangle( const QgsRectangle &rectangle ) const;
%Docstring
Returns a list of callouts with origins or destinations inside the given
``rectangle``.

The ``rectangle`` is specified in map coordinates.

.. versionadded:: 3.20
%End

    void setMapSettings( const QgsMapSettings &settings );
%Docstring
Sets the map ``settings`` associated with the labeling run.

.. versionadded:: 3.4.8
%End

  private:
    QgsLabelingResults( const QgsLabelingResults & );
};

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