QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | Friends | List of all members
QgsRelationReferenceWidget Class Reference
gui library

#include <qgsrelationreferencewidget.h>

Inheritance diagram for QgsRelationReferenceWidget:
Inheritance graph
[legend]

Public Types

enum  CanvasExtent { Fixed , Pan , Scale }
 

Public Slots

void deleteForeignKeys ()
 unset the currently related feature
 
void mapIdentification ()
 activate the map tool to select a new related feature on the map
 
void openForm ()
 open the form of the related feature in a new dialog
 

Signals

Q_DECL_DEPRECATED void foreignKeyChanged (const QVariant &)
 Emitted when the foreign key changed.
 
void foreignKeysChanged (const QVariantList &)
 Emitted when the foreign keys changed.
 

Public Member Functions

 QgsRelationReferenceWidget (QWidget *parent)
 
 ~QgsRelationReferenceWidget () override
 
bool allowAddFeatures () const
 Determines if a button for adding new features should be shown.
 
bool allowMapIdentification ()
 determines if the widget offers the possibility to select the related feature on the map (using a dedicated map tool)
 
bool chainFilters () const
 Determines if the filters are chained.
 
bool embedForm ()
 determines if the form of the related feature will be shown
 
int fetchLimit () const
 Returns the limit of fetched features (0 means all features)
 
QString filterExpression () const
 Returns the currently set filter expression.
 
Q_DECL_DEPRECATED QVariant foreignKey () const
 returns the related feature foreign key
 
QVariantList foreignKeys () const
 returns the related feature foreign key
 
bool openFormButtonVisible ()
 determines the open form button is visible in the widget
 
bool readOnlySelector ()
 determines if the drop-down is enabled
 
QgsFeature referencedFeature () const
 Returns the related feature (from the referenced layer) if no feature is related, it returns an invalid feature.
 
QString referencedLayerDataSource () const
 Returns the public data source of the referenced layer.
 
QString referencedLayerId () const
 Returns the id of the referenced layer.
 
QString referencedLayerName () const
 Returns the name of the referenced layer.
 
QString referencedLayerProviderKey () const
 Returns the data provider key of the referenced layer.
 
QgsRelation relation () const
 Returns the current relation, which might be invalid.
 
void setAllowAddFeatures (bool allowAddFeatures)
 Determines if a button for adding new features should be shown.
 
void setAllowMapIdentification (bool allowMapIdentification)
 
void setChainFilters (bool chainFilters)
 Set if filters are chained.
 
void setEditorContext (const QgsAttributeEditorContext &context, QgsMapCanvas *canvas, QgsMessageBar *messageBar)
 Sets the editor context.
 
void setEmbedForm (bool display)
 
void setFetchLimit (int fetchLimit)
 Set the limit of fetched features (0 means all features)
 
void setFilterExpression (const QString &filterExpression)
 If not empty, will be used as filter expression.
 
void setFilterFields (const QStringList &filterFields)
 Sets the fields for which filter comboboxes will be created.
 
Q_DECL_DEPRECATED void setForeignKey (const QVariant &value)
 this sets the related feature using from the foreign key
 
void setForeignKeys (const QVariantList &values)
 Sets the related feature using the foreign keys.
 
void setFormFeature (const QgsFeature &formFeature)
 Set the current form feature (from the referencing layer)
 
void setOpenFormButtonVisible (bool openFormButtonVisible)
 
void setReadOnlySelector (bool readOnly)
 
void setReferencedLayerDataSource (const QString &referencedLayerDataSource)
 Set the public data source of the referenced layer to referencedLayerDataSource.
 
void setReferencedLayerId (const QString &referencedLayerId)
 Set the id of the referenced layer to referencedLayerId.
 
void setReferencedLayerName (const QString &referencedLayerName)
 Set the name of the referenced layer to referencedLayerName.
 
void setReferencedLayerProviderKey (const QString &referencedLayerProviderKey)
 Set the data provider key of the referenced layer to referencedLayerProviderKey.
 
