Public Member Functions
bool	operator== (const QgsVectorJoinInfo &other) const
void	setJoinFieldNamesSubset (QStringList *fieldNamesSubset)
	Set subset of fields to be used from joined layer.
QStringList *	joinFieldNamesSubset () const
	Get subset of fields to be used from joined layer.

Public Attributes
QString	targetFieldName
	Join field in the target layer.
QString	joinLayerId
	Source layer.
QString	joinFieldName
	Join field in the source layer.
bool	memoryCache
	True if the join is cached in virtual memory.
QHash< QString, QgsAttributes >	cachedAttributes
	Cache for joined attributes to provide fast lookup (size is 0 if no memory caching)
int	targetFieldIndex
	Join field index in the target layer.
int	joinFieldIndex
	Join field index in the source layer.

Protected Attributes
QSharedPointer< QStringList >	joinFieldsSubset
	Subset of fields to use from joined layer.

Member Function Documentation

QStringList* QgsVectorJoinInfo::joinFieldNamesSubset ( ) const

inline

Get subset of fields to be used from joined layer.

All fields will be used if null is returned.

bool QgsVectorJoinInfo::operator== ( const QgsVectorJoinInfo & other ) const

inline

void QgsVectorJoinInfo::setJoinFieldNamesSubset ( QStringList * fieldNamesSubset )

inline

Set subset of fields to be used from joined layer.

Takes ownership of the passed pointer. Null pointer tells to use all fields.

Member Data Documentation

QHash< QString, QgsAttributes> QgsVectorJoinInfo::cachedAttributes

Cache for joined attributes to provide fast lookup (size is 0 if no memory caching)

int QgsVectorJoinInfo::joinFieldIndex

Join field index in the source layer.

For backward compatibility with 1.x (x>=7)

QString QgsVectorJoinInfo::joinFieldName

Join field in the source layer.

QSharedPointer<QStringList> QgsVectorJoinInfo::joinFieldsSubset

protected

Subset of fields to use from joined layer.

null = use all fields

QString QgsVectorJoinInfo::joinLayerId

Source layer.

bool QgsVectorJoinInfo::memoryCache

True if the join is cached in virtual memory.

int QgsVectorJoinInfo::targetFieldIndex

Join field index in the target layer.

For backward compatibility with 1.x (x>=7)

QString QgsVectorJoinInfo::targetFieldName

Join field in the target layer.

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