A widget for customizing text formatting settings. More...

#include <qgstextformatwidget.h>

Inheritance diagram for QgsTextFormatWidget:

[legend]

Public Slots
void	setDockMode (bool enabled)
	Sets whether the widget should be shown in a compact dock mode.

Signals
void	auxiliaryFieldCreated ()
	Emitted when an auxiliary field is created in the widget.
void	widgetChanged ()
	Emitted when the text format defined by the widget changes.

Public Member Functions
	QgsTextFormatWidget (const QgsTextFormat &format=QgsTextFormat(), QgsMapCanvas mapCanvas=nullptr, QWidget parent=nullptr, QgsMapLayer *layer=nullptr)
	Constructor for QgsTextFormatWidget.
	~QgsTextFormatWidget () override
QgsSymbolWidgetContext	context () const
	Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
void	deactivateField (QgsPalLayerSettings::Property key)
	Deactivate a field from data defined properties and update the corresponding button.
QgsTextFormat	format (bool includeDataDefinedProperties=true) const
	Returns the current formatting settings defined by the widget.
virtual void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
void	setFormat (const QgsTextFormat &format)
	Sets the current formatting settings.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Protected Types
enum	Mode { Text = 0 , Labeling }
	Widget mode. More...

Protected Slots
void	populateDataDefinedButtons ()
	Sets up connections required for data defined buttons, or updates the existing definition of these buttons.
virtual void	saveFormat ()
	Saves the current text settings to a style entry.
virtual void	setFormatFromStyle (const QString &name, QgsStyle::StyleEntity type, const QString &stylePath)
	Sets the current text settings from a style entry.
void	updateLinePlacementOptions ()
	Updates line placement options to reflect current state of widget.
void	updatePlacementWidgets ()
	Updates label placement options to reflect current state of widget.
void	updatePreview ()
	Updates the text preview.

Protected Member Functions
	QgsTextFormatWidget (QgsMapCanvas mapCanvas, QWidget parent, Mode mode, QgsMapLayer *layer=nullptr)
	Constructor for QgsTextFormatWidget.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Q_DECL_DEPRECATED void	enableDataDefinedAlignment (bool enable)
	Update the enabled state of the data defined alignment buttons.
Qgis::GeometryType	labelGeometryType () const
	Returns the geometry type which will be used by the labeling engine when registering labels for the labeling settings currently defined by the widget.
void	setPreviewBackground (const QColor &color)
	Sets the background color for the text preview widget.
void	setPropertyOverrideButtonsVisible (bool visible)
	Toggles whether data defined buttons should be shown in the widget.
void	updateWidgetForFormat (const QgsTextFormat &format)
	Updates the widget's state to reflect the settings in a QgsTextFormat.

Protected Attributes
QListWidgetItem *	mBackgroundItem = nullptr
	Background widget item.
QListWidgetItem *	mBufferItem = nullptr
	Buffer widget item.
QListWidgetItem *	mCalloutItem = nullptr
	Callout widget item.
QgsSymbolWidgetContext	mContext
	Context in which widget is shown.
QgsPropertyCollection	mDataDefinedProperties
	Data defined properties as defined in the widget.
QButtonGroup *	mDirectSymbBtnGrp = nullptr
	Symbol direction button group.
QListWidgetItem *	mFormattingItem = nullptr
	Formatting widget item.
Qgis::GeometryType	mGeomType = Qgis::GeometryType::Unknown
	Geometry type for layer, if known.
QgsMapLayer *	mLayer = nullptr
	Associated vector layer.
QgsMapCanvas *	mMapCanvas = nullptr
	Associated map canvas.
QList< QgsSymbolLayerReference >	mMaskedSymbolLayers
QListWidgetItem *	mMaskItem = nullptr
	Mask widget item.
int	mMinPixelLimit = 0
	Pixel size font limit.
QListWidgetItem *	mPlacementItem = nullptr
	Placement widget item.
QButtonGroup *	mQuadrantBtnGrp = nullptr
	Quadrant button group.
QListWidgetItem *	mRenderingItem = nullptr
	Rendering widget item.
QListWidgetItem *	mShadowItem = nullptr
	Shadow widget item.
QgsStringReplacementCollection	mSubstitutions
	Text substitution list.
QList< QgsTextFormat::Tab >	mTabPositions
	Tab positions.
QListWidgetItem *	mTextItem = nullptr
	Text widget item.