void setRelation (const QgsRelation &relation, bool allowNullValue)
 
void setRelationEditable (bool editable)
 
void showIndeterminateState ()
 Sets the widget to display in an indeterminate "mixed value" state.
 

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 56 of file qgsrelationreferencewidget.cpp.

◆ ~QgsRelationReferenceWidget()

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )
override

Definition at line 156 of file qgsrelationreferencewidget.cpp.

Member Function Documentation

◆ allowAddFeatures()

bool QgsRelationReferenceWidget::allowAddFeatures ( ) const

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

Definition at line 639 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 131 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 146 of file qgsrelationreferencewidget.h.

◆ deleteForeignKeys

void QgsRelationReferenceWidget::deleteForeignKeys ( )
slot

unset the currently related feature

Definition at line 278 of file qgsrelationreferencewidget.cpp.

◆ embedForm()

bool QgsRelationReferenceWidget::embedForm ( )
inline

determines if the form of the related feature will be shown

Definition at line 123 of file qgsrelationreferencewidget.h.

◆ fetchLimit()

int QgsRelationReferenceWidget::fetchLimit ( ) const
inline

Returns the limit of fetched features (0 means all features)

Since
QGIS 3.32

Definition at line 255 of file qgsrelationreferencewidget.h.

◆ filterExpression()

QString QgsRelationReferenceWidget::filterExpression ( ) const
inline

Returns the currently set filter expression.

Definition at line 159 of file qgsrelationreferencewidget.h.

◆ foreignKey()

QVariant QgsRelationReferenceWidget::foreignKey ( ) const

returns the related feature foreign key

Deprecated:
since QGIS 3.10

Definition at line 312 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 321 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 399 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 595 of file qgsrelationreferencewidget.cpp.

◆ openForm

void QgsRelationReferenceWidget::openForm ( )
slot

open the form of the related feature in a new dialog

Definition at line 520 of file qgsrelationreferencewidget.cpp.

◆ openFormButtonVisible()

bool QgsRelationReferenceWidget::openFormButtonVisible ( )
inline

determines the open form button is visible in the widget

Definition at line 138 of file qgsrelationreferencewidget.h.

◆ readOnlySelector()

bool QgsRelationReferenceWidget::readOnlySelector ( )
inline

determines if the drop-down is enabled

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

◆ referencedLayerDataSource()

QString QgsRelationReferenceWidget::referencedLayerDataSource ( ) const

Returns the public data source of the referenced layer.

Since
QGIS 3.12

Definition at line 988 of file qgsrelationreferencewidget.cpp.

◆ referencedLayerId()

QString QgsRelationReferenceWidget::referencedLayerId ( ) const

Returns the id of the referenced layer.

Since
QGIS 3.12

Definition at line 968 of file qgsrelationreferencewidget.cpp.

◆ referencedLayerName()

QString QgsRelationReferenceWidget::referencedLayerName ( ) const

Returns the name of the referenced layer.

Since
QGIS 3.12

Definition at line 958 of file qgsrelationreferencewidget.cpp.

◆ referencedLayerProviderKey()

QString QgsRelationReferenceWidget::referencedLayerProviderKey ( ) const

Returns the data provider key of the referenced layer.

Since
QGIS 3.12

Definition at line 978 of file qgsrelationreferencewidget.cpp.

◆ relation()

QgsRelation QgsRelationReferenceWidget::relation ( ) const

Returns the current relation, which might be invalid.

Since
QGIS 3.10

Definition at line 650 of file qgsrelationreferencewidget.cpp.

◆ setAllowAddFeatures()

void QgsRelationReferenceWidget::setAllowAddFeatures ( bool  allowAddFeatures)

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

Definition at line 644 of file qgsrelationreferencewidget.cpp.

◆ setAllowMapIdentification()

void QgsRelationReferenceWidget::setAllowMapIdentification ( bool  allowMapIdentification)

