QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsrelationreferencesearchwidgetwrapper.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrelationreferencesearchwidgetwrapper.h
3  ----------------------------------------
4  Date : 2016-05-25
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 QGSRELATIONREFERENCESEARCHWIDGETWRAPPER_H
17 #define QGSRELATIONREFERENCESEARCHWIDGETWRAPPER_H
18 
19 #include "qgssearchwidgetwrapper.h"
20 
21 #include <QComboBox>
22 #include <QListWidget>
23 #include <QLineEdit>
24 
25 #include "qgis_gui.h"
26 #include "qgis_sip.h"
27 
28 class QgsRelationReferenceWidgetFactory;
29 class QgsMapCanvas;
31 
40 {
41  Q_OBJECT
42 
43  public:
44 
52  explicit QgsRelationReferenceSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QgsMapCanvas *canvas, QWidget *parent = nullptr );
53 
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 
67  QgsSearchWidgetWrapper::FilterFlags defaultFlags() const override;
68  QString createExpression( QgsSearchWidgetWrapper::FilterFlags flags ) const override;
69 
70  public slots:
71 
72  void clearWidget() override;
73  void setEnabled( bool enabled ) override;
74 
75  protected:
76  QWidget *createWidget( QWidget *parent ) override;
77  void initWidget( QWidget *editor ) override;
78 
79  public slots:
80 
85  Q_DECL_DEPRECATED void onValueChanged( const QVariant &value ) SIP_DEPRECATED;
86 
87  protected slots:
88  void setExpression( const QString &exp ) override;
89 
90  private:
91  void onValuesChanged( const QVariantList &values );
92 
93  QgsRelationReferenceWidget *mWidget = nullptr;
94  QgsVectorLayer *mLayer = nullptr;
95  QgsMapCanvas *mCanvas = nullptr;
96 
97  friend class QgsRelationReferenceWidgetFactory;
98 };
99 
100 #endif // QGSRELATIONREFERENCESEARCHWIDGETWRAPPER_H
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:89
Shows a search widget on a filter form.
void setEnabled(bool enabled) override
Toggles whether the search widget is enabled or disabled.
virtual QString createExpression(FilterFlags flags) const
Creates a filter expression based on the current state of the search widget and the specified filter ...
virtual QString expression() const =0
Will be used to access the widget's value.
virtual FilterFlags defaultFlags() const
Returns the filter flags which should be set by default for the search widget.
virtual void setExpression(const QString &expression)=0
Set the expression which is currently used as filter for this widget.
virtual FilterFlags supportedFlags() const
Returns filter flags supported by the search widget.
virtual bool applyDirectly()=0
If this is true, then this search widget should take effect directly when its expression changes.
virtual void clearWidget()
Clears the widget's current value and resets it back to the default state.
Represents a vector layer which manages a vector based data sets.
virtual bool valid() const =0
Returns true if the widget has been properly initialized.
virtual void initWidget(QWidget *editor)
This method should initialize the editor widget with runtime data.
virtual QWidget * createWidget(QWidget *parent)=0
This method should create a new widget with the provided parent.
#define SIP_DEPRECATED
Definition: qgis_sip.h:106