qgsmaptooledit.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaptooledit.h  -  base class for editing map tools
    ---------------------
    begin                : Juli 2007
    copyright            : (C) 2007 by Marco Hugentobler
    email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMAPTOOLEDIT_H
#define QGSMAPTOOLEDIT_H
 
#include "qgis_gui.h"
#include "qgsmaptool.h"
#include "qgswkbtypes.h"
 
class QgsRubberBand;
class QgsGeometryRubberBand;
class QgsVectorLayer;
class QKeyEvent;

class GUI_EXPORT QgsMapToolEdit : public QgsMapTool
{
    Q_OBJECT
 
  public:
    QgsMapToolEdit( QgsMapCanvas *canvas );
 
    Flags flags() const override { return QgsMapTool::EditTool; }

    static double defaultZValue();

    static double defaultMValue();

    QgsGeometryRubberBand *createGeometryRubberBand( Qgis::GeometryType geometryType = Qgis::GeometryType::Line, bool alternativeBand = false ) const SIP_FACTORY;
 
  private slots:
    void connectLayers( const QList<QgsMapLayer *> &layers );

    void cleanCanvas();
 
  protected:
    static QColor digitizingStrokeColor();
    static int digitizingStrokeWidth();
    static QColor digitizingFillColor();

    QgsRubberBand *createRubberBand( Qgis::GeometryType geometryType = Qgis::GeometryType::Line, bool alternativeBand = false ) SIP_FACTORY;

    QgsRubberBand *createRubberBandForLayer( QgsVectorLayer *layer = nullptr, const QList< QgsFeatureId > &fids = QList< QgsFeatureId >(), bool alternativeBand = false ) SIP_FACTORY;

    void prepareRubberBandForLayer( QgsRubberBand *rubberBand, QgsVectorLayer *layer = nullptr, const QList< QgsFeatureId > &fids = QList< QgsFeatureId >() );

    QgsVectorLayer *currentVectorLayer();

    enum TopologicalResult
    {
      Success = 0,       
      InvalidCanvas = 1, 
      InvalidLayer = 2,  
    };

    Q_DECL_DEPRECATED TopologicalResult addTopologicalPoints( const QVector<QgsPointXY> &vertices ) SIP_DEPRECATED;

    TopologicalResult addTopologicalPoints( const QVector<QgsPoint> &vertices );

    void notifyNotVectorLayer();
    void notifyNotEditableLayer();
 
  private:
    QList<QgsVectorLayer *> editableVectorLayers();
};
 
#endif