qgslayoutguidecollection.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutguidecollection.h
                             --------------------------
    begin                : July 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 QGSLAYOUTGUIDECOLLECTION_H
#define QGSLAYOUTGUIDECOLLECTION_H
 
#include <memory>
 
#include "qgis_core.h"
#include "qgslayoutitempage.h"
#include "qgslayoutmeasurement.h"
#include "qgslayoutpoint.h"
#include "qgslayoutserializableobject.h"
 
#include <QAbstractListModel>
#include <QGraphicsLineItem>
#include <QPen>
#include <QSortFilterProxyModel>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsLayout;
class QgsLayoutPageCollection;
class QDomElement;
class QDomDocument;
class QgsReadWriteContext;

class CORE_EXPORT QgsLayoutGuide : public QObject
{
    Q_OBJECT
 
  public:
    QgsLayoutGuide( Qt::Orientation orientation, QgsLayoutMeasurement position, QgsLayoutItemPage *page );
 
    ~QgsLayoutGuide() override;

    QgsLayout *layout() const;

    void setLayout( QgsLayout *layout );

    Qt::Orientation orientation() const;

    QgsLayoutMeasurement position() const;

    void setPosition( QgsLayoutMeasurement position );

    QgsLayoutItemPage *page();

    void setPage( QgsLayoutItemPage *page );

    void update();

    QGraphicsLineItem *item();

    double layoutPosition() const;

    void setLayoutPosition( double position );
 
  signals:

    void positionChanged();
 
  private:
    Qt::Orientation mOrientation = Qt::Vertical;

    QgsLayoutMeasurement mPosition;

    QPointer< QgsLayoutItemPage > mPage;
 
    QPointer< QgsLayout > mLayout;

    QGraphicsLineItem *mLineItem = nullptr;
};

class CORE_EXPORT QgsLayoutGuideCollection : public QAbstractTableModel, public QgsLayoutSerializableObject
{
    Q_OBJECT
 
  public:
 
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsLayoutGuideCollection, Roles ) : int
    {
      Orientation SIP_MONKEYPATCH_COMPAT_NAME( OrientationRole ) = Qt::UserRole, 
      Position SIP_MONKEYPATCH_COMPAT_NAME( PositionRole ),                      
      Units SIP_MONKEYPATCH_COMPAT_NAME( UnitsRole ),                            
      Page SIP_MONKEYPATCH_COMPAT_NAME( PageRole ),                              
      LayoutPosition SIP_MONKEYPATCH_COMPAT_NAME( LayoutPositionRole ),          
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsLayoutGuideCollection( QgsLayout *layout, QgsLayoutPageCollection *pageCollection );
    ~QgsLayoutGuideCollection() override;
 
    QString stringType() const override { return u"LayoutGuideCollection"_s; }
    QgsLayout *layout() override;
 
    int rowCount( const QModelIndex & ) const override;
    int columnCount( const 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;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;
    bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;

    void addGuide( QgsLayoutGuide *guide SIP_TRANSFER );

    void removeGuide( QgsLayoutGuide *guide );

    void setGuideLayoutPosition( QgsLayoutGuide *guide, double position );

    void clear();

    void applyGuidesToAllOtherPages( int sourcePage );

    void update();

    QList< QgsLayoutGuide * > guides();

    QList< QgsLayoutGuide * > guides( Qt::Orientation orientation, int page = -1 );

    QList< QgsLayoutGuide * > guidesOnPage( int page );

    bool visible() const;

    void setVisible( bool visible );

    bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const override;

    bool readXml( const QDomElement &collectionElement, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private slots:
 
    void pageAboutToBeRemoved( int pageNumber );
 
  private:
    enum UndoRoles
    {
      Move = 10000,
      Remove = 20000,
    };
 
    QgsLayout *mLayout = nullptr;
    QgsLayoutPageCollection *mPageCollection = nullptr;
 
    QList< QgsLayoutGuide * > mGuides;
    int mHeaderSize = 0;
 
    bool mGuidesVisible = true;
    bool mBlockUndoCommands = false;
 
    friend class QgsLayoutGuideCollectionUndoCommand;
};
 

class CORE_EXPORT QgsLayoutGuideProxyModel : public QSortFilterProxyModel
{
    Q_OBJECT
 
  public:
    explicit QgsLayoutGuideProxyModel( QObject *parent SIP_TRANSFERTHIS, Qt::Orientation orientation, int page );

    void setPage( int page );
 
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;
    bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
 
  private:
    Qt::Orientation mOrientation = Qt::Horizontal;
    int mPage = 0;
};
 
#endif //QGSLAYOUTGUIDECOLLECTION_H