File: qgspointcloudattributecombobox.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (122 lines) | stat: -rw-r--r-- 4,249 bytes parent folder | download | duplicates (5)
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgspointcloudattributecombobox.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsPointCloudAttributeComboBox : QComboBox
{
%Docstring(signature="appended")
The :py:class:`QgsPointCloudAttributeComboBox` is a combo box which displays the list of attributes of a given point cloud layer.
It might be combined with a :py:class:`QgsMapLayerComboBox` to automatically update attributes according to a chosen layer.

.. versionadded:: 3.18
%End

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

    explicit QgsPointCloudAttributeComboBox( QWidget *parent /TransferThis/ = 0 );
%Docstring
QgsPointCloudAttributeComboBox creates a combo box to display the fields of a layer.
The layer can be either manually given or dynamically set by connecting the signal :py:class:`QgsMapLayerComboBox`.layerChanged to the slot setLayer.
%End

    void setFilters( QgsPointCloudAttributeProxyModel::Filters filters );
%Docstring
Sets ``filters`` to allow filtering available attributes according to the attribute properties.

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

    QgsPointCloudAttributeProxyModel::Filters filters() const;
%Docstring
Returns the current filters used for filtering available attributes.

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

    void setAllowEmptyAttributeName( bool allowEmpty );
%Docstring
Sets whether an optional empty attribute ("not set") option is shown in the combo box.

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

    bool allowEmptyAttributeName() const;
%Docstring
Returns ``True`` if the combo box allows the empty field ("not set") choice.

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

    QString currentAttribute() const;
%Docstring
Returns the currently selected attribute
%End

    QgsPointCloudLayer *layer() const;
%Docstring
Returns the layer currently associated with the combobox.

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

    void setAttributes( const QgsPointCloudAttributeCollection &attributes );
%Docstring
Manually sets the ``attributes`` to use for the combo box.

This method should only be used when the combo box ISN'T associated with a :py:func:`~QgsPointCloudAttributeComboBox.layer`
and needs to show the fields from an arbitrary attribute collection instead. Calling
:py:func:`~QgsPointCloudAttributeComboBox.setAttributes` will automatically clear any existing :py:func:`~QgsPointCloudAttributeComboBox.layer`.

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

    QgsPointCloudAttributeCollection attributes() const;
%Docstring
Returns the attributes currently shown in the combobox.

This will either be attributes from the associated :py:func:`~QgsPointCloudAttributeComboBox.layer` or the attributes
manually set by a call to :py:func:`~QgsPointCloudAttributeComboBox.setAttributes`.
%End

  signals:
    void attributeChanged( const QString &name );
%Docstring
Emitted when the currently selected attribute changes.
%End

  public slots:

    void setLayer( QgsMapLayer *layer );
%Docstring
Sets the layer for which fields are listed in the combobox. If no layer is set
or a non-point cloud layer is set then the combobox will be empty.

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

    void setAttribute( const QString &name );
%Docstring
Sets the currently selected attribute by ``name``
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgspointcloudattributecombobox.h                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/