QButtonGroup *	mUpsidedownBtnGrp = nullptr
	Upside down labels button group.

Properties
QgsTextFormat	format

Detailed Description

A widget for customizing text formatting settings.

QgsTextFormatWidget provides a widget for controlling the appearance of text rendered using QgsTextRenderer. The widget includes all settings contained within a QgsTextFormat, including shadow, background and buffer.

Additionally, the widget can handle labeling settings due to the large overlap between the text renderer settings and the labeling settings. This mode is possible by subclassing QgsTextFormatWidget and calling the protected constructor with a mode of Labeling.

Definition at line 51 of file qgstextformatwidget.h.

Member Enumeration Documentation

◆ Mode

enum QgsTextFormatWidget::Mode

protected

Widget mode.

Enumerator
Text	Default mode, show text formatting settings only.
Labeling	Show labeling settings in addition to text formatting settings.

Definition at line 127 of file qgstextformatwidget.h.

Constructor & Destructor Documentation

◆ QgsTextFormatWidget() [1/2]

QgsTextFormatWidget::QgsTextFormatWidget	(	const QgsTextFormat &	format = QgsTextFormat(),
		QgsMapCanvas *	mapCanvas = nullptr,
		QWidget *	parent = nullptr,
		QgsMapLayer *	layer = nullptr )

Constructor for QgsTextFormatWidget.

Parameters

format	initial formatting settings to show in widget
mapCanvas	associated map canvas
parent	parent widget
layer	associated layer (vector or mesh)

Definition at line 55 of file qgstextformatwidget.cpp.

◆ ~QgsTextFormatWidget()

QgsTextFormatWidget::~QgsTextFormatWidget ( )

override

Definition at line 1193 of file qgstextformatwidget.cpp.

◆ QgsTextFormatWidget() [2/2]

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

protected

Constructor for QgsTextFormatWidget.

Parameters

mapCanvas	associated map canvas
parent	parent widget
mode	widget mode
layer	associated vector layer

Definition at line 66 of file qgstextformatwidget.cpp.

Member Function Documentation

◆ auxiliaryFieldCreated

void QgsTextFormatWidget::auxiliaryFieldCreated ( )

signal

Emitted when an auxiliary field is created in the widget.

Since: QGIS 3.10

◆ context()

QgsSymbolWidgetContext QgsTextFormatWidget::context ( ) const

Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also: setContext()

Since: QGIS 3.10

Definition at line 1345 of file qgstextformatwidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsTextFormatWidget::createExpressionContext ( ) const

overrideprotectedvirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 2322 of file qgstextformatwidget.cpp.

◆ deactivateField()

void QgsTextFormatWidget::deactivateField ( QgsPalLayerSettings::Property key )

Deactivate a field from data defined properties and update the corresponding button.

Parameters

key	The property key to deactivate

Definition at line 1350 of file qgstextformatwidget.cpp.

◆ enableDataDefinedAlignment()

Q_DECL_DEPRECATED void QgsTextFormatWidget::enableDataDefinedAlignment ( bool enable )

inlineprotected

Update the enabled state of the data defined alignment buttons.

Deprecated: QGIS 3.24

Definition at line 159 of file qgstextformatwidget.h.

◆ format()

QgsTextFormat QgsTextFormatWidget::format ( bool includeDataDefinedProperties = true ) const

Returns the current formatting settings defined by the widget.

If includateDataDefinedProperties is true, then data defined properties specified in the widget will be included in the format definition.

Definition at line 1214 of file qgstextformatwidget.cpp.

◆ labelGeometryType()

Qgis::GeometryType QgsTextFormatWidget::labelGeometryType ( ) const

protected

Returns the geometry type which will be used by the labeling engine when registering labels for the labeling settings currently defined by the widget.

Since: QGIS 3.16

Definition at line 2350 of file qgstextformatwidget.cpp.

◆ populateDataDefinedButtons

void QgsTextFormatWidget::populateDataDefinedButtons ( )

protectedslot

Sets up connections required for data defined buttons, or updates the existing definition of these buttons.

Since: QGIS 3.10

Definition at line 836 of file qgstextformatwidget.cpp.

◆ saveFormat

void QgsTextFormatWidget::saveFormat ( )

protectedvirtualslot

Saves the current text settings to a style entry.

Definition at line 2135 of file qgstextformatwidget.cpp.

