QGIS API Documentation
Classes | Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Friends | List of all members
QgsVectorLayer Class Reference

Represents a vector layer which manages a vector based data sets. More...

#include <qgsvectorlayer.h>

Inheritance diagram for QgsVectorLayer:
Inheritance graph
[legend]

Classes

struct  RangeData
 
struct  ValueRelationData
 

Public Types

enum  EditorLayout { GeneratedLayout = 0, TabLayout = 1, UiFileLayout = 2 }
 
enum  EditResult {
  Success = 0, EmptyGeometry = 1, EditFailed = 2, FetchFeatureFailed = 3,
  InvalidLayer = 4
}
 Result of an edit operation. More...
 
enum  EditType {
  LineEdit, UniqueValues, UniqueValuesEditable, ValueMap,
  Classification, EditRange, SliderRange, CheckBox,
  FileName, Enumeration, Immutable, Hidden,
  TextEdit, Calendar, DialRange, ValueRelation,
  UuidGenerator, Photo, WebView, Color,
  EditorWidgetV2
}
 
enum  FeatureFormSuppress { SuppressDefault = 0, SuppressOn = 1, SuppressOff = 2 }
 Types of feature form suppression after feature creation. More...
 
typedef QgsEditFormConfig::GroupData GroupData
 
typedef QgsEditFormConfig::TabData TabData
 
enum  VertexMarkerType { SemiTransparentCircle, Cross, NoMarker }
 Editing vertex markers. More...
 
- Public Types inherited from QgsMapLayer
enum  LayerType { VectorLayer, RasterLayer, PluginLayer }
 Layers enum defining the types of layers that can be added to a map. More...
 

Public Slots

void checkJoinLayerRemove (const QString &theLayerId)
 Check if there is a join with a layer that will be removed. More...
 
void deselect (const QgsFeatureId featureId)
 Deselect feature by its ID. More...
 
void deselect (const QgsFeatureIds &featureIds)
 Deselect features by their ID. More...
 
void removeSelection ()
 Clear selection. More...
 
void select (QgsFeatureId featureId)
 Select feature by its ID. More...
 
void select (const QgsFeatureIds &featureIds)
 Select features by their ID. More...
 
bool startEditing ()
 Make layer editable. More...
 
virtual void updateExtents ()
 Update the extents for the layer. More...
 
- Public Slots inherited from QgsMapLayer
Q_DECL_DEPRECATED void clearCacheImage ()
 Clear cached image. More...
 
virtual void invalidTransformInput ()
 Event handler for when a coordinate transform fails due to bad vertex error. More...
 
void setMaximumScale (double theMaxScale)
 Sets the maximum scale denominator at which the layer will be visible. More...
 
void setMinimumScale (double theMinScale)
 Sets the minimum scale denominator at which the layer will be visible. More...
 
void setScaleBasedVisibility (const bool enabled)
 Sets whether scale based visibility is enabled for the layer. More...
 
virtual QDateTime timestamp () const
 Time stamp of data source in the moment when data/metadata were loaded by provider. More...
 
Q_DECL_DEPRECATED void toggleScaleBasedVisibility (bool theVisibilityFlag)
 Accessor for the scale based visilibility flag. More...
 
void triggerRepaint ()
 Will advice the map canvas (and any other interested party) that this layer requires to be repainted. More...
 

Signals

void attributeAdded (int idx)
 Will be emitted, when a new attribute has been added to this vector layer. More...
 
void attributeDeleted (int idx)
 Will be emitted, when an attribute has been deleted from this vector layer. More...
 
void attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &)
 
void beforeAddingExpressionField (const QString &fieldName)
 Will be emitted, when an expression field is going to be added to this vector layer. More...
 
void beforeCommitChanges ()
 Is emitted, before changes are commited to the data provider. More...
 
void beforeEditingStarted ()
 Is emitted, before editing on this layer is started. More...
 
void beforeModifiedCheck () const
 Is emitted, when layer is checked for modifications. More...
 
void beforeRemovingExpressionField (int idx)
 Will be emitted, when an expression field is going to be deleted from this vector layer. More...
 
void beforeRollBack ()
 Is emitted, before changes are rolled back. More...
 
void committedAttributesAdded (const QString &layerId, const QList< QgsField > &addedAttributes)
 
void committedAttributesDeleted (const QString &layerId, const QgsAttributeList &deletedAttributes)
 Signals emitted after committing changes. More...
 
