QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsTextFormatDialog Class Reference

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

#include <qgstextformatwidget.h>

Inheritance diagram for QgsTextFormatDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsTextFormatDialog (const QgsTextFormat &format, QgsMapCanvas *mapCanvas=nullptr, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 Constructor for QgsTextFormatDialog. More...
 
 ~QgsTextFormatDialog () override
 
QgsTextFormat format () const
 Returns the current formatting settings defined by the widget. 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 228 of file qgstextformatwidget.h.

Constructor & Destructor Documentation

◆ QgsTextFormatDialog()

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

Constructor for QgsTextFormatDialog.

Parameters
formatinitial format settings to show in dialog
mapCanvasoptional associated map canvas
parentparent widget
flwindow flags for dialog

Definition at line 1446 of file qgstextformatwidget.cpp.

◆ ~QgsTextFormatDialog()

QgsTextFormatDialog::~QgsTextFormatDialog ( )
override

Definition at line 1469 of file qgstextformatwidget.cpp.

Member Function Documentation

◆ format()

QgsTextFormat QgsTextFormatDialog::format ( ) const

Returns the current formatting settings defined by the widget.

Definition at line 1475 of file qgstextformatwidget.cpp.


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