QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
QgsVectorJoinInfo Struct Reference

#include <qgsvectorlayer.h>

Public Member Functions

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

Public Attributes

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

Protected Attributes

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

Detailed Description

Definition at line 165 of file qgsvectorlayer.h.

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.

Note
added in 2.6

Definition at line 199 of file qgsvectorlayer.h.

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

Definition at line 185 of file qgsvectorlayer.h.

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.

Note
added in 2.6

Definition at line 196 of file qgsvectorlayer.h.

Member Data Documentation

QHash< QString, QgsAttributes> QgsVectorJoinInfo::cachedAttributes

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

Note
not available in python bindings

Definition at line 178 of file qgsvectorlayer.h.

int QgsVectorJoinInfo::joinFieldIndex

Join field index in the source layer.

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

Definition at line 183 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::joinFieldName

Join field in the source layer.

Definition at line 172 of file qgsvectorlayer.h.

QSharedPointer<QStringList> QgsVectorJoinInfo::joinFieldsSubset
protected

Subset of fields to use from joined layer.

null = use all fields

Definition at line 203 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::joinLayerId

Source layer.

Definition at line 170 of file qgsvectorlayer.h.

bool QgsVectorJoinInfo::memoryCache

True if the join is cached in virtual memory.

Definition at line 174 of file qgsvectorlayer.h.

int QgsVectorJoinInfo::targetFieldIndex

Join field index in the target layer.

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

Definition at line 181 of file qgsvectorlayer.h.

QString QgsVectorJoinInfo::targetFieldName

Join field in the target layer.

Definition at line 168 of file qgsvectorlayer.h.


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