QGIS/python/gui/qgslegendfilterbutton.sip
2017-05-24 13:48:03 +02:00

73 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgslegendfilterbutton.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLegendFilterButton: QToolButton
{
%Docstring
A tool button that allows enabling or disabling legend filter by contents of the map.
An additional pop down menu allows defining a boolean expression to refine the filtering.
.. versionadded:: 2.14
%End
%TypeHeaderCode
#include "qgslegendfilterbutton.h"
%End
public:
QgsLegendFilterButton( QWidget *parent = 0 );
%Docstring
Construct a new filter legend button
\param parent The parent QWidget
%End
QString expressionText() const;
%Docstring
Returns the current text used as filter expression
:rtype: str
%End
void setExpressionText( const QString &expression );
%Docstring
Sets the current text used as filter expression.
This will update the menu
%End
QgsVectorLayer *vectorLayer() const;
%Docstring
Returns the current associated vectorLayer
May be null
:rtype: QgsVectorLayer
%End
void setVectorLayer( QgsVectorLayer *layer );
%Docstring
Sets the associated vectorLayer
May be null
%End
signals:
void expressionTextChanged();
%Docstring
Emitted when the expression text changes
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgslegendfilterbutton.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/