QGIS API Documentation  2.7.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 }
 

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 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 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 setEditorContext (QgsAttributeEditorContext context, QgsMapCanvas *canvas, QgsMessageBar *messageBar)
 
void setEmbedForm (bool display)
 
void setForeignKey (const QVariant &value)
 this sets the related feature using from the foreign key More...
 
void setOpenFormButtonVisible (bool openFormButtonVisible)
 
void setReadOnlySelector (bool readOnly)
 
void setRelation (QgsRelation relation, bool allowNullValue)
 
void setRelationEditable (bool editable)
 

Protected Member Functions

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

Detailed Description

Definition at line 33 of file qgsrelationreferencewidget.h.

Member Enumeration Documentation

Enumerator
Fixed 
Pan 
Scale 

Definition at line 39 of file qgsrelationreferencewidget.h.

Constructor & Destructor Documentation

QgsRelationReferenceWidget::QgsRelationReferenceWidget ( QWidget *  parent)
explicit

Definition at line 37 of file qgsrelationreferencewidget.cpp.

QgsRelationReferenceWidget::~QgsRelationReferenceWidget ( )

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

void QgsRelationReferenceWidget::deleteForeignKey ( )
slot

unset the currently related feature

Definition at line 261 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::embedForm ( )
inline

determines if the form of the related feature will be shown

Definition at line 63 of file qgsrelationreferencewidget.h.

QVariant QgsRelationReferenceWidget::foreignKey ( )

returns the related feature foreign key

Definition at line 310 of file qgsrelationreferencewidget.cpp.

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

Definition at line 378 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::mapIdentification ( )
slot

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

Definition at line 517 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::openForm ( )
slot

open the form of the related feature in a new dialog

Definition at line 434 of file qgsrelationreferencewidget.cpp.

bool QgsRelationReferenceWidget::openFormButtonVisible ( )
inline

determines the open form button is visible in the widget

Definition at line 75 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 67 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 291 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setAllowMapIdentification ( bool  allowMapIdentification)

Definition at line 356 of file qgsrelationreferencewidget.cpp.

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

Definition at line 330 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setEmbedForm ( bool  display)

Definition at line 342 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setForeignKey ( const QVariant &  value)

this sets the related feature using from the foreign key

Definition at line 201 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setOpenFormButtonVisible ( bool  openFormButtonVisible)

Definition at line 363 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setReadOnlySelector ( bool  readOnly)

Definition at line 348 of file qgsrelationreferencewidget.cpp.

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

Definition at line 154 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::setRelationEditable ( bool  editable)

Definition at line 190 of file qgsrelationreferencewidget.cpp.

void QgsRelationReferenceWidget::showEvent ( QShowEvent *  e)
protectedvirtual

Definition at line 369 of file qgsrelationreferencewidget.cpp.


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