QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | Friends | List of all members
QgsRelationReferenceWidget Class Reference

#include <qgsrelationreferencewidget.h>

Inheritance diagram for QgsRelationReferenceWidget:
Inheritance graph
[legend]

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 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...
 
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
 Returns 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)
 Sets 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)
 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 54 of file qgsrelationreferencewidget.h.

Member Enumeration Documentation

Enumerator
Fixed 
Pan 
Scale 

Definition at line 71 of file qgsrelationreferencewidget.h.

Constructor & Destructor Documentation

QgsRelationReferenceWidget::QgsRelationReferenceWidget ( QWidget *  parent)
explicit

Definition at line 45 of file qgsrelationreferencewidget.cpp.

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )
override

Definition at line 151 of file qgsrelationreferencewidget.cpp.

Member Function Documentation

bool QgsRelationReferenceWidget::allowAddFeatures ( ) const

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

Since
QGIS 2.16

Definition at line 717 of file qgsrelationreferencewidget.cpp.

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 103 of file qgsrelationreferencewidget.h.

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.

void QgsRelationReferenceWidget::deleteForeignKey ( )
slot

unset the currently related feature

Definition at line 319 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::embedForm ( )
inline

determines if the form of the related feature will be shown

Definition at line 95 of file qgsrelationreferencewidget.h.

QVariant QgsRelationReferenceWidget::foreignKey ( ) const

returns the related feature foreign key

Definition at line 384 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::foreignKeyChanged ( const QVariant &  )
signal
void QgsRelationReferenceWidget::init ( )
protected

Definition at line 464 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::mapIdentification ( )
slot

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

Definition at line 665 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::openForm ( )
slot

open the form of the related feature in a new dialog

Definition at line 580 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::openFormButtonVisible ( )
inline

determines the open form button is visible in the widget

Definition at line 114 of file qgsrelationreferencewidget.h.

bool QgsRelationReferenceWidget::orderByValue ( )
inline

If the widget will order the combobox entries by value.

Definition at line 107 of file qgsrelationreferencewidget.h.

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.

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

void QgsRelationReferenceWidget::setAllowAddFeatures ( bool  allowAddFeatures)

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

Since
QGIS 2.16

Definition at line 722 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setAllowMapIdentification ( bool  allowMapIdentification)

Definition at line 427 of file qgsrelationreferencewidget.cpp.

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

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

Definition at line 396 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setEmbedForm ( bool  display)

Definition at line 407 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setFilterFields ( const QStringList &  filterFields)

Sets the fields for which filter comboboxes will be created.

Definition at line 439 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setForeignKey ( const QVariant &  value)

this sets the related feature using from the foreign key

Definition at line 247 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setOpenFormButtonVisible ( bool  openFormButtonVisible)

Definition at line 444 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setOrderByValue ( bool  orderByValue)

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

Definition at line 434 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setReadOnlySelector ( bool  readOnly)

Definition at line 419 of file qgsrelationreferencewidget.cpp.

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

Definition at line 190 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setRelationEditable ( bool  editable)

Definition at line 234 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::showEvent ( QShowEvent *  e)
overrideprotected

Definition at line 455 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::showIndeterminateState ( )

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

Since
QGIS 2.16

Definition at line 370 of file qgsrelationreferencewidget.cpp.

Friends And Related Function Documentation

friend class TestQgsRelationReferenceWidget
friend

Definition at line 253 of file qgsrelationreferencewidget.h.

Property Documentation

bool QgsRelationReferenceWidget::openFormButtonVisible
readwrite

Definition at line 67 of file qgsrelationreferencewidget.h.


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