Definition at line 362 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
chainFiltersIf chaining should be enabled

Definition at line 380 of file qgsrelationreferencewidget.cpp.

◆ setEditorContext()

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

Sets the editor context.

Note
if context cadDockWidget is null, it won't be possible to digitize the geometry of a referenced feature from this widget

Definition at line 326 of file qgsrelationreferencewidget.cpp.

◆ setEmbedForm()

void QgsRelationReferenceWidget::setEmbedForm ( bool  display)

Definition at line 343 of file qgsrelationreferencewidget.cpp.

◆ setFetchLimit()

void QgsRelationReferenceWidget::setFetchLimit ( int  fetchLimit)
inline

Set the limit of fetched features (0 means all features)

Since
QGIS 3.32

Definition at line 261 of file qgsrelationreferencewidget.h.

◆ setFilterExpression()

void QgsRelationReferenceWidget::setFilterExpression ( const QString &  filterExpression)

If not empty, will be used as filter expression.

Only if this evaluates to true, the value will be shown.

Definition at line 385 of file qgsrelationreferencewidget.cpp.

◆ setFilterFields()

void QgsRelationReferenceWidget::setFilterFields ( const QStringList &  filterFields)

Sets the fields for which filter comboboxes will be created.

Definition at line 369 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 232 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 237 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 999 of file qgsrelationreferencewidget.cpp.

◆ setOpenFormButtonVisible()

void QgsRelationReferenceWidget::setOpenFormButtonVisible ( bool  openFormButtonVisible)

Definition at line 374 of file qgsrelationreferencewidget.cpp.

◆ setReadOnlySelector()

void QgsRelationReferenceWidget::setReadOnlySelector ( bool  readOnly)

Definition at line 355 of file qgsrelationreferencewidget.cpp.

◆ setReferencedLayerDataSource()

void QgsRelationReferenceWidget::setReferencedLayerDataSource ( const QString &  referencedLayerDataSource)

Set the public data source of the referenced layer to referencedLayerDataSource.

Since
QGIS 3.12

Definition at line 993 of file qgsrelationreferencewidget.cpp.

◆ setReferencedLayerId()

void QgsRelationReferenceWidget::setReferencedLayerId ( const QString &  referencedLayerId)

Set the id of the referenced layer to referencedLayerId.

Since
QGIS 3.12

Definition at line 973 of file qgsrelationreferencewidget.cpp.

◆ setReferencedLayerName()

void QgsRelationReferenceWidget::setReferencedLayerName ( const QString &  referencedLayerName)

Set the name of the referenced layer to referencedLayerName.

Since
QGIS 3.12

Definition at line 963 of file qgsrelationreferencewidget.cpp.

◆ setReferencedLayerProviderKey()

void QgsRelationReferenceWidget::setReferencedLayerProviderKey ( const QString &  referencedLayerProviderKey)

Set the data provider key of the referenced layer to referencedLayerProviderKey.

Since
QGIS 3.12

Definition at line 983 of file qgsrelationreferencewidget.cpp.

◆ setRelation()

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

Definition at line 162 of file qgsrelationreferencewidget.cpp.

◆ setRelationEditable()

void QgsRelationReferenceWidget::setRelationEditable ( bool  editable)

Definition at line 217 of file qgsrelationreferencewidget.cpp.

◆ showEvent()

void QgsRelationReferenceWidget::showEvent ( QShowEvent *  e)
overrideprotected

Definition at line 390 of file qgsrelationreferencewidget.cpp.

◆ showIndeterminateState()

void QgsRelationReferenceWidget::showIndeterminateState ( )

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

Definition at line 305 of file qgsrelationreferencewidget.cpp.

Friends And Related Symbol Documentation

◆ TestQgsRelationReferenceWidget

friend class TestQgsRelationReferenceWidget
friend

Definition at line 372 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:
Generated on Mon Feb 26 2024 10:02:44 for QGIS API Documentation by doxygen 1.9.8