35#include <QButtonGroup>
69void QgsLabelingGui::updateCalloutWidget(
QgsCallout *callout )
73 mCalloutStackedWidget->setCurrentWidget( pageDummy );
77 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
80 mCalloutStackedWidget->setCurrentWidget( pageDummy );
84 if ( mCalloutStackedWidget->currentWidget() != pageDummy )
87 if (
QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
98 if ( mGeometryGeneratorGroupBox->isChecked() )
102 w->setGeometryType( geometryType );
103 w->setCallout( callout );
105 w->setContext( context() );
106 mCalloutStackedWidget->addWidget( w );
107 mCalloutStackedWidget->setCurrentWidget( w );
114 mCalloutStackedWidget->setCurrentWidget( pageDummy );
117void QgsLabelingGui::showObstacleSettings()
119 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
137 auto applySettings = [ = ]
139 mObstacleSettings = widget->
settings();
142 emit widgetChanged();
158 dialog.buttonBox()->addButton( QDialogButtonBox::Help );
159 connect( dialog.buttonBox(), &QDialogButtonBox::helpRequested,
this, [ = ]
161 QgsHelp::openHelp( QStringLiteral(
"style_library/label_settings.html#obstacles" ) );
173void QgsLabelingGui::showLineAnchorSettings()
175 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
193 auto applySettings = [ = ]
197 mLineSettings.setAnchorType( widgetSettings.
anchorType() );
198 mLineSettings.setAnchorClipping( widgetSettings.
anchorClipping() );
202 emit widgetChanged();
218 dialog.buttonBox()->addButton( QDialogButtonBox::Help );
219 connect( dialog.buttonBox(), &QDialogButtonBox::helpRequested,
this, [ = ]
221 QgsHelp::openHelp( QStringLiteral(
"style_library/label_settings.html#placement-for-line-layers" ) );
235 , mSettings( layerSettings )
237 , mCanvas( mapCanvas )
241 mGeomType = geomType;
258 connect( mBufferDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
260 connect( mEnableMaskChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
261 connect( mShapeDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
262 connect( mCalloutsDrawCheckBox, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
263 connect( mShadowDrawChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
264 connect( mDirectSymbChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
265 connect( mFormatNumChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
266 connect( mScaleBasedVisibilityChkBx, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
267 connect( mFontLimitPixelChkBox, &QAbstractButton::toggled,
this, &QgsLabelingGui::updateUi );
268 connect( mGeometryGeneratorGroupBox, &QGroupBox::toggled,
this, &QgsLabelingGui::updateGeometryTypeBasedWidgets );
269 connect( mGeometryGeneratorType, qOverload<int>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::updateGeometryTypeBasedWidgets );
270 connect( mGeometryGeneratorExpressionButton, &QToolButton::clicked,
this, &QgsLabelingGui::showGeometryGeneratorExpressionBuilder );
271 connect( mGeometryGeneratorGroupBox, &QGroupBox::toggled,
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
272 connect( mGeometryGenerator, &QgsCodeEditorExpression::textChanged,
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
273 connect( mGeometryGeneratorType, qOverload<int>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::validateGeometryGeneratorExpression );
274 connect( mObstacleSettingsButton, &QAbstractButton::clicked,
this, &QgsLabelingGui::showObstacleSettings );
275 connect( mLineAnchorSettingsButton, &QAbstractButton::clicked,
this, &QgsLabelingGui::showLineAnchorSettings );
277 mFieldExpressionWidget->registerExpressionContextGenerator(
this );
279 mMinScaleWidget->setMapCanvas( mCanvas );
280 mMinScaleWidget->setShowCurrentScaleButton(
true );
281 mMaxScaleWidget->setMapCanvas( mCanvas );
282 mMaxScaleWidget->setShowCurrentScaleButton(
true );
284 mGeometryGeneratorExpressionButton->setSizePolicy( QSizePolicy::Minimum, QSizePolicy::Minimum );
288 for (
const QString &type : calloutTypes )
294 mGeometryGeneratorWarningLabel->setStyleSheet( QStringLiteral(
"color: #FFC107;" ) );
295 mGeometryGeneratorWarningLabel->setTextInteractionFlags( Qt::TextBrowserInteraction );
296 connect( mGeometryGeneratorWarningLabel, &QLabel::linkActivated,
this, [
this](
const QString & link )
298 if ( link == QLatin1String(
"#determineGeometryGeneratorType" ) )
299 determineGeometryGeneratorType();
302 connect( mCalloutStyleComboBox,
static_cast<void ( QComboBox::* )(
int )
>( &QComboBox::currentIndexChanged ),
this, &QgsLabelingGui::calloutTypeChanged );
304 mLblNoObstacle1->installEventFilter(
this );
309void QgsLabelingGui::setLayer(
QgsMapLayer *mapLayer )
322 QgsVectorLayer *vLayer = qobject_cast<QgsVectorLayer *>( mapLayer );
324 mTextFormatsListWidget->setLayerType( vLayer ? vLayer->
geometryType() : mGeomType );
325 mBackgroundMarkerSymbolButton->setLayer( vLayer );
326 mBackgroundFillSymbolButton->setLayer( vLayer );
329 updateGeometryTypeBasedWidgets();
331 mFieldExpressionWidget->setLayer( mapLayer );
336 mFieldExpressionWidget->setGeomCalculator( da );
338 mFieldExpressionWidget->setEnabled( mMode == Labels || !mLayer );
339 mLabelingFrame->setEnabled( mMode == Labels || !mLayer );
341 blockInitSignals(
true );
343 mGeometryGenerator->setText( mSettings.geometryGenerator );
344 mGeometryGeneratorGroupBox->setChecked( mSettings.geometryGeneratorEnabled );
345 if ( !mSettings.geometryGeneratorEnabled )
346 mGeometryGeneratorGroupBox->setCollapsed(
true );
347 mGeometryGeneratorType->setCurrentIndex( mGeometryGeneratorType->findData( QVariant::fromValue( mSettings.geometryGeneratorType ) ) );
349 updateWidgetForFormat( mSettings.format().isValid() ? mSettings.format() :
QgsStyle::defaultTextFormatForProject(
QgsProject::instance(),
QgsStyle::TextFormatContext::Labeling ) );
351 mFieldExpressionWidget->setRow( -1 );
352 mFieldExpressionWidget->setField( mSettings.fieldName );
353 mCheckBoxSubstituteText->setChecked( mSettings.useSubstitutions );
354 mSubstitutions = mSettings.substitutions;
357 mCentroidRadioWhole->setChecked( mSettings.centroidWhole );
358 mCentroidInsideCheckBox->setChecked( mSettings.centroidInside );
359 mFitInsidePolygonCheckBox->setChecked( mSettings.fitInPolygonOnly );
360 mLineDistanceSpnBx->setValue( mSettings.dist );
361 mLineDistanceUnitWidget->setUnit( mSettings.distUnits );
362 mLineDistanceUnitWidget->setMapUnitScale( mSettings.distMapUnitScale );
364 mMaximumDistanceSpnBx->setValue( mSettings.pointSettings().maximumDistance() );
365 mMaximumDistanceUnitWidget->setUnit( mSettings.pointSettings().maximumDistanceUnit() );
366 mMaximumDistanceUnitWidget->setMapUnitScale( mSettings.pointSettings().maximumDistanceMapUnitScale() );
368 mOffsetTypeComboBox->setCurrentIndex( mOffsetTypeComboBox->findData(
static_cast< int >( mSettings.offsetType ) ) );
369 mQuadrantBtnGrp->button(
static_cast<int>( mSettings.pointSettings().quadrant() ) )->setChecked(
true );
370 mPointOffsetXSpinBox->setValue( mSettings.xOffset );
371 mPointOffsetYSpinBox->setValue( mSettings.yOffset );
372 mPointOffsetUnitWidget->setUnit( mSettings.offsetUnits );
373 mPointOffsetUnitWidget->setMapUnitScale( mSettings.labelOffsetMapUnitScale );
374 mPointAngleSpinBox->setValue( mSettings.angleOffset );
382 const int placementIndex = mPlacementModeComboBox->findData(
static_cast< int >( mSettings.placement ) );
383 if ( placementIndex >= 0 )
385 mPlacementModeComboBox->setCurrentIndex( placementIndex );
390 mPlacementModeComboBox->setCurrentIndex( 0 );
394 mRepeatDistanceSpinBox->setValue( mSettings.repeatDistance );
395 mRepeatDistanceUnitWidget->setUnit( mSettings.repeatDistanceUnit );
396 mRepeatDistanceUnitWidget->setMapUnitScale( mSettings.repeatDistanceMapUnitScale );
398 mOverrunDistanceSpinBox->setValue( mSettings.lineSettings().overrunDistance() );
399 mOverrunDistanceUnitWidget->setUnit( mSettings.lineSettings().overrunDistanceUnit() );
400 mOverrunDistanceUnitWidget->setMapUnitScale( mSettings.lineSettings().overrunDistanceMapUnitScale() );
402 mPrioritySlider->setValue( mSettings.priority );
403 mChkNoObstacle->setChecked( mSettings.obstacleSettings().isObstacle() );
405 mObstacleSettings = mSettings.obstacleSettings();
406 mLineSettings = mSettings.lineSettings();
408 chkLabelPerFeaturePart->setChecked( mSettings.labelPerPart );
410 mComboOverlapHandling->setCurrentIndex( mComboOverlapHandling->findData(
static_cast< int >( mSettings.placementSettings().overlapHandling() ) ) );
411 mCheckAllowDegradedPlacement->setChecked( mSettings.placementSettings().allowDegradedPlacement() );
412 mPrioritizationComboBox->setCurrentIndex( mPrioritizationComboBox->findData( QVariant::fromValue( mSettings.placementSettings().prioritization() ) ) );
414 chkMergeLines->setChecked( mSettings.lineSettings().mergeLines() );
415 mMinSizeSpinBox->setValue( mSettings.thinningSettings().minimumFeatureSize() );
416 mLimitLabelChkBox->setChecked( mSettings.thinningSettings().limitNumberOfLabelsEnabled() );
417 mLimitLabelSpinBox->setValue( mSettings.thinningSettings().maximumNumberLabels() );
420 mDirectSymbChkBx->setChecked( mSettings.lineSettings().addDirectionSymbol() );
421 mDirectSymbLeftLineEdit->setText( mSettings.lineSettings().leftDirectionSymbol() );
422 mDirectSymbRightLineEdit->setText( mSettings.lineSettings().rightDirectionSymbol() );
423 mDirectSymbRevChkBx->setChecked( mSettings.lineSettings().reverseDirectionSymbol() );
425 mDirectSymbBtnGrp->button(
static_cast<int>( mSettings.lineSettings().directionSymbolPlacement() ) )->setChecked(
true );
426 mUpsidedownBtnGrp->button(
static_cast<int>( mSettings.upsidedownLabels ) )->setChecked(
true );
429 mMaxCharAngleInDSpinBox->setValue( mSettings.maxCurvedCharAngleIn );
431 mMaxCharAngleOutDSpinBox->setValue( std::fabs( mSettings.maxCurvedCharAngleOut ) );
433 wrapCharacterEdit->setText( mSettings.wrapChar );
434 mAutoWrapLengthSpinBox->setValue( mSettings.autoWrapLength );
435 mAutoWrapTypeComboBox->setCurrentIndex( mSettings.useMaxLineLengthForAutoWrap ? 0 : 1 );
437 if ( mFontMultiLineAlignComboBox->findData(
static_cast< int >( mSettings.multilineAlign ) ) != -1 )
439 mFontMultiLineAlignComboBox->setCurrentIndex( mFontMultiLineAlignComboBox->findData(
static_cast< int >( mSettings.multilineAlign ) ) );
445 mFontMultiLineAlignComboBox->setCurrentIndex( 0 );
448 chkPreserveRotation->setChecked( mSettings.preserveRotation );
450 mCoordRotationUnitComboBox->setCurrentIndex( 0 );
451 if ( mCoordRotationUnitComboBox->findData(
static_cast< unsigned int >( mSettings.rotationUnit() ) ) >= 0 )
452 mCoordRotationUnitComboBox->setCurrentIndex( mCoordRotationUnitComboBox->findData(
static_cast< unsigned int >( mSettings.rotationUnit() ) ) );
454 mScaleBasedVisibilityChkBx->setChecked( mSettings.scaleVisibility );
455 mMinScaleWidget->setScale( mSettings.minimumScale );
456 mMaxScaleWidget->setScale( mSettings.maximumScale );
458 mFormatNumChkBx->setChecked( mSettings.formatNumbers );
459 mFormatNumDecimalsSpnBx->setValue( mSettings.decimals );
460 mFormatNumPlusSignChkBx->setChecked( mSettings.plusSign );
464 mFontLimitPixelChkBox->setChecked( mSettings.fontLimitPixelSize );
465 mMinPixelLimit = mSettings.fontMinPixelSize;
466 mFontMinPixelSpinBox->setValue( mSettings.fontMinPixelSize == 0 ? 3 : mSettings.fontMinPixelSize );
467 mFontMaxPixelSpinBox->setValue( mSettings.fontMaxPixelSize );
469 mZIndexSpinBox->setValue( mSettings.zIndex );
471 mDataDefinedProperties = mSettings.dataDefinedProperties();
474 if (
auto *lCallout = mSettings.callout() )
476 whileBlocking( mCalloutsDrawCheckBox )->setChecked( lCallout->enabled() );
477 whileBlocking( mCalloutStyleComboBox )->setCurrentIndex( mCalloutStyleComboBox->findData( lCallout->type() ) );
478 updateCalloutWidget( lCallout );
483 whileBlocking( mCalloutStyleComboBox )->setCurrentIndex( mCalloutStyleComboBox->findData( defaultCallout->type() ) );
485 updateCalloutWidget( defaultCallout.get() );
488 updatePlacementWidgets();
489 updateLinePlacementOptions();
492 blockInitSignals(
false );
496 populateDataDefinedButtons();
503 mSettings = settings;
507void QgsLabelingGui::blockInitSignals(
bool block )
509 chkLineAbove->blockSignals( block );
510 chkLineBelow->blockSignals( block );
511 mPlacementModeComboBox->blockSignals( block );
514void QgsLabelingGui::setLabelMode( LabelMode mode )
517 mFieldExpressionWidget->setEnabled( mMode == Labels );
518 mLabelingFrame->setEnabled( mMode == Labels );
528 lyr.
drawLabels = ( mMode == Labels ) || !mLayer;
531 lyr.
fieldName = mFieldExpressionWidget->currentField( &isExpression );
537 if ( mCheckAllowLabelsOutsidePolygons->isChecked() )
544 lyr.
dist = mLineDistanceSpnBx->value();
545 lyr.
distUnits = mLineDistanceUnitWidget->unit();
553 if ( mQuadrantBtnGrp )
557 lyr.
xOffset = mPointOffsetXSpinBox->value();
558 lyr.
yOffset = mPointOffsetYSpinBox->value();
564 if ( chkLineAbove->isChecked() )
566 if ( chkLineBelow->isChecked() )
568 if ( chkLineOn->isChecked() )
570 if ( ! chkLineOrientationDependent->isChecked() )
584 lyr.
priority = mPrioritySlider->value();
586 mObstacleSettings.setIsObstacle( mChkNoObstacle->isChecked() || mMode == ObstaclesOnly );
611 lyr.
decimals = mFormatNumDecimalsSpnBx->value();
612 lyr.
plusSign = mFormatNumPlusSignChkBx->isChecked();
619 if ( mDirectSymbBtnGrp )
623 if ( mUpsidedownBtnGrp )
639 lyr.
wrapChar = wrapCharacterEdit->text();
649 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
652 lyr.
zIndex = mZIndexSpinBox->value();
657 const QString calloutType = mCalloutStyleComboBox->currentData().toString();
658 std::unique_ptr< QgsCallout > callout;
659 if (
QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
661 callout.reset( pew->callout()->clone() );
666 callout->
setEnabled( mCalloutsDrawCheckBox->isChecked() );
674 f->setEnabled( chkBx->isChecked() || ddBtn->
isActive() );
677bool QgsLabelingGui::eventFilter( QObject *
object, QEvent *event )
679 if (
object == mLblNoObstacle1 )
681 if ( event->type() == QEvent::MouseButtonPress && qgis::down_cast< QMouseEvent * >( event )->button() == Qt::LeftButton )
684 mChkNoObstacle->setChecked( !mChkNoObstacle->isChecked() );
689 return QgsTextFormatWidget::eventFilter(
object, event );
692void QgsLabelingGui::updateUi()
696 syncDefinedCheckboxFrame( mBufferDrawDDBtn, mBufferDrawChkBx, mBufferFrame );
697 syncDefinedCheckboxFrame( mEnableMaskDDBtn, mEnableMaskChkBx, mMaskFrame );
698 syncDefinedCheckboxFrame( mShapeDrawDDBtn, mShapeDrawChkBx, mShapeFrame );
699 syncDefinedCheckboxFrame( mShadowDrawDDBtn, mShadowDrawChkBx, mShadowFrame );
700 syncDefinedCheckboxFrame( mCalloutDrawDDBtn, mCalloutsDrawCheckBox, mCalloutFrame );
702 syncDefinedCheckboxFrame( mDirectSymbDDBtn, mDirectSymbChkBx, mDirectSymbFrame );
703 syncDefinedCheckboxFrame( mFormatNumDDBtn, mFormatNumChkBx, mFormatNumFrame );
704 syncDefinedCheckboxFrame( mScaleBasedVisibilityDDBtn, mScaleBasedVisibilityChkBx, mScaleBasedVisibilityFrame );
705 syncDefinedCheckboxFrame( mFontLimitPixelDDBtn, mFontLimitPixelChkBox, mFontLimitPixelFrame );
707 chkMergeLines->setEnabled( !mDirectSymbChkBx->isChecked() );
708 if ( mDirectSymbChkBx->isChecked() )
710 chkMergeLines->setToolTip( tr(
"This option is not compatible with line direction symbols." ) );
714 chkMergeLines->setToolTip( QString() );
718void QgsLabelingGui::setFormatFromStyle(
const QString &name,
QgsStyle::StyleEntity type,
const QString &stylePath )
749 settings.
fieldName = mFieldExpressionWidget->currentField( &isExpression );
752 setSettings( settings );
760 if (
QgsCalloutWidget *cw = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() ) )
762 cw->setContext( context );
767void QgsLabelingGui::saveFormat()
770 saveDlg.setDefaultTags( mTextFormatsListWidget->currentTagFilter() );
771 if ( !saveDlg.exec() )
774 if ( saveDlg.name().isEmpty() )
777 QgsStyle *style = saveDlg.destinationStyle();
781 switch ( saveDlg.selectedType() )
788 const int res = QMessageBox::warning(
this, tr(
"Save Text Format" ),
789 tr(
"Format with name '%1' already exists. Overwrite?" )
790 .arg( saveDlg.name() ),
791 QMessageBox::Yes | QMessageBox::No );
792 if ( res != QMessageBox::Yes )
798 const QStringList symbolTags = saveDlg.tags().split(
',' );
802 style->
saveTextFormat( saveDlg.name(), newFormat, saveDlg.isFavorite(), symbolTags );
811 const int res = QMessageBox::warning(
this, tr(
"Save Label Settings" ),
812 tr(
"Label settings with the name '%1' already exist. Overwrite?" )
813 .arg( saveDlg.name() ),
814 QMessageBox::Yes | QMessageBox::No );
815 if ( res != QMessageBox::Yes )
821 const QStringList symbolTags = saveDlg.tags().split(
',' );
825 style->
saveLabelSettings( saveDlg.name(), newSettings, saveDlg.isFavorite(), symbolTags );
839void QgsLabelingGui::updateGeometryTypeBasedWidgets()
843 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
845 if ( mGeometryGeneratorGroupBox->isChecked() )
858 mPlacementModeComboBox->clear();
860 switch ( geometryType )
887 qFatal(
"unknown geometry type unexpected" );
890 if ( mPlacementModeComboBox->findData(
static_cast< int >( prevPlacement ) ) != -1 )
892 mPlacementModeComboBox->setCurrentIndex( mPlacementModeComboBox->findData(
static_cast< int >( prevPlacement ) ) );
905 mFontMultiLineAlignComboBox->removeItem( idx );
908 updatePlacementWidgets();
909 updateLinePlacementOptions();
912void QgsLabelingGui::showGeometryGeneratorExpressionBuilder()
914 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
917 expressionBuilder.setExpressionText( mGeometryGenerator->text() );
918 expressionBuilder.setExpressionContext( createExpressionContext() );
920 if ( expressionBuilder.exec() )
922 mGeometryGenerator->setText( expressionBuilder.expressionText() );
926void QgsLabelingGui::validateGeometryGeneratorExpression()
930 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
932 if ( mGeometryGeneratorGroupBox->isChecked() )
934 if ( !mPreviewFeature.isValid() && vLayer )
941 expression.prepare( &context );
943 if ( expression.hasParserError() )
945 mGeometryGeneratorWarningLabel->setText( expression.parserErrorString() );
950 const QVariant result = expression.evaluate( &context );
955 mGeometryGeneratorWarningLabel->setText( tr(
"Result of the expression is not a geometry" ) );
958 else if ( geometry.
type() != configuredGeometryType )
960 mGeometryGeneratorWarningLabel->setText( QStringLiteral(
"<p>%1</p><p><a href=\"#determineGeometryGeneratorType\">%2</a></p>" ).arg(
961 tr(
"Result of the expression does not match configured geometry type." ),
970 QTimer *timer =
new QTimer();
971 connect( timer, &QTimer::timeout,
this, [
this, valid]()
973 mGeometryGeneratorWarningLabel->setVisible( !valid );
975 connect( timer, &QTimer::timeout, timer, &QTimer::deleteLater );
979void QgsLabelingGui::determineGeometryGeneratorType()
981 QgsVectorLayer *vLayer = qobject_cast< QgsVectorLayer * >( mLayer );
982 if ( !mPreviewFeature.isValid() && vLayer )
989 expression.prepare( &context );
992 mGeometryGeneratorType->setCurrentIndex( mGeometryGeneratorType->findData( QVariant::fromValue( geometry.
type() ) ) );
995void QgsLabelingGui::calloutTypeChanged()
997 const QString newCalloutType = mCalloutStyleComboBox->currentData().toString();
998 QgsCalloutWidget *pew = qobject_cast< QgsCalloutWidget * >( mCalloutStackedWidget->currentWidget() );
1017 updateCalloutWidget( newCallout.get() );
1030 QVBoxLayout *vLayout =
new QVBoxLayout();
1031 mWidget =
new QgsLabelingGui( layer, mapCanvas, settings,
nullptr, geomType );
1032 vLayout->addWidget( mWidget );
1033 mButtonBox =
new QDialogButtonBox( QDialogButtonBox::Cancel | QDialogButtonBox::Help | QDialogButtonBox::Ok, Qt::Horizontal );
1034 connect( mButtonBox, &QDialogButtonBox::accepted,
this, &QDialog::accept );
1035 connect( mButtonBox, &QDialogButtonBox::rejected,
this, &QDialog::reject );
1036 connect( mButtonBox, &QDialogButtonBox::helpRequested,
this, &QgsLabelSettingsDialog::showHelp );
1037 vLayout->addWidget( mButtonBox );
1038 setLayout( vLayout );
1039 setWindowTitle( tr(
"Label Settings" ) );
1042QDialogButtonBox *QgsLabelSettingsDialog::buttonBox()
const
1047void 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 * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
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.