QGIS/python/gui/auto_generated/qgsfieldvalueslineedit.sip.in

105 lines
2.7 KiB
Plaintext
Raw Normal View History

2017-05-23 14:44:34 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfieldvalueslineedit.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFieldValuesLineEdit: QgsFilterLineEdit
{
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
A line edit with an autocompleter which takes unique values from a vector layer's fields.
The autocompleter is populated from the vector layer in the background to ensure responsive
interaction with the widget.
2017-05-23 14:44:34 +02:00
.. versionadded:: 3.0
%End
%TypeHeaderCode
2017-05-23 14:44:34 +02:00
#include "qgsfieldvalueslineedit.h"
%End
public:
QgsFieldValuesLineEdit( QWidget *parent /TransferThis/ = 0 );
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsFieldValuesLineEdit
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param parent: parent widget
2017-05-23 14:44:34 +02:00
%End
~QgsFieldValuesLineEdit();
void setLayer( QgsVectorLayer *layer );
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the layer containing the field that values will be shown from.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param layer: vector layer
.. seealso:: :py:func:`layer`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`setAttributeIndex`
2017-05-23 14:44:34 +02:00
%End
QgsVectorLayer *layer() const;
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns the layer containing the field that values will be shown from.
.. seealso:: :py:func:`setLayer`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`attributeIndex`
2017-05-23 14:44:34 +02:00
%End
void setAttributeIndex( int index );
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the attribute index for the field containing values to show in the widget.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param index: index of attribute
.. seealso:: :py:func:`attributeIndex`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`setLayer`
2017-05-23 14:44:34 +02:00
%End
int attributeIndex() const;
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns the attribute index for the field containing values shown in the widget.
.. seealso:: :py:func:`setAttributeIndex`
2017-12-15 10:36:55 -04:00
.. seealso:: :py:func:`layer`
2017-05-23 14:44:34 +02:00
%End
signals:
void layerChanged( QgsVectorLayer *layer );
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted when the layer associated with the widget changes.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param layer: vector layer
2017-05-23 14:44:34 +02:00
%End
void attributeIndexChanged( int index );
2017-05-23 14:44:34 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted when the field associated with the widget changes.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param index: new attribute index for field
2017-05-23 14:44:34 +02:00
%End
};
2017-05-23 14:44:34 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsfieldvalueslineedit.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/