◆ setContext()

void QgsTextFormatWidget::setContext ( const QgsSymbolWidgetContext & context )

virtual

Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also: context()

Since: QGIS 3.10

Definition at line 1386 of file qgstextformatwidget.cpp.

◆ setDockMode

void QgsTextFormatWidget::setDockMode ( bool enabled )

slot

Sets whether the widget should be shown in a compact dock mode.

Parameters

enabled set to true to show in dock mode.

Definition at line 737 of file qgstextformatwidget.cpp.

◆ setFormat()

void QgsTextFormatWidget::setFormat ( const QgsTextFormat & format )

Sets the current formatting settings.

Since: QGIS 3.2

Definition at line 1327 of file qgstextformatwidget.cpp.

◆ setFormatFromStyle

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

protectedvirtualslot

Sets the current text settings from a style entry.

Since: QGIS 3.10

Definition at line 2093 of file qgstextformatwidget.cpp.

◆ setPreviewBackground()

void QgsTextFormatWidget::setPreviewBackground ( const QColor & color )

protected

Sets the background color for the text preview widget.

Parameters

color background color

Definition at line 1489 of file qgstextformatwidget.cpp.

◆ setPropertyOverrideButtonsVisible()

void QgsTextFormatWidget::setPropertyOverrideButtonsVisible ( bool visible )

protected

Toggles whether data defined buttons should be shown in the widget.

Since: QGIS 3.42

Definition at line 722 of file qgstextformatwidget.cpp.

◆ updateLinePlacementOptions

void QgsTextFormatWidget::updateLinePlacementOptions ( )

protectedslot

Updates line placement options to reflect current state of widget.

Definition at line 1888 of file qgstextformatwidget.cpp.

◆ updatePlacementWidgets

void QgsTextFormatWidget::updatePlacementWidgets ( )

protectedslot

Updates label placement options to reflect current state of widget.

Definition at line 1502 of file qgstextformatwidget.cpp.

◆ updatePreview

void QgsTextFormatWidget::updatePreview ( )

protectedslot

Updates the text preview.

Since: QGIS 3.10

Definition at line 1469 of file qgstextformatwidget.cpp.

◆ updateWidgetForFormat()

void QgsTextFormatWidget::updateWidgetForFormat ( const QgsTextFormat & format )

protected

Updates the widget's state to reflect the settings in a QgsTextFormat.

Parameters

format source format

Definition at line 1021 of file qgstextformatwidget.cpp.

◆ widgetChanged

void QgsTextFormatWidget::widgetChanged ( )

signal

Emitted when the text format defined by the widget changes.

Member Data Documentation

◆ mBackgroundItem

QListWidgetItem* QgsTextFormatWidget::mBackgroundItem = nullptr

protected

Background widget item.

Definition at line 218 of file qgstextformatwidget.h.

◆ mBufferItem

QListWidgetItem* QgsTextFormatWidget::mBufferItem = nullptr

protected

Buffer widget item.

Definition at line 214 of file qgstextformatwidget.h.

◆ mCalloutItem

QListWidgetItem* QgsTextFormatWidget::mCalloutItem = nullptr

protected

Callout widget item.

Definition at line 222 of file qgstextformatwidget.h.

◆ mContext

QgsSymbolWidgetContext QgsTextFormatWidget::mContext

protected

Context in which widget is shown.

Definition at line 196 of file qgstextformatwidget.h.

◆ mDataDefinedProperties

QgsPropertyCollection QgsTextFormatWidget::mDataDefinedProperties

protected

Data defined properties as defined in the widget.

Definition at line 199 of file qgstextformatwidget.h.

◆ mDirectSymbBtnGrp

QButtonGroup* QgsTextFormatWidget::mDirectSymbBtnGrp = nullptr

protected

Symbol direction button group.

Definition at line 186 of file qgstextformatwidget.h.

◆ mFormattingItem

QListWidgetItem* QgsTextFormatWidget::mFormattingItem = nullptr

protected

Formatting widget item.

Definition at line 212 of file qgstextformatwidget.h.

◆ mGeomType

Qgis::GeometryType QgsTextFormatWidget::mGeomType = Qgis::GeometryType::Unknown

protected

Geometry type for layer, if known.

Definition at line 207 of file qgstextformatwidget.h.

◆ mLayer

QgsMapLayer* QgsTextFormatWidget::mLayer = nullptr

