#include <qgsrelationreferencewidget.h>

Inheritance diagram for QgsRelationReferenceWidget:

Public Types
enum	CanvasExtent { Fixed, Pan, Scale }

Public Slots
void	deleteForeignKey ()
	unset the currently related feature More...

void	mapIdentification ()
	activate the map tool to select a new related feature on the map More...

void	openForm ()
	open the form of the related feature in a new dialog More...

Signals
void	foreignKeyChanged (const QVariant &)

Public Member Functions
	QgsRelationReferenceWidget (QWidget *parent)

	~QgsRelationReferenceWidget () override

bool	allowAddFeatures () const
	Determines if a button for adding new features should be shown. More...

bool	allowMapIdentification ()
	determines if the widge offers the possibility to select the related feature on the map (using a dedicated map tool) More...

bool	chainFilters () const
	Determines if the filters are chained. More...

bool	embedForm ()
	determines if the form of the related feature will be shown More...

QVariant	foreignKey () const
	returns the related feature foreign key More...

bool	openFormButtonVisible ()
	determines the open form button is visible in the widget More...

bool	orderByValue ()
	If the widget will order the combobox entries by value. More...

bool	readOnlySelector ()
	determines if the foreign key is shown in a combox box or a read-only line edit More...

QgsFeature	referencedFeature () const
	return the related feature (from the referenced layer) if no feature is related, it returns an invalid feature More...

void	setAllowAddFeatures (bool allowAddFeatures)
	Determines if a button for adding new features should be shown. More...

void	setAllowMapIdentification (bool allowMapIdentification)

void	setChainFilters (bool chainFilters)
	Set if filters are chained. More...

void	setEditorContext (const QgsAttributeEditorContext &context, QgsMapCanvas canvas, QgsMessageBar messageBar)

void	setEmbedForm (bool display)

void	setFilterFields (const QStringList &filterFields)
	Set the fields for which filter comboboxes will be created. More...

void	setForeignKey (const QVariant &value)
	this sets the related feature using from the foreign key More...

void	setOpenFormButtonVisible (bool openFormButtonVisible)

void	setOrderByValue (bool orderByValue)
	Set if the widget will order the combobox entries by value. More...

void	setReadOnlySelector (bool readOnly)

void	setRelation (const QgsRelation &relation, bool allowNullValue)

void	setRelationEditable (bool editable)

void	showIndeterminateState ()
	Sets the widget to display in an indeterminate "mixed value" state. More...

Protected Member Functions
void	init ()

void	showEvent (QShowEvent *e) override

Properties
bool	openFormButtonVisible

Friends
class	TestQgsRelationReferenceWidget

Detailed Description

Definition at line 54 of file qgsrelationreferencewidget.h.

Member Enumeration Documentation

◆ CanvasExtent

enum QgsRelationReferenceWidget::CanvasExtent

Enumerator
Fixed
Pan
Scale

Definition at line 71 of file qgsrelationreferencewidget.h.

Constructor & Destructor Documentation

◆ QgsRelationReferenceWidget()

QgsRelationReferenceWidget::QgsRelationReferenceWidget ( QWidget * parent )

explicit

Definition at line 45 of file qgsrelationreferencewidget.cpp.

◆ ~QgsRelationReferenceWidget()

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )

override

Definition at line 150 of file qgsrelationreferencewidget.cpp.

Member Function Documentation

◆ allowAddFeatures()

bool QgsRelationReferenceWidget::allowAddFeatures ( ) const

Determines if a button for adding new features should be shown.

Since: QGIS 2.16

Definition at line 683 of file qgsrelationreferencewidget.cpp.

◆ allowMapIdentification()

bool QgsRelationReferenceWidget::allowMapIdentification ( )

inline

determines if the widge offers the possibility to select the related feature on the map (using a dedicated map tool)

Definition at line 103 of file qgsrelationreferencewidget.h.

◆ chainFilters()

bool QgsRelationReferenceWidget::chainFilters ( ) const

inline

Determines if the filters are chained.

Returns: True if filters are chained

Definition at line 122 of file qgsrelationreferencewidget.h.

◆ deleteForeignKey

void QgsRelationReferenceWidget::deleteForeignKey ( )

slot

unset the currently related feature

Definition at line 287 of file qgsrelationreferencewidget.cpp.

◆ embedForm()

bool QgsRelationReferenceWidget::embedForm ( )

inline

determines if the form of the related feature will be shown

Definition at line 95 of file qgsrelationreferencewidget.h.

◆ foreignKey()

QVariant QgsRelationReferenceWidget::foreignKey ( ) const

returns the related feature foreign key

Definition at line 354 of file qgsrelationreferencewidget.cpp.

◆ foreignKeyChanged

void QgsRelationReferenceWidget::foreignKeyChanged ( const QVariant & )

signal

◆ init()

void QgsRelationReferenceWidget::init ( )

protected

Definition at line 435 of file qgsrelationreferencewidget.cpp.

◆ mapIdentification

void QgsRelationReferenceWidget::mapIdentification ( )

slot

activate the map tool to select a new related feature on the map

Definition at line 632 of file qgsrelationreferencewidget.cpp.

◆ openForm

void QgsRelationReferenceWidget::openForm ( )

slot

open the form of the related feature in a new dialog

Definition at line 547 of file qgsrelationreferencewidget.cpp.

◆ openFormButtonVisible()

bool QgsRelationReferenceWidget::openFormButtonVisible ( )

inline

determines the open form button is visible in the widget

Definition at line 114 of file qgsrelationreferencewidget.h.

◆ orderByValue()

