QGIS API Documentation  2.5.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  RelationMode { Undefined, Multiple, Single }
 Determines in which direction a relation was resolved. More...
 
enum  FormMode { Embed, StandaloneDialog, Popup }
 

Public Member Functions

 QgsAttributeEditorContext ()
 
 QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, FormMode formMode)
 
 QgsAttributeEditorContext (const QgsAttributeEditorContext &parentContext, const QgsRelation &relation, RelationMode relationMode, FormMode widgetMode)
 
void setDistanceArea (const QgsDistanceArea &distanceArea)
 
const QgsDistanceAreadistanceArea () const
 
void setVectorLayerTools (QgsVectorLayerTools *vlTools)
 
const QgsVectorLayerToolsvectorLayerTools () const
 
void setRelation (const QgsRelation &relation, RelationMode mode)
 
const QgsRelationrelation () const
 
RelationMode relationMode () const
 
FormMode formMode () const
 
const QgsAttributeEditorContextparentContext () 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)

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)

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)

Constructor & Destructor Documentation

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

Member Function Documentation

const QgsDistanceArea& QgsAttributeEditorContext::distanceArea ( ) const
inline
FormMode QgsAttributeEditorContext::formMode ( ) const
inline
const QgsAttributeEditorContext* QgsAttributeEditorContext::parentContext ( ) const
inline
const QgsRelation& QgsAttributeEditorContext::relation ( ) const
inline
RelationMode QgsAttributeEditorContext::relationMode ( ) const
inline
void QgsAttributeEditorContext::setDistanceArea ( const QgsDistanceArea distanceArea)
inline
void QgsAttributeEditorContext::setRelation ( const QgsRelation relation,
RelationMode  mode 
)
inline
void QgsAttributeEditorContext::setVectorLayerTools ( QgsVectorLayerTools vlTools)
inline
const QgsVectorLayerTools* QgsAttributeEditorContext::vectorLayerTools ( ) const
inline

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