qgsmaplayercombobox.h

Go to the documentation of this file.

/***************************************************************************
   qgsmaplayercombobox.h
    --------------------------------------
   Date                 : 01.04.2014
   Copyright            : (C) 2014 Denis Rouzaud
   Email                : [email protected]
***************************************************************************
*                                                                         *
*   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 QGSMAPLAYERCOMBOBOX_H
#define QGSMAPLAYERCOMBOBOX_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsmaplayerproxymodel.h"
 
#include <QComboBox>
 
class QgsMapLayer;
class QgsVectorLayer;

class GUI_EXPORT QgsMapLayerComboBox : public QComboBox
{
    Q_OBJECT
    Q_PROPERTY( Qgis::LayerFilters filters READ filters WRITE setFilters )
    Q_PROPERTY( bool allowEmptyLayer READ allowEmptyLayer WRITE setAllowEmptyLayer )
    Q_PROPERTY( bool showCrs READ showCrs WRITE setShowCrs )
    Q_PROPERTY( QStringList excludedProviders READ excludedProviders WRITE setExcludedProviders )
 
  public:
    explicit QgsMapLayerComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setFilters( Qgis::LayerFilters filters ) { mProxyModel->setFilters( filters ); }

    Q_DECL_DEPRECATED void setFilters( int filters ) SIP_DEPRECATED { setFilters( static_cast<Qgis::LayerFilters>( filters ) ); }

    Qgis::LayerFilters filters() const { return mProxyModel->filters(); }

    void setExceptedLayerList( const QList<QgsMapLayer *> &layerList ) { mProxyModel->setExceptedLayerList( layerList ); }

    QList<QgsMapLayer *> exceptedLayerList() const { return mProxyModel->exceptedLayerList(); }

    void setExcludedProviders( const QStringList &providers );

    QStringList excludedProviders() const;

    void setProject( QgsProject *project );
 

    void setAllowEmptyLayer( bool allowEmpty, const QString &text = QString(), const QIcon &icon = QIcon() );

    bool allowEmptyLayer() const;

    void setShowCrs( bool showCrs );

    bool showCrs() const;

    void setAdditionalItems( const QStringList &items );

    QStringList additionalItems() const;

    void setAdditionalLayers( const QList<QgsMapLayer *> &layers );

    QList<QgsMapLayer *> additionalLayers() const;

    QgsMapLayer *currentLayer() const;

    QgsMapLayer *layer( int layerIndex ) const;
 
  public slots:

    void setLayer( QgsMapLayer *layer );
 
  signals:
    void layerChanged( QgsMapLayer *layer );
 
  protected:
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragLeaveEvent( QDragLeaveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
    void paintEvent( QPaintEvent *e ) override;
 
  protected slots:
    void indexChanged( int i );
    void rowsChanged();
 
  private:
    QgsMapLayerProxyModel *mProxyModel = nullptr;
    bool mDragActive = false;
    bool mHighlight = false;

    QgsMapLayer *compatibleMapLayerFromMimeData( const QMimeData *data ) const;
 
    friend class QgsProcessingMapLayerComboBox;
};
 
#endif // QGSMAPLAYERCOMBOBOX_H