qgslabellineanchorwidget.cpp

Go to the documentation of this file.

/***************************************************************************
    qgslabellineanchorwidget.cpp
    ----------------------
    begin                : August 2020
    copyright            : (C) 2020 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
 
#include "qgslabellineanchorwidget.h"
 
#include "qgsapplication.h"
#include "qgsexpressioncontextutils.h"
 
#include <QString>
 
#include "moc_qgslabellineanchorwidget.cpp"
 
using namespace Qt::StringLiterals;
 
QgsLabelLineAnchorWidget::QgsLabelLineAnchorWidget( QWidget *parent, QgsVectorLayer *vl )
  : QgsLabelSettingsWidgetBase( parent, vl )
{
  setupUi( this );
 
  setPanelTitle( tr( "Line Anchor Settings" ) );
 
  mPercentPlacementComboBox->addItem( QgsApplication::getThemeIcon( u"/mActionLabelAnchorCenter.svg"_s ), tr( "Center of Line" ), 0.5 );
  mPercentPlacementComboBox->addItem( QgsApplication::getThemeIcon( u"/mActionLabelAnchorStart.svg"_s ), tr( "Start of Line" ), 0.0 );
  mPercentPlacementComboBox->addItem( QgsApplication::getThemeIcon( u"/mActionLabelAnchorEnd.svg"_s ), tr( "End of Line" ), 1.0 );
  mPercentPlacementComboBox->addItem( QgsApplication::getThemeIcon( u"/mActionLabelAnchorCustom.svg"_s ), tr( "Custom…" ), -1.0 );
 
  mClippingComboBox->addItem( tr( "Use Visible Part of Line" ), static_cast<int>( QgsLabelLineSettings::AnchorClipping::UseVisiblePartsOfLine ) );
  mClippingComboBox->addItem( tr( "Use Entire Line" ), static_cast<int>( QgsLabelLineSettings::AnchorClipping::UseEntireLine ) );
 
  mAnchorTypeComboBox->addItem( tr( "Preferred Placement Hint" ), static_cast<int>( QgsLabelLineSettings::AnchorType::HintOnly ) );
  mAnchorTypeComboBox->addItem( tr( "Strict" ), static_cast<int>( QgsLabelLineSettings::AnchorType::Strict ) );
 
  mAnchorTextPointComboBox->addItem( tr( "Automatic" ), static_cast<int>( QgsLabelLineSettings::AnchorTextPoint::FollowPlacement ) );
  mAnchorTextPointComboBox->addItem( tr( "Start of Text" ), static_cast<int>( QgsLabelLineSettings::AnchorTextPoint::StartOfText ) );
  mAnchorTextPointComboBox->addItem( tr( "Center of Text" ), static_cast<int>( QgsLabelLineSettings::AnchorTextPoint::CenterOfText ) );
  mAnchorTextPointComboBox->addItem( tr( "End of Text" ), static_cast<int>( QgsLabelLineSettings::AnchorTextPoint::EndOfText ) );
 
  connect( mPercentPlacementComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, [this]( int ) {
    if ( !mBlockSignals )
      emit changed();
 
    if ( mPercentPlacementComboBox->currentData().toDouble() < 0 )
      mCustomPlacementSpinBox->setEnabled( true );
    else
    {
      mCustomPlacementSpinBox->setEnabled( false );
      mBlockSignals = true;
      mCustomPlacementSpinBox->setValue( mPercentPlacementComboBox->currentData().toDouble() * 100 );
      mBlockSignals = false;
    }
  } );
  connect( mCustomPlacementSpinBox, qOverload<double>( &QDoubleSpinBox::valueChanged ), this, [this]( double ) {
    if ( !mBlockSignals )
      emit changed();
  } );
 
  connect( mAnchorTypeComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, [this]( int ) {
    if ( !mBlockSignals )
      emit changed();
 
    updateAnchorTypeHint();
  } );
 
  connect( mClippingComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, [this]( int ) {
    if ( !mBlockSignals )
      emit changed();
  } );
 
  connect( mAnchorTextPointComboBox, qOverload<int>( &QComboBox::currentIndexChanged ), this, [this]( int ) {
    if ( !mBlockSignals )
      emit changed();
 
    updateAnchorTextPointHint();
  } );
 
  registerDataDefinedButton( mLinePlacementDDBtn, QgsPalLayerSettings::Property::LineAnchorPercent );
  registerDataDefinedButton( mLineClippingDDBtn, QgsPalLayerSettings::Property::LineAnchorClipping );
  registerDataDefinedButton( mAnchorTextPointDDBtn, QgsPalLayerSettings::Property::LineAnchorTextPoint );
  registerDataDefinedButton( mAnchorTypeDDBtn, QgsPalLayerSettings::Property::LineAnchorType );
  updateAnchorTypeHint();
  updateAnchorTextPointHint();
}
 
void QgsLabelLineAnchorWidget::setSettings( const QgsLabelLineSettings &settings )
{
  mBlockSignals = true;
  const int comboIndex = mPercentPlacementComboBox->findData( settings.lineAnchorPercent() );
  if ( comboIndex >= 0 )
  {
    mPercentPlacementComboBox->setCurrentIndex( comboIndex );
  }
  else
  {
    // set custom control
    mPercentPlacementComboBox->setCurrentIndex( mPercentPlacementComboBox->findData( -1.0 ) );
    mCustomPlacementSpinBox->setValue( settings.lineAnchorPercent() * 100.0 );
  }
  mCustomPlacementSpinBox->setEnabled( mPercentPlacementComboBox->currentData().toDouble() < 0 );
 
  mAnchorTypeComboBox->setCurrentIndex( mAnchorTypeComboBox->findData( static_cast<int>( settings.anchorType() ) ) );
  mClippingComboBox->setCurrentIndex( mClippingComboBox->findData( static_cast<int>( settings.anchorClipping() ) ) );
  mAnchorTextPointComboBox->setCurrentIndex( mAnchorTextPointComboBox->findData( static_cast<int>( settings.anchorTextPoint() ) ) );
  mBlockSignals = false;
}
 
QgsLabelLineSettings QgsLabelLineAnchorWidget::settings() const
{
  QgsLabelLineSettings settings;
 
  if ( mPercentPlacementComboBox->currentData().toDouble() >= 0 )
  {
    settings.setLineAnchorPercent( mPercentPlacementComboBox->currentData().toDouble() );
  }
  else
  {
    settings.setLineAnchorPercent( mCustomPlacementSpinBox->value() / 100.0 );
  }
 
  settings.setAnchorType( static_cast<QgsLabelLineSettings::AnchorType>( mAnchorTypeComboBox->currentData().toInt() ) );
  settings.setAnchorClipping( static_cast<QgsLabelLineSettings::AnchorClipping>( mClippingComboBox->currentData().toInt() ) );
  settings.setAnchorTextPoint( static_cast<QgsLabelLineSettings::AnchorTextPoint>( mAnchorTextPointComboBox->currentData().toInt() ) );
  return settings;
}
 
void QgsLabelLineAnchorWidget::updateDataDefinedProperties( QgsPropertyCollection &properties )
{
  properties.setProperty( QgsPalLayerSettings::Property::LineAnchorPercent, mDataDefinedProperties.property( QgsPalLayerSettings::Property::LineAnchorPercent ) );
  properties.setProperty( QgsPalLayerSettings::Property::LineAnchorClipping, mDataDefinedProperties.property( QgsPalLayerSettings::Property::LineAnchorClipping ) );
  properties.setProperty( QgsPalLayerSettings::Property::LineAnchorType, mDataDefinedProperties.property( QgsPalLayerSettings::Property::LineAnchorType ) );
  properties.setProperty( QgsPalLayerSettings::Property::LineAnchorTextPoint, mDataDefinedProperties.property( QgsPalLayerSettings::Property::LineAnchorTextPoint ) );
}
 
void QgsLabelLineAnchorWidget::updateAnchorTypeHint()
{
  QString hint;
  switch ( static_cast<QgsLabelLineSettings::AnchorType>( mAnchorTypeComboBox->currentData().toInt() ) )
  {
    case QgsLabelLineSettings::AnchorType::Strict:
      hint = tr( "Labels are placed exactly on the label anchor only, and no other fallback placements are permitted." );
      break;
 
    case QgsLabelLineSettings::AnchorType::HintOnly:
      hint = tr( "The label anchor is treated as a hint for the preferred label placement, but other placements close to the anchor point are permitted." );
      break;
  }
  mAnchorTypeHintLabel->setText( hint );
}
 
void QgsLabelLineAnchorWidget::updateAnchorTextPointHint()
{
  QString hint;
  switch ( static_cast<QgsLabelLineSettings::AnchorTextPoint>( mAnchorTextPointComboBox->currentData().toInt() ) )
  {
    case QgsLabelLineSettings::AnchorTextPoint::StartOfText:
      hint = tr( "Labels are placed so that the start of their text is placed at the anchor point." );
      break;
    case QgsLabelLineSettings::AnchorTextPoint::CenterOfText:
      hint = tr( "Labels are placed so that the center of their text is placed at the anchor point." );
      break;
    case QgsLabelLineSettings::AnchorTextPoint::EndOfText:
      hint = tr( "Labels are placed so that the end of their text is placed at the anchor point." );
      break;
    case QgsLabelLineSettings::AnchorTextPoint::FollowPlacement:
      hint = tr( "The text justification is determined based on the anchor point. Anchors close to the start of the line will use the start of the text, anchors close to the end will use the end of the text, and central values will use the center of the text." );
      break;
  }
  mAnchorTextPointHintLabel->setText( hint );
}