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

#include <qgsattributeformrelationeditorwidget.h>

Inheritance diagram for QgsAttributeFormRelationEditorWidget:

[legend]

Public Member Functions
	QgsAttributeFormRelationEditorWidget (QgsRelationWidgetWrapper wrapper, QgsAttributeForm form)
	Constructor.

void	createSearchWidgetWrappers (const QgsAttributeEditorContext &context=QgsAttributeEditorContext()) override
	Creates the search widget wrappers for the widget used when the form is in search mode.

QString	currentFilterExpression () const override
	Creates an expression matching the current search filter value and search properties represented in the widget.

void	setMultiEditFeatureIds (const QgsFeatureIds &fids)
	Set multiple feature to edit simultaneously.

Public Member Functions inherited from QgsAttributeFormWidget
	QgsAttributeFormWidget (QgsWidgetWrapper widget, QgsAttributeForm form)
	A new form widget for the wrapper widget on form.

	~QgsAttributeFormWidget () override

void	addAdditionalSearchWidgetWrapper (QgsSearchWidgetWrapper *wrapper)
	Adds an additional search widget wrapper.

QgsAttributeForm *	form () const
	The form on which this widget is shown.

QgsVectorLayer *	layer ()
	The layer for which this widget and its form is shown.

Mode	mode () const
	Returns the current mode for the widget.

void	resetSearch ()
	Resets the search/filter value of the widget.

QWidget *	searchWidgetFrame ()
	Returns the widget which should be used as a parent during construction of the search widget wrapper.

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.

QList< QgsSearchWidgetWrapper * >	searchWidgetWrappers ()
	Returns the search widget wrapper used in this widget.

void	setMode (Mode mode)
	Sets the current mode for the widget.

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.

void	setSearchWidgetWrapper (QgsSearchWidgetWrapper *wrapper)
	Sets the search widget wrapper for the widget used when the form is in search mode.

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.

QWidget *	searchPage () const
	Returns a pointer to the search page widget.

void	setVisiblePageForMode (QgsAttributeFormWidget::Mode mode)
	Sets the visible page in the widget to the page matching the specified mode.

QStackedWidget *	stack () const
	Returns a pointer to the stacked widget managing edit and search page.

Detailed Description

Widget to show for child relations on an attribute form.

Definition at line 32 of file qgsattributeformrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsAttributeFormRelationEditorWidget()

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

explicit

Constructor.

Definition at line 23 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

context editor context (not available in Python bindings)

Implements QgsAttributeFormWidget.

Definition at line 30 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.

Reimplemented from QgsAttributeFormWidget.

Definition at line 41 of file qgsattributeformrelationeditorwidget.cpp.

◆ setMultiEditFeatureIds()

void QgsAttributeFormRelationEditorWidget::setMultiEditFeatureIds ( const QgsFeatureIds & fids )

Set multiple feature to edit simultaneously.

Parameters

fids	Multiple Id of features to edit

Since: QGIS 3.24

Definition at line 50 of file qgsattributeformrelationeditorwidget.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/qgsattributeformrelationeditorwidget.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/gui/qgsattributeformrelationeditorwidget.cpp

Public Member Functions