qgstextformatwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgstextformatwidget.h
    ---------------------
    begin                : June 2009
    copyright            : (C) Martin Dobias
    email                : wonder dot sk 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 QGSTEXTFORMATWIDGET_H
#define QGSTEXTFORMATWIDGET_H
 
#include "ui_qgstextformatwidgetbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsguiutils.h"
#include "qgsstringutils.h"
#include "qgssymbolwidgetcontext.h"
#include "qgstextformat.h"
 
#include <QFontDatabase>
 
class QgsMapCanvas;
class QgsCharacterSelectorDialog;
 

 
class GUI_EXPORT QgsTextFormatWidget : public QWidget, public QgsExpressionContextGenerator, protected Ui::QgsTextFormatWidgetBase
{
    Q_OBJECT
    Q_PROPERTY( QgsTextFormat format READ format )
 
  public:
    QgsTextFormatWidget( const QgsTextFormat &format = QgsTextFormat(), QgsMapCanvas *mapCanvas = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsMapLayer *layer = nullptr );
 
    ~QgsTextFormatWidget() override;

    QgsTextFormat format( bool includeDataDefinedProperties = true ) const;

    void setFormat( const QgsTextFormat &format );

    virtual void setContext( const QgsSymbolWidgetContext &context );

    QgsSymbolWidgetContext context() const;

    void deactivateField( QgsPalLayerSettings::Property key );
 
  public slots:

    void setDockMode( bool enabled );
 
  signals:

    void widgetChanged();

    void auxiliaryFieldCreated();
 
  protected:
    enum Mode
    {
      Text = 0, 
      Labeling, 
    };

    QgsTextFormatWidget( QgsMapCanvas *mapCanvas, QWidget *parent SIP_TRANSFERTHIS, Mode mode, QgsMapLayer *layer = nullptr );

    void updateWidgetForFormat( const QgsTextFormat &format );

    void setPreviewBackground( const QColor &color );

    Q_DECL_DEPRECATED void enableDataDefinedAlignment( bool enable ) SIP_DEPRECATED { Q_UNUSED( enable ) }
 
    QgsExpressionContext createExpressionContext() const override;

    Qgis::GeometryType labelGeometryType() const;

    void setPropertyOverrideButtonsVisible( bool visible );

    QgsStringReplacementCollection mSubstitutions;
    QList<QgsTextFormat::Tab> mTabPositions;

    QButtonGroup *mQuadrantBtnGrp = nullptr;
    QButtonGroup *mDirectSymbBtnGrp = nullptr;
    QButtonGroup *mUpsidedownBtnGrp = nullptr;
    int mMinPixelLimit = 0;

    QgsMapCanvas *mMapCanvas = nullptr;

    QgsSymbolWidgetContext mContext;

    QgsPropertyCollection mDataDefinedProperties;

    QgsMapLayer *mLayer = nullptr;
 
    QList<QgsSymbolLayerReference> mMaskedSymbolLayers;

    Qgis::GeometryType mGeomType = Qgis::GeometryType::Unknown;

    QListWidgetItem *mTextItem = nullptr;
    QListWidgetItem *mFormattingItem = nullptr;
    QListWidgetItem *mBufferItem = nullptr;
    QListWidgetItem *mMaskItem = nullptr;
    QListWidgetItem *mBackgroundItem = nullptr;
    QListWidgetItem *mShadowItem = nullptr;
    QListWidgetItem *mCalloutItem = nullptr;
    QListWidgetItem *mPlacementItem = nullptr;
    QListWidgetItem *mRenderingItem = nullptr;
 
  protected slots:

    void updateLinePlacementOptions();

    void updatePlacementWidgets();

    virtual void setFormatFromStyle( const QString &name, QgsStyle::StyleEntity type, const QString &stylePath );

    virtual void saveFormat();

    void updatePreview();
 
#ifndef SIP_RUN

    void populateDataDefinedButtons();
#endif
 
  private:
    Mode mWidgetMode = Text;
 
    QgsCharacterSelectorDialog *mCharDlg = nullptr;
    std::unique_ptr<QgsPaintEffect> mBufferEffect;
    std::unique_ptr<QgsPaintEffect> mMaskEffect;
    std::unique_ptr<QgsPaintEffect> mBackgroundEffect;
    QColor mPreviewBackgroundColor;
 
    QFontDatabase mFontDB;
 
    // background reference font
    QFont mRefFont;
    bool mDockMode = false;
 
