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

This class contains context information for attribute editor widgets. More...

#include <qgsattributeeditorcontext.h>

Public Types

enum  FormMode { Embed, StandaloneDialog, Popup }
 
enum  RelationMode { Undefined, Multiple, Single }
 Determines in which direction a relation was resolved. More...
 

Public Member Functions

 QgsAttributeEditorContext ()
 
 QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, FormMode formMode)
 
 QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode)
 
const QgsDistanceAreadistanceArea () const
 
FormMode formMode () const
 
const QgsAttributeEditorContextparentContext () const
 
const QgsRelationrelation () const
 
RelationMode relationMode () const
 
void setDistanceArea (const QgsDistanceArea &distanceArea)
 
void setRelation (const QgsRelation &relation, RelationMode mode)
 
void setVectorLayerTools (QgsVectorLayerTools *vlTools)
 
const QgsVectorLayerToolsvectorLayerTools () const
 

Detailed Description

This class contains context information for attribute editor widgets.

It will be passed to embedded widgets whenever this occurs (e.g. when showing an embedded form due to relations)

Definition at line 33 of file qgsattributeeditorcontext.h.

Member Enumeration Documentation

Enumerator
Embed 

A form was embedded as a widget on another form.

StandaloneDialog 

A form was opened as a new dialog.

Popup 

A widget was opened as a popup (e.g. attribute table editor widget)

Definition at line 46 of file qgsattributeeditorcontext.h.

Determines in which direction a relation was resolved.

Enumerator
Undefined 

This context is not defined by a relation.

Multiple 

When showing a list of features (e.g. houses as an embedded form in a district form)

Single 

When showing a single feature (e.g. district information when looking at the form of a house)

Definition at line 39 of file qgsattributeeditorcontext.h.

Constructor & Destructor Documentation

QgsAttributeEditorContext::QgsAttributeEditorContext ( )
inline

Definition at line 53 of file qgsattributeeditorcontext.h.

QgsAttributeEditorContext::QgsAttributeEditorContext ( const QgsAttributeEditorContext parentContext,
FormMode  formMode 
)
inline

Definition at line 60 of file qgsattributeeditorcontext.h.

QgsAttributeEditorContext::QgsAttributeEditorContext ( const QgsAttributeEditorContext parentContext,
const QgsRelation relation,
RelationMode  relationMode,
FormMode  widgetMode 
)
inline

Definition at line 71 of file qgsattributeeditorcontext.h.

Member Function Documentation

const QgsDistanceArea& QgsAttributeEditorContext::distanceArea ( ) const
inline

Definition at line 92 of file qgsattributeeditorcontext.h.

FormMode QgsAttributeEditorContext::formMode ( ) const
inline

Definition at line 101 of file qgsattributeeditorcontext.h.

const QgsAttributeEditorContext* QgsAttributeEditorContext::parentContext ( ) const
inline

Definition at line 103 of file qgsattributeeditorcontext.h.

const QgsRelation& QgsAttributeEditorContext::relation ( ) const
inline

Definition at line 98 of file qgsattributeeditorcontext.h.

RelationMode QgsAttributeEditorContext::relationMode ( ) const
inline

Definition at line 99 of file qgsattributeeditorcontext.h.

void QgsAttributeEditorContext::setDistanceArea ( const QgsDistanceArea distanceArea)
inline

Definition at line 83 of file qgsattributeeditorcontext.h.

void QgsAttributeEditorContext::setRelation ( const QgsRelation relation,
RelationMode  mode 
)
inline

Definition at line 97 of file qgsattributeeditorcontext.h.

void QgsAttributeEditorContext::setVectorLayerTools ( QgsVectorLayerTools vlTools)
inline

Definition at line 94 of file qgsattributeeditorcontext.h.

const QgsVectorLayerTools* QgsAttributeEditorContext::vectorLayerTools ( ) const
inline

Definition at line 95 of file qgsattributeeditorcontext.h.


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