qgsvectorlayersaveasdialog.h

Go to the documentation of this file.

/***************************************************************************
                          qgsvectorlayersaveasdialog.h
 Dialog to select destination, type and crs to save as ogr layers
                             -------------------
    begin                : Mon Mar 22 2010
    copyright            : (C) 2010 by Juergen E. Fischer
    email                : jef at norbit dot de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSVECTORLAYERSAVEASDIALOG_H
#define QGSVECTORLAYERSAVEASDIALOG_H
 
#include "ui_qgsvectorlayersaveasdialogbase.h"
 
#include "qgis_gui.h"
#include "qgsvectorfilewriter.h"
 
#include <QDialog>
 
class QgsVectorLayer;

class GUI_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVectorLayerSaveAsDialogBase
{
    Q_OBJECT
 
  public:
    enum class Option : int SIP_ENUM_BASETYPE( IntFlag )
    {
      Symbology = 1,           
      DestinationCrs = 1 << 2, 
      Fields = 1 << 3,         
      AddToCanvas = 1 << 4,    
      SelectedOnly = 1 << 5,   
      GeometryType = 1 << 6,   
      Extent = 1 << 7,         
      Metadata = 1 << 8,       
      AllOptions = ~0          
    };
    Q_ENUM( Option )
 
    
    Q_DECLARE_FLAGS( Options, Option )
    Q_FLAG( Options )

    Q_DECL_DEPRECATED QgsVectorLayerSaveAsDialog( long srsid, QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::WindowFlags() ) SIP_SKIP;

    QgsVectorLayerSaveAsDialog(
      QgsVectorLayer *layer, QgsVectorLayerSaveAsDialog::Options options = QgsVectorLayerSaveAsDialog::Option::AllOptions, QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::WindowFlags()
    );

    QString format() const;

    QString encoding() const;

    QString fileName() const;

    QString layerName() const;

    QStringList datasourceOptions() const;

    QStringList layerOptions() const;

    QgsCoordinateReferenceSystem crs() const;

    QgsAttributeList selectedAttributes() const;

    QgsAttributeList attributesAsDisplayedValues() const;

    QStringList attributesExportNames() const;

    bool addToCanvas() const;

    void setAddToCanvas( bool checked );

    Qgis::FeatureSymbologyExport symbologyExport() const;

    double scale() const;

    void setMapCanvas( QgsMapCanvas *canvas );

    bool hasFilterExtent() const;

    QgsRectangle filterExtent() const;

    void setOnlySelected( bool onlySelected );

    bool onlySelected() const;

    bool persistMetadata() const;

    Qgis::WkbType geometryType() const;

    bool automaticGeometryType() const;

    bool forceMulti() const;

    void setForceMulti( bool checked );

    bool includeZ() const;

    void setIncludeZ( bool checked );

    QgsVectorFileWriter::ActionOnExistingFile creationActionOnExistingFile() const;
 
    void accept() override;
 
  private slots:
 
    void mFormatComboBox_currentIndexChanged( int idx );
    void mCrsSelector_crsChanged( const QgsCoordinateReferenceSystem &crs );
    void showHelp();
    void mSymbologyExportComboBox_currentIndexChanged( const QString &text );
    void mGeometryTypeComboBox_currentIndexChanged( int index );
    void mSelectAllAttributes_clicked();
    void mDeselectAllAttributes_clicked();
    void mUseAliasesForExportedName_stateChanged( int state );
    void mReplaceRawFieldValues_stateChanged( int state );
    void mAttributeTable_itemChanged( QTableWidgetItem *item );
 
  private:
    enum class ColumnIndex : int
    {
      Name = 0,
      ExportName = 1,
      Type = 2,
      ExportAsDisplayedValue = 3
    };
 
    void setup();
    QList<QPair<QLabel *, QWidget *>> createControls( const QMap<QString, QgsVectorFileWriter::Option *> &options );
 
    QgsCoordinateReferenceSystem mSelectedCrs;
 
    QgsRectangle mLayerExtent;
    QgsCoordinateReferenceSystem mLayerCrs;
    QgsVectorLayer *mLayer = nullptr;
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsVectorFileWriter::ActionOnExistingFile mActionOnExistingFile;
    Options mOptions = Option::AllOptions;
    QString mDefaultOutputLayerNameFromInputLayerName;
    bool mAddToCanvasStateOnOpenCompatibleDriver = true;
    QHash<QString, QPair<bool, std::optional<bool>>> mFieldsState;
    QString mPreviousFormat;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsVectorLayerSaveAsDialog::Options )
 
 
#endif // QGSVECTORLAYERSAVEASDIALOG_H