qgslayoutmapwidget.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutmapwidget.h
                         ----------------------
    begin                : October 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 QGSLAYOUTMAPWIDGET_H
#define QGSLAYOUTMAPWIDGET_H
 
// We don't want to expose this in the public API
 
#include "ui_qgslayoutmapclippingwidgetbase.h"
#include "ui_qgslayoutmaplabelingwidgetbase.h"
#include "ui_qgslayoutmapwidgetbase.h"
 
#include "qgis_gui.h"
#include "qgslayoutitemmapgrid.h"
#include "qgslayoutitemwidget.h"
 
#define SIP_NO_FILE
 
class QgsMapLayer;
class QgsLayoutItemMap;
class QgsLayoutItemMapOverview;
class QgsLayoutMapLabelingWidget;
class QgsLayoutMapClippingWidget;
class QgsBookmarkManagerProxyModel;
class QgsReferencedRectangle;

class GUI_EXPORT QgsLayoutMapWidget : public QgsLayoutItemBaseWidget, private Ui::QgsLayoutMapWidgetBase
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutMapWidget( QgsLayoutItemMap *item, QgsMapCanvas *mapCanvas );
    void setMasterLayout( QgsMasterLayoutInterface *masterLayout ) override;
 
    void setReportTypeString( const QString &string ) override;
    void setDesignerInterface( QgsLayoutDesignerInterface *iface ) override;
 
  private slots:
    void mScaleLineEdit_editingFinished();
    void setToMapCanvasExtent();
    void setToMapCanvasScale();
    void viewExtentInCanvas();
    void viewScaleInCanvas();
    void updatePreview();
    void mFollowVisibilityPresetCheckBox_stateChanged( int state );
    void mKeepLayerListCheckBox_stateChanged( int state );
    void mKeepLayerStylesCheckBox_stateChanged( int state );
    void mDrawCanvasItemsCheckBox_stateChanged( int state );
    void overviewMapChanged( QgsLayoutItem *item );
    void mOverviewBlendModeComboBox_currentIndexChanged( int index );
    void mOverviewInvertCheckbox_toggled( bool state );
    void mOverviewCenterCheckbox_toggled( bool state );
    void overviewStackingChanged( int value );
    void overviewStackingLayerChanged( QgsMapLayer *layer );
 
    void mXMinLineEdit_editingFinished();
    void mXMaxLineEdit_editingFinished();
    void mYMinLineEdit_editingFinished();
    void mYMaxLineEdit_editingFinished();
 
    void mAtlasMarginRadio_toggled( bool checked );
 
    void mAtlasCheckBox_toggled( bool checked );
    void mAtlasMarginSpinBox_valueChanged( int value );
    void mAtlasFixedScaleRadio_toggled( bool checked );
    void mAtlasPredefinedScaleRadio_toggled( bool checked );
 
    void mAddGridPushButton_clicked();
    void mRemoveGridPushButton_clicked();
    void mCopyGridPushButton_clicked();
    void mGridUpButton_clicked();
    void mGridDownButton_clicked();
 
    QgsLayoutItemMapGrid *currentGrid();
    void mGridListWidget_currentItemChanged( QListWidgetItem *current, QListWidgetItem *previous );
    void mGridListWidget_itemChanged( QListWidgetItem *item );
    void mGridPropertiesButton_clicked();
 
    //overviews
    void mAddOverviewPushButton_clicked();
    void mRemoveOverviewPushButton_clicked();
    void mOverviewUpButton_clicked();
    void mOverviewDownButton_clicked();
    QgsLayoutItemMapOverview *currentOverview();
    void mOverviewCheckBox_toggled( bool state );
    void mOverviewListWidget_currentItemChanged( QListWidgetItem *current, QListWidgetItem *previous );
    void mOverviewListWidget_itemChanged( QListWidgetItem *item );
    void setOverviewItemsEnabled( bool enabled );
    void setOverviewItems( QgsLayoutItemMapOverview *overview );
    void blockOverviewItemsSignals( bool block );
 
    void mTemporalCheckBox_toggled( bool checked );
    void updateTemporalExtent();
 
    void mElevationRangeCheckBox_toggled( bool checked );
    void updateZRange();
 
  protected:
    bool setNewItem( QgsLayoutItem *item ) override;
 
  protected slots:
    void populateDataDefinedButtons();
 
  private slots:

    void updateGuiElements();

    void atlasLayerChanged( QgsVectorLayer *layer );

    void compositionAtlasToggled( bool atlasEnabled );
 
    void aboutToShowKeepLayersVisibilityPresetsMenu();
 
    void followVisibilityPresetSelected( int currentIndex );
    void keepLayersVisibilityPresetSelected();
 
    void onMapThemesChanged();
 
    void mapCrsChanged( const QgsCoordinateReferenceSystem &crs );
    void overviewSymbolChanged();
    void showLabelSettings();
    void showClipSettings();
    void switchToMoveContentTool();
    void aboutToShowLayersMenu();
    void aboutToShowBookmarkMenu();
 
  private:
    QPointer<QgsLayoutItemMap> mMapItem;
    QgsMapCanvas *mMapCanvas = nullptr;
    QgsLayoutItemPropertiesWidget *mItemPropertiesWidget = nullptr;
    QgsLayoutDesignerInterface *mInterface = nullptr;
    QPointer<QgsLayoutMapLabelingWidget> mLabelWidget;
    QPointer<QgsLayoutMapClippingWidget> mClipWidget;
    QMenu *mLayersMenu = nullptr;
    QMenu *mBookmarkMenu = nullptr;
    QgsMapLayerProxyModel *mMapLayerModel = nullptr;
    QgsBookmarkManagerProxyModel *mBookmarkModel = nullptr;
    QString mReportTypeString;
    int mBlockThemeComboChanges = 0;

    void updateComposerExtentFromGui();

    void blockAllSignals( bool b );
 
    void rotationChanged( double value );

    void toggleAtlasScalingOptionsByLayerType();

    void updateMapForAtlas();

    bool hasPredefinedScales() const;
 
    QListWidgetItem *addGridListItem( const QString &id, const QString &name );
 
    void loadGridEntries();
 
    QListWidgetItem *addOverviewListItem( const QString &id, const QString &name );
 
    void loadOverviewEntries();
 
    void storeCurrentLayerSet();

    QList<QgsMapLayer *> orderedPresetVisibleLayers( const QString &name ) const;
 
    void setToCustomExtent( const QgsReferencedRectangle &extent );
};