bool QgsRelationReferenceWidget::orderByValue ( )

inline

If the widget will order the combobox entries by value.

Definition at line 107 of file qgsrelationreferencewidget.h.

◆ readOnlySelector()

bool QgsRelationReferenceWidget::readOnlySelector ( )

inline

determines if the foreign key is shown in a combox box or a read-only line edit

Definition at line 99 of file qgsrelationreferencewidget.h.

◆ referencedFeature()

QgsFeature QgsRelationReferenceWidget::referencedFeature ( ) const

return the related feature (from the referenced layer) if no feature is related, it returns an invalid feature

Definition at line 321 of file qgsrelationreferencewidget.cpp.

◆ setAllowAddFeatures()

void QgsRelationReferenceWidget::setAllowAddFeatures ( bool allowAddFeatures )

Determines if a button for adding new features should be shown.

Since: QGIS 2.16

Definition at line 688 of file qgsrelationreferencewidget.cpp.

◆ setAllowMapIdentification()

void QgsRelationReferenceWidget::setAllowMapIdentification ( bool allowMapIdentification )

Definition at line 398 of file qgsrelationreferencewidget.cpp.

◆ setChainFilters()

void QgsRelationReferenceWidget::setChainFilters ( bool chainFilters )

Set if filters are chained.

Chained filters restrict the option of subsequent filters based on the selection of a previous filter.

Parameters

chainFilters If chaining should be enabled

Definition at line 421 of file qgsrelationreferencewidget.cpp.

◆ setEditorContext()

void QgsRelationReferenceWidget::setEditorContext	(	const QgsAttributeEditorContext &	context,
		QgsMapCanvas *	canvas,
		QgsMessageBar *	messageBar
	)

Definition at line 366 of file qgsrelationreferencewidget.cpp.

◆ setEmbedForm()

void QgsRelationReferenceWidget::setEmbedForm ( bool display )

Definition at line 378 of file qgsrelationreferencewidget.cpp.

◆ setFilterFields()

void QgsRelationReferenceWidget::setFilterFields ( const QStringList & filterFields )

Set the fields for which filter comboboxes will be created.

Definition at line 410 of file qgsrelationreferencewidget.cpp.

◆ setForeignKey()

void QgsRelationReferenceWidget::setForeignKey ( const QVariant & value )

this sets the related feature using from the foreign key

Definition at line 216 of file qgsrelationreferencewidget.cpp.

◆ setOpenFormButtonVisible()

void QgsRelationReferenceWidget::setOpenFormButtonVisible ( bool openFormButtonVisible )

Definition at line 415 of file qgsrelationreferencewidget.cpp.

◆ setOrderByValue()

void QgsRelationReferenceWidget::setOrderByValue ( bool orderByValue )

Set if the widget will order the combobox entries by value.

Definition at line 405 of file qgsrelationreferencewidget.cpp.

◆ setReadOnlySelector()

void QgsRelationReferenceWidget::setReadOnlySelector ( bool readOnly )

Definition at line 390 of file qgsrelationreferencewidget.cpp.

◆ setRelation()

void QgsRelationReferenceWidget::setRelation	(	const QgsRelation &	relation,
		bool	allowNullValue
	)

Definition at line 158 of file qgsrelationreferencewidget.cpp.

◆ setRelationEditable()

void QgsRelationReferenceWidget::setRelationEditable ( bool editable )

Definition at line 203 of file qgsrelationreferencewidget.cpp.

◆ showEvent()

void QgsRelationReferenceWidget::showEvent ( QShowEvent * e )

overrideprotected

Definition at line 426 of file qgsrelationreferencewidget.cpp.

◆ showIndeterminateState()

void QgsRelationReferenceWidget::showIndeterminateState ( )

Sets the widget to display in an indeterminate "mixed value" state.

Since: QGIS 2.16

Definition at line 340 of file qgsrelationreferencewidget.cpp.

Friends And Related Function Documentation

◆ TestQgsRelationReferenceWidget

friend class TestQgsRelationReferenceWidget

friend

Definition at line 246 of file qgsrelationreferencewidget.h.

Property Documentation

◆ openFormButtonVisible

bool QgsRelationReferenceWidget::openFormButtonVisible

readwrite

Definition at line 67 of file qgsrelationreferencewidget.h.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/gui/editorwidgets/qgsrelationreferencewidget.h
/tmp/buildd/qgis-3.0.2+14stretch/src/gui/editorwidgets/qgsrelationreferencewidget.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Detailed Description

Member Enumeration Documentation

◆ CanvasExtent

Constructor & Destructor Documentation

◆ QgsRelationReferenceWidget()

◆ ~QgsRelationReferenceWidget()

Member Function Documentation

◆ allowAddFeatures()

◆ allowMapIdentification()

◆ chainFilters()

◆ deleteForeignKey

◆ embedForm()

◆ foreignKey()

◆ foreignKeyChanged

◆ init()

◆ mapIdentification

◆ openForm

◆ openFormButtonVisible()

◆ orderByValue()

◆ readOnlySelector()

◆ referencedFeature()

◆ setAllowAddFeatures()

◆ setAllowMapIdentification()

◆ setChainFilters()

◆ setEditorContext()

◆ setEmbedForm()

◆ setFilterFields()

◆ setForeignKey()

◆ setOpenFormButtonVisible()

◆ setOrderByValue()

◆ setReadOnlySelector()

◆ setRelation()

◆ setRelationEditable()

◆ showEvent()

◆ showIndeterminateState()

Friends And Related Function Documentation

◆ TestQgsRelationReferenceWidget

Property Documentation

◆ openFormButtonVisible