QGIS API Documentation  2.9.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsRelationReferenceWidget Class Reference

#include <qgsrelationreferencewidget.h>

Inheritance diagram for QgsRelationReferenceWidget:
Inheritance graph
[legend]

Public Types

enum  CanvasExtent { Fixed, Pan, Scale }
 
typedef QVector
< ValueRelationItem
ValueRelationCache
 
typedef QPair< QVariant,
QgsFeatureId
ValueRelationItem
 

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 (QVariant)
 

Public Member Functions

 QgsRelationReferenceWidget (QWidget *parent)
 
 ~QgsRelationReferenceWidget ()
 
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 ()
 Determines if the filters are chained. More...
 
bool embedForm ()
 determines if the form of the related feature will be shown More...
 
QVariant foreignKey ()
 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 ()
 return the related feature (from the referenced layer) if no feature is related, it returns an invalid feature 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 (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 (QgsRelation relation, bool allowNullValue)
 
void setRelationEditable (bool editable)
 

Protected Member Functions

void init ()
 
virtual void showEvent (QShowEvent *e) override
 

Detailed Description

Definition at line 37 of file qgsrelationreferencewidget.h.

Member Typedef Documentation

Definition at line 44 of file qgsrelationreferencewidget.h.

Definition at line 43 of file qgsrelationreferencewidget.h.

Member Enumeration Documentation

Enumerator
Fixed 
Pan 
Scale 

Definition at line 46 of file qgsrelationreferencewidget.h.

Constructor & Destructor Documentation

QgsRelationReferenceWidget::QgsRelationReferenceWidget ( QWidget *  parent)
explicit

Definition at line 56 of file qgsrelationreferencewidget.cpp.

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )

Definition at line 180 of file qgsrelationreferencewidget.cpp.

Member Function Documentation

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

bool QgsRelationReferenceWidget::chainFilters ( )
inline

Determines if the filters are chained.

Returns
True if filters are chained

Definition at line 97 of file qgsrelationreferencewidget.h.

void QgsRelationReferenceWidget::deleteForeignKey ( )
slot

unset the currently related feature

Definition at line 303 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::embedForm ( )
inline

determines if the form of the related feature will be shown

Definition at line 70 of file qgsrelationreferencewidget.h.

QVariant QgsRelationReferenceWidget::foreignKey ( )

returns the related feature foreign key

Definition at line 352 of file qgsrelationreferencewidget.cpp.

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

Definition at line 435 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::mapIdentification ( )
slot

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

Definition at line 644 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::openForm ( )
slot

open the form of the related feature in a new dialog

Definition at line 559 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::openFormButtonVisible ( )
inline

determines the open form button is visible in the widget

Definition at line 89 of file qgsrelationreferencewidget.h.

bool QgsRelationReferenceWidget::orderByValue ( )
inline

If the widget will order the combobox entries by value.

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

QgsFeature QgsRelationReferenceWidget::referencedFeature ( )

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

Definition at line 333 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setAllowMapIdentification ( bool  allowMapIdentification)

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

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

Definition at line 372 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setEmbedForm ( bool  display)

Definition at line 384 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setFilterFields ( QStringList  filterFields)

Set the fields for which filter comboboxes will be created.

Definition at line 410 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setForeignKey ( const QVariant &  value)

this sets the related feature using from the foreign key

Definition at line 236 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setOpenFormButtonVisible ( bool  openFormButtonVisible)

Definition at line 415 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setOrderByValue ( bool  orderByValue)

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

Definition at line 405 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setReadOnlySelector ( bool  readOnly)

Definition at line 390 of file qgsrelationreferencewidget.cpp.

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

Definition at line 188 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setRelationEditable ( bool  editable)

Definition at line 224 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::showEvent ( QShowEvent *  e)
overrideprotectedvirtual

Definition at line 426 of file qgsrelationreferencewidget.cpp.


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