qgssublayersdialog.h

Go to the documentation of this file.

/***************************************************************************
    qgssublayersdialog.h  - dialog for selecting sublayers
    ---------------------
    begin                : January 2009
    copyright            : (C) 2009 by Florian El Ahdab
    email                : felahdab at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSSUBLAYERSDIALOG_H
#define QGSSUBLAYERSDIALOG_H
 
#include "ui_qgssublayersdialogbase.h"
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QCheckBox>
#include <QDialog>

class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDialogBase
{
    Q_OBJECT
  public:
    enum PromptMode
    {

      PromptAlways,

      PromptIfNeeded,

      PromptNever,

      PromptLoadAll
    };
    Q_ENUM( PromptMode )
 
    enum ProviderType
    {
      Ogr,
      Gdal,
      Vsifile,
      Mdal 
    };

    struct LayerDefinition
    {
        int layerId = -1;

        QString layerName;

        int count = -1;

        QString type;

        QString description;
    };

    typedef QList<QgsSublayersDialog::LayerDefinition> LayerDefinitionList;


    Q_DECL_DEPRECATED QgsSublayersDialog(
      ProviderType providerType, const QString &name, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = Qt::WindowFlags(), const QString &dataSourceUri = QString()
    ) SIP_DEPRECATED;
 
    ~QgsSublayersDialog() override;

    void populateLayerTable( const LayerDefinitionList &list );

    LayerDefinitionList selection();

    void setShowAddToGroupCheckbox( bool showAddToGroupCheckbox ) { mShowAddToGroupCheckbox = showAddToGroupCheckbox; }

    bool showAddToGroupCheckbox() const { return mShowAddToGroupCheckbox; }

    bool addToGroupCheckbox() const { return mCbxAddToGroup->isChecked(); }

    int countColumn() const { return mShowCount ? 2 : -1; }
 
  public slots:
    int exec() override;
 
  private slots:
    void layersTable_selectionChanged( const QItemSelection &, const QItemSelection & );
    void mBtnDeselectAll_pressed();
 
  protected:
    QString mName;
    QStringList mSelectedSubLayers;

    bool mShowCount = false;
    bool mShowType = false;
    bool mShowDescription = false;
 
  private:
    bool mShowAddToGroupCheckbox = false;
};
 
#endif