protected

Associated vector layer.

Definition at line 202 of file qgstextformatwidget.h.

◆ mMapCanvas

QgsMapCanvas* QgsTextFormatWidget::mMapCanvas = nullptr

protected

Associated map canvas.

Definition at line 193 of file qgstextformatwidget.h.

◆ mMaskedSymbolLayers

QList<QgsSymbolLayerReference> QgsTextFormatWidget::mMaskedSymbolLayers

protected

Definition at line 204 of file qgstextformatwidget.h.

◆ mMaskItem

QListWidgetItem* QgsTextFormatWidget::mMaskItem = nullptr

protected

Mask widget item.

Definition at line 216 of file qgstextformatwidget.h.

◆ mMinPixelLimit

int QgsTextFormatWidget::mMinPixelLimit = 0

protected

Pixel size font limit.

Definition at line 190 of file qgstextformatwidget.h.

◆ mPlacementItem

QListWidgetItem* QgsTextFormatWidget::mPlacementItem = nullptr

protected

Placement widget item.

Definition at line 224 of file qgstextformatwidget.h.

◆ mQuadrantBtnGrp

QButtonGroup* QgsTextFormatWidget::mQuadrantBtnGrp = nullptr

protected

Quadrant button group.

Definition at line 184 of file qgstextformatwidget.h.

◆ mRenderingItem

QListWidgetItem* QgsTextFormatWidget::mRenderingItem = nullptr

protected

Rendering widget item.

Definition at line 226 of file qgstextformatwidget.h.

◆ mShadowItem

QListWidgetItem* QgsTextFormatWidget::mShadowItem = nullptr

protected

Shadow widget item.

Definition at line 220 of file qgstextformatwidget.h.

◆ mSubstitutions

QgsStringReplacementCollection QgsTextFormatWidget::mSubstitutions

protected

Text substitution list.

Definition at line 179 of file qgstextformatwidget.h.

◆ mTabPositions

QList<QgsTextFormat::Tab> QgsTextFormatWidget::mTabPositions

protected

Tab positions.

Definition at line 181 of file qgstextformatwidget.h.

◆ mTextItem

QListWidgetItem* QgsTextFormatWidget::mTextItem = nullptr

protected

Text widget item.

Definition at line 210 of file qgstextformatwidget.h.

◆ mUpsidedownBtnGrp

QButtonGroup* QgsTextFormatWidget::mUpsidedownBtnGrp = nullptr

protected

Upside down labels button group.

Definition at line 188 of file qgstextformatwidget.h.

Property Documentation

◆ format

QgsTextFormat QgsTextFormatWidget::format

read

Definition at line 54 of file qgstextformatwidget.h.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20251207+21b3aa880ba+99sid/src/gui/qgstextformatwidget.h
/build/qgis-3.99.0+git20251207+21b3aa880ba+99sid/src/gui/qgstextformatwidget.cpp

Public Slots

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ QgsTextFormatWidget() [1/2]

◆ ~QgsTextFormatWidget()

◆ QgsTextFormatWidget() [2/2]

Member Function Documentation

◆ auxiliaryFieldCreated

◆ context()

◆ createExpressionContext()

◆ deactivateField()

◆ enableDataDefinedAlignment()

◆ format()

◆ labelGeometryType()

◆ populateDataDefinedButtons

◆ saveFormat

◆ setContext()

◆ setDockMode

◆ setFormat()

◆ setFormatFromStyle

◆ setPreviewBackground()

◆ setPropertyOverrideButtonsVisible()

◆ updateLinePlacementOptions

◆ updatePlacementWidgets

◆ updatePreview

◆ updateWidgetForFormat()

◆ widgetChanged

Member Data Documentation

◆ mBackgroundItem

◆ mBufferItem

◆ mCalloutItem

◆ mContext

◆ mDataDefinedProperties

◆ mDirectSymbBtnGrp

◆ mFormattingItem

◆ mGeomType

◆ mLayer

◆ mMapCanvas

◆ mMaskedSymbolLayers

◆ mMaskItem

◆ mMinPixelLimit

◆ mPlacementItem

◆ mQuadrantBtnGrp

◆ mRenderingItem

◆ mShadowItem

◆ mSubstitutions

◆ mTabPositions

◆ mTextItem

◆ mUpsidedownBtnGrp

Property Documentation

◆ format