void committedAttributeValuesChanges (const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
 
void committedFeaturesAdded (const QString &layerId, const QgsFeatureList &addedFeatures)
 
void committedFeaturesRemoved (const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
 
void committedGeometriesChanges (const QString &layerId, const QgsGeometryMap &changedGeometries)
 
void editCommandDestroyed ()
 Signal emitted, whan an edit command is destroyed. More...
 
void editCommandEnded ()
 Signal emitted, when an edit command successfully ended. More...
 
void editCommandStarted (const QString &text)
 Signal emitted when a new edit command has been started. More...
 
void editingStarted ()
 Is emitted, when editing on this layer has started. More...
 
void editingStopped ()
 Is emitted, when edited changes successfully have been written to the data provider. More...
 
void featureAdded (QgsFeatureId fid)
 Emitted when a new feature has been added to the layer. More...
 
void featureBlendModeChanged (QPainter::CompositionMode blendMode)
 Signal emitted when setFeatureBlendMode() is called. More...
 
void featureDeleted (QgsFeatureId fid)
 Emitted when a feature has been deleted. More...
 
void featuresDeleted (const QgsFeatureIds &fids)
 Emitted when features have been deleted. More...
 
void geometryChanged (QgsFeatureId fid, QgsGeometry &geom)
 
void labelingFontNotFound (QgsVectorLayer *layer, const QString &fontfamily)
 Emitted when the font family defined for labeling layer is not found on system. More...
 
void layerDeleted ()
 TODO QGIS3: remove in favor of QObject::destroyed. More...
 
void layerModified ()
 This signal is emitted when modifications has been done on layer. More...
 
void layerTransparencyChanged (int layerTransparency)
 Signal emitted when setLayerTransparency() is called. More...
 
void raiseError (const QString &msg)
 Signals an error related to this vector layer. More...
 
void readCustomSymbology (const QDomElement &element, QString &errorMessage)
 Signal emitted whenever the symbology (QML-file) for this layer is being read. More...
 
void saveLayerToProject ()
 
void selectionChanged (const QgsFeatureIds &selected, const QgsFeatureIds &deselected, const bool clearAndSelect)
 This signal is emitted when selection was changed. More...
 
void selectionChanged ()
 This signal is emitted when selection was changed. More...
 
void updatedFields ()
 Is emitted, whenever the fields available from this layer have been changed. More...
 
void writeCustomSymbology (QDomElement &element, QDomDocument &doc, QString &errorMessage) const
 Signal emitted whenever the symbology (QML-file) for this layer is being written. More...
 
- Signals inherited from QgsMapLayer
void blendModeChanged (QPainter::CompositionMode blendMode)
 Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() More...
 
void dataChanged ()
 Data of layer changed. More...
 
Q_DECL_DEPRECATED void drawingProgress (int theProgress, int theTotalSteps)
 
void layerCrsChanged ()
 Emit a signal that layer's CRS has been reset. More...
 
void layerNameChanged ()
 Emit a signal that the layer name has been changed. More...
 
void legendChanged ()
 Signal emitted when legend of the layer has changed. More...
 
void recalculateExtents ()
 This is used to send a request that any mapcanvas using this layer update its extents. More...
 
void rendererChanged ()
 Signal emitted when renderer is changed. More...
 
void repaintRequested ()
 By emitting this signal the layer tells that either appearance or content have been changed and any view showing the rendered layer should refresh itself. More...
 
void screenUpdateRequested ()
 
void statusChanged (const QString &theStatus)
 Emit a signal with status (e.g. More...
 

Public Member Functions

 QgsVectorLayer (const QString &path=QString::null, const QString &baseName=QString::null, const QString &providerLib=QString::null, bool loadDefaultStyleFlag=true)
 Constructor - creates a vector layer. More...
 
virtual ~QgsVectorLayer ()
 Destructor. More...
 
QgsActionManageractions ()
 Get all layer actions defined on this layer. More...
 
bool addAttribute (const QgsField &field)
 Add an attribute field (but does not commit it) returns true if the field was added. More...
 
void addAttributeAlias (int attIndex, const QString &aliasString)
 Sets an alias (a display name) for attributes to display in dialogs. More...
 
Q_DECL_DEPRECATED void addAttributeEditorWidget (QgsAttributeEditorElement *data)
 Adds a tab (for the attribute editor form) holding groups and fields. More...
 
int addExpressionField (const QString &exp, const QgsField &fld)
 Add a new field which is calculated by the expression specified. More...
 
bool addFeature (QgsFeature &f, bool alsoUpdateExtent=true)
 Adds a feature. More...
 
bool addFeatures (QgsFeatureList features, bool makeSelected=true)
 Insert a copy of the given features into the layer (but does not commit it) More...
 
bool addJoin (const QgsVectorJoinInfo &joinInfo)
 Joins another vector layer to this layer. More...
 
int addPart (const QList< QgsPoint > &ring)
 Adds a new part polygon to a multipart feature. More...
 
int addPart (const QgsPointSequenceV2 &ring)
 Adds a new part polygon to a multipart feature. More...
 
int addPart (QgsCurveV2 *ring)
 
int addRing (const QList< QgsPoint > &ring, QgsFeatureId *featureId=nullptr)
 Adds a ring to polygon/multipolygon features. More...
 
int addRing (QgsCurveV2 *ring, QgsFeatureId *featureId=nullptr)
 Adds a ring to polygon/multipolygon features (takes ownership) More...
 
int addTopologicalPoints (const QgsGeometry *geom)
 Adds topological points for every vertex of the geometry. More...
 
int addTopologicalPoints (const QgsPoint &p)
 Adds a vertex to segments which intersect point p but don't already have a vertex there. More...
 
QgsFeatureIds allFeatureIds ()
 Get all feature Ids. More...
 
QString annotationForm () const
 Get annotation form. More...
 
virtual Q_DECL_DEPRECATED bool applyNamedStyle (const QString &namedStyle, QString &errorMsg)
 Will load a named style from a provided QML string. More...
 
QString attributeAlias (int attributeIndex) const
 Returns the alias of an attribute name or a null string if there is no alias. More...
 
const QMap< QString, QString > & attributeAliases () const
 
QString attributeDisplayName (int attributeIndex) const
 Convenience function that returns the attribute alias if defined or the field name else. More...
 
QgsAttributeEditorElementattributeEditorElementFromDomElement (QDomElement &elem, QObject *parent)
 Convert a saved attribute editor element into a AttributeEditor structure as it's used internally. More...
 
Q_DECL_DEPRECATED QList< QgsAttributeEditorElement * > attributeEditorElements ()
 Returns a list of tabs holding groups and fields. More...
 
QgsAttributeList attributeList () const
 Returns list of attribute indexes. More...
 
QgsAttributeTableConfig attributeTableConfig () const
 Get the attribute table configuration object. More...
 
void beginEditCommand (const QString &text)
 Create edit command for undo/redo operations. More...
 
QgsRectangle boundingBoxOfSelected ()
 Returns the bounding box of the selected features. More...
 
QgsGeometryCachecache ()
 
QString capabilitiesString () const
 Capabilities for this layer in a friendly format. More...
 
Q_DECL_DEPRECATED bool changeAttributeValue (QgsFeatureId fid, int field, const QVariant &value, bool emitSignal)
 Changes an attribute value (but does not commit it) More...
 
bool changeAttributeValue (QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
 Changes an attribute value (but does not commit it) More...
 
bool changeGeometry (QgsFeatureId fid, QgsGeometry *geom)
 Change feature's geometry. More...
 
void clearAttributeEditorWidgets ()
 Clears all the tabs for the attribute editor form. More...
 
bool commitChanges ()
 Attempts to commit any changes to disk. More...
 
const QStringListcommitErrors ()
 
QgsConditionalLayerStylesconditionalStyles () const
 Return the conditional styles that are set for this layer. More...
 
bool countSymbolFeatures (bool showProgress=true)
 Count features for symbols. More...
 
void createJoinCaches ()
 Caches joined attributes if required (and not already done) More...
 
virtual QgsMapLayerRenderercreateMapRenderer (QgsRenderContext &rendererContext) override
 Return new instance of QgsMapLayerRenderer that will be used for rendering of given context. More...
 
QString dataComment () const
 Returns a comment for the data in the layer. More...
 
QgsVectorDataProviderdataProvider ()
 Returns the data provider. More...
 
const QgsVectorDataProviderdataProvider () const
 Returns the data provider in a const-correct manner. More...
 
Q_DECL_DEPRECATED QString dateFormat (int idx)
 Access date format. More...
 
bool deleteAttribute (int attr)
 Delete an attribute field (but does not commit it) More...
 
bool deleteAttributes (QList< int > attrs)
 Deletes a list of attribute fields (but does not commit it) More...
 
bool deleteFeature (QgsFeatureId fid)
 Delete a feature from the layer (but does not commit it) More...
 
bool deleteFeatures (const QgsFeatureIds &fids)
 Deletes a set of features from the layer (but does not commit it) More...
 
bool deleteSelectedFeatures (int *deletedCount=nullptr)
 Deletes the selected features. More...
 
Q_DECL_DEPRECATED bool deleteVertex (QgsFeatureId atFeatureId, int atVertex)
 Deletes a vertex from a feature. More...
 
EditResult deleteVertexV2 (QgsFeatureId featureId, int vertex)
 Deletes a vertex from a feature. More...
 
void destroyEditCommand ()
 Destroy active command and reverts all changes in it. More...
 
const QgsDiagramLayerSettingsdiagramLayerSettings () const
 
const QgsDiagramRendererV2diagramRenderer () const
 
bool diagramsEnabled () const
 Returns whether the layer contains diagrams which are enabled and should be drawn. More...
 
const QString displayExpression ()
 Get the preview expression, used to create a human readable preview string. More...
 
const QString displayField () const
 Returns the primary display field name used in the identify results dialog. More...
 
bool draw (QgsRenderContext &rendererContext) override
 Draws the layer. More...
 
Q_DECL_DEPRECATED void drawLabels (QgsRenderContext &rendererContext) override
 Draws the layer labels using the old labeling engine. More...
 
QgsVectorLayerEditBuffereditBuffer ()
 Buffer with uncommitted editing operations. Only valid after editing has been turned on. More...
 
Q_DECL_DEPRECATED QString editForm () const
 Get edit form. More...
 
QgsEditFormConfigeditFormConfig () const
 Get the configuration of the form used to represent this vector layer. More...
 
Q_DECL_DEPRECATED QString editFormInit () const
 Get python function for edit form initialization. More...
 
Q_DECL_DEPRECATED EditorLayout editorLayout ()
 Get the active layout for the attribute editor for this layer. More...
 
Q_DECL_DEPRECATED const QString editorWidgetV2 (int fieldIdx) const
 Get the id for the editor widget used to represent the field at the given index. More...
 
Q_DECL_DEPRECATED const QString editorWidgetV2 (const QString &fieldName) const
 Get the id for the editor widget used to represent the field at the given index. More...
 
Q_DECL_DEPRECATED const QgsEditorWidgetConfig editorWidgetV2Config (int fieldIdx) const
 Get the configuration for the editor widget used to represent the field at the given index. More...
 
Q_DECL_DEPRECATED const QgsEditorWidgetConfig editorWidgetV2Config (const QString &fieldName) const
 Get the configuration for the editor widget used to represent the field with the given name. More...
 
Q_DECL_DEPRECATED EditType editType (int idx)
 Get edit type. More...
 
Q_DECL_DEPRECATED void enableLabels (bool on)
 Set labels on. More...
 
void endEditCommand ()
 Finish edit command and add it to undo/redo stack. More...
 
const QSet< QString > & excludeAttributesWFS () const
 
const QSet< QString > & excludeAttributesWMS () const
 
QString expressionField (int index)
 Returns the expressoin used for a given expression field. More...
 
QgsRectangle extent () override
 Return the extent of the layer. More...
 
QPainter::CompositionMode featureBlendMode () const
 Returns the current blending mode for features. More...
 
long featureCount (QgsSymbolV2 *symbol)
 Number of features rendered with specified symbol. More...
 
long featureCount () const
 Returns feature count including changes which have not yet been committed If you need only the count of committed features call this method on this layer's provider. More...
 
Q_DECL_DEPRECATED QgsVectorLayer::FeatureFormSuppress featureFormSuppress () const
 Type of feature form pop-up suppression after feature creation (overrides app setting) More...
 
Q_DECL_DEPRECATED bool fieldEditable (int idx)
 Is edit widget editable. More...
 
int fieldNameIndex (const QString &fieldName) const
 Returns the index of a field name or -1 if the field does not exist. More...
 
QgsFields fields () const
 Returns the list of fields of this layer. More...
 
QGis::GeometryType geometryType () const
 Returns point, line or polygon. More...
 
QList< double > getDoubleValues (const QString &fieldOrExpression, bool &ok, bool selectedOnly=false, int *nullCount=nullptr)
 Fetches all double values from a specified field name or expression. More...
 
QgsFeatureIterator getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest())
 Query the provider for features specified in request. More...
 
virtual QString getStyleFromDatabase (const QString &styleId, QString &msgError)
 Will return the named style corresponding to style id provided. More...
 
QList< QVariantgetValues (const QString &fieldOrExpression, bool &ok, bool selectedOnly=false)
 Fetches all values from a specified field name or expression. More...
 
bool hasGeometryType () const
 Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry. More...
 
Q_DECL_DEPRECATED bool hasLabelsEnabled () const
 Label is on. More...
 
int insertSegmentVerticesForSnap (const QList< QgsSnappingResult > &snapResults)
 Inserts vertices to the snapped segments. More...
 
bool insertVertex (double x, double y, QgsFeatureId atFeatureId, int beforeVertex)
 Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries. More...
 
void invertSelection ()
 Select not selected features and deselect selected ones. More...
 
void invertSelectionInRectangle (QgsRectangle &rect)
 Invert selection of features found within the search rectangle (in layer's coordinates) More...
 
virtual bool isEditable () const override
 Returns true if the provider is in editing mode. More...
 
virtual bool isModified () const
 Returns true if the provider has been modified since the last commit. More...
 
virtual Q_DECL_DEPRECATED bool isReadOnly () const override
 Returns true if the provider is in read-only mode. More...
 
virtual bool isSpatial () const override
 Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. More...
 
QgsLabellabel ()
 Get the label rendering properties associated with this layer. More...
 
const QgsLabellabel () const
 Get the label rendering properties associated with this layer. More...
 
const QgsAbstractVectorLayerLabelinglabeling () const
 Access to labeling configuration. More...
 
Q_DECL_DEPRECATED bool labelOnTop (int idx)
 Label widget on top. More...
 
bool labelsEnabled () const
 Returns whether the layer contains labels which are enabled and should be drawn. More...
 
virtual QSet< QStringlayerDependencies () const
 Get the list of layer ids on which this layer depends. More...
 
int layerTransparency () const
 Returns the current transparency for the vector layer. More...
 
virtual int listStylesInDatabase (QStringList &ids, QStringList &names, QStringList &descriptions, QString &msgError)
 Lists all the style in db split into related to the layer and not related to. More...
 
virtual QString loadNamedStyle (const QString &theURI, bool &theResultFlag, bool loadFromLocalDb)
 Load a named style from file/local db/datasource db. More...
 
virtual QString loadNamedStyle (const QString &theURI, bool &theResultFlag) override
 Calls loadNamedStyle( theURI, theResultFlag, false ); Retained for backward compatibility. More...
 
QVariant maximumValue (int index)
 Returns maximum value for an attribute column or invalid variant in case of error. More...
 
QString metadata () override
 Obtain Metadata for this layer. More...
 
QVariant minimumValue (int index)
 Returns minimum value for an attribute column or invalid variant in case of error. More...
 
void modifySelection (QgsFeatureIds selectIds, QgsFeatureIds deselectIds)
 Modifies the current selection on this layer. More...
 
bool moveVertex (double x, double y, QgsFeatureId atFeatureId, int atVertex)
 Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates. More...
 
bool moveVertex (const QgsPointV2 &p, QgsFeatureId atFeatureId, int atVertex)
 Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates. More...
 
QgsAttributeList pendingAllAttributesList () const
 Returns list of attribute indexes. More...
 
long pendingFeatureCount () const
 Returns feature count including changes which have not yet been committed Alias for featureCount(). More...
 
QgsFields pendingFields () const
 Returns the list of fields of this layer. More...
 
QgsAttributeList pendingPkAttributesList () const
 Returns list of attributes making up the primary key Alias for pkAttributeList(). More...
 
QgsAttributeList pkAttributeList () const
 Returns list of attributes making up the primary key. More...
 
QString providerType () const
 Return the provider type for this layer. More...
 
Q_DECL_DEPRECATED RangeData range (int idx)
 Access range widget config data. More...
 
bool readSld (const QDomNode &node, QString &errorMessage) override
 
bool readSymbology (const QDomNode &node, QString &errorMessage) override
 Read the symbology for the current layer from the Dom node supplied. More...
 
virtual bool readXml (const QDomNode &layer_node) override
 Reads vector layer specific state from project file Dom node. More...
 
QList< QgsRelationreferencingRelations (int idx)
 Get relations, where the foreign key is on this layer. More...
 
virtual void reload () override
 Synchronises with changes in the datasource. More...
 
void remAttributeAlias (int attIndex)
 Removes an alias (a display name) for attributes to display in dialogs. More...
 
void removeExpressionField (int index)
 Remove an expression field. More...
 
bool removeJoin (const QString &joinLayerId)
 Removes a vector layer join. More...
 
Q_DECL_DEPRECATED int removePolygonIntersections (QgsGeometry *geom, const QgsFeatureIds &ignoreFeatures=QgsFeatureIds())
 Changes the specified geometry such that it has no intersections with other polygon (or multipolygon) geometries in this vector layer. More...
 
QgsFeatureRendererV2rendererV2 ()
 Return renderer V2. More...
 
const QgsFeatureRendererV2rendererV2 () const
 Return const renderer V2. More...
 
bool rollBack (bool deleteBuffer=true)
 Stop editing and discard the edits. More...
 
virtual void saveStyleToDatabase (const QString &name, const QString &description, bool useAsDefault, const QString &uiFileContent, QString &msgError)
 Save named and sld style of the layer to the style table in the db. More...
 
void select (QgsRectangle &rect, bool addToSelection)
 Select features found within the search rectangle (in layer's coordinates) More...
 
void selectAll ()
 Select all the features. More...
 
int selectedFeatureCount ()
 The number of features that are selected in this layer. More...
 
QgsFeatureList selectedFeatures ()
 Get a copy of the user-selected features. More...
 
const QgsFeatureIdsselectedFeaturesIds () const
 Return reference to identifiers of selected features. More...
 
QgsFeatureIterator selectedFeaturesIterator (QgsFeatureRequest request=QgsFeatureRequest())
 Get an iterator of the selected features. More...
 
void setAnnotationForm (const QString &ui)
 Set annotation form for layer. More...
 
void setAttributeTableConfig (const QgsAttributeTableConfig &attributeTableConfig)
 Set the attribute table configuration object. More...
 
Q_DECL_DEPRECATED void setCheckedState (int idx, const QString &checked, const QString &notChecked)
 Set string representing 'true' for a checkbox. More...
 
void setCoordinateSystem ()
 Setup the coordinate system transformation for the layer. More...
 
void setDataSource (const QString &dataSource, const QString &baseName, const QString &provider, bool loadDefaultStyleFlag=false)
 Update the data source of the layer. More...
 
void setDiagramLayerSettings (const QgsDiagramLayerSettings &s)
 
void setDiagramRenderer (QgsDiagramRendererV2 *r)
 Sets diagram rendering object (takes ownership) More...
 
void setDisplayExpression (const QString &displayExpression)
 Set the preview expression, used to create a human readable preview string. More...
 
void setDisplayField (const QString &fldName="")
 Set the primary display field to be used in the identify results dialog. More...
 
Q_DECL_DEPRECATED void setEditForm (const QString &ui)
 Set edit form. More...
 
Q_DECL_DEPRECATED void setEditFormInit (const QString &function)
 Set python function for edit form initialization. More...
 
Q_DECL_DEPRECATED void setEditorLayout (EditorLayout editorLayout)
 Set the active layout for the attribute editor for this layer. More...
 
Q_DECL_DEPRECATED void setEditorWidgetV2 (int attrIdx, const QString &widgetType)
 Set the editor widget type for a field. More...
 
Q_DECL_DEPRECATED void setEditorWidgetV2Config (int attrIdx, const QgsEditorWidgetConfig &config)
 Set the editor widget config for a field. More...
 
Q_DECL_DEPRECATED void setEditType (int idx, EditType edit)
 Set edit type. More...
 
void setExcludeAttributesWFS (const QSet< QString > &att)
 
void setExcludeAttributesWMS (const QSet< QString > &att)
 
void setFeatureBlendMode (QPainter::CompositionMode blendMode)
 Set the blending mode used for rendering each feature. More...
 
Q_DECL_DEPRECATED void setFeatureFormSuppress (QgsVectorLayer::FeatureFormSuppress s)
 Set type of feature form pop-up suppression after feature creation (overrides app setting) More...
 
Q_DECL_DEPRECATED void setFieldEditable (int idx, bool editable)
 Set edit widget editable. More...
 
void setLabeling (QgsAbstractVectorLayerLabeling *labeling)
 Set labeling configuration. More...
 
Q_DECL_DEPRECATED void setLabelOnTop (int idx, bool onTop)
 Label widget on top. More...
 
void setLayerTransparency (int layerTransparency)
 Set the transparency for the vector layer. More...
 
void setProviderEncoding (const QString &encoding)
 Sets the textencoding of the data provider. More...
 
bool setReadOnly (bool readonly=true)
 Make layer read-only (editing disabled) or not. More...
 
void setRendererV2 (QgsFeatureRendererV2 *r)
 Set renderer which will be invoked to represent this layer. More...
 
void setSelectedFeatures (const QgsFeatureIds &ids)
 Change selection to the new set of features. More...
 
void setSimplifyMethod (const QgsVectorSimplifyMethod &simplifyMethod)
 Set the simplification settings for fast rendering of features. More...
 
virtual bool setSubsetString (const QString &subset)
 Set the string (typically sql) used to define a subset of the layer. More...
 
bool simplifyDrawingCanbeApplied (const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint) const
 Returns whether the VectorLayer can apply the specified simplification hint. More...
 
const QgsVectorSimplifyMethodsimplifyMethod () const
 Returns the simplification settings for fast rendering of features. More...
 
bool snapPoint (QgsPoint &point, double tolerance)
 Snaps a point to the closest vertex if there is one within the snapping tolerance. More...
 
int snapWithContext (const QgsPoint &startPoint, double snappingTolerance, QMultiMap< double, QgsSnappingResult > &snappingResults, QgsSnapper::SnappingType snap_to)
 Snaps to segment or vertex within given tolerance. More...
 
int splitFeatures (const QList< QgsPoint > &splitLine, bool topologicalEditing=false)
 Splits features cut by the given line. More...
 
int splitParts (const QList< QgsPoint > &splitLine, bool topologicalEditing=false)
 Splits parts cut by the given line. More...
 
QString storageType () const
 Returns the permanent storage type for this layer as a friendly name. More...
 
virtual QString subsetString ()
 Get the string (typically sql) used to define a subset of the layer. More...
 
int translateFeature (QgsFeatureId featureId, double dx, double dy)
 Translates feature by dx, dy. More...
 
void uniqueValues (int index, QList< QVariant > &uniqueValues, int limit=-1)
 Returns unique values for column. More...
 
void updateExpressionField (int index, const QString &exp)
 Changes the expression used to define an expression based (virtual) field. More...
 
bool updateFeature (QgsFeature &f)
 Updates an existing feature. More...
 
void updateFields ()
 Assembles mUpdatedFields considering provider fields, joined fields and added fields. More...
 
Q_DECL_DEPRECATED QMap< QString, QVariantvalueMap (int idx)
 Access value map. More...
 
ValueRelationData valueRelation (int idx)
 Access value relation widget data. More...
 
const QList< QgsVectorJoinInfovectorJoins () const
 
Q_DECL_DEPRECATED QSize widgetSize (int idx)
 Access widget size for photo and webview widget. More...
 
QGis::WkbType wkbType () const
 Returns the WKBType or WKBUnknown in case of error. More...
 
bool writeSld (QDomNode &node, QDomDocument &doc, QString &errorMessage) const
 
bool writeSymbology (QDomNode &node, QDomDocument &doc, QString &errorMessage) const override
 Write the symbology for the layer into the docment provided. More...
 
virtual bool writeXml (QDomNode &layer_node, QDomDocument &doc) override
 Write vector layer specific state to project file Dom node. More...
 
- Public Member Functions inherited from QgsMapLayer
 QgsMapLayer (QgsMapLayer::LayerType type=VectorLayer, const QString &lyrname=QString::null, const QString &source=QString::null)
 Constructor. More...
 
virtual ~QgsMapLayer ()
 Destructor. More...
 
QString abstract () const
 Get the abstract of the layer used by QGIS Server in GetCapabilities request. More...
 
QString attribution () const
 Get the attribution of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
QString attributionUrl () const
 Get the attribution URL of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
QPainter::CompositionMode blendMode () const
 Returns the current blending mode for a layer. More...
 
Q_DECL_DEPRECATED QImagecacheImage ()
 
const QgsCoordinateReferenceSystemcrs () const
 Returns layer's spatial reference system. More...
 
QVariant customProperty (const QString &value, const QVariant &defaultValue=QVariant()) const
 Read a custom property from layer. More...
 
QString dataUrl () const
 Get the DataUrl of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
QString dataUrlFormat () const
 Get the DataUrl format of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
virtual QgsError error () const
 Get current status error. More...
 
virtual void exportNamedStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as named style in a QDomDocument. More...
 
virtual void exportSldStyle (QDomDocument &doc, QString &errorMsg)
 Export the properties of this layer as SLD style in a QDomDocument. More...
 
bool hasScaleBasedVisibility () const
 Returns whether scale based visibility is enabled for the layer. More...
 
QString id () const
 Get this layer's unique ID, this ID is used to access this layer from map layer registry. More...
 
virtual bool importNamedStyle (QDomDocument &doc, QString &errorMsg)
 Import the properties of this layer from a QDomDocument. More...
 
bool isInScaleRange (double scale) const
 Tests whether the layer should be visible at the specified scale. More...
 
bool isValid ()
 Return the status of the layer. More...
 
QString keywordList () const
 Get the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
 
virtual Q_DECL_DEPRECATED QString lastError ()
 
virtual Q_DECL_DEPRECATED QString lastErrorTitle ()
 
QgsMapLayerLegendlegend () const
 Can be null. More...
 
QString legendUrl () const
 
QString legendUrlFormat () const
 
virtual QString loadDefaultStyle (bool &theResultFlag)
 Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual bool loadNamedStyleFromDb (const QString &db, const QString &theURI, QString &qml)
 
virtual QString loadSldStyle (const QString &theURI, bool &theResultFlag)
 
double maximumScale () const
 Returns the maximum scale denominator at which the layer is visible. More...
 
QString metadataUrl () const
 Get the metadata URL of the layer used by QGIS Server in GetCapabilities request MetadataUrl is a a link to the detailed, standardized metadata about the data. More...
 
QString metadataUrlFormat () const
 Get the metadata format of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates how the metadata is structured. More...
 
QString metadataUrlType () const
 Get the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...
 
double minimumScale () const
 Returns the minimum scale denominator at which the layer is visible. More...
 
QString name () const
 Get the display name of the layer. More...
 
virtual Q_DECL_DEPRECATED void onCacheImageDelete ()
 
QString originalName () const
 Get the original name of the layer. More...
 
QString publicSource () const
 Gets a version of the internal layer definition that has sensitive bits removed (for example, the password). More...
 
bool readLayerXML (const QDomElement &layerElement)
 Sets state from Dom document. More...
 
bool readOnly () const
 Returns if this layer is read only. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from layer. More...
 
virtual QString saveDefaultStyle (bool &theResultFlag)
 Save the properties of this layer as the default style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString saveNamedStyle (const QString &theURI, bool &theResultFlag)
 Save the properties of this layer as a named style (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QString saveSldStyle (const QString &theURI, bool &theResultFlag)
 
void setAbstract (const QString &abstract)
 Set the abstract of the layer used by QGIS Server in GetCapabilities request. More...
 
void setAttribution (const QString &attrib)
 Set the attribution of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
void setAttributionUrl (const QString &attribUrl)
 Set the attribution URL of the layer used by QGIS Server in GetCapabilities request Attribution indicates the provider of a Layer or collection of Layers. More...
 
void setBlendMode (QPainter::CompositionMode blendMode)
 Set the blending mode used for rendering a layer. More...
 
Q_DECL_DEPRECATED void setCacheImage (QImage *)
 
void setCrs (const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
 Sets layer's spatial reference system. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for layer. More...
 
void setDataUrl (const QString &dataUrl)
 Set the DataUrl of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
void setDataUrlFormat (const QString &dataUrlFormat)
 Set the DataUrl format of the layer used by QGIS Server in GetCapabilities request DataUrl is a a link to the underlying data represented by a particular layer. More...
 
void setKeywordList (const QString &keywords)
 Set the keyword list of the layer used by QGIS Server in GetCapabilities request. More...
 
void setLayerName (const QString &name)
 Set the display name of the layer. More...
 
virtual void setLayerOrder (const QStringList &layers)
 Reorders the previously selected sublayers of this layer from bottom to top (Useful for providers that manage their own layers, such as WMS) More...
 
void setLegend (QgsMapLayerLegend *legend)
 Assign a legend controller to the map layer. More...
 
void setLegendUrl (const QString &legendUrl)
 
void setLegendUrlFormat (const QString &legendUrlFormat)
 
void setMetadataUrl (const QString &metaUrl)
 Set the metadata URL of the layer used by QGIS Server in GetCapabilities request MetadataUrl is a a link to the detailed, standardized metadata about the data. More...
 
void setMetadataUrlFormat (const QString &metaUrlFormat)
 Set the metadata format of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates how the metadata is structured. More...
 
void setMetadataUrlType (const QString &metaUrlType)
 Set the metadata type of the layer used by QGIS Server in GetCapabilities request MetadataUrlType indicates the standard to which the metadata complies. More...
 
void setShortName (const QString &shortName)
 Set the short name of the layer used by QGIS Server to identify the layer. More...
 
virtual void setSubLayerVisibility (const QString &name, bool vis)
 Set the visibility of the given sublayer name. More...
 
void setTitle (const QString &title)
 Set the title of the layer used by QGIS Server in GetCapabilities request. More...
 
QString shortName () const
 Get the short name of the layer used by QGIS Server to identify the layer. More...
 
QString source () const
 Returns the source for the layer. More...
 
QgsMapLayerStyleManagerstyleManager () const
 Get access to the layer's style manager. More...
 
virtual QString styleURI ()
 Retrieve the style URI for this layer (either as a .qml file on disk or as a record in the users style table in their personal qgis.db) More...
 
virtual QStringList subLayers () const
 Returns the sublayers of this layer (Useful for providers that manage their own layers, such as WMS) More...
 
QString title () const
 Get the title of the layer used by QGIS Server in GetCapabilities request. More...
 
QgsMapLayer::LayerType type () const
 Get the type of the layer. More...
 
QUndoStackundoStack ()
 Return pointer to layer's undo stack. More...
 
bool writeLayerXML (QDomElement &layerElement, QDomDocument &document, const QString &relativeBasePath=QString::null)
 Stores state in Dom node. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Static Public Member Functions

static void drawVertexMarker (double x, double y, QPainter &p, QgsVectorLayer::VertexMarkerType type, int vertexSize)
 Draws a vertex symbol at (screen) coordinates x, y. More...
 
- Static Public Member Functions inherited from QgsMapLayer
static QDomDocument asLayerDefinition (const QList< QgsMapLayer * > &layers, const QString &relativeBasePath=QString::null)
 Returns the given layer as a layer definition document Layer definitions store the data source as well as styling and custom properties. More...
 
static QString capitaliseLayerName (const QString &name)
 A convenience function to (un)capitalise the layer name. More...
 
static QList< QgsMapLayer * > fromLayerDefinition (QDomDocument &document, bool addToRegistry=false, bool addToLegend=false)
 Creates a new layer from a layer defininition document. More...
 
static QList< QgsMapLayer * > fromLayerDefinitionFile (const QString &qlrfile)
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Slots

void invalidateSymbolCountedFlag ()
 

Protected Member Functions

void setExtent (const QgsRectangle &rect) override
 Set the extent. More...
 
- Protected Member Functions inherited from QgsMapLayer
void appendError (const QgsErrorMessage &theMessage)
 Add error message. More...
 
void readCustomProperties (const QDomNode &layerNode, const QString &keyStartsWith="")
 Read custom properties from project file. More...
 
void readStyleManager (const QDomNode &layerNode)
 Read style manager's configuration (if any). More...
 
void setError (const QgsError &theError)
 Set error message. More...
 
void setValid (bool valid)
 Set whether layer is valid or not - should be used in constructor. More...
 
void writeCustomProperties (QDomNode &layerNode, QDomDocument &doc) const
 Write custom properties to project file. More...
 
void writeStyleManager (QDomNode &layerNode, QDomDocument &doc) const
 Write style manager's configuration (if exists). More...
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Friends

class QgsVectorLayerEditBuffer
 
class QgsVectorLayerFeatureSource
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from QgsMapLayer
QString mAbstract
 Description of the layer. More...
 
QString mAttribution
 Attribution of the layer. More...
 
QString mAttributionUrl
 
QString mDataSource
 Data source description string, varies by layer type. More...
 
QString mDataUrl
 DataUrl of the layer. More...
 
QString mDataUrlFormat
 
QgsError mError
 Error. More...
 
QgsRectangle mExtent
 Extent of the layer. More...
 
QString mKeywordList
 
QString mLayerName
 Name of the layer - used for display. More...
 
QString mLayerOrigName
 Original name of the layer. More...
 
QString mLegendUrl
 WMS legend. More...
 
QString mLegendUrlFormat
 
QString mMetadataUrl
 MetadataUrl of the layer. More...
 
QString mMetadataUrlFormat
 
QString mMetadataUrlType
 
QString mShortName
 
QString mTitle
 
bool mValid
 Indicates if the layer is valid and can be drawn. More...
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Represents a vector layer which manages a vector based data sets.

The QgsVectorLayer is instantiated by specifying the name of a data provider, such as postgres or wfs, and url defining the specific data set to connect to. The vector layer constructor in turn instantiates a QgsVectorDataProvider subclass corresponding to the provider type, and passes it the url. The data provider connects to the data source.

The QgsVectorLayer provides a common interface to the different data types. It also manages editing transactions.

Sample usage of the QgsVectorLayer class:

QString uri = "point?crs=epsg:4326&field=id:integer";
QgsVectorLayer *scratchLayer = new QgsVectorLayer(uri, "Scratch point layer", "memory");

The main data providers supported by QGIS are listed below.

Vector data providers

Memory data providerType (memory)

The memory data provider is used to construct in memory data, for example scratch data or data generated from spatial operations such as contouring. There is no inherent persistent storage of the data. The data source uri is constructed. The url specifies the geometry type ("point", "linestring", "polygon", "multipoint","multilinestring","multipolygon"), optionally followed by url parameters as follows:

An example url is "Point?crs=epsg:4326&field=id:integer&field=name:string(20)&index=yes"

OGR data provider (ogr)

Accesses data using the OGR drivers (http://www.gdal.org/ogr/ogr_formats.html). The url is the OGR connection string. A wide variety of data formats can be accessed using this driver, including file based formats used by many GIS systems, database formats, and web services. Some of these formats are also supported by custom data providers listed below.

Spatialite data provider (spatialite)

Access data in a spatialite database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.

Postgresql data provider (postgres)

Connects to a postgresql database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.

Microsoft SQL server data provider (mssql)

Connects to a Microsoft SQL server database. The url defines the connection parameters, table, geometry column, and other attributes. The url can be constructed using the QgsDataSourceURI class.

WFS (web feature service) data provider (wfs)

Used to access data provided by a web feature service.

The url can be a HTTP url to a WFS server (legacy, e.g. http://foobar/wfs?TYPENAME=xxx&SRSNAME=yyy[&FILTER=zzz]), or, starting with QGIS 2.16, a URI constructed using the QgsDataSourceURI class with the following parameters :

The ‘FILTER’ query string parameter can be used to filter the WFS feature type. The ‘FILTER’ key value can either be a QGIS expression or an OGC XML filter. If the value is set to a QGIS expression the driver will turn it into OGC XML filter before passing it to the WFS server. Beware the QGIS expression filter only supports” =, !=, <, >, <=, >=, AND, OR, NOT, LIKE, IS NULL” attribute operators, “BBOX, Disjoint, Intersects, Touches, Crosses, Contains, Overlaps, Within” spatial binary operators and the QGIS local “geomFromWKT, geomFromGML” geometry constructor functions.

Also note:

Delimited text file data provider (delimitedtext)

Accesses data in a delimited text file, for example CSV files generated by spreadsheets. The contents of the file are split into columns based on specified delimiter characters. Each record may be represented spatially either by an X and Y coordinate column, or by a WKT (well known text) formatted columns.

The url defines the filename, the formatting options (how the text in the file is divided into data fields, and which fields contain the X,Y coordinates or WKT text definition. The options are specified as url query items.

At its simplest the url can just be the filename, in which case it will be loaded as a CSV formatted file.

The url may include the following items:

-subsetIndex=(yes|no)

Determines whether the provider generates an index to improve the efficiency of subsets. The default is yes

-spatialIndex=(yes|no)

Determines whether the provider generates a spatial index. The default is no.

-watchFile=(yes|no)

Defines whether the file will be monitored for changes. The default is to monitor for changes.

GPX data provider (gpx)

Provider reads tracks, routes, and waypoints from a GPX file. The url defines the name of the file, and the type of data to retrieve from it ("track", "route", or "waypoint").

An example url is "/home/user/data/holiday.gpx?type=route"

Grass data provider (grass)

Provider to display vector data in a GRASS GIS layer.

TODO QGIS3: Remove virtual from non-inherited methods (like isModified)

Definition at line 395 of file qgsvectorlayer.h.

Member Typedef Documentation

Definition at line 401 of file qgsvectorlayer.h.

Definition at line 402 of file qgsvectorlayer.h.

Member Enumeration Documentation

Enumerator
GeneratedLayout 
TabLayout 
UiFileLayout 

Definition at line 404 of file qgsvectorlayer.h.

Result of an edit operation.

Enumerator
Success 

Edit operation was successful.

EmptyGeometry 

Edit operation resulted in an empty geometry.

EditFailed 

Edit operation failed.

FetchFeatureFailed 

Unable to fetch requested feature.

InvalidLayer 

Edit failed due to invalid layer.

Definition at line 496 of file qgsvectorlayer.h.

Deprecated:
Use the editorWidgetV2() system instead
Enumerator
LineEdit 
UniqueValues 
UniqueValuesEditable 
ValueMap 
Classification 
EditRange 
SliderRange 
CheckBox 
FileName 
Enumeration 
Immutable 

The attribute value should not be changed in the attribute form.

Hidden 

The attribute value should not be shown in the attribute form.

TextEdit 

multiline edit

Calendar 

calendar widget

DialRange 

dial range

ValueRelation 

value map from an table

UuidGenerator 

uuid generator - readonly and automatically intialized

Photo 

phote widget

WebView 

webview widget

Color 

color

EditorWidgetV2 

modularized edit widgets

Note
added in 2.1

Definition at line 470 of file qgsvectorlayer.h.

Types of feature form suppression after feature creation.

Note
added in 2.1
Deprecated:
in 2.14, Use QgsEditFormConfig instead
Enumerator
SuppressDefault 
SuppressOn 
SuppressOff 

Definition at line 460 of file qgsvectorlayer.h.

Editing vertex markers.

Enumerator
SemiTransparentCircle 
Cross 
NoMarker 

Definition at line 1612 of file qgsvectorlayer.h.

Constructor & Destructor Documentation

QgsVectorLayer::QgsVectorLayer ( const QString path = QString::null,
const QString baseName = QString::null,
const QString providerLib = QString::null,
bool  loadDefaultStyleFlag = true 
)

Constructor - creates a vector layer.

The QgsVectorLayer is constructed by instantiating a data provider. The provider interprets the supplied path (url) of the data source to connect to and access the data.

Parameters
pathThe path or url of the parameter. Typically this encodes parameters used by the data provider as url query items.
baseNameThe name used to represent the layer in the legend
providerLibThe name of the data provider, eg "memory", "postgres"
loadDefaultStyleFlagwhether to load the default style

Definition at line 123 of file qgsvectorlayer.cpp.

QgsVectorLayer::~QgsVectorLayer ( )
virtual

Destructor.

Definition at line 175 of file qgsvectorlayer.cpp.

Member Function Documentation

QgsActionManager* QgsVectorLayer::actions ( )
inline

Get all layer actions defined on this layer.

The pointer which is returned directly points to the actions object which is used by the layer, so any changes are immediately applied.

Definition at line 642 of file qgsvectorlayer.h.

bool QgsVectorLayer::addAttribute ( const QgsField field)

Add an attribute field (but does not commit it) returns true if the field was added.

Definition at line 2236 of file qgsvectorlayer.cpp.

void QgsVectorLayer::addAttributeAlias ( int  attIndex,
const QString aliasString 
)

Sets an alias (a display name) for attributes to display in dialogs.

Definition at line 2257 of file qgsvectorlayer.cpp.

Q_DECL_DEPRECATED void QgsVectorLayer::addAttributeEditorWidget ( QgsAttributeEditorElement data)
inline

Adds a tab (for the attribute editor form) holding groups and fields.

Deprecated:
Use editFormConfig()->addTab() instead

Definition at line 1262 of file qgsvectorlayer.h.

int QgsVectorLayer::addExpressionField ( const QString exp,
const QgsField fld 
)

Add a new field which is calculated by the expression specified.

Parameters
expThe expression which calculates the field
fldThe field to calculate
Returns
The index of the new field
Note
added in 2.6, return value added in 2.9

Definition at line 2946 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::addFeature ( QgsFeature f,
bool  alsoUpdateExtent = true 
)

Adds a feature.

Parameters
ffeature to add
alsoUpdateExtentIf True, will also go to the effort of e.g. updating the extents.
Returns
True in case of success and False in case of error

Definition at line 1017 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::addFeatures ( QgsFeatureList  features,
bool  makeSelected = true 
)

Insert a copy of the given features into the layer (but does not commit it)

Definition at line 2537 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::addJoin ( const QgsVectorJoinInfo joinInfo)

Joins another vector layer to this layer.

Parameters
joinInfojoin object containing join layer id, target and source field
Note
since 2.6 returns bool indicating whether the join can be added

Definition at line 2918 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addPart ( const QList< QgsPoint > &  ring)

Adds a new part polygon to a multipart feature.

Returns
0 in case of success, 1 if selected feature is not multipart, 2 if ring is not a valid geometry, 3 if new polygon ring not disjoint with existing rings, 4 if no feature was selected, 5 if several features are selected, 6 if selected geometry not found 7 layer not editable

Definition at line 1231 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addPart ( const QgsPointSequenceV2 ring)

Adds a new part polygon to a multipart feature.

Returns
0 in case of success, 1 if selected feature is not multipart, 2 if ring is not a valid geometry, 3 if new polygon ring not disjoint with existing rings, 4 if no feature was selected, 5 if several features are selected, 6 if selected geometry not found 7 layer not editable
Note
available in python bindings as addPartV2

Definition at line 1257 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addPart ( QgsCurveV2 ring)
Note
available in python as addCurvedPart

Definition at line 1283 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addRing ( const QList< QgsPoint > &  ring,
QgsFeatureId featureId = nullptr 
)

Adds a ring to polygon/multipolygon features.

Parameters
ringring to add
featureIdif specified, feature ID for feature ring was added to will be stored in this parameter
Returns
0 in case of success, 1 problem with feature type, 2 ring not closed, 3 ring not valid, 4 ring crosses existing rings, 5 no feature found where ring can be inserted 6 layer not editable

Definition at line 1170 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addRing ( QgsCurveV2 ring,
QgsFeatureId featureId = nullptr 
)

Adds a ring to polygon/multipolygon features (takes ownership)

Parameters
ringring to add
featureIdif specified, feature ID for feature ring was added to will be stored in this parameter
Returns
0 in case of success 1 problem with feature type 2 ring not closed 6 layer not editable
Note
available in python as addCurvedRing

Definition at line 1193 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addTopologicalPoints ( const QgsGeometry geom)

Adds topological points for every vertex of the geometry.

Parameters
geomthe geometry where each vertex is added to segments of other features
Note
geom is not going to be modified by the function
Returns
0 in case of success

Definition at line 1384 of file qgsvectorlayer.cpp.

int QgsVectorLayer::addTopologicalPoints ( const QgsPoint p)

Adds a vertex to segments which intersect point p but don't already have a vertex there.

If a feature already has a vertex at position p, no additional vertex is inserted. This method is useful for topological editing.

Parameters
pposition of the vertex
Returns
0 in case of success

Definition at line 1393 of file qgsvectorlayer.cpp.

QgsFeatureIds QgsVectorLayer::allFeatureIds ( )

Get all feature Ids.

Definition at line 493 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::annotationForm ( ) const
inline

Get annotation form.

Definition at line 1511 of file qgsvectorlayer.h.

bool QgsVectorLayer::applyNamedStyle ( const QString namedStyle,
QString errorMsg 
)
virtual

Will load a named style from a provided QML string.

Parameters
namedStyleA QML string
errorMsgAn error message indicating problems if any
Returns
true on success
Deprecated:
Will be removed for QGIS 3 in favor of importNamedStyle

Definition at line 4085 of file qgsvectorlayer.cpp.

void QgsVectorLayer::attributeAdded ( int  idx)
signal

Will be emitted, when a new attribute has been added to this vector layer.

Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression

Parameters
idxThe index of the new attribute
See also
updatedFields()
QString QgsVectorLayer::attributeAlias ( int  attributeIndex) const

Returns the alias of an attribute name or a null string if there is no alias.

See also
{attributeDisplayName( int attributeIndex )} which returns the field name if no alias is defined.

Definition at line 2268 of file qgsvectorlayer.cpp.

const QMap< QString, QString >& QgsVectorLayer::attributeAliases ( ) const
inline

Definition at line 1343 of file qgsvectorlayer.h.

void QgsVectorLayer::attributeDeleted ( int  idx)
signal

Will be emitted, when an attribute has been deleted from this vector layer.

Applies only to types QgsFields::OriginEdit, QgsFields::OriginProvider and QgsFields::OriginExpression

Parameters
idxThe index of the deleted attribute
See also
updatedFields()
QString QgsVectorLayer::attributeDisplayName ( int  attributeIndex) const

Convenience function that returns the attribute alias if defined or the field name else.

Definition at line 2278 of file qgsvectorlayer.cpp.

QgsAttributeEditorElement* QgsVectorLayer::attributeEditorElementFromDomElement ( QDomElement elem,
QObject parent 
)
inline

Convert a saved attribute editor element into a AttributeEditor structure as it's used internally.

Parameters
elemthe DOM element
parentthe QObject which will own this object

Definition at line 848 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED QList< QgsAttributeEditorElement* > QgsVectorLayer::attributeEditorElements ( )
inline

Returns a list of tabs holding groups and fields.

Deprecated:
Use editFormConfig()->tabs() instead

Definition at line 1317 of file qgsvectorlayer.h.

QgsAttributeList QgsVectorLayer::attributeList ( ) const
inline

Returns list of attribute indexes.

i.e. a list from 0 ... fieldCount() Alias for attributeList()

Definition at line 1195 of file qgsvectorlayer.h.

QgsAttributeTableConfig QgsVectorLayer::attributeTableConfig ( ) const

Get the attribute table configuration object.

This defines the appearance of the attribute table.

Definition at line 3596 of file qgsvectorlayer.cpp.

void QgsVectorLayer::attributeValueChanged ( QgsFeatureId  fid,
int  idx,
const QVariant  
)
signal
void QgsVectorLayer::beforeAddingExpressionField ( const QString fieldName)
signal

Will be emitted, when an expression field is going to be added to this vector layer.

Applies only to types QgsFields::OriginExpression

Parameters
fieldNameThe name of the attribute to be added
void QgsVectorLayer::beforeCommitChanges ( )
signal

Is emitted, before changes are commited to the data provider.

void QgsVectorLayer::beforeEditingStarted ( )
signal

Is emitted, before editing on this layer is started.

void QgsVectorLayer::beforeModifiedCheck ( ) const
signal

Is emitted, when layer is checked for modifications.

Use for last-minute additions

void QgsVectorLayer::beforeRemovingExpressionField ( int  idx)
signal

Will be emitted, when an expression field is going to be deleted from this vector layer.

Applies only to types QgsFields::OriginExpression

Parameters
idxThe index of the attribute to be deleted
void QgsVectorLayer::beforeRollBack ( )
signal

Is emitted, before changes are rolled back.

void QgsVectorLayer::beginEditCommand ( const QString text)

Create edit command for undo/redo operations.

Parameters
texttext which is to be displayed in undo window

Definition at line 2853 of file qgsvectorlayer.cpp.

QgsRectangle QgsVectorLayer::boundingBoxOfSelected ( )

Returns the bounding box of the selected features.

If there is no selection, QgsRectangle(0,0,0,0) is returned

Definition at line 606 of file qgsvectorlayer.cpp.

QgsGeometryCache* QgsVectorLayer::cache ( )
inline
Note
not available in python bindings

Definition at line 1676 of file qgsvectorlayer.h.

QString QgsVectorLayer::capabilitiesString ( ) const

Capabilities for this layer in a friendly format.

Definition at line 209 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::changeAttributeValue ( QgsFeatureId  fid,
int  field,
const QVariant value,
bool  emitSignal 
)

Changes an attribute value (but does not commit it)

Deprecated:
The emitSignal parameter is obsolete and not considered at the moment. It will be removed in future releases. Remove it to be prepared for the future. (Since 2.1)

Definition at line 2222 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::changeAttributeValue ( QgsFeatureId  fid,
int  field,
const QVariant newValue,
const QVariant oldValue = QVariant() 
)

Changes an attribute value (but does not commit it)

Parameters
fidThe feature id of the feature to be changed
fieldThe index of the field to be updated
newValueThe value which will be assigned to the field
oldValueThe previous value to restore on undo (will otherwise be retrieved)
Returns
true in case of success

Definition at line 2228 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::changeGeometry ( QgsFeatureId  fid,
QgsGeometry geom 
)

Change feature's geometry.

Definition at line 2205 of file qgsvectorlayer.cpp.

void QgsVectorLayer::checkJoinLayerRemove ( const QString theLayerId)
slot

Check if there is a join with a layer that will be removed.

Definition at line 2923 of file qgsvectorlayer.cpp.

void QgsVectorLayer::clearAttributeEditorWidgets ( )
inline

Clears all the tabs for the attribute editor form.

Definition at line 1330 of file qgsvectorlayer.h.

bool QgsVectorLayer::commitChanges ( )

Attempts to commit any changes to disk.

Returns the result of the attempt. If a commit fails, the in-memory changes are left alone.

This allows editing to continue if the commit failed on e.g. a disallowed value in a Postgres database - the user can re-edit and try again.

The commits occur in distinct stages, (add attributes, add features, change attribute values, change geometries, delete features, delete attributes) so if a stage fails, it's difficult to roll back cleanly. Therefore any error message also includes which stage failed so that the user has some chance of repairing the damage cleanly.

Definition at line 2380 of file qgsvectorlayer.cpp.

const QStringList & QgsVectorLayer::commitErrors ( )

Definition at line 2425 of file qgsvectorlayer.cpp.

void QgsVectorLayer::committedAttributesAdded ( const QString layerId,
const QList< QgsField > &  addedAttributes 
)
signal
void QgsVectorLayer::committedAttributesDeleted ( const QString layerId,
const QgsAttributeList deletedAttributes 
)
signal

Signals emitted after committing changes.

void QgsVectorLayer::committedAttributeValuesChanges ( const QString layerId,
const QgsChangedAttributesMap changedAttributesValues 
)
signal
void QgsVectorLayer::committedFeaturesAdded ( const QString layerId,
const QgsFeatureList addedFeatures 
)
signal
void QgsVectorLayer::committedFeaturesRemoved ( const QString layerId,
const QgsFeatureIds deletedFeatureIds 
)
signal
void QgsVectorLayer::committedGeometriesChanges ( const QString layerId,
const QgsGeometryMap changedGeometries 
)
signal
QgsConditionalLayerStyles * QgsVectorLayer::conditionalStyles ( ) const

Return the conditional styles that are set for this layer.

Style information is used to render conditional formatting in the attribute table.

Returns
Return a QgsConditionalLayerStyles object holding the conditional attribute style information. Style information is generic and can be used for anything.
Note
added in QGIS 2.12

Definition at line 1003 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::countSymbolFeatures ( bool  showProgress = true)

Count features for symbols.

Feature counts may be get by featureCount( QgsSymbolV2*).

Parameters
showProgressshow progress dialog
Returns
true if calculated, false if failed or was canceled by user

Definition at line 738 of file qgsvectorlayer.cpp.

void QgsVectorLayer::createJoinCaches ( )

Caches joined attributes if required (and not already done)

Definition at line 3005 of file qgsvectorlayer.cpp.

QgsMapLayerRenderer * QgsVectorLayer::createMapRenderer ( QgsRenderContext rendererContext)
overridevirtual

Return new instance of QgsMapLayerRenderer that will be used for rendering of given context.

Note
added in 2.4

Reimplemented from QgsMapLayer.

Definition at line 383 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::dataComment ( ) const

Returns a comment for the data in the layer.

Definition at line 218 of file qgsvectorlayer.cpp.

QgsVectorDataProvider * QgsVectorLayer::dataProvider ( )

Returns the data provider.

Definition at line 547 of file qgsvectorlayer.cpp.

const QgsVectorDataProvider * QgsVectorLayer::dataProvider ( ) const

Returns the data provider in a const-correct manner.

Note
not available in python bindings

Definition at line 552 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::dateFormat ( int  idx)

Access date format.

Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 2822 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteAttribute ( int  attr)

Delete an attribute field (but does not commit it)

Definition at line 2291 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteAttributes ( QList< int >  attrs)

Deletes a list of attribute fields (but does not commit it)

Parameters
attrsthe indices of the attributes to delete
Returns
true if at least one attribute has been deleted

Definition at line 2308 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteFeature ( QgsFeatureId  fid)

Delete a feature from the layer (but does not commit it)

Definition at line 2328 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteFeatures ( const QgsFeatureIds fids)

Deletes a set of features from the layer (but does not commit it)

Parameters
fidsThe feature ids to delete
Returns
false if the layer is not in edit mode or does not support deleting in case of an active transaction depends on the provider implementation

Definition at line 2343 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteSelectedFeatures ( int *  deletedCount = nullptr)

Deletes the selected features.

Returns
true in case of success and false otherwise

Definition at line 1138 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::deleteVertex ( QgsFeatureId  atFeatureId,
int  atVertex 
)

Deletes a vertex from a feature.

Deprecated:
use deleteVertexV2() instead

Definition at line 1114 of file qgsvectorlayer.cpp.

QgsVectorLayer::EditResult QgsVectorLayer::deleteVertexV2 ( QgsFeatureId  featureId,
int  vertex 
)

Deletes a vertex from a feature.

Parameters
featureIdID of feature to remove vertex from
vertexindex of vertex to delete
Note
added in QGIS 2.14

Definition at line 1124 of file qgsvectorlayer.cpp.

void QgsVectorLayer::deselect ( const QgsFeatureId  featureId)
slot

Deselect feature by its ID.

Parameters
featureIdThe id of the feature to deselect
See also
deselect(QgsFeatureIds)

Definition at line 424 of file qgsvectorlayer.cpp.

void QgsVectorLayer::deselect ( const QgsFeatureIds featureIds)
slot

Deselect features by their ID.

Parameters
featureIdsThe ids of the features to deselect
See also
deselect(QgsFeatureId)

Definition at line 431 of file qgsvectorlayer.cpp.

void QgsVectorLayer::destroyEditCommand ( )

Destroy active command and reverts all changes in it.

Definition at line 2886 of file qgsvectorlayer.cpp.

const QgsDiagramLayerSettings* QgsVectorLayer::diagramLayerSettings ( ) const
inline

Definition at line 752 of file qgsvectorlayer.h.

const QgsDiagramRendererV2* QgsVectorLayer::diagramRenderer ( ) const
inline

Definition at line 749 of file qgsvectorlayer.h.

bool QgsVectorLayer::diagramsEnabled ( ) const

Returns whether the layer contains diagrams which are enabled and should be drawn.

Returns
true if layer contains enabled diagrams
Note
added in QGIS 2.9

Definition at line 679 of file qgsvectorlayer.cpp.

const QString QgsVectorLayer::displayExpression ( )

Get the preview expression, used to create a human readable preview string.

Uses QgsExpression

Returns
The expression which will be used to preview features for this layer

Definition at line 2737 of file qgsvectorlayer.cpp.

const QString QgsVectorLayer::displayField ( ) const

Returns the primary display field name used in the identify results dialog.

Definition at line 2727 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::draw ( QgsRenderContext rendererContext)
overridevirtual

Draws the layer.

Returns
false if an error occurred during drawing

Reimplemented from QgsMapLayer.

Definition at line 388 of file qgsvectorlayer.cpp.

void QgsVectorLayer::drawLabels ( QgsRenderContext rendererContext)
overridevirtual

Draws the layer labels using the old labeling engine.

Deprecated:
will be removed in QGIS 3.0

Reimplemented from QgsMapLayer.

Definition at line 315 of file qgsvectorlayer.cpp.

void QgsVectorLayer::drawVertexMarker ( double  x,
double  y,
QPainter p,
QgsVectorLayer::VertexMarkerType  type,
int  vertexSize 
)
static

Draws a vertex symbol at (screen) coordinates x, y.

(Useful to assist vertex editing.)

Definition at line 394 of file qgsvectorlayer.cpp.

QgsVectorLayerEditBuffer* QgsVectorLayer::editBuffer ( )
inline

Buffer with uncommitted editing operations. Only valid after editing has been turned on.

Definition at line 1594 of file qgsvectorlayer.h.

void QgsVectorLayer::editCommandDestroyed ( )
signal

Signal emitted, whan an edit command is destroyed.

Note
This is not a rollback, it is only related to the current edit command. See beforeRollBack()
void QgsVectorLayer::editCommandEnded ( )
signal

Signal emitted, when an edit command successfully ended.

Note
This does not mean it is also committed, only that it is written to the edit buffer. See beforeCommitChanges()
void QgsVectorLayer::editCommandStarted ( const QString text)
signal

Signal emitted when a new edit command has been started.

Parameters
textDescription for this edit command
Q_DECL_DEPRECATED QString QgsVectorLayer::editForm ( ) const
inline

Get edit form.

Deprecated:
Use editFormConfig()->uiForm() instead

Definition at line 1490 of file qgsvectorlayer.h.

QgsEditFormConfig* QgsVectorLayer::editFormConfig ( ) const
inline

Get the configuration of the form used to represent this vector layer.

This is a writable configuration that can directly be changed in place.

Returns
The configuration of this layers' form

Definition at line 1325 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED QString QgsVectorLayer::editFormInit ( ) const
inline

Get python function for edit form initialization.

Deprecated:
Use editFormConfig()->initFunction() instead

Definition at line 1521 of file qgsvectorlayer.h.

void QgsVectorLayer::editingStarted ( )
signal

Is emitted, when editing on this layer has started.

void QgsVectorLayer::editingStopped ( )
signal

Is emitted, when edited changes successfully have been written to the data provider.

Q_DECL_DEPRECATED EditorLayout QgsVectorLayer::editorLayout ( )
inline

Get the active layout for the attribute editor for this layer.

Deprecated:
Use editFormConfig()->layout() instead

Definition at line 1419 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED const QString QgsVectorLayer::editorWidgetV2 ( int  fieldIdx) const
inline

Get the id for the editor widget used to represent the field at the given index.

Parameters
fieldIdxThe index of the field
Returns
The id for the editor widget or a NULL string if not applicable
Deprecated:
Use editFormConfig()->widgetType() instead

Definition at line 1273 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED const QString QgsVectorLayer::editorWidgetV2 ( const QString fieldName) const
inline

Get the id for the editor widget used to represent the field at the given index.

Parameters
fieldNameThe name of the field
Returns
The id for the editor widget or a NULL string if not applicable
Note
python method name editorWidgetV2ByName
Deprecated:
Use editFormConfig()->widgetType() instead

Definition at line 1286 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED const QgsEditorWidgetConfig QgsVectorLayer::editorWidgetV2Config ( int  fieldIdx) const
inline

Get the configuration for the editor widget used to represent the field at the given index.

Parameters
fieldIdxThe index of the field
Returns
The configuration for the editor widget or an empty config if the field does not exist
Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 1297 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED const QgsEditorWidgetConfig QgsVectorLayer::editorWidgetV2Config ( const QString fieldName) const
inline

Get the configuration for the editor widget used to represent the field with the given name.

Parameters
fieldNameThe name of the field
Returns
The configuration for the editor widget or an empty config if the field does not exist
Note
python method name is editorWidgetV2ConfigByName
Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 1310 of file qgsvectorlayer.h.

QgsVectorLayer::EditType QgsVectorLayer::editType ( int  idx)

Get edit type.

Deprecated:
Use editFormConfig()->widgetType() instead

Definition at line 2773 of file qgsvectorlayer.cpp.

void QgsVectorLayer::enableLabels ( bool  on)

Set labels on.

Deprecated:
this method is for the old labeling engine

Definition at line 1412 of file qgsvectorlayer.cpp.

void QgsVectorLayer::endEditCommand ( )

Finish edit command and add it to undo/redo stack.

Definition at line 2867 of file qgsvectorlayer.cpp.

const QSet<QString>& QgsVectorLayer::excludeAttributesWFS ( ) const
inline

Definition at line 1348 of file qgsvectorlayer.h.

const QSet<QString>& QgsVectorLayer::excludeAttributesWMS ( ) const
inline

Definition at line 1345 of file qgsvectorlayer.h.

QString QgsVectorLayer::expressionField ( int  index)

Returns the expressoin used for a given expression field.

Parameters
indexAn index of an epxression based (virtual) field
Returns
The expression for the field at index
Note
added in 2.9

Definition at line 2965 of file qgsvectorlayer.cpp.

QgsRectangle QgsVectorLayer::extent ( )
overridevirtual

Return the extent of the layer.

Reimplemented from QgsMapLayer.

Definition at line 870 of file qgsvectorlayer.cpp.

void QgsVectorLayer::featureAdded ( QgsFeatureId  fid)
signal

Emitted when a new feature has been added to the layer.

Parameters
fidThe id of the new feature
QPainter::CompositionMode QgsVectorLayer::featureBlendMode ( ) const

Returns the current blending mode for features.

Read blend mode for layer.

Definition at line 3341 of file qgsvectorlayer.cpp.

void QgsVectorLayer::featureBlendModeChanged ( QPainter::CompositionMode  blendMode)
signal

Signal emitted when setFeatureBlendMode() is called.

long QgsVectorLayer::featureCount ( QgsSymbolV2 symbol)

Number of features rendered with specified symbol.

Features must be first calculated by countSymbolFeatures()

Parameters
symbolthe symbol
Returns
number of features rendered by symbol or -1 if failed or counts are not available

Definition at line 692 of file qgsvectorlayer.cpp.

long QgsVectorLayer::featureCount ( ) const

Returns feature count including changes which have not yet been committed If you need only the count of committed features call this method on this layer's provider.

Definition at line 2374 of file qgsvectorlayer.cpp.

void QgsVectorLayer::featureDeleted ( QgsFeatureId  fid)
signal

Emitted when a feature has been deleted.

If you do expensive operations in a slot connected to this, you should prever to use featuresDeleted( const QgsFeatureIds& ).

Parameters
fidThe id of the feature which has been deleted
Q_DECL_DEPRECATED QgsVectorLayer::FeatureFormSuppress QgsVectorLayer::featureFormSuppress ( ) const
inline

Type of feature form pop-up suppression after feature creation (overrides app setting)

Note
added in 2.1
Deprecated:
Use editFormConfig()->suppress() instead

Definition at line 1502 of file qgsvectorlayer.h.

void QgsVectorLayer::featuresDeleted ( const QgsFeatureIds fids)
signal

Emitted when features have been deleted.

If features are deleted within an edit command, this will only be emitted once at the end to allow connected slots to minimize the overhead. If features are deleted outside of an edit command, this signal will be emitted once per feature.

Parameters
fidsThe feature ids that have been deleted.
Q_DECL_DEPRECATED bool QgsVectorLayer::fieldEditable ( int  idx)
inline

Is edit widget editable.

Deprecated:
Use editFormConfig()->fieldEditable() instead

Definition at line 1573 of file qgsvectorlayer.h.

int QgsVectorLayer::fieldNameIndex ( const QString fieldName) const

Returns the index of a field name or -1 if the field does not exist.

Definition at line 2913 of file qgsvectorlayer.cpp.

QgsFields QgsVectorLayer::fields ( ) const
inline

Returns the list of fields of this layer.

This also includes fields which have not yet been saved to the provider.

Returns
A list of fields

Definition at line 1174 of file qgsvectorlayer.h.

void QgsVectorLayer::geometryChanged ( QgsFeatureId  fid,
QgsGeometry geom 
)
signal
QGis::GeometryType QgsVectorLayer::geometryType ( ) const

Returns point, line or polygon.

Definition at line 573 of file qgsvectorlayer.cpp.

QList< double > QgsVectorLayer::getDoubleValues ( const QString fieldOrExpression,
bool &  ok,
bool  selectedOnly = false,
int *  nullCount = nullptr 
)

Fetches all double values from a specified field name or expression.

Null values or invalid expression results are skipped.

Parameters
fieldOrExpressionfield name or an expression string evaluating to a double value
okwill be set to false if field or expression is invalid, otherwise true
selectedOnlyset to true to get values from selected features only
nullCountoptional pointer to integer to store number of null values encountered in
Returns
list of fetched values
Note
added in QGIS 2.9
See also
getValues

Definition at line 3305 of file qgsvectorlayer.cpp.

QgsFeatureIterator QgsVectorLayer::getFeatures ( const QgsFeatureRequest request = QgsFeatureRequest())

Query the provider for features specified in request.

Definition at line 1008 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::getStyleFromDatabase ( const QString styleId,
QString msgError 
)
virtual

Will return the named style corresponding to style id provided.

Definition at line 3988 of file qgsvectorlayer.cpp.

QList< QVariant > QgsVectorLayer::getValues ( const QString fieldOrExpression,
bool &  ok,
bool  selectedOnly = false 
)

Fetches all values from a specified field name or expression.

Parameters
fieldOrExpressionfield name or an expression string
okwill be set to false if field or expression is invalid, otherwise true
selectedOnlyset to true to get values from selected features only
Returns
list of fetched values
Note
added in QGIS 2.9
See also
getDoubleValues

Definition at line 3240 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::hasGeometryType ( ) const

Returns true if this is a geometry layer and false in case of NoGeometry (table only) or UnknownGeometry.

Definition at line 595 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::hasLabelsEnabled ( ) const

Label is on.

Deprecated:
this method is for the old labeling engine, use labelsEnabled instead

Definition at line 1417 of file qgsvectorlayer.cpp.

int QgsVectorLayer::insertSegmentVerticesForSnap ( const QList< QgsSnappingResult > &  snapResults)

Inserts vertices to the snapped segments.

This is useful for topological editing if snap to segment is enabled.

Parameters
snapResultsresults collected from the snapping operation
Returns
0 in case of success

Definition at line 2699 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::insertVertex ( double  x,
double  y,
QgsFeatureId  atFeatureId,
int  beforeVertex 
)

Insert a new vertex before the given vertex number, in the given ring, item (first number is index 0), and feature Not meaningful for Point geometries.

Definition at line 1075 of file qgsvectorlayer.cpp.

void QgsVectorLayer::invalidateSymbolCountedFlag ( )
protectedslot

Definition at line 3867 of file qgsvectorlayer.cpp.

void QgsVectorLayer::invertSelection ( )

Select not selected features and deselect selected ones.

Definition at line 481 of file qgsvectorlayer.cpp.

void QgsVectorLayer::invertSelectionInRectangle ( QgsRectangle rect)

Invert selection of features found within the search rectangle (in layer's coordinates)

Parameters
rectThe rectangle in which the selection of features will be inverted
See also
invertSelection()

Definition at line 510 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::isEditable ( ) const
overridevirtual

Returns true if the provider is in editing mode.

Reimplemented from QgsMapLayer.

Definition at line 2742 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::isModified ( ) const
virtual

Returns true if the provider has been modified since the last commit.

Definition at line 2767 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::isReadOnly ( ) const
overridevirtual

Returns true if the provider is in read-only mode.

Deprecated:
Use readOnly() instead. Will be made private with QGIS 3

TODO QGIS3: make private

Reimplemented from QgsMapLayer.

Definition at line 2752 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::isSpatial ( ) const
overridevirtual

Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it.

Note
added in QGIS 2.16

Reimplemented from QgsMapLayer.

Definition at line 2747 of file qgsvectorlayer.cpp.

QgsLabel * QgsVectorLayer::label ( )

Get the label rendering properties associated with this layer.

Definition at line 1402 of file qgsvectorlayer.cpp.

const QgsLabel * QgsVectorLayer::label ( ) const

Get the label rendering properties associated with this layer.

Note
not available in python bindings

Definition at line 1407 of file qgsvectorlayer.cpp.

const QgsAbstractVectorLayerLabeling* QgsVectorLayer::labeling ( ) const
inline

Access to labeling configuration.

Note
added in 2.12
not available in Python bindings

Definition at line 1102 of file qgsvectorlayer.h.

void QgsVectorLayer::labelingFontNotFound ( QgsVectorLayer layer,
const QString fontfamily 
)
signal

Emitted when the font family defined for labeling layer is not found on system.

Q_DECL_DEPRECATED bool QgsVectorLayer::labelOnTop ( int  idx)
inline

Label widget on top.

Deprecated:
Use editFormConfig()->labelOnTop() instead

Definition at line 1579 of file qgsvectorlayer.h.

bool QgsVectorLayer::labelsEnabled ( ) const

Returns whether the layer contains labels which are enabled and should be drawn.

Returns
true if layer contains enabled labels
Note
added in QGIS 2.9

Definition at line 665 of file qgsvectorlayer.cpp.

void QgsVectorLayer::layerDeleted ( )
signal

TODO QGIS3: remove in favor of QObject::destroyed.

QSet< QString > QgsVectorLayer::layerDependencies ( ) const
virtual

Get the list of layer ids on which this layer depends.

This in particular determines the order of layer loading.

Definition at line 4108 of file qgsvectorlayer.cpp.

void QgsVectorLayer::layerModified ( )
signal

This signal is emitted when modifications has been done on layer.

int QgsVectorLayer::layerTransparency ( ) const

Returns the current transparency for the vector layer.

Read transparency for layer.

Definition at line 3354 of file qgsvectorlayer.cpp.

void QgsVectorLayer::layerTransparencyChanged ( int  layerTransparency)
signal

Signal emitted when setLayerTransparency() is called.

int QgsVectorLayer::listStylesInDatabase ( QStringList ids,
QStringList names,
QStringList descriptions,
QString msgError 
)
virtual

Lists all the style in db split into related to the layer and not related to.

Parameters
idsthe list in which will be stored the style db ids
namesthe list in which will be stored the style names
descriptionsthe list in which will be stored the style descriptions
msgError
Returns
the number of styles related to current layer

Definition at line 3967 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::loadNamedStyle ( const QString theURI,
bool &  theResultFlag,
bool  loadFromLocalDb 
)
virtual

Load a named style from file/local db/datasource db.

Parameters
theURIthe URI of the style or the URI of the layer
theResultFlagwill be set to true if a named style is correctly loaded
loadFromLocalDbif true forces to load from local db instead of datasource one

Definition at line 4057 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::loadNamedStyle ( const QString theURI,
bool &  theResultFlag 
)
overridevirtual

Calls loadNamedStyle( theURI, theResultFlag, false ); Retained for backward compatibility.

Reimplemented from QgsMapLayer.

Definition at line 4052 of file qgsvectorlayer.cpp.

QVariant QgsVectorLayer::maximumValue ( int  index)

Returns maximum value for an attribute column or invalid variant in case of error.

Definition at line 3174 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::metadata ( )
overridevirtual

Obtain Metadata for this layer.

Reimplemented from QgsMapLayer.

Definition at line 3613 of file qgsvectorlayer.cpp.

QVariant QgsVectorLayer::minimumValue ( int  index)

Returns minimum value for an attribute column or invalid variant in case of error.

Definition at line 3108 of file qgsvectorlayer.cpp.

void QgsVectorLayer::modifySelection ( QgsFeatureIds  selectIds,
QgsFeatureIds  deselectIds 
)

Modifies the current selection on this layer.

Parameters
selectIdsSelect these ids
deselectIdsDeselect these ids
See also
select(QgsFeatureIds)
select(QgsFeatureId)
deselect(QgsFeatureIds)
deselect(QgsFeatureId)

Definition at line 467 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::moveVertex ( double  x,
double  y,
QgsFeatureId  atFeatureId,
int  atVertex 
)

Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.

Definition at line 1088 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::moveVertex ( const QgsPointV2 p,
QgsFeatureId  atFeatureId,
int  atVertex 
)

Moves the vertex at the given position number, ring and item (first number is index 0), and feature to the given coordinates.

Note
available in python as moveVertexV2

Definition at line 1101 of file qgsvectorlayer.cpp.

QgsAttributeList QgsVectorLayer::pendingAllAttributesList ( ) const
inline

Returns list of attribute indexes.

i.e. a list from 0 ... fieldCount() Alias for attributeList()

Definition at line 1189 of file qgsvectorlayer.h.

long QgsVectorLayer::pendingFeatureCount ( ) const
inline

Returns feature count including changes which have not yet been committed Alias for featureCount().

Definition at line 1210 of file qgsvectorlayer.h.

QgsFields QgsVectorLayer::pendingFields ( ) const
inline

Returns the list of fields of this layer.

This also includes fields which have not yet been saved to the provider. Alias for fields()

Returns
A list of fields

Definition at line 1183 of file qgsvectorlayer.h.

QgsAttributeList QgsVectorLayer::pendingPkAttributesList ( ) const
inline

Returns list of attributes making up the primary key Alias for pkAttributeList().

Definition at line 1201 of file qgsvectorlayer.h.

QgsAttributeList QgsVectorLayer::pkAttributeList ( ) const

Returns list of attributes making up the primary key.

Definition at line 2359 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::providerType ( ) const

Return the provider type for this layer.

Definition at line 228 of file qgsvectorlayer.cpp.

void QgsVectorLayer::raiseError ( const QString msg)
signal

Signals an error related to this vector layer.

QgsVectorLayer::RangeData QgsVectorLayer::range ( int  idx)

Access range widget config data.

Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 2810 of file qgsvectorlayer.cpp.

void QgsVectorLayer::readCustomSymbology ( const QDomElement element,
QString errorMessage 
)
signal

Signal emitted whenever the symbology (QML-file) for this layer is being read.

If there is custom style information saved in the file, you can connect to this signal and update the layer style accordingly.

Parameters
elementThe XML layer style element.
errorMessageWrite error messages into this string.
bool QgsVectorLayer::readSld ( const QDomNode node,
QString errorMessage 
)
overridevirtual

Reimplemented from QgsMapLayer.

Definition at line 2164 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::readSymbology ( const QDomNode node,
QString errorMessage 
)
overridevirtual

Read the symbology for the current layer from the Dom node supplied.

Parameters
nodenode that will contain the symbology definition for this layer.
errorMessagereference to string that will be updated with any error messages
Returns
true in case of success.

Implements QgsMapLayer.

Definition at line 1793 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::readXml ( const QDomNode layer_node)
overridevirtual

Reads vector layer specific state from project file Dom node.

Note
Called by QgsMapLayer::readXML().

Reimplemented from QgsMapLayer.

Definition at line 1498 of file qgsvectorlayer.cpp.

QList< QgsRelation > QgsVectorLayer::referencingRelations ( int  idx)

Get relations, where the foreign key is on this layer.

Parameters
idxOnly get relations, where idx forms part of the foreign key
Returns
A list of relations

Definition at line 3909 of file qgsvectorlayer.cpp.

void QgsVectorLayer::reload ( )
overridevirtual

Synchronises with changes in the datasource.

Reimplemented from QgsMapLayer.

Definition at line 375 of file qgsvectorlayer.cpp.

void QgsVectorLayer::remAttributeAlias ( int  attIndex)

Removes an alias (a display name) for attributes to display in dialogs.

Definition at line 2244 of file qgsvectorlayer.cpp.

void QgsVectorLayer::removeExpressionField ( int  index)

Remove an expression field.

Parameters
indexThe index of the field
Note
added in 2.6

Definition at line 2956 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::removeJoin ( const QString joinLayerId)

Removes a vector layer join.

Returns
true if join was found and successfully removed

Definition at line 2928 of file qgsvectorlayer.cpp.

int QgsVectorLayer::removePolygonIntersections ( QgsGeometry geom,
const QgsFeatureIds ignoreFeatures = QgsFeatureIds() 
)

Changes the specified geometry such that it has no intersections with other polygon (or multipolygon) geometries in this vector layer.

Parameters
geomgeometry to modify
ignoreFeatureslist of feature ids where intersections should be ignored
Returns
0 in case of success
Deprecated:
since 2.2 - not being used for "avoid intersections" functionality anymore

Definition at line 1340 of file qgsvectorlayer.cpp.

void QgsVectorLayer::removeSelection ( )
slot

Clear selection.

See also
setSelectedFeatures(const QgsFeatureIds&)

Definition at line 539 of file qgsvectorlayer.cpp.

QgsFeatureRendererV2* QgsVectorLayer::rendererV2 ( )
inline

Return renderer V2.

Definition at line 755 of file qgsvectorlayer.h.

const QgsFeatureRendererV2* QgsVectorLayer::rendererV2 ( ) const
inline

Return const renderer V2.

Note
not available in python bindings

Definition at line 760 of file qgsvectorlayer.h.

bool QgsVectorLayer::rollBack ( bool  deleteBuffer = true)

Stop editing and discard the edits.

Parameters
deleteBufferwhether to delete editing buffer

Definition at line 2430 of file qgsvectorlayer.cpp.

void QgsVectorLayer::saveLayerToProject ( )
signal
void QgsVectorLayer::saveStyleToDatabase ( const QString name,
const QString description,
bool  useAsDefault,
const QString uiFileContent,
QString msgError 
)
virtual

Save named and sld style of the layer to the style table in the db.

Parameters
name
description
useAsDefault
uiFileContent
msgError

Definition at line 4010 of file qgsvectorlayer.cpp.

void QgsVectorLayer::select ( QgsRectangle rect,
bool  addToSelection 
)

Select features found within the search rectangle (in layer's coordinates)

Parameters
rectThe search rectangle
addToSelectionIf set to true will not clear before selecting
See also
invertSelectionInRectangle(QgsRectangle & rect)

Definition at line 438 of file qgsvectorlayer.cpp.

void QgsVectorLayer::select ( QgsFeatureId  featureId)
slot

Select feature by its ID.

Parameters
featureIdThe id of the feature to select
See also
select(QgsFeatureIds)

Definition at line 410 of file qgsvectorlayer.cpp.

void QgsVectorLayer::select ( const QgsFeatureIds featureIds)
slot

Select features by their ID.

Parameters
featureIdsThe ids of the features to select
See also
select(QgsFeatureId)

Definition at line 417 of file qgsvectorlayer.cpp.

void QgsVectorLayer::selectAll ( )

Select all the features.

Definition at line 488 of file qgsvectorlayer.cpp.

int QgsVectorLayer::selectedFeatureCount ( )

The number of features that are selected in this layer.

Returns
See description

Definition at line 2483 of file qgsvectorlayer.cpp.

QgsFeatureList QgsVectorLayer::selectedFeatures ( )

Get a copy of the user-selected features.

Returns
A list of QgsFeature 's
See also
selectedFeaturesIds()
selectedFeaturesIterator() which is more memory friendly when handling large selections

Definition at line 2493 of file qgsvectorlayer.cpp.

const QgsFeatureIds & QgsVectorLayer::selectedFeaturesIds ( ) const

Return reference to identifiers of selected features.

Returns
A list of QgsFeatureId 's
See also
selectedFeatures()

Definition at line 2488 of file qgsvectorlayer.cpp.

QgsFeatureIterator QgsVectorLayer::selectedFeaturesIterator ( QgsFeatureRequest  request = QgsFeatureRequest())

Get an iterator of the selected features.

Parameters
requestYou may specify a request, e.g. to limit the set of requested attributes. Any filter on the request will be discarded.
Returns
Iterator over the selected features
See also
selectedFeaturesIds()
selectedFeatures()

Definition at line 2521 of file qgsvectorlayer.cpp.

void QgsVectorLayer::selectionChanged ( const QgsFeatureIds selected,
const QgsFeatureIds deselected,
const bool  clearAndSelect 
)
signal

This signal is emitted when selection was changed.

Parameters
selectedNewly selected feature ids
deselectedIds of all features which have previously been selected but are not any more
clearAndSelectIn case this is set to true, the old selection was dismissed and the new selection corresponds to selected
void QgsVectorLayer::selectionChanged ( )
signal

This signal is emitted when selection was changed.

void QgsVectorLayer::setAnnotationForm ( const QString ui)

Set annotation form for layer.

Definition at line 2798 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setAttributeTableConfig ( const QgsAttributeTableConfig attributeTableConfig)

Set the attribute table configuration object.

This defines the appearance of the attribute table.

Definition at line 3601 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setCheckedState ( int  idx,
const QString checked,
const QString notChecked 
)

Set string representing 'true' for a checkbox.

Deprecated:

Use

Use editFormConfig()->setWidgetConfig() instead

Definition at line 2903 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setCoordinateSystem ( )

Setup the coordinate system transformation for the layer.

Definition at line 2706 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setDataSource ( const QString dataSource,
const QString baseName,
const QString provider,
bool  loadDefaultStyleFlag = false 
)

Update the data source of the layer.

The layer's renderer and legend will be preserved only if the geometry type of the new data source matches the current geometry type of the layer.

Parameters
dataSourcenew layer data source
baseNamebase name of the layer
providerprovider string
loadDefaultStyleFlagset to true to reset the layer's style to the default for the data source
Note
added in QGIS 2.10

Definition at line 1592 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setDiagramLayerSettings ( const QgsDiagramLayerSettings s)

Definition at line 3606 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setDiagramRenderer ( QgsDiagramRendererV2 r)

Sets diagram rendering object (takes ownership)

Definition at line 566 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setDisplayExpression ( const QString displayExpression)

Set the preview expression, used to create a human readable preview string.

Used e.g. in the attribute table feature list. Uses QgsExpression.

Parameters
displayExpressionThe expression which will be used to preview features for this layer

Definition at line 2732 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setDisplayField ( const QString fldName = "")

Set the primary display field to be used in the identify results dialog.

sets the preferred display field based on some fuzzy logic

Definition at line 236 of file qgsvectorlayer.cpp.

Q_DECL_DEPRECATED void QgsVectorLayer::setEditForm ( const QString ui)
inline

Set edit form.

Deprecated:
Use editFormConfig()->setUiForm() instead

Definition at line 1496 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED void QgsVectorLayer::setEditFormInit ( const QString function)
inline

Set python function for edit form initialization.

Deprecated:
Use editFormConfig()->setInitFunction() instead

Definition at line 1528 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED void QgsVectorLayer::setEditorLayout ( EditorLayout  editorLayout)
inline

Set the active layout for the attribute editor for this layer.

Deprecated:
Use editFormConfig()->setLayout() instead

Definition at line 1425 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED void QgsVectorLayer::setEditorWidgetV2 ( int  attrIdx,
const QString widgetType 
)
inline

Set the editor widget type for a field.

QGIS ships the following widget types, additional types may be available depending on plugins.

Parameters
attrIdxIndex of the field
widgetTypeType id of the editor widget to use
Deprecated:
Use editFormConfig()->setWidgetType() instead

Definition at line 1457 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED void QgsVectorLayer::setEditorWidgetV2Config ( int  attrIdx,
const QgsEditorWidgetConfig config 
)
inline

Set the editor widget config for a field.

Python: Will accept a map.

Example:

1 layer.setEditorWidgetV2Config( 1, { 'Layer': 'otherlayerid_1234', 'Key': 'Keyfield', 'Value': 'ValueField' } )
Parameters
attrIdxIndex of the field
configThe config to set for this field
See also
setEditorWidgetV2() for a list of widgets and choose the widget to see the available options.
Deprecated:
Use editFormConfig()->setWidgetConfig() instead

Definition at line 1476 of file qgsvectorlayer.h.

void QgsVectorLayer::setEditType ( int  idx,
EditType  edit 
)

Set edit type.

Deprecated:
Use editFormConfig()->setWidgetType() instead

Definition at line 2783 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setExcludeAttributesWFS ( const QSet< QString > &  att)
inline

Definition at line 1349 of file qgsvectorlayer.h.

void QgsVectorLayer::setExcludeAttributesWMS ( const QSet< QString > &  att)
inline

Definition at line 1346 of file qgsvectorlayer.h.

void QgsVectorLayer::setExtent ( const QgsRectangle rect)
overrideprotectedvirtual

Set the extent.

Reimplemented from QgsMapLayer.

Definition at line 864 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setFeatureBlendMode ( QPainter::CompositionMode  blendMode)

Set the blending mode used for rendering each feature.

Write blend mode for features.

Definition at line 3334 of file qgsvectorlayer.cpp.

Q_DECL_DEPRECATED void QgsVectorLayer::setFeatureFormSuppress ( QgsVectorLayer::FeatureFormSuppress  s)
inline

Set type of feature form pop-up suppression after feature creation (overrides app setting)

Note
added in 2.1
Deprecated:
Use editFormConfig()->setSuppress() instead

Definition at line 1508 of file qgsvectorlayer.h.

Q_DECL_DEPRECATED void QgsVectorLayer::setFieldEditable ( int  idx,
bool  editable 
)
inline

Set edit widget editable.

Deprecated:
Use editFormConfig()->setFieldEditable() instead

Definition at line 1585 of file qgsvectorlayer.h.

void QgsVectorLayer::setLabeling ( QgsAbstractVectorLayerLabeling labeling)

Set labeling configuration.

Takes ownership of the object.

Note
added in 2.12
not available in Python bindings

Definition at line 1422 of file qgsvectorlayer.cpp.

Q_DECL_DEPRECATED void QgsVectorLayer::setLabelOnTop ( int  idx,
bool  onTop 
)
inline

Label widget on top.

Deprecated:
Use editFormConfig()->setLabelOnTop() instead

Definition at line 1591 of file qgsvectorlayer.h.

void QgsVectorLayer::setLayerTransparency ( int  layerTransparency)

Set the transparency for the vector layer.

Write transparency for layer.

Definition at line 3347 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setProviderEncoding ( const QString encoding)

Sets the textencoding of the data provider.

Definition at line 557 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::setReadOnly ( bool  readonly = true)

Make layer read-only (editing disabled) or not.

Returns
false if the layer is in editing yet

Definition at line 2757 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setRendererV2 ( QgsFeatureRendererV2 r)

Set renderer which will be invoked to represent this layer.

Ownership is transferred.

Definition at line 2837 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setSelectedFeatures ( const QgsFeatureIds ids)

Change selection to the new set of features.

Dismisses the current selection. Will emit the selectionChanged( const QgsFeatureIds&, const QgsFeatureIds&qt_check_for_QOBJECT_macro, bool ) signal with the clearAndSelect flag set.

Parameters
idsThe ids which will be the new selection

Definition at line 2474 of file qgsvectorlayer.cpp.

void QgsVectorLayer::setSimplifyMethod ( const QgsVectorSimplifyMethod simplifyMethod)
inline

Set the simplification settings for fast rendering of features.

Note
added in 2.2

Definition at line 1681 of file qgsvectorlayer.h.

bool QgsVectorLayer::setSubsetString ( const QString subset)
virtual

Set the string (typically sql) used to define a subset of the layer.

Parameters
subsetThe subset string. This may be the where clause of a sql statement or other defintion string specific to the underlying dataprovider and data store.
Returns
true, when setting the subset string was successful, false otherwise

Definition at line 968 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::simplifyDrawingCanbeApplied ( const QgsRenderContext renderContext,
QgsVectorSimplifyMethod::SimplifyHint  simplifyHint 
) const

Returns whether the VectorLayer can apply the specified simplification hint.

Note
Do not use in 3rd party code - may be removed in future version!
added in 2.2

Definition at line 988 of file qgsvectorlayer.cpp.

const QgsVectorSimplifyMethod& QgsVectorLayer::simplifyMethod ( ) const
inline

Returns the simplification settings for fast rendering of features.

Note
added in 2.2

Definition at line 1685 of file qgsvectorlayer.h.

bool QgsVectorLayer::snapPoint ( QgsPoint point,
double  tolerance 
)

Snaps a point to the closest vertex if there is one within the snapping tolerance.

Parameters
pointThe point which is set to the position of a vertex if there is one within the snapping tolerance. If there is no point within this tolerance, point is left unchanged.
toleranceThe snapping tolerance
Returns
true if the point has been snapped, false if no vertex within search tolerance

Definition at line 2560 of file qgsvectorlayer.cpp.

int QgsVectorLayer::snapWithContext ( const QgsPoint startPoint,
double  snappingTolerance,
QMultiMap< double, QgsSnappingResult > &  snappingResults,
QgsSnapper::SnappingType  snap_to 
)

Snaps to segment or vertex within given tolerance.

Parameters
startPointpoint to snap (in layer coordinates)
snappingTolerancedistance tolerance for snapping
snappingResultssnapping results. Key is the distance between startPoint and snapping target
snap_toto segment / to vertex
Returns
0 in case of success

Definition at line 2585 of file qgsvectorlayer.cpp.

int QgsVectorLayer::splitFeatures ( const QList< QgsPoint > &  splitLine,
bool  topologicalEditing = false 
)

Splits features cut by the given line.

Parameters
splitLineline that splits the layer features
topologicalEditingtrue if topological editing is enabled
Returns
0 in case of success, 4 if there is a selection but no feature split

Definition at line 1331 of file qgsvectorlayer.cpp.

int QgsVectorLayer::splitParts ( const QList< QgsPoint > &  splitLine,
bool  topologicalEditing = false 
)

Splits parts cut by the given line.

Parameters
splitLineline that splits the layer features
topologicalEditingtrue if topological editing is enabled
Returns
0 in case of success, 4 if there is a selection but no feature split

Definition at line 1322 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::startEditing ( )
slot

Make layer editable.

This starts an edit session on this layer. Changes made in this edit session will not be made persistent until commitChanges() is called and can be reverted by calling rollBack().

Definition at line 1431 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::storageType ( ) const

Returns the permanent storage type for this layer as a friendly name.

Definition at line 199 of file qgsvectorlayer.cpp.

QString QgsVectorLayer::subsetString ( )
virtual

Get the string (typically sql) used to define a subset of the layer.

Returns
The subset string or QString::null if not implemented by the provider

Definition at line 958 of file qgsvectorlayer.cpp.

int QgsVectorLayer::translateFeature ( QgsFeatureId  featureId,
double  dx,
double  dy 
)

Translates feature by dx, dy.

Parameters
featureIdid of the feature to translate
dxtranslation of x-coordinate
dytranslation of y-coordinate
Returns
0 in case of success

Definition at line 1309 of file qgsvectorlayer.cpp.

void QgsVectorLayer::uniqueValues ( int  index,
QList< QVariant > &  uniqueValues,
int  limit = -1 
)

Returns unique values for column.

Parameters
indexcolumn index for attribute
uniqueValuesout: result list
limitmaximum number of values to return (-1 if unlimited)

Definition at line 3013 of file qgsvectorlayer.cpp.

void QgsVectorLayer::updatedFields ( )
signal

Is emitted, whenever the fields available from this layer have been changed.

This can be due to manually adding attributes or due to a join.

void QgsVectorLayer::updateExpressionField ( int  index,
const QString exp 
)

Changes the expression used to define an expression based (virtual) field.

Parameters
indexThe index of the expression to change
expThe new expression to set
Note
added in 2.9

Definition at line 2971 of file qgsvectorlayer.cpp.

void QgsVectorLayer::updateExtents ( )
virtualslot

Update the extents for the layer.

This is necessary if features are added/deleted or the layer has been subsetted.

Definition at line 859 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::updateFeature ( QgsFeature f)

Updates an existing feature.

This method needs to query the datasource on every call. Consider using changeAttributeValue() or changeGeometry() instead.

Parameters
fFeature to update
Returns
True in case of success and False in case of error

Definition at line 1031 of file qgsvectorlayer.cpp.

void QgsVectorLayer::updateFields ( )

Assembles mUpdatedFields considering provider fields, joined fields and added fields.

Definition at line 2977 of file qgsvectorlayer.cpp.

QMap< QString, QVariant > QgsVectorLayer::valueMap ( int  idx)

Access value map.

Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 2803 of file qgsvectorlayer.cpp.

QgsVectorLayer::ValueRelationData QgsVectorLayer::valueRelation ( int  idx)

Access value relation widget data.

Definition at line 3888 of file qgsvectorlayer.cpp.

const QList< QgsVectorJoinInfo > QgsVectorLayer::vectorJoins ( ) const

Definition at line 2938 of file qgsvectorlayer.cpp.

QSize QgsVectorLayer::widgetSize ( int  idx)

Access widget size for photo and webview widget.

Deprecated:
Use editFormConfig()->widgetConfig() instead

Definition at line 2829 of file qgsvectorlayer.cpp.

QGis::WkbType QgsVectorLayer::wkbType ( ) const

Returns the WKBType or WKBUnknown in case of error.

Definition at line 601 of file qgsvectorlayer.cpp.

void QgsVectorLayer::writeCustomSymbology ( QDomElement element,
QDomDocument doc,
QString errorMessage 
) const
signal

Signal emitted whenever the symbology (QML-file) for this layer is being written.

If there is custom style information you want to save to the file, you can connect to this signal and update the element accordingly.

Parameters
elementThe XML element where you can add additional style information to.
docThe XML document that you can use to create new XML nodes.
errorMessageWrite error messages into this string.
bool QgsVectorLayer::writeSld ( QDomNode node,
QDomDocument doc,
QString errorMessage 
) const

Definition at line 2188 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::writeSymbology ( QDomNode node,
QDomDocument doc,
QString errorMessage 
) const
overridevirtual

Write the symbology for the layer into the docment provided.

Parameters
nodethe node that will have the style element added to it.
docthe document that will have the QDomNode added.
errorMessagereference to string that will be updated with any error messages
Returns
true in case of success.

Implements QgsMapLayer.

Definition at line 1996 of file qgsvectorlayer.cpp.

bool QgsVectorLayer::writeXml ( QDomNode layer_node,
QDomDocument doc 
)
overridevirtual

Write vector layer specific state to project file Dom node.

Note
Called by QgsMapLayer::writeXML().

Reimplemented from QgsMapLayer.

Definition at line 1732 of file qgsvectorlayer.cpp.

Friends And Related Function Documentation

friend class QgsVectorLayerEditBuffer
friend

Definition at line 2088 of file qgsvectorlayer.h.

friend class QgsVectorLayerFeatureSource
friend

Definition at line 2118 of file qgsvectorlayer.h.


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