File: qgsfeaturerenderergenerator.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 (74 lines) | stat: -rw-r--r-- 2,793 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology/qgsfeaturerenderergenerator.h                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsFeatureRendererGenerator
{
%Docstring(signature="appended")
An interface for objects which generate feature renderers for vector
layers.

.. versionadded:: 3.18
%End

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

    virtual ~QgsFeatureRendererGenerator();

    virtual QString id() const = 0;
%Docstring
Returns a unique ID string identifying the renderer generator.
%End

    virtual double level() const;
%Docstring
Returns a double value which dictates the stacking or z order level
associated with the returned renderer.

A value > 0 will always be rendered AFTER the normal renderer for a
vector layer (i.e. the renderer will be drawn on top of the normal
feature renderer), while a value < 0 will always be rendered BEFORE the
normal renderer (i.e. the rendered features will be drawn below the
normal feature renderer).

Since a layer may potentially have multiple extra renderers created by
QgsFeatureRendererGenerator subclasses, the level will always be used to
control the order that these renderers are drawn. A renderer with a
lower :py:func:`~QgsFeatureRendererGenerator.level` return value will
always be drawn before those with a higher
:py:func:`~QgsFeatureRendererGenerator.level` value.

The default implementation returns 1.0, i.e. features will be rendered
ABOVE the normal vector layer renderer.

.. note::

   If two QgsFeatureRendererGenerator implementations return the same :py:func:`~QgsFeatureRendererGenerator.level` value, then their
   ordering will be unpredictable.
%End

    virtual QgsFeatureRenderer *createRenderer() const = 0 /Factory/;
%Docstring
Creates a new feature renderer to use when rendering a vector layer.

Caller takes ownership of the returned renderer.
%End
};

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