File: qgslabelplacementsettings.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 (95 lines) | stat: -rw-r--r-- 3,055 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/labeling/qgslabelplacementsettings.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsLabelPlacementSettings
{
%Docstring(signature="appended")
Contains general settings related to how labels are placed.

.. versionadded:: 3.26
%End

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

    Qgis::LabelOverlapHandling overlapHandling() const;
%Docstring
Returns the technique used to handle overlapping labels.

.. seealso:: :py:func:`setOverlapHandling`
%End

    void setOverlapHandling( Qgis::LabelOverlapHandling handling );
%Docstring
Sets the technique used to handle overlapping labels.

.. seealso:: :py:func:`overlapHandling`
%End

    bool allowDegradedPlacement() const;
%Docstring
Returns ``True`` if labels can be placed in inferior fallback positions
if they cannot otherwise be placed.

For instance, this will permit a curved line label to fallback to a
horizontal label at the end of the line if the label cannot otherwise be
placed on the line in a curved manner.

.. seealso:: :py:func:`setAllowDegradedPlacement`
%End

    void setAllowDegradedPlacement( bool allow );
%Docstring
Sets whether labels can be placed in inferior fallback positions if they
cannot otherwise be placed.

For instance, this will permit a curved line label to fallback to a
horizontal label at the end of the line if the label cannot otherwise be
placed on the line in a curved manner.

.. seealso:: :py:func:`allowDegradedPlacement`
%End

    Qgis::LabelPrioritization prioritization() const;
%Docstring
Returns the label prioritization technique.

.. seealso:: :py:func:`setPrioritization`

.. versionadded:: 3.38
%End

    void setPrioritization( Qgis::LabelPrioritization prioritization );
%Docstring
Sets the technique used to prioritize labels.

.. seealso:: :py:func:`prioritization`

.. versionadded:: 3.38
%End

    void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
%Docstring
Updates the placement settings to respect any data defined properties
set within the specified ``properties`` collection.
%End

};

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