A simple dialog for customizing text formatting settings. More...

#include <qgstextformatwidget.h>

Inheritance diagram for QgsTextFormatDialog:

Public Member Functions
	QgsTextFormatDialog (const QgsTextFormat &format, QgsMapCanvas mapCanvas=nullptr, QWidget parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QgsVectorLayer *layer=nullptr)
	Constructor for QgsTextFormatDialog. More...

QDialogButtonBox *	buttonBox () const
	Returns a reference to the dialog's button box. More...

QgsTextFormat	format () const
	Returns the current formatting settings defined by the widget. More...

void	setContext (const QgsSymbolWidgetContext &context)
	Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts. More...

Detailed Description

A simple dialog for customizing text formatting settings.

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

Since: QGIS 3.0

Definition at line 327 of file qgstextformatwidget.h.

Constructor & Destructor Documentation

◆ QgsTextFormatDialog()

QgsTextFormatDialog::QgsTextFormatDialog	(	const QgsTextFormat &	format,
		QgsMapCanvas *	mapCanvas = `nullptr`,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	fl = `QgsGuiUtils::ModalDialogFlags`,
		QgsVectorLayer *	layer = `nullptr`
	)

Constructor for QgsTextFormatDialog.

Parameters

format	initial format settings to show in dialog
mapCanvas	optional associated map canvas
parent	parent widget
fl	window flags for dialog
layer	associated vector layer

Definition at line 2063 of file qgstextformatwidget.cpp.

Member Function Documentation

◆ buttonBox()

QDialogButtonBox * QgsTextFormatDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Since: QGIS 3.10

Definition at line 2100 of file qgstextformatwidget.cpp.

◆ format()

QgsTextFormat QgsTextFormatDialog::format ( ) const

Returns the current formatting settings defined by the widget.

Definition at line 2085 of file qgstextformatwidget.cpp.

◆ setContext()

void QgsTextFormatDialog::setContext ( const QgsSymbolWidgetContext & context )

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

Since: QGIS 3.10

Definition at line 2095 of file qgstextformatwidget.cpp.

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

/build/qgis-3.18.1+99unstable/src/gui/qgstextformatwidget.h
/build/qgis-3.18.1+99unstable/src/gui/qgstextformatwidget.cpp