QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | List of all members
QgsAttributeFormRelationEditorWidget Class Reference

Widget to show for child relations on an attribute form. More...

#include <qgsattributeformrelationeditorwidget.h>

Inheritance diagram for QgsAttributeFormRelationEditorWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsAttributeFormRelationEditorWidget (QgsRelationWidgetWrapper *wrapper, QgsAttributeForm *form)
 Constructor. More...
 
void createSearchWidgetWrappers (const QgsAttributeEditorContext &context=QgsAttributeEditorContext()) override
 Creates the search widget wrappers for the widget used when the form is in search mode. More...
 
QString currentFilterExpression () const override
 Creates an expression matching the current search filter value and search properties represented in the widget. More...
 
- Public Member Functions inherited from QgsAttributeFormWidget
 QgsAttributeFormWidget (QgsWidgetWrapper *widget, QgsAttributeForm *form)
 A new form widget for the wrapper widget on form. More...
 
void addAdditionalSearchWidgetWrapper (QgsSearchWidgetWrapper *wrapper)
 Adds an additional search widget wrapper. More...
 
QgsAttributeFormform () const
 The form on which this widget is shown. More...
 
QgsVectorLayerlayer ()
 The layer for which this widget and its form is shown. More...
 
Mode mode () const
 Returns the current mode for the widget. More...
 
void resetSearch ()
 Resets the search/filter value of the widget. More...
 
QWidget * searchWidgetFrame ()
 Returns the widget which should be used as a parent during construction of the search widget wrapper. More...
 
bool searchWidgetToolButtonVisible () const
 The visibility of the search widget tool button, that allows (de)activating this search widgte or defines the comparison operator to use. More...
 
QList< QgsSearchWidgetWrapper *> searchWidgetWrappers ()
 Returns the search widget wrapper used in this widget. More...
 
void setMode (Mode mode)
 Sets the current mode for the widget. More...
 
void setSearchWidgetToolButtonVisible (bool searchWidgetToolButtonVisible)
 The visibility of the search widget tool button, that allows (de)activating this search widgte or defines the comparison operator to use. More...
 
void setSearchWidgetWrapper (QgsSearchWidgetWrapper *wrapper)
 Sets the search widget wrapper for the widget used when the form is in search mode. More...
 

Additional Inherited Members

- Public Types inherited from QgsAttributeFormWidget
enum  Mode { DefaultMode, MultiEditMode, SearchMode, AggregateSearchMode }
 Widget modes. More...
 
- Protected Member Functions inherited from QgsAttributeFormWidget
QWidget * editPage () const
 Returns a pointer to the EDIT page widget. More...
 
QWidget * searchPage () const
 Returns a pointer to the search page widget. More...
 
QStackedWidget * stack () const
 Returns a pointer to the stacked widget managing edit and search page. More...
 

Detailed Description

Widget to show for child relations on an attribute form.

Since
QGIS 3.0

Definition at line 33 of file qgsattributeformrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsAttributeFormRelationEditorWidget()

QgsAttributeFormRelationEditorWidget::QgsAttributeFormRelationEditorWidget ( QgsRelationWidgetWrapper wrapper,
QgsAttributeForm form 
)
explicit

Constructor.

Definition at line 22 of file qgsattributeformrelationeditorwidget.cpp.

Member Function Documentation

◆ createSearchWidgetWrappers()

void QgsAttributeFormRelationEditorWidget::createSearchWidgetWrappers ( const QgsAttributeEditorContext context = QgsAttributeEditorContext())
overridevirtual

Creates the search widget wrappers for the widget used when the form is in search mode.

Parameters
contexteditor context (not available in Python bindings)

Implements QgsAttributeFormWidget.

Definition at line 29 of file qgsattributeformrelationeditorwidget.cpp.

◆ currentFilterExpression()

QString QgsAttributeFormRelationEditorWidget::currentFilterExpression ( ) const
overridevirtual

Creates an expression matching the current search filter value and search properties represented in the widget.

Since
QGIS 2.16

Reimplemented from QgsAttributeFormWidget.

Definition at line 40 of file qgsattributeformrelationeditorwidget.cpp.


The documentation for this class was generated from the following files: