QgsRelationReferenceWidget Class Reference

#include <qgsrelationreferencewidget.h>

Inheritance diagram for QgsRelationReferenceWidget:

Public Types
enum	CanvasExtent { Fixed, Pan, Scale }

Public Slots
void	deleteForeignKeys ()
	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
Q_DECL_DEPRECATED void	foreignKeyChanged (const QVariant &)
	Emitted when the foreign key changed. More...
void	foreignKeysChanged (const QVariantList &)
	Emitted when the foreign keys changed. More...

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 widget 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...
Q_DECL_DEPRECATED QVariant	foreignKey () const
	returns the related feature foreign key More...
QVariantList	foreignKeys () 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
	Returns the related feature (from the referenced layer) if no feature is related, it returns an invalid feature. More...
QgsRelation	relation () const
	Returns the current relation, which might be invalid. 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)
	Sets the fields for which filter comboboxes will be created. More...
Q_DECL_DEPRECATED void	setForeignKey (const QVariant &value)
	this sets the related feature using from the foreign key More...
void	setForeignKeys (const QVariantList &values)
	Sets the related feature using the foreign keys. More...
void	setFormFeature (const QgsFeature &formFeature)
	Set the current form feature (from the referencing layer) More...
void	setOpenFormButtonVisible (bool openFormButtonVisible)
void	setOrderByValue (bool orderByValue)
	Sets 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 57 of file qgsrelationreferencewidget.h.

Member Enumeration Documentation

CanvasExtent

enum QgsRelationReferenceWidget::CanvasExtent

Enumerator
Fixed
Pan
Scale

Definition at line 74 of file qgsrelationreferencewidget.h.

Constructor & Destructor Documentation

QgsRelationReferenceWidget()

QgsRelationReferenceWidget::QgsRelationReferenceWidget ( QWidget *  parent )

explicit

Definition at line 63 of file qgsrelationreferencewidget.cpp.

~QgsRelationReferenceWidget()

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )

override

Definition at line 169 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 758 of file qgsrelationreferencewidget.cpp.

allowMapIdentification()

bool QgsRelationReferenceWidget::allowMapIdentification ( )

inline

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

Definition at line 126 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 145 of file qgsrelationreferencewidget.h.

deleteForeignKeys

void QgsRelationReferenceWidget::deleteForeignKeys ( )

slot

unset the currently related feature

Definition at line 358 of file qgsrelationreferencewidget.cpp.

embedForm()

bool QgsRelationReferenceWidget::embedForm ( )

inline

determines if the form of the related feature will be shown

Definition at line 118 of file qgsrelationreferencewidget.h.

foreignKey()

QVariant QgsRelationReferenceWidget::foreignKey

(

)

const

returns the related feature foreign key

Deprecated:

since QGIS 3.10

Definition at line 430 of file qgsrelationreferencewidget.cpp.

foreignKeyChanged

Q_DECL_DEPRECATED void QgsRelationReferenceWidget::foreignKeyChanged ( const QVariant &  )

signal

Emitted when the foreign key changed.

Deprecated:

since QGIS 3.10

foreignKeys()

QVariantList QgsRelationReferenceWidget::foreignKeys

(

)

const

returns the related feature foreign key

Returns the related feature foreign keys

Since

QGIS 3.10

Definition at line 439 of file qgsrelationreferencewidget.cpp.

foreignKeysChanged

void QgsRelationReferenceWidget::foreignKeysChanged ( const QVariantList &  )

signal

Emitted when the foreign keys changed.

Since

QGIS 3.10

init()

void QgsRelationReferenceWidget::init ( )

protected

Definition at line 521 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 713 of file qgsrelationreferencewidget.cpp.

openForm

void QgsRelationReferenceWidget::openForm ( )

slot

open the form of the related feature in a new dialog

Definition at line 638 of file qgsrelationreferencewidget.cpp.

openFormButtonVisible()

bool QgsRelationReferenceWidget::openFormButtonVisible ( )

