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



class QgsProcessingParameterDxfLayers : QgsProcessingParameterDefinition
{
%Docstring(signature="appended")
A parameter for Processing algorithms that need a list of input vector
layers to export as DXF file - this parameter provides Processing
framework's adapter for QList<:py:class:`QgsDxfExport`.DxfLayer>.

A valid value for this parameter is a list (QVariantList), where each
item is a map (QVariantMap) in this form:

.. code-block:: python

     {
       'layer':  string or QgsMapLayer,
       'attributeIndex': int
     }

Also it can accept lists (either string lists or
:py:class:`QgsVectorLayer` list) as well as individual layer object or
string representing layer source.

Static functions :py:func:`~parametersAsLayers`,
:py:func:`~variantMapAsLayer`, :py:func:`~layerAsVariantMap` provide
conversion between :py:class:`QgsDxfExport`.DxfLayer representation and
QVariant representation.

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgsprocessingparameterdxflayers.h"
%End
  public:
    QgsProcessingParameterDxfLayers( const QString &name, const QString &description = QString() );
%Docstring
Constructor for QgsProcessingParameterDxfLayers.
%End

    virtual QgsProcessingParameterDefinition *clone() const /Factory/;

    virtual QString type() const;

    virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = 0 ) const;

    virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;

    virtual QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const;

    virtual QString valueAsString( const QVariant &value, QgsProcessingContext &context, bool &ok /Out/ ) const;

    virtual QVariant valueAsJsonObject( const QVariant &value, QgsProcessingContext &context ) const;


    static QString typeName();
%Docstring
Returns the type name for the parameter class.
%End
    static QList<QgsDxfExport::DxfLayer> parameterAsLayers( const QVariant &layersVariant, QgsProcessingContext &context );
%Docstring
Converts a QVariant value (a QVariantList) to a list of input layers
%End
    static QgsDxfExport::DxfLayer variantMapAsLayer( const QVariantMap &layerVariantMap, QgsProcessingContext &context );
%Docstring
Converts a QVariant value (a QVariantMap) to a single input layer
%End
    static QVariantMap layerAsVariantMap( const QgsDxfExport::DxfLayer &layer );
%Docstring
Converts a single input layer to QVariant representation (a QVariantMap)
%End
};


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