File: qgsembeddedsymbolrenderer.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 (108 lines) | stat: -rw-r--r-- 4,038 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
104
105
106
107
108
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/symbology/qgsembeddedsymbolrenderer.h                       *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/


class QgsEmbeddedSymbolRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A vector feature renderer which uses embedded feature symbology to
render per-feature symbols.

This renderer can be used for vector layers with a data provider which
supports the :py:class:`QgsVectorDataProvider`.FeatureSymbology
capability, where the dataset has embedded information on how each
feature should be rendered.

.. versionadded:: 3.20
%End

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

    QgsEmbeddedSymbolRenderer( QgsSymbol *defaultSymbol /Transfer/ );
%Docstring
Constructor for QgsEmbeddedSymbolRenderer.

The ``defaultSymbol`` will be used to render any feature without
embedded symbology. Ownership of ``defaultSymbol`` is transferred to the
renderer.
%End
    ~QgsEmbeddedSymbolRenderer();

    virtual QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;

    virtual QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;

    virtual void startRender( QgsRenderContext &context, const QgsFields &fields );

    virtual bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) throw( QgsCsException );

    virtual void stopRender( QgsRenderContext &context );

    virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;

    virtual bool usesEmbeddedSymbols() const;

    virtual QgsEmbeddedSymbolRenderer *clone() const /Factory/;

    virtual QgsFeatureRenderer::Capabilities capabilities();

    virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context );

    virtual QgsSymbolList symbols( QgsRenderContext &context ) const;


    QgsSymbol *defaultSymbol() const;
%Docstring
Returns the default symbol which will be rendered for any feature which
does not have embedded symbology.

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

    void setDefaultSymbol( QgsSymbol *symbol /Transfer/ );
%Docstring
Sets the default ``symbol`` which will be rendered for any feature which
does not have embedded symbology.

Ownership of ``symbol`` is transferred to the renderer.

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

    static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Creates a new embedded symbol renderer from an XML ``element``, using
the supplied read/write ``context``.

The caller takes ownership of the returned renderer.
%End

    static QgsEmbeddedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/;
%Docstring
Creates a QgsEmbeddedSymbolRenderer from an existing ``renderer``.

:return: a new renderer if the conversion was possible, otherwise
         ``None``.
%End

  private:
    QgsEmbeddedSymbolRenderer( const QgsEmbeddedSymbolRenderer & );
    QgsEmbeddedSymbolRenderer &operator=( const QgsEmbeddedSymbolRenderer & );
};


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