inline

determines the open form button is visible in the widget

Definition at line 137 of file qgsrelationreferencewidget.h.

orderByValue()

bool QgsRelationReferenceWidget::orderByValue ( )

inline

If the widget will order the combobox entries by value.

Definition at line 130 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 122 of file qgsrelationreferencewidget.h.

referencedFeature()

QgsFeature QgsRelationReferenceWidget::referencedFeature

(

)

const

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

Definition at line 397 of file qgsrelationreferencewidget.cpp.

relation()

QgsRelation QgsRelationReferenceWidget::relation

(

)

const

Returns the current relation, which might be invalid.

Since

QGIS 3.10

Definition at line 769 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 763 of file qgsrelationreferencewidget.cpp.

setAllowMapIdentification()

void QgsRelationReferenceWidget::setAllowMapIdentification

(

bool

allowMapIdentification

)

Definition at line 484 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 507 of file qgsrelationreferencewidget.cpp.

setEditorContext()

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

Definition at line 451 of file qgsrelationreferencewidget.cpp.

setEmbedForm()

void QgsRelationReferenceWidget::setEmbedForm

(

bool

display

)

Definition at line 464 of file qgsrelationreferencewidget.cpp.

setFilterFields()

void QgsRelationReferenceWidget::setFilterFields

(

const QStringList &

filterFields

)

Sets the fields for which filter comboboxes will be created.

Definition at line 496 of file qgsrelationreferencewidget.cpp.

setForeignKey()

void QgsRelationReferenceWidget::setForeignKey

(

const QVariant &

value

)

this sets the related feature using from the foreign key

Deprecated:

since QGIS 3.10 use setForeignKeys

Definition at line 269 of file qgsrelationreferencewidget.cpp.

setForeignKeys()

void QgsRelationReferenceWidget::setForeignKeys

(

const QVariantList &

values

)

Sets the related feature using the foreign keys.

Since

QGIS 3.10

Definition at line 274 of file qgsrelationreferencewidget.cpp.

setFormFeature()

void QgsRelationReferenceWidget::setFormFeature

(

const QgsFeature &

formFeature

)

Set the current form feature (from the referencing layer)

Since

QGIS 3.10

Definition at line 1089 of file qgsrelationreferencewidget.cpp.

setOpenFormButtonVisible()

void QgsRelationReferenceWidget::setOpenFormButtonVisible

(

bool

openFormButtonVisible

)

Definition at line 501 of file qgsrelationreferencewidget.cpp.

setOrderByValue()

void QgsRelationReferenceWidget::setOrderByValue

(

bool

orderByValue

)

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

Definition at line 491 of file qgsrelationreferencewidget.cpp.

setReadOnlySelector()

void QgsRelationReferenceWidget::setReadOnlySelector

(

bool

readOnly

)

Definition at line 476 of file qgsrelationreferencewidget.cpp.

setRelation()

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

Definition at line 207 of file qgsrelationreferencewidget.cpp.

setRelationEditable()

void QgsRelationReferenceWidget::setRelationEditable

(

bool

editable

)

Definition at line 254 of file qgsrelationreferencewidget.cpp.

showEvent()

void QgsRelationReferenceWidget::showEvent ( QShowEvent *  e )

overrideprotected

Definition at line 512 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 416 of file qgsrelationreferencewidget.cpp.

Friends And Related Function Documentation

TestQgsRelationReferenceWidget

friend class TestQgsRelationReferenceWidget

friend

Definition at line 304 of file qgsrelationreferencewidget.h.

Property Documentation

openFormButtonVisible

bool QgsRelationReferenceWidget::openFormButtonVisible

readwrite

Definition at line 70 of file qgsrelationreferencewidget.h.

---

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

• /build/qgis-3.10.0+15buster/src/gui/editorwidgets/qgsrelationreferencewidget.h
• /build/qgis-3.10.0+15buster/src/gui/editorwidgets/qgsrelationreferencewidget.cpp