QgsTextFormatWidget Class Reference

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

#include <qgstextformatwidget.h>

Inheritance diagram for QgsTextFormatWidget:

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

Signals
void	widgetChanged ()
	Emitted when the text format defined by the widget changes. More...

Public Member Functions
	QgsTextFormatWidget (const QgsTextFormat &format=QgsTextFormat(), QgsMapCanvas *mapCanvas=nullptr, QWidget *parent=nullptr)
	Constructor for QgsTextFormatWidget. More...
	~QgsTextFormatWidget () override
QgsTextFormat	format () const
	Returns the current formatting settings defined by the widget. More...
void	setFormat (const QgsTextFormat &format)
	Sets the current formatting settings. More...

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

Protected Slots
void	updateLinePlacementOptions ()
	Updates line placement options to reflect current state of widget. More...
void	updatePlacementWidgets ()
	Updates label placement options to reflect current state of widget. More...

Protected Member Functions
	QgsTextFormatWidget (QgsMapCanvas *mapCanvas, QWidget *parent, Mode mode)
	Constructor for QgsTextFormatWidget. More...
void	enableDataDefinedAlignment (bool enable)
	Controls whether data defined alignment buttons are enabled. More...
void	setPreviewBackground (const QColor &color)
	Sets the background color for the text preview widget. More...
void	updateWidgetForFormat (const QgsTextFormat &format)
	Updates the widget's state to reflect the settings in a QgsTextFormat. More...

Protected Attributes
QButtonGroup *	mDirectSymbBtnGrp = nullptr
	Symbol direction button group. More...
int	mMinPixelLimit = 0
	Pixel size font limit. More...
QButtonGroup *	mPlaceLineBtnGrp = nullptr
	Line placement button group. More...
QButtonGroup *	mPlacePointBtnGrp = nullptr
	Point placement button group. More...
QButtonGroup *	mPlacePolygonBtnGrp = nullptr
	Polygon placement button group. More...
QButtonGroup *	mQuadrantBtnGrp = nullptr
	Quadrant button group. More...
QgsStringReplacementCollection	mSubstitutions
	Text substitution list. More...
QButtonGroup *	mUpsidedownBtnGrp = nullptr
	Upside down labels button group. More...

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.

Since

QGIS 3.0

Definition at line 49 of file qgstextformatwidget.h.

Member Enumeration Documentation

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 93 of file qgstextformatwidget.h.

Constructor & Destructor Documentation

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

Constructor for QgsTextFormatWidget.

Parameters

format	initial formatting settings to show in widget
mapCanvas	associated map canvas
parent	parent widget

Definition at line 34 of file qgstextformatwidget.cpp.

QgsTextFormatWidget::~QgsTextFormatWidget ( )

override

Definition at line 771 of file qgstextformatwidget.cpp.

QgsTextFormatWidget::QgsTextFormatWidget ( QgsMapCanvas *  mapCanvas, QWidget *  parent, Mode  mode  )

protected

Constructor for QgsTextFormatWidget.

Parameters

mapCanvas	associated map canvas
parent	parent widget
mode	widget mode

Definition at line 43 of file qgstextformatwidget.cpp.

Member Function Documentation

void QgsTextFormatWidget::enableDataDefinedAlignment ( bool  enable )

protected

Controls whether data defined alignment buttons are enabled.

Parameters

enable

set to true to enable alignment controls

Definition at line 1479 of file qgstextformatwidget.cpp.

QgsTextFormat QgsTextFormatWidget::format

(

)

const

Returns the current formatting settings defined by the widget.

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 568 of file qgstextformatwidget.cpp.

void QgsTextFormatWidget::setFormat

(

const QgsTextFormat &

format

)

Sets the current formatting settings.

Since

QGIS 3.2

Definition at line 863 of file qgstextformatwidget.cpp.

void QgsTextFormatWidget::setPreviewBackground ( const QColor &  color )

protected

Sets the background color for the text preview widget.

Parameters

color

background color

Definition at line 957 of file qgstextformatwidget.cpp.

void QgsTextFormatWidget::updateLinePlacementOptions ( )

protectedslot

Updates line placement options to reflect current state of widget.

Definition at line 1252 of file qgstextformatwidget.cpp.

void QgsTextFormatWidget::updatePlacementWidgets ( )

protectedslot

Updates label placement options to reflect current state of widget.

Definition at line 970 of file qgstextformatwidget.cpp.

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 647 of file qgstextformatwidget.cpp.

void QgsTextFormatWidget::widgetChanged ( )

signal

Emitted when the text format defined by the widget changes.

Member Data Documentation

QButtonGroup* QgsTextFormatWidget::mDirectSymbBtnGrp = nullptr

protected

Symbol direction button group.

Definition at line 130 of file qgstextformatwidget.h.

int QgsTextFormatWidget::mMinPixelLimit = 0

protected

Pixel size font limit.

Definition at line 140 of file qgstextformatwidget.h.

QButtonGroup* QgsTextFormatWidget::mPlaceLineBtnGrp = nullptr

protected

Line placement button group.

Definition at line 136 of file qgstextformatwidget.h.

QButtonGroup* QgsTextFormatWidget::mPlacePointBtnGrp = nullptr

protected

Point placement button group.

Definition at line 134 of file qgstextformatwidget.h.

QButtonGroup* QgsTextFormatWidget::mPlacePolygonBtnGrp = nullptr

protected

Polygon placement button group.

Definition at line 138 of file qgstextformatwidget.h.

QButtonGroup* QgsTextFormatWidget::mQuadrantBtnGrp = nullptr

protected

Quadrant button group.

Definition at line 128 of file qgstextformatwidget.h.

QgsStringReplacementCollection QgsTextFormatWidget::mSubstitutions

protected

Text substitution list.

Definition at line 126 of file qgstextformatwidget.h.

QButtonGroup* QgsTextFormatWidget::mUpsidedownBtnGrp = nullptr

protected

Upside down labels button group.

Definition at line 132 of file qgstextformatwidget.h.

Property Documentation

QgsTextFormat QgsTextFormatWidget::format

read

Definition at line 52 of file qgstextformatwidget.h.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/qgstextformatwidget.h
• /build/qgis-3.4.15+24xenial/src/gui/qgstextformatwidget.cpp