qgslayoutitemlabel.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutitemlabel.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 QGSLAYOUTITEMLABEL_H
#define QGSLAYOUTITEMLABEL_H
 
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include "qgstextformat.h"
 
#include <QFont>
#include <QUrl>
 
class QgsVectorLayer;
class QgsFeature;
class QgsDistanceArea;

class CORE_EXPORT QgsLayoutItemLabel : public QgsLayoutItem
{
    Q_OBJECT
 
  public:
    enum Mode
    {
      ModeFont, 
      ModeHtml, 
    };

    QgsLayoutItemLabel( QgsLayout *layout );

    static QgsLayoutItemLabel *create( QgsLayout *layout ) SIP_FACTORY;
 
    int type() const override;
    QIcon icon() const override;
    //Overridden to contain part of label's text
    QString displayName() const override;

    void adjustSizeToText();

    void adjustSizeToText( QgsLayoutItem::ReferencePoint referencePoint );

    QSizeF sizeForText() const;

    QString text() const { return mText; }

    void setText( const QString &text );

    QString currentText() const;

    Mode mode() const { return mMode; }

    void setMode( Mode mode );

    Q_DECL_DEPRECATED QFont font() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setFont( const QFont &font ) SIP_DEPRECATED;

    Qt::AlignmentFlag vAlign() const { return mVAlignment; }

    Qt::AlignmentFlag hAlign() const { return mHAlignment; }

    void setHAlign( Qt::AlignmentFlag alignment )
    {
      mHAlignment = alignment;
      invalidateCache();
    }

    void setVAlign( Qt::AlignmentFlag alignment )
    {
      mVAlignment = alignment;
      invalidateCache();
    }

    double marginX() const { return mMarginX; }

    double marginY() const { return mMarginY; }

    void setMargin( double margin );

    void setMarginX( double margin );

    void setMarginY( double margin );

    Q_DECL_DEPRECATED void setFontColor( const QColor &color ) SIP_DEPRECATED { mFormat.setColor( color ); }

    Q_DECL_DEPRECATED QColor fontColor() const SIP_DEPRECATED { return mFormat.color(); }
 
    // In case of negative margins, the bounding rect may be larger than the
    // label's frame
    QRectF boundingRect() const override;
    void setFrameEnabled( bool drawFrame ) override;
    void setFrameStrokeWidth( QgsLayoutMeasurement strokeWidth ) override;

    QgsTextFormat textFormat() const;

    void setTextFormat( const QgsTextFormat &format );
 
  public slots:
 
    void refresh() override;

    void convertToStaticText();
 
  protected:
    void draw( QgsLayoutItemRenderContext &context ) override;
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
 
  private slots:
 
    void refreshExpressionContext();
    void updateBoundingRect();
 
  private:
    // Text
    QString mText;
 
    Mode mMode = ModeFont;
    double mHtmlUnitsToLayoutUnits = 1.0;
    double htmlUnitsToLayoutUnits(); //calculate scale factor

    void itemShiftAdjustSize( double newWidth, double newHeight, double &xShift, double &yShift ) const;

    void contentChanged();
 
    QgsTextFormat mFormat;

    double mMarginX = 0.0;
    double mMarginY = 0.0;

    Qt::AlignmentFlag mHAlignment = Qt::AlignLeft;

    Qt::AlignmentFlag mVAlignment = Qt::AlignTop;

    void replaceDateText( QString &text ) const;

    QFont createDefaultFont() const;

    QUrl createStylesheetUrl() const;

    QString createStylesheet() const;
 
    std::unique_ptr< QgsDistanceArea > mDistanceArea;
 
    QRectF mCurrentRectangle;
 
    friend class QgsLayoutItemHtml;
};
 
#endif //QGSLAYOUTITEMLABEL_H