35#include <QButtonGroup>
45 expContext = mCanvas->createExpressionContext();
74void QgsLabelingGui::updateCalloutWidget(
QgsCallout *callout )
78 mCalloutStackedWidget->setCurrentWidget( pageDummy );
82 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
85 mCalloutStackedWidget->setCurrentWidget( pageDummy );
89 if ( mCalloutStackedWidget->currentWidget() != pageDummy )
92 if (
QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
103 if ( mGeometryGeneratorGroupBox->isChecked() )
107 w->setGeometryType( geometryType );
108 w->setCallout( callout );
110 w->setContext( context() );
111 mCalloutStackedWidget->addWidget( w );
112 mCalloutStackedWidget->setCurrentWidget( w );
119 mCalloutStackedWidget->setCurrentWidget( pageDummy );
122void QgsLabelingGui::showObstacleSettings()
124 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
142 auto applySettings = [ = ]
144 mObstacleSettings = widget->
settings();
147 emit widgetChanged();
163 dialog.buttonBox()->addButton( QDialogButtonBox::Help );
164 connect( dialog.buttonBox(), &QDialogButtonBox::helpRequested,
this, [ = ]
166 QgsHelp::openHelp( QStringLiteral(
"style_library/label_settings.html#obstacles" ) );
178void QgsLabelingGui::showLineAnchorSettings()
180 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
198 auto applySettings = [ = ]
202 mLineSettings.setAnchorType( widgetSettings.
anchorType() );
203 mLineSettings.setAnchorClipping( widgetSettings.
anchorClipping() );
207 emit widgetChanged();
223 dialog.buttonBox()->addButton( QDialogButtonBox::Help );
224 connect( dialog.buttonBox(), &QDialogButtonBox::helpRequested,
this, [ = ]
226 QgsHelp::openHelp( QStringLiteral(
"style_library/label_settings.html#placement-for-line-layers" ) );
240 , mSettings( layerSettings )
242 , mCanvas( mapCanvas )
246 mGeomType = geomType;
263 connect( mBufferDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
265 connect( mEnableMaskChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
266 connect( mShapeDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
267 connect( mCalloutsDrawCheckBox, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
268 connect( mShadowDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
269 connect( mDirectSymbChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
270 connect( mFormatNumChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
271 connect( mScaleBasedVisibilityChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
272 connect( mFontLimitPixelChkBox, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
273 connect( mGeometryGeneratorGroupBox, &QGroupBox::toggled,
this, &QgsLabelingGui::updateGeometryTypeBasedWidgets );
274 connect( mGeometryGeneratorType, qOverload<int>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::updateGeometryTypeBasedWidgets );
275 connect( mGeometryGeneratorExpressionButton, &QToolButton::clicked,
this, &QgsLabelingGui::showGeometryGeneratorExpressionBuilder );
276 connect( mGeometryGeneratorGroupBox, &QGroupBox::toggled,
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
277 connect( mGeometryGenerator, &QgsCodeEditorExpression::textChanged,
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
278 connect( mGeometryGeneratorType, qOverload<int>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
279 connect( mObstacleSettingsButton, &QAbstractButton::clicked,
this, &QgsLabelingGui::showObstacleSettings );
280 connect( mLineAnchorSettingsButton, &QAbstractButton::clicked,
this, &QgsLabelingGui::showLineAnchorSettings );
282 mFieldExpressionWidget->registerExpressionContextGenerator(
this );
284 mMinScaleWidget->setMapCanvas( mCanvas );
285 mMinScaleWidget->setShowCurrentScaleButton(
true );
286 mMaxScaleWidget->setMapCanvas( mCanvas );
287 mMaxScaleWidget->setShowCurrentScaleButton(
true );
289 mGeometryGeneratorExpressionButton->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Minimum );
293 for (
const QString &type : calloutTypes )
299 mGeometryGeneratorWarningLabel->setStyleSheet( QStringLiteral(
"color: #FFC107;" ) );
300 mGeometryGeneratorWarningLabel->setTextInteractionFlags( Qt::TextBrowserInteraction );
301 connect( mGeometryGeneratorWarningLabel, &QLabel::linkActivated,
this, [
this](
const QString & link )
303 if ( link == QLatin1String(
"#determineGeometryGeneratorType" ) )
304 determineGeometryGeneratorType();
307 connect( mCalloutStyleComboBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::calloutTypeChanged );
309 mLblNoObstacle1->installEventFilter(
this );
314void QgsLabelingGui::setLayer(
QgsMapLayer *mapLayer )
327 QgsVectorLayer *vLayer = qobject_cast<QgsVectorLayer *>( mapLayer );
329 mTextFormatsListWidget->setLayerType( vLayer ? vLayer->
geometryType() : mGeomType );
330 mBackgroundMarkerSymbolButton->setLayer( vLayer );
331 mBackgroundFillSymbolButton->setLayer( vLayer );
334 updateGeometryTypeBasedWidgets();
336 mFieldExpressionWidget->setLayer( mapLayer );
341 mFieldExpressionWidget->setGeomCalculator( da );
343 mFieldExpressionWidget->setEnabled( mMode == Labels || !mLayer );
344 mLabelingFrame->setEnabled( mMode == Labels || !mLayer );
346 blockInitSignals(
true );
348 mGeometryGenerator->setText( mSettings.geometryGenerator );
349 mGeometryGeneratorGroupBox->setChecked( mSettings.geometryGeneratorEnabled );
350 if ( !mSettings.geometryGeneratorEnabled )
351 mGeometryGeneratorGroupBox->setCollapsed(
true );
352 mGeometryGeneratorType->setCurrentIndex( mGeometryGeneratorType->findData( QVariant::fromValue( mSettings.geometryGeneratorType ) ) );
354 updateWidgetForFormat( mSettings.format().isValid() ? mSettings.format() :
QgsStyle::defaultTextFormatForProject(
QgsProject::instance(),
QgsStyle::TextFormatContext::Labeling ) );
356 mFieldExpressionWidget->setRow( -1 );
357 mFieldExpressionWidget->setField( mSettings.fieldName );
358 mCheckBoxSubstituteText->setChecked( mSettings.useSubstitutions );
359 mSubstitutions = mSettings.substitutions;
362 mCentroidRadioWhole->setChecked( mSettings.centroidWhole );
363 mCentroidInsideCheckBox->setChecked( mSettings.centroidInside );
364 mFitInsidePolygonCheckBox->setChecked( mSettings.fitInPolygonOnly );
365 mLineDistanceSpnBx->setValue( mSettings.dist );
366 mLineDistanceUnitWidget->setUnit( mSettings.distUnits );
367 mLineDistanceUnitWidget->setMapUnitScale( mSettings.distMapUnitScale );
369 mMaximumDistanceSpnBx->setValue( mSettings.pointSettings().maximumDistance() );
370 mMaximumDistanceUnitWidget->setUnit( mSettings.pointSettings().maximumDistanceUnit() );
371 mMaximumDistanceUnitWidget->setMapUnitScale( mSettings.pointSettings().maximumDistanceMapUnitScale() );
373 mOffsetTypeComboBox->setCurrentIndex( mOffsetTypeComboBox->findData(
static_cast< int >( mSettings.offsetType ) ) );
374 mQuadrantBtnGrp->button(
static_cast<int>( mSettings.pointSettings().quadrant() ) )->setChecked(
true );
375 mPointOffsetXSpinBox->setValue( mSettings.xOffset );
376 mPointOffsetYSpinBox->setValue( mSettings.yOffset );
377 mPointOffsetUnitWidget->setUnit( mSettings.offsetUnits );
378 mPointOffsetUnitWidget->setMapUnitScale( mSettings.labelOffsetMapUnitScale );
379 mPointAngleSpinBox->setValue( mSettings.angleOffset );
387 const int placementIndex = mPlacementModeComboBox->findData(
static_cast< int >( mSettings.placement ) );
388 if ( placementIndex >= 0 )
390 mPlacementModeComboBox->setCurrentIndex( placementIndex );
395 mPlacementModeComboBox->setCurrentIndex( 0 );
399 mRepeatDistanceSpinBox->setValue( mSettings.repeatDistance );
400 mRepeatDistanceUnitWidget->setUnit( mSettings.repeatDistanceUnit );
401 mRepeatDistanceUnitWidget->setMapUnitScale( mSettings.repeatDistanceMapUnitScale );
403 mOverrunDistanceSpinBox->setValue( mSettings.lineSettings().overrunDistance() );
404 mOverrunDistanceUnitWidget->setUnit( mSettings.lineSettings().overrunDistanceUnit() );
405 mOverrunDistanceUnitWidget->setMapUnitScale( mSettings.lineSettings().overrunDistanceMapUnitScale() );
407 mPrioritySlider->setValue( mSettings.priority );
408 mChkNoObstacle->setChecked( mSettings.obstacleSettings().isObstacle() );
410 mObstacleSettings = mSettings.obstacleSettings();
411 mLineSettings = mSettings.lineSettings();
413 chkLabelPerFeaturePart->setChecked( mSettings.labelPerPart );
415 mComboOverlapHandling->setCurrentIndex( mComboOverlapHandling->findData(
static_cast< int >( mSettings.placementSettings().overlapHandling() ) ) );
416 mCheckAllowDegradedPlacement->setChecked( mSettings.placementSettings().allowDegradedPlacement() );
417 mPrioritizationComboBox->setCurrentIndex( mPrioritizationComboBox->findData( QVariant::fromValue( mSettings.placementSettings().prioritization() ) ) );
419 chkMergeLines->setChecked( mSettings.lineSettings().mergeLines() );
420 mMinSizeSpinBox->setValue( mSettings.thinningSettings().minimumFeatureSize() );
421 mLimitLabelChkBox->setChecked( mSettings.thinningSettings().limitNumberOfLabelsEnabled() );
422 mLimitLabelSpinBox->setValue( mSettings.thinningSettings().maximumNumberLabels() );
425 mDirectSymbChkBx->setChecked( mSettings.lineSettings().addDirectionSymbol() );
426 mDirectSymbLeftLineEdit->setText( mSettings.lineSettings().leftDirectionSymbol() );
427 mDirectSymbRightLineEdit->setText( mSettings.lineSettings().rightDirectionSymbol() );
428 mDirectSymbRevChkBx->setChecked( mSettings.lineSettings().reverseDirectionSymbol() );
430 mDirectSymbBtnGrp->button(
static_cast<int>( mSettings.lineSettings().directionSymbolPlacement() ) )->setChecked(
true );
431 mUpsidedownBtnGrp->button(
static_cast<int>( mSettings.upsidedownLabels ) )->setChecked(
true );
434 mMaxCharAngleInDSpinBox->setValue( mSettings.maxCurvedCharAngleIn );
436 mMaxCharAngleOutDSpinBox->setValue( std::fabs( mSettings.maxCurvedCharAngleOut ) );
438 wrapCharacterEdit->setText( mSettings.wrapChar );
439 mAutoWrapLengthSpinBox->setValue( mSettings.autoWrapLength );
440 mAutoWrapTypeComboBox->setCurrentIndex( mSettings.useMaxLineLengthForAutoWrap ? 0 : 1 );
442 if ( mFontMultiLineAlignComboBox->findData(
static_cast< int >( mSettings.multilineAlign ) ) != -1 )
444 mFontMultiLineAlignComboBox->setCurrentIndex( mFontMultiLineAlignComboBox->findData(
static_cast< int >( mSettings.multilineAlign ) ) );
450 mFontMultiLineAlignComboBox->setCurrentIndex( 0 );
453 chkPreserveRotation->setChecked( mSettings.preserveRotation );
455 mCoordRotationUnitComboBox->setCurrentIndex( 0 );
456 if ( mCoordRotationUnitComboBox->findData(
static_cast< unsigned int >( mSettings.rotationUnit() ) ) >= 0 )
457 mCoordRotationUnitComboBox->setCurrentIndex( mCoordRotationUnitComboBox->findData(
static_cast< unsigned int >( mSettings.rotationUnit() ) ) );
459 mScaleBasedVisibilityChkBx->setChecked( mSettings.scaleVisibility );
460 mMinScaleWidget->setScale( mSettings.minimumScale );
461 mMaxScaleWidget->setScale( mSettings.maximumScale );
463 mFormatNumChkBx->setChecked( mSettings.formatNumbers );
464 mFormatNumDecimalsSpnBx->setValue( mSettings.decimals );
465 mFormatNumPlusSignChkBx->setChecked( mSettings.plusSign );
469 mFontLimitPixelChkBox->setChecked( mSettings.fontLimitPixelSize );
470 mMinPixelLimit = mSettings.fontMinPixelSize;
471 mFontMinPixelSpinBox->setValue( mSettings.fontMinPixelSize == 0 ? 3 : mSettings.fontMinPixelSize );
472 mFontMaxPixelSpinBox->setValue( mSettings.fontMaxPixelSize );
474 mZIndexSpinBox->setValue( mSettings.zIndex );
476 mDataDefinedProperties = mSettings.dataDefinedProperties();
479 if (
auto *lCallout = mSettings.callout() )
481 whileBlocking( mCalloutsDrawCheckBox )->setChecked( lCallout->enabled() );
482 whileBlocking( mCalloutStyleComboBox )->setCurrentIndex( mCalloutStyleComboBox->findData( lCallout->type() ) );
483 updateCalloutWidget( lCallout );
488 whileBlocking( mCalloutStyleComboBox )->setCurrentIndex( mCalloutStyleComboBox->findData( defaultCallout->type() ) );
490 updateCalloutWidget( defaultCallout.get() );
493 updatePlacementWidgets();
494 updateLinePlacementOptions();
497 blockInitSignals(
false );
501 populateDataDefinedButtons();
508 mSettings = settings;
512void QgsLabelingGui::blockInitSignals(
bool block )
514 chkLineAbove->blockSignals( block );
515 chkLineBelow->blockSignals( block );
516 mPlacementModeComboBox->blockSignals( block );
519void QgsLabelingGui::setLabelMode( LabelMode mode )
522 mFieldExpressionWidget->setEnabled( mMode == Labels );
523 mLabelingFrame->setEnabled( mMode == Labels );
533 lyr.
drawLabels = ( mMode == Labels ) || !mLayer;
536 lyr.
fieldName = mFieldExpressionWidget->currentField( &isExpression );
542 if ( mCheckAllowLabelsOutsidePolygons->isChecked() )
549 lyr.
dist = mLineDistanceSpnBx->value();
550 lyr.
distUnits = mLineDistanceUnitWidget->unit();
558 if ( mQuadrantBtnGrp )
562 lyr.
xOffset = mPointOffsetXSpinBox->value();
563 lyr.
yOffset = mPointOffsetYSpinBox->value();
569 if ( chkLineAbove->isChecked() )
571 if ( chkLineBelow->isChecked() )
573 if ( chkLineOn->isChecked() )
575 if ( ! chkLineOrientationDependent->isChecked() )
589 lyr.
priority = mPrioritySlider->value();
591 mObstacleSettings.setIsObstacle( mChkNoObstacle->isChecked() || mMode == ObstaclesOnly );
616 lyr.
decimals = mFormatNumDecimalsSpnBx->value();
617 lyr.
plusSign = mFormatNumPlusSignChkBx->isChecked();
624 if ( mDirectSymbBtnGrp )
628 if ( mUpsidedownBtnGrp )
644 lyr.
wrapChar = wrapCharacterEdit->text();
654 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
657 lyr.
zIndex = mZIndexSpinBox->value();
662 const QString calloutType = mCalloutStyleComboBox->currentData().toString();
663 std::unique_ptr< QgsCallout > callout;
664 if (
QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
666 callout.reset( pew->callout()->clone() );
671 callout->
setEnabled( mCalloutsDrawCheckBox->isChecked() );
679 f->setEnabled( chkBx->isChecked() || ddBtn->
isActive() );
682bool QgsLabelingGui::eventFilter( QObject *
object, QEvent *event )
684 if (
object == mLblNoObstacle1 )
686 if ( event->type() == QEvent::MouseButtonPress && qgis::down_cast< QMouseEvent * >( event )->button() == Qt::LeftButton )
689 mChkNoObstacle->setChecked( !mChkNoObstacle->isChecked() );
694 return QgsTextFormatWidget::eventFilter(
object, event );
697void QgsLabelingGui::updateUi()
701 syncDefinedCheckboxFrame( mBufferDrawDDBtn, mBufferDrawChkBx, mBufferFrame );
702 syncDefinedCheckboxFrame( mEnableMaskDDBtn, mEnableMaskChkBx, mMaskFrame );
703 syncDefinedCheckboxFrame( mShapeDrawDDBtn, mShapeDrawChkBx, mShapeFrame );
704 syncDefinedCheckboxFrame( mShadowDrawDDBtn, mShadowDrawChkBx, mShadowFrame );
705 syncDefinedCheckboxFrame( mCalloutDrawDDBtn, mCalloutsDrawCheckBox, mCalloutFrame );
707 syncDefinedCheckboxFrame( mDirectSymbDDBtn, mDirectSymbChkBx, mDirectSymbFrame );
708 syncDefinedCheckboxFrame( mFormatNumDDBtn, mFormatNumChkBx, mFormatNumFrame );
709 syncDefinedCheckboxFrame( mScaleBasedVisibilityDDBtn, mScaleBasedVisibilityChkBx, mScaleBasedVisibilityFrame );
710 syncDefinedCheckboxFrame( mFontLimitPixelDDBtn, mFontLimitPixelChkBox, mFontLimitPixelFrame );
712 chkMergeLines->setEnabled( !mDirectSymbChkBx->isChecked() );
713 if ( mDirectSymbChkBx->isChecked() )
715 chkMergeLines->setToolTip( tr(
"This option is not compatible with line direction symbols." ) );
719 chkMergeLines->setToolTip( QString() );
723void QgsLabelingGui::setFormatFromStyle(
const QString &name,
QgsStyle::StyleEntity type,
const QString &stylePath )
754 settings.
fieldName = mFieldExpressionWidget->currentField( &isExpression );
757 setSettings( settings );
765 if (
QgsCalloutWidget *cw = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
767 cw->setContext( context );
772void QgsLabelingGui::saveFormat()
775 saveDlg.setDefaultTags( mTextFormatsListWidget->currentTagFilter() );
776 if ( !saveDlg.exec() )
779 if ( saveDlg.name().isEmpty() )
782 QgsStyle *style = saveDlg.destinationStyle();
786 switch ( saveDlg.selectedType() )
793 const int res = QMessageBox::warning(
this, tr(
"Save Text Format" ),
794 tr(
"Format with name '%1' already exists. Overwrite?" )
795 .arg( saveDlg.name() ),
796 QMessageBox::Yes | QMessageBox::No );
797 if ( res != QMessageBox::Yes )
803 const QStringList symbolTags = saveDlg.tags().split(
',' );
807 style->
saveTextFormat( saveDlg.name(), newFormat, saveDlg.isFavorite(), symbolTags );
816 const int res = QMessageBox::warning(
this, tr(
"Save Label Settings" ),
817 tr(
"Label settings with the name '%1' already exist. Overwrite?" )
818 .arg( saveDlg.name() ),
819 QMessageBox::Yes | QMessageBox::No );
820 if ( res != QMessageBox::Yes )
826 const QStringList symbolTags = saveDlg.tags().split(
',' );
830 style->
saveLabelSettings( saveDlg.name(), newSettings, saveDlg.isFavorite(), symbolTags );
844void QgsLabelingGui::updateGeometryTypeBasedWidgets()
848 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
850 if ( mGeometryGeneratorGroupBox->isChecked() )
863 mPlacementModeComboBox->clear();
865 switch ( geometryType )
892 qFatal(
"unknown geometry type unexpected" );
895 if ( mPlacementModeComboBox->findData(
static_cast< int >( prevPlacement ) ) != -1 )
897 mPlacementModeComboBox->setCurrentIndex( mPlacementModeComboBox->findData(
static_cast< int >( prevPlacement ) ) );
910 mFontMultiLineAlignComboBox->removeItem( idx );
913 updatePlacementWidgets();
914 updateLinePlacementOptions();
917void QgsLabelingGui::showGeometryGeneratorExpressionBuilder()
919 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
922 expressionBuilder.setExpressionText( mGeometryGenerator->text() );
923 expressionBuilder.setExpressionContext( createExpressionContext() );
925 if ( expressionBuilder.exec() )
927 mGeometryGenerator->setText( expressionBuilder.expressionText() );
931void QgsLabelingGui::validateGeometryGeneratorExpression()
935 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
937 if ( mGeometryGeneratorGroupBox->isChecked() )
939 if ( !mPreviewFeature.isValid() && vLayer )
946 expression.prepare( &context );
948 if ( expression.hasParserError() )
950 mGeometryGeneratorWarningLabel->setText( expression.parserErrorString() );
955 const QVariant result = expression.evaluate( &context );
960 mGeometryGeneratorWarningLabel->setText( tr(
"Result of the expression is not a geometry" ) );
963 else if ( geometry.
type() != configuredGeometryType )
965 mGeometryGeneratorWarningLabel->setText( QStringLiteral(
"<p>%1</p><p><a href=\"#determineGeometryGeneratorType\">%2</a></p>" ).arg(
966 tr(
"Result of the expression does not match configured geometry type." ),
975 QTimer *timer =
new QTimer();
976 connect( timer, &QTimer::timeout,
this, [
this, valid]()
978 mGeometryGeneratorWarningLabel->setVisible( !valid );
980 connect( timer, &QTimer::timeout, timer, &QTimer::deleteLater );
984void QgsLabelingGui::determineGeometryGeneratorType()
986 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
987 if ( !mPreviewFeature.isValid() && vLayer )
994 expression.prepare( &context );
997 mGeometryGeneratorType->setCurrentIndex( mGeometryGeneratorType->findData( QVariant::fromValue( geometry.
type() ) ) );
1000void QgsLabelingGui::calloutTypeChanged()
1002 const QString newCalloutType = mCalloutStyleComboBox->currentData().toString();
1003 QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() );
1022 updateCalloutWidget( newCallout.get() );
1035 QVBoxLayout *vLayout =
new QVBoxLayout();
1036 mWidget =
new QgsLabelingGui( layer, mapCanvas, settings,
nullptr, geomType );
1037 vLayout->addWidget( mWidget );
1038 mButtonBox =
new QDialogButtonBox( QDialogButtonBox::Cancel | QDialogButtonBox::Help | QDialogButtonBox::Ok, Qt::Horizontal );
1039 connect( mButtonBox, &QDialogButtonBox::accepted,
this, &QDialog::accept );
1040 connect( mButtonBox, &QDialogButtonBox::rejected,
this, &QDialog::reject );
1041 connect( mButtonBox, &QDialogButtonBox::helpRequested,
this, &QgsLabelSettingsDialog::showHelp );
1042 vLayout->addWidget( mButtonBox );
1043 setLayout( vLayout );
1044 setWindowTitle( tr(
"Label Settings" ) );
1047QDialogButtonBox *QgsLabelSettingsDialog::buttonBox()
const
1052void QgsLabelSettingsDialog::showHelp()
The Qgis class provides global constants for use throughout the application.
@ BelowLine
Labels can be placed below a line feature. Unless MapOrientation is also specified this mode respects...
@ MapOrientation
Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the...
@ OnLine
Labels can be placed directly over a line feature.
@ AboveLine
Labels can be placed above a line feature. Unless MapOrientation is also specified this mode respects...
AngleUnit
Units of angles.
@ SecondsOfArc
Seconds of arc.
@ Radians
Square kilometers.
@ MinutesOfArc
Minutes of arc.
@ MilliradiansSI
Angular milliradians (SI definition, 1/1000 of radian)
@ MilNATO
Angular mil (NATO definition, 6400 mil = 2PI radians)
LabelOffsetType
Behavior modifier for label offset and distance, only applies in some label placement modes.
LabelPrioritization
Label prioritization.
LabelPlacement
Placement modes which determine how label candidates are generated for a feature.
@ OverPoint
Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point....
@ Curved
Arranges candidates following the curvature of a line feature. Applies to line layers only.
@ AroundPoint
Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygo...
@ Line
Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon'...
@ Free
Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the pol...
@ OrderedPositionsAroundPoint
Candidates are placed in predefined positions around a point. Preference is given to positions with g...
@ Horizontal
Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only...
@ PerimeterCurved
Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.
@ OutsidePolygons
Candidates are placed outside of polygon boundaries. Applies to polygon layers only.
@ AllowPlacementInsideOfPolygon
Labels can be placed inside a polygon feature.
@ AllowPlacementOutsideOfPolygon
Labels can be placed outside of a polygon feature.
QFlags< LabelLinePlacementFlag > LabelLinePlacementFlags
Line placement flags, which control how candidates are generated for a linear feature.
QFlags< LabelPolygonPlacementFlag > LabelPolygonPlacementFlags
Polygon placement flags, which control how candidates are generated for a polygon feature.
LabelQuadrantPosition
Label quadrant positions.
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
LabelMultiLineAlignment
Text alignment for multi-line labels.
@ FollowPlacement
Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right ...
@ Mesh
Mesh layer. Added in QGIS 3.2.
LabelOverlapHandling
Label overlap handling.
UpsideDownLabelHandling
Handling techniques for upside down labels.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QgsCalloutRegistry * calloutRegistry()
Returns the application's callout registry, used for managing callout types.
Registry of available callout classes.
QgsCalloutAbstractMetadata * calloutMetadata(const QString &type) const
Returns the metadata for specified the specified callout type.
static QgsCallout * defaultCallout()
Create a new instance of a callout with default settings.
QStringList calloutTypes() const
Returns a list of all available callout types.
Abstract base class for callout renderers.
void setEnabled(bool enabled)
Sets whether the callout is enabled.
virtual QString type() const =0
Returns a unique string representing the callout type.
virtual QVariantMap properties(const QgsReadWriteContext &context) const
Returns the properties describing the callout encoded in a string format.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
void setSourceCrs(const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
Sets source spatial reference system crs.
bool setEllipsoid(const QString &ellipsoid)
Sets the ellipsoid by its acronym.
A generic dialog for building expression strings.
Single scope for storing variables and functions for use within a QgsExpressionContext.
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * atlasScope(const QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
static QgsExpressionContextScope * meshExpressionScope(QgsMesh::ElementType elementType)
Creates a new scope which contains functions relating to mesh layer element elementType.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setOriginalValueVariable(const QVariant &value)
Sets the original value variable value for the context.
static const QString EXPR_SYMBOL_COLOR
Inbuilt variable name for symbol color variable.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
void setHighlightedVariables(const QStringList &variableNames)
Sets the list of variable names within the context intended to be highlighted to the user.
static const QString EXPR_ORIGINAL_VALUE
Inbuilt variable name for value original value variable.
Class for parsing and evaluation of expressions (formerly called "search strings").
bool nextFeature(QgsFeature &f)
Fetch next feature and stores in f, returns true on success.
This class wraps a request for features to a vector layer (or directly its vector data provider).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
A geometry is the spatial representation of a feature.
static void initCalloutWidgets()
Initializes callout widgets.
static void openHelp(const QString &key)
Opens help topic for the given help key using default system web browser.
Contains settings related to how the label engine places and formats labels for line features (or pol...
void setPlacementFlags(Qgis::LabelLinePlacementFlags flags)
Returns the line placement flags, which dictate how line labels can be placed above or below the line...
void setLineAnchorPercent(double percent)
Sets the percent along the line at which labels should be placed.
void setDirectionSymbolPlacement(DirectionSymbolPlacement placement)
Sets the placement for direction symbols.
AnchorType anchorType() const
Returns the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
void setAnchorTextPoint(AnchorTextPoint point)
Sets the line anchor text point, which dictates which part of the label text should be placed at the ...
void setLeftDirectionSymbol(const QString &symbol)
Sets the string to use for left direction arrows.
AnchorTextPoint anchorTextPoint() const
Returns the line anchor text point, which dictates which part of the label text should be placed at t...
void setMergeLines(bool merge)
Sets whether connected line features with identical label text should be merged prior to generating l...
DirectionSymbolPlacement
Placement options for direction symbols.
void setRightDirectionSymbol(const QString &symbol)
Sets the string to use for right direction arrows.
void setAnchorClipping(AnchorClipping clipping)
Sets the line anchor clipping mode, which dictates how line strings are clipped before calculating th...
void setOverrunDistanceMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale for label overrun distance.
double lineAnchorPercent() const
Returns the percent along the line at which labels should be placed.
void setAnchorType(AnchorType type)
Sets the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
void setOverrunDistanceUnit(const Qgis::RenderUnit &unit)
Sets the unit for label overrun distance.
void setOverrunDistance(double distance)
Sets the distance which labels are allowed to overrun past the start or end of line features.
AnchorClipping anchorClipping() const
Returns the line anchor clipping mode, which dictates how line strings are clipped before calculating...
void setReverseDirectionSymbol(bool reversed)
Sets whether the direction symbols should be reversed.
void setAddDirectionSymbol(bool enabled)
Sets whether '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will...
void setOverlapHandling(Qgis::LabelOverlapHandling handling)
Sets the technique used to handle overlapping labels.
void setPrioritization(Qgis::LabelPrioritization prioritization)
Sets the technique used to prioritize labels.
void setAllowDegradedPlacement(bool allow)
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.
void setMaximumDistance(double distance)
Sets the maximum distance which labels are allowed to be from their corresponding points.
void setMaximumDistanceMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale for label maximum distance.
void setQuadrant(Qgis::LabelQuadrantPosition quadrant)
Sets the quadrant in which to offset labels from the point.
void setMaximumDistanceUnit(Qgis::RenderUnit unit)
Sets the unit for label maximum distance.
void setMaximumNumberLabels(int number)
Sets the maximum number of labels which should be drawn for this layer.
void setLimitNumberLabelsEnabled(bool enabled)
Sets whether the the number of labels drawn for the layer should be limited.
void setMinimumFeatureSize(double size)
Sets the minimum feature size (in millimeters) for a feature to be labelled.
Map canvas is a class for displaying all GIS data types on a canvas.
Base class for all map layer types.
Contains settings for how a map layer will be labeled.
bool fitInPolygonOnly
true if only labels which completely fit within a polygon are allowed.
double yOffset
Vertical offset of label.
QgsMapUnitScale labelOffsetMapUnitScale
Map unit scale for label offset.
int fontMaxPixelSize
Maximum pixel size for showing rendered map unit labels (1 - 10000).
void setObstacleSettings(const QgsLabelObstacleSettings &settings)
Sets the label obstacle settings.
const QgsLabelPlacementSettings & placementSettings() const
Returns the label placement settings.
double maxCurvedCharAngleIn
Maximum angle between inside curved label characters (valid range 20.0 to 60.0).
void setFormat(const QgsTextFormat &format)
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
double zIndex
Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-ind...
void setPolygonPlacementFlags(Qgis::LabelPolygonPlacementFlags flags)
Sets the polygon placement flags, which dictate how polygon labels can be placed.
QString wrapChar
Wrapping character string.
Qgis::LabelOffsetType offsetType
Offset type for layer (only applies in certain placement modes)
double xOffset
Horizontal offset of label.
Qgis::LabelPlacement placement
Label placement mode.
bool drawLabels
Whether to draw labels for this layer.
bool fontLimitPixelSize
true if label sizes should be limited by pixel size.
double minimumScale
The minimum map scale (i.e.
bool scaleVisibility
Set to true to limit label visibility to a range of scales.
double repeatDistance
Distance for repeating labels for a single feature.
bool geometryGeneratorEnabled
Defines if the geometry generator is enabled or not. If disabled, the standard geometry will be taken...
Qgis::LabelMultiLineAlignment multilineAlign
Horizontal alignment of multi-line labels.
bool centroidInside
true if centroid positioned labels must be placed inside their corresponding feature polygon,...
int priority
Label priority.
Qgis::GeometryType geometryGeneratorType
The type of the result geometry of the geometry generator.
bool labelPerPart
true if every part of a multi-part feature should be labeled.
int fontMinPixelSize
Minimum pixel size for showing rendered map unit labels (1 - 1000).
double angleOffset
Label rotation, in degrees clockwise.
double maxCurvedCharAngleOut
Maximum angle between outside curved label characters (valid range -20.0 to -95.0)
const QgsLabelThinningSettings & thinningSettings() const
Returns the label thinning settings.
Qgis::GeometryType layerType
Geometry type of layers associated with these settings.
Qgis::RenderUnit offsetUnits
Units for offsets of label.
void setDataDefinedProperties(const QgsPropertyCollection &collection)
Sets the label's property collection, used for data defined overrides.
bool isExpression
true if this label is made from a expression string, e.g., FieldName || 'mm'
bool preserveRotation
True if label rotation should be preserved during label pin/unpin operations.
bool plusSign
Whether '+' signs should be prepended to positive numeric labels.
QString geometryGenerator
The geometry generator expression. Null if disabled.
const QgsLabelLineSettings & lineSettings() const
Returns the label line settings, which contain settings related to how the label engine places and fo...
QgsMapUnitScale distMapUnitScale
Map unit scale for label feature distance.
QgsStringReplacementCollection substitutions
Substitution collection for automatic text substitution with labels.
int decimals
Number of decimal places to show for numeric labels.
double dist
Distance from feature to the label.
void setRotationUnit(Qgis::AngleUnit angleUnit)
Set unit for rotation of labels.
QgsMapUnitScale repeatDistanceMapUnitScale
Map unit scale for repeating labels for a single feature.
Qgis::RenderUnit distUnits
Units the distance from feature to the label.
bool centroidWhole
true if feature centroid should be calculated from the whole feature, or false if only the visible pa...
Qgis::RenderUnit repeatDistanceUnit
Units for repeating labels for a single feature.
Qgis::UpsideDownLabelHandling upsidedownLabels
Controls whether upside down labels are displayed and how they are handled.
QString fieldName
Name of field (or an expression) to use for label text.
bool formatNumbers
Set to true to format numeric label text as numbers (e.g.
void setCallout(QgsCallout *callout)
Sets the label callout renderer, responsible for drawing label callouts.
double maximumScale
The maximum map scale (i.e.
int autoWrapLength
If non-zero, indicates that label text should be automatically wrapped to (ideally) the specified num...
bool useMaxLineLengthForAutoWrap
If true, indicates that when auto wrapping label text the autoWrapLength length indicates the maximum...
void setUnplacedVisibility(Qgis::UnplacedLabelVisibility visibility)
Sets the layer's unplaced label visibility.
const QgsLabelPointSettings & pointSettings() const
Returns the label point settings, which contain settings related to how the label engine places and f...
bool useSubstitutions
True if substitutions should be applied.
QgsStyle * styleAtPath(const QString &path)
Returns a reference to the style database associated with the project with matching file path.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
static QgsProject * instance()
Returns the QgsProject singleton instance.
const QgsProjectStyleSettings * styleSettings() const
Returns the project's style settings, which contains settings and properties relating to how a QgsPro...
QgsCoordinateTransformContext transformContext
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
The class is used as a container of context for various read/write operations on other objects.
a dialog for setting properties of a newly saved style.
bool removeLabelSettings(const QString &name)
Removes label settings from the style.
bool saveLabelSettings(const QString &name, const QgsPalLayerSettings &settings, bool favorite, const QStringList &tags)
Adds label settings to the database.
QStringList textFormatNames() const
Returns a list of names of text formats in the style.
bool removeTextFormat(const QString &name)
Removes a text format from the style.
StyleEntity
Enum for Entities involved in a style.
@ LabelSettingsEntity
Label settings.
@ TextFormatEntity
Text formats.
@ SmartgroupEntity
Smart groups.
@ Symbol3DEntity
3D symbol entity
@ ColorrampEntity
Color ramps.
@ LegendPatchShapeEntity
Legend patch shape.
static QgsStyle * defaultStyle(bool initialize=true)
Returns the default application-wide style.
QStringList labelSettingsNames() const
Returns a list of names of label settings in the style.
bool addTextFormat(const QString &name, const QgsTextFormat &format, bool update=false)
Adds a text format with the specified name to the style.
QgsPalLayerSettings labelSettings(const QString &name) const
Returns the label settings with the specified name.
bool saveTextFormat(const QString &name, const QgsTextFormat &format, bool favorite, const QStringList &tags)
Adds a text format to the database.
bool addLabelSettings(const QString &name, const QgsPalLayerSettings &settings, bool update=false)
Adds label settings with the specified name to the style.
Contains settings which reflect the context in which a symbol (or renderer) widget is shown,...
void setMapCanvas(QgsMapCanvas *canvas)
Sets the map canvas associated with the widget.
void setExpressionContext(QgsExpressionContext *context)
Sets the optional expression context used for the widget.
A widget for customizing text formatting settings.
virtual void setContext(const QgsSymbolWidgetContext &context)
Sets the context in which the widget is shown, e.g., the associated map canvas and expression context...
virtual void setFormatFromStyle(const QString &name, QgsStyle::StyleEntity type, const QString &stylePath)
Sets the current text settings from a style entry.
Container for all settings relating to text rendering.
static Q_INVOKABLE QString toString(Qgis::DistanceUnit unit)
Returns a translated string representing a distance unit.
Represents a vector layer which manages a vector based data sets.
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
Q_INVOKABLE Qgis::GeometryType geometryType() const
Returns point, line or polygon.
static QString geometryDisplayString(Qgis::GeometryType type)
Returns a display string for a geometry type.
@ Unknown
Unknown/invalid format.
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.