qgslayoutgridsettings.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutgridsettings.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 QGSLAYOUTGRIDSETTINGS_H
#define QGSLAYOUTGRIDSETTINGS_H
 
#include "qgis_core.h"
#include "qgslayoutmeasurement.h"
#include "qgslayoutpoint.h"
#include "qgslayoutserializableobject.h"
#include "qgslayoutundocommand.h"
 
#include <QPen>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsLayout;
class QgsReadWriteContext;
class QgsSettingsEntryColor;
class QgsSettingsEntryDouble;
class QgsSettingsEntryString;

class CORE_EXPORT QgsLayoutGridSettings : public QgsLayoutSerializableObject
{
  public:
    enum Style
    {
      StyleLines,  
      StyleDots,   
      StyleCrosses 
    };

    QgsLayoutGridSettings( QgsLayout *layout );
 
    QString stringType() const override { return u"LayoutGrid"_s; }
    QgsLayout *layout() override;

    void setResolution( QgsLayoutMeasurement resolution );

    QgsLayoutMeasurement resolution() const { return mGridResolution; }

    void setOffset( const QgsLayoutPoint &offset );

    QgsLayoutPoint offset() const { return mGridOffset; }

    void setPen( const QPen &pen ) { mGridPen = pen; }

    QPen pen() const { return mGridPen; }

    void setStyle( const Style style ) { mGridStyle = style; }

    Style style() const { return mGridStyle; }

    void loadFromSettings();

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

    bool readXml( const QDomElement &gridElement, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private:
    // Used for 'collapsing' undo commands
    enum UndoCommand
    {
      UndoGridResolution = 1,
      UndoGridOffset,
    };
 
    QgsLayoutMeasurement mGridResolution;
    QgsLayoutPoint mGridOffset;
    QPen mGridPen;
    Style mGridStyle = StyleLines;
    QgsLayout *mLayout = nullptr;
 
  public:
#ifndef SIP_RUN
    static const QgsSettingsEntryString *settingsGridStyle SIP_SKIP;
    static const QgsSettingsEntryColor *settingsGridColor SIP_SKIP;
    static const QgsSettingsEntryDouble *settingsGridResolution SIP_SKIP;
    static const QgsSettingsEntryDouble *settingsGridOffsetX SIP_SKIP;
    static const QgsSettingsEntryDouble *settingsGridOffsetY SIP_SKIP;
#endif
};
 
#endif //QGSLAYOUTGRIDSETTINGS_H