class GUI_EXPORT QgsLayoutMapItemBlocksLabelsModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutMapItemBlocksLabelsModel( QgsLayoutItemMap *map, QgsLayoutModel *layoutModel, QObject *parent = nullptr );
 
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
 
  protected:
    bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
 
  private:
    QgsLayoutModel *mLayoutModel = nullptr;
    QPointer<QgsLayoutItemMap> mMapItem;
};

class GUI_EXPORT QgsLayoutMapLabelingWidget : public QgsLayoutItemBaseWidget, private Ui::QgsLayoutMapLabelingWidgetBase
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutMapLabelingWidget( QgsLayoutItemMap *map );
 
  protected:
    bool setNewItem( QgsLayoutItem *item ) final;
 
  private slots:
    void updateGuiElements();
    void labelMarginChanged( double val );
    void labelMarginUnitsChanged();
    void showPartialsToggled( bool checked );
    void showUnplacedToggled( bool checked );
 
  private:
    QPointer<QgsLayoutItemMap> mMapItem;
};

class GUI_EXPORT QgsLayoutMapClippingWidget : public QgsLayoutItemBaseWidget, private Ui::QgsLayoutMapClippingWidgetBase
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutMapClippingWidget( QgsLayoutItemMap *map );
 
    void setReportTypeString( const QString &string ) override;
 
  protected:
    bool setNewItem( QgsLayoutItem *item ) final;
 
  private slots:
    void updateGuiElements();
    void atlasLayerChanged( QgsVectorLayer *layer );
    void atlasToggled( bool atlasEnabled );
    void selectAll();
    void deselectAll();
    void invertSelection();
    void toggleLayersSelectionGui( bool toggled );
 
  private:
    QPointer<QgsLayoutItemMap> mMapItem;
    QgsMapLayerModel *mLayerModel = nullptr;
 
    bool mBlockUpdates = false;
};
 
#endif