qgslabelinggui.h

Go to the documentation of this file.

/***************************************************************************
  qgslabelinggui.h
  Smart labeling for vector layers
  -------------------
         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 QGSLABELINGGUI_H
#define QGSLABELINGGUI_H
 
#include "qgis_gui.h"
#include "qgspallabeling.h"
#include "qgspropertyoverridebutton.h"
#include "qgstextformatwidget.h"
 
class QDialogButtonBox;
 
class QgsMeshLayer;
class QgsVectorTileLayer;
 
#define SIP_NO_FILE

 
class GUI_EXPORT QgsLabelingGui : public QgsTextFormatWidget
{
    Q_OBJECT
 
  public:

    QgsLabelingGui( QgsVectorLayer *layer, QgsMapCanvas *mapCanvas, const QgsPalLayerSettings &settings, QWidget *parent = nullptr, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown );

    QgsLabelingGui( QgsMeshLayer *layer, QgsMapCanvas *mapCanvas, const QgsPalLayerSettings &settings, QWidget *parent = nullptr, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown );

    QgsLabelingGui( QgsVectorTileLayer *layer, QgsMapCanvas *mapCanvas, const QgsPalLayerSettings &settings, QWidget *parent = nullptr, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown );

    QgsLabelingGui( QgsMapCanvas *mapCanvas, const QgsPalLayerSettings &settings, QWidget *parent = nullptr );
 
    QgsPalLayerSettings layerSettings();
 
    enum LabelMode
    {
      NoLabels,
      Labels,
      ObstaclesOnly,
    };
 
    void setLabelMode( LabelMode mode );
 
    virtual void setLayer( QgsMapLayer *layer );
 
    void setSettings( const QgsPalLayerSettings &settings );
 
    void setContext( const QgsSymbolWidgetContext &context ) override;
 
  public slots:
 
    void updateUi();
 
  protected slots:
    void setFormatFromStyle( const QString &name, QgsStyle::StyleEntity type, const QString &stylePath ) override;
    void saveFormat() override;
 
  protected:

    QgsLabelingGui( QgsMapCanvas *mapCanvas, QWidget *parent, QgsMapLayer *layer ) SIP_SKIP;

    void init();
 
    void blockInitSignals( bool block );
    void syncDefinedCheckboxFrame( QgsPropertyOverrideButton *ddBtn, QCheckBox *chkBx, QFrame *f );
    bool eventFilter( QObject *object, QEvent *event ) override;

    LabelMode mMode;
 
  private slots:

    void updateGeometryTypeBasedWidgets();
    void showGeometryGeneratorExpressionBuilder();
    void validateGeometryGeneratorExpression();
    void determineGeometryGeneratorType();

    void calloutTypeChanged();
 
  private:
    QgsPalLayerSettings mSettings;
    QgsFeature mPreviewFeature;
 
    QgsLabelObstacleSettings mObstacleSettings;
    QgsLabelLineSettings mLineSettings;
    QgsLabelThinningSettings mThinningSettings;
 
    QgsExpressionContext createExpressionContext() const override;
 
  private slots:
 
    void updateCalloutWidget( QgsCallout *callout );
    void showObstacleSettings();
    void showLineAnchorSettings();
    void showDuplicateSettings();
};
 
class GUI_EXPORT QgsLabelSettingsDialog : public QDialog
{
    Q_OBJECT
 
  public:
    QgsLabelSettingsDialog( const QgsPalLayerSettings &settings, QgsVectorLayer *layer, QgsMapCanvas *mapCanvas, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qgis::GeometryType geomType = Qgis::GeometryType::Unknown );
 
    QgsPalLayerSettings settings() const { return mWidget->layerSettings(); }

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

 
#endif // QGSLABELINGGUI_H