QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgscheckboxsearchwidgetwrapper.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscheckboxsearchwidgetwrapper.h
3  -------------------------------
4  Date : 2016-05-23
5  Copyright : (C) 2016 Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSCHECKBOXSEARCHWIDGETWRAPPER_H
17 #define QGSCHECKBOXSEARCHWIDGETWRAPPER_H
18 
19 #include "qgssearchwidgetwrapper.h"
20 #include "qgis_sip.h"
21 
22 #include <QComboBox>
23 #include <QListWidget>
24 #include <QLineEdit>
25 #include "qgis_gui.h"
26 class QCheckBox;
27 
29 
38 {
39  Q_OBJECT
40 
41  public:
42 
49  explicit QgsCheckboxSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent SIP_TRANSFERTHIS = nullptr );
50 
57  QVariant value() const;
58 
59  bool applyDirectly() override;
60  QString expression() const override;
61  bool valid() const override;
62  QgsSearchWidgetWrapper::FilterFlags supportedFlags() const override;
63  QgsSearchWidgetWrapper::FilterFlags defaultFlags() const override;
64  QString createExpression( QgsSearchWidgetWrapper::FilterFlags flags ) const override;
65 
66  public slots:
67 
68  void clearWidget() override;
69  void setEnabled( bool enabled ) override;
70 
71  protected:
72  QWidget *createWidget( QWidget *parent ) override;
73  void initWidget( QWidget *editor ) override;
74 
75  protected slots:
76  void setExpression( const QString &expression ) override;
77 
78  private slots:
79  void stateChanged( int state );
80 
81  private:
82  QCheckBox *mCheckBox = nullptr;
83  QgsVectorLayer *mLayer = nullptr;
84 
86 };
87 
88 #endif // QGSCHECKBOXSEARCHWIDGETWRAPPER_H
QgsSearchWidgetWrapper::clearWidget
virtual void clearWidget()
Clears the widget's current value and resets it back to the default state.
Definition: qgssearchwidgetwrapper.h:223
QgsWidgetWrapper::initWidget
virtual void initWidget(QWidget *editor)
This method should initialize the editor widget with runtime data.
Definition: qgswidgetwrapper.cpp:106
QgsWidgetWrapper::valid
virtual bool valid() const =0
Returns true if the widget has been properly initialized.
QgsSearchWidgetWrapper::applyDirectly
virtual bool applyDirectly()=0
If this is true, then this search widget should take effect directly when its expression changes.
QgsSearchWidgetWrapper::expression
virtual QString expression() const =0
Will be used to access the widget's value.
QgsSearchWidgetWrapper
Shows a search widget on a filter form.
Definition: qgssearchwidgetwrapper.h:86
QgsSearchWidgetWrapper::supportedFlags
virtual FilterFlags supportedFlags() const
Returns filter flags supported by the search widget.
Definition: qgssearchwidgetwrapper.cpp:94
QgsSearchWidgetWrapper::setExpression
virtual void setExpression(const QString &expression)=0
Set the expression which is currently used as filter for this widget.
QgsCheckboxSearchWidgetWrapper
Wraps a checkbox edit widget for searching.
Definition: qgscheckboxsearchwidgetwrapper.h:38
QgsSearchWidgetWrapper::defaultFlags
virtual FilterFlags defaultFlags() const
Returns the filter flags which should be set by default for the search widget.
Definition: qgssearchwidgetwrapper.cpp:99
qgssearchwidgetwrapper.h
qgis_sip.h
QgsSearchWidgetWrapper::createExpression
virtual QString createExpression(FilterFlags flags) const
Creates a filter expression based on the current state of the search widget and the specified filter ...
Definition: qgssearchwidgetwrapper.h:184
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:387
QgsSearchWidgetWrapper::setEnabled
void setEnabled(bool enabled) override
Toggles whether the search widget is enabled or disabled.
Definition: qgssearchwidgetwrapper.h:229
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
QgsWidgetWrapper::createWidget
virtual QWidget * createWidget(QWidget *parent)=0
This method should create a new widget with the provided parent.
QgsCheckboxWidgetFactory
Definition: qgscheckboxwidgetfactory.h:31