    bool mLoadSvgParams = false;
    QgsExpressionContext mPreviewExpressionContext;
 
    QMap<QgsPalLayerSettings::Property, QgsPropertyOverrideButton *> mButtons;
 
    void initWidget();
    void setWidgetMode( Mode mode );
    void blockFontChangeSignals( bool blk );
    void populateFontCapitalsComboBox();
    void populateFontStyleComboBox();
    void updateFont( const QFont &font );
    void connectValueChanged( const QList<QWidget *> &widgets );
 
    void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsPalLayerSettings::Property key );
 
  private slots:
    void optionsStackedWidget_CurrentChanged( int indx );
    void showBackgroundRadius( bool show );
    void mShapeSVGPathLineEdit_textChanged( const QString &text );
    void onSubstitutionsChanged( const QgsStringReplacementCollection &substitutions );
    void previewScaleChanged( double scale );
    void mFontSizeSpinBox_valueChanged( double d );
    void mFontFamilyCmbBx_currentFontChanged( const QFont &f );
    void mFontStyleComboBox_currentIndexChanged( const QString &text );
    void mFontUnderlineBtn_toggled( bool ckd );
    void mFontStrikethroughBtn_toggled( bool ckd );
    void kerningToggled( bool checked );
    void mFontWordSpacingSpinBox_valueChanged( double spacing );
    void mFontLetterSpacingSpinBox_valueChanged( double spacing );
    void mFontSizeUnitWidget_changed();
    void mFontMinPixelSpinBox_valueChanged( int px );
    void mFontMaxPixelSpinBox_valueChanged( int px );
    void mBufferUnitWidget_changed();
    void mMaskBufferUnitWidget_changed();
    void mCoordXDDBtn_changed();
    void mCoordXDDBtn_activated( bool isActive );
    void mCoordYDDBtn_changed();
    void mCoordYDDBtn_activated( bool isActive );
    void mCoordPointDDBtn_changed();
    void mCoordPointDDBtn_activated( bool isActive );
    void mShapeTypeCmbBx_currentIndexChanged( int index );
    void mShapeRotationCmbBx_currentIndexChanged( int index );
    void mShapeSVGParamsBtn_clicked();
    void mShapeSVGSelectorBtn_clicked();
    void mPreviewTextEdit_textChanged( const QString &text );
    void mPreviewTextBtn_clicked();
    void mPreviewBackgroundBtn_colorChanged( const QColor &color );
    void mDirectSymbLeftToolBtn_clicked();
    void mDirectSymbRightToolBtn_clicked();
    void chkLineOrientationDependent_toggled( bool active );
    void mToolButtonConfigureSubstitutes_clicked();
    void configureTabStops();
    void collapseSample( bool collapse );
    void changeTextColor( const QColor &color );
    void changeBufferColor( const QColor &color );
    void scrollPreview();
    void updateSvgWidgets( const QString &svgPath );
    void updateAvailableShadowPositions();
    void updateProperty();
    void createAuxiliaryField();
    void updateShapeFrameStatus();
    void updateBufferFrameStatus();
    void updateShadowFrameStatus();
    void updateCalloutFrameStatus();
    void updateDataDefinedAlignment();
    void overlapModeChanged();
};
 

 
class GUI_EXPORT QgsTextFormatDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsTextFormatDialog( const QgsTextFormat &format, QgsMapCanvas *mapCanvas = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QgsMapLayer *layer = nullptr );

    QgsTextFormat format() const;

    void setContext( const QgsSymbolWidgetContext &context );

    QDialogButtonBox *buttonBox() const;
 
  private:
    QgsTextFormatWidget *mFormatWidget = nullptr;
    QDialogButtonBox *mButtonBox = nullptr;
 
  private slots:
    void showHelp();
};

 
class GUI_EXPORT QgsTextFormatPanelWidget : public QgsPanelWidgetWrapper
{
    Q_OBJECT
 
  public:
    QgsTextFormatPanelWidget( const QgsTextFormat &format, QgsMapCanvas *mapCanvas = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsMapLayer *layer = nullptr );

    QgsTextFormat format() const;

    void setFormat( const QgsTextFormat &format );

    void setContext( const QgsSymbolWidgetContext &context );
 
    void setDockMode( bool dockMode ) override;
 
  private:
    QgsTextFormatWidget *mFormatWidget = nullptr;
    bool mBlockSignals = false;
};
 
#endif //QGSTEXTFORMATWIDGET_H