QGIS API Documentation 3.39.0-Master (93ce9bf5c90)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsNumericFormatSelectorDialog Class Reference

A simple dialog for customizing a numeric format. More...

#include <qgsnumericformatselectorwidget.h>

Inheritance diagram for QgsNumericFormatSelectorDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsNumericFormatSelectorDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=QgsGuiUtils::ModalDialogFlags)
 Constructor for QgsNumericFormatSelectorDialog.
 
QgsNumericFormatformat () const
 Returns a new format object representing the settings currently configured in the dialog.
 
void registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
 Register an expression context generator class that will be used to retrieve an expression context for the dialog when required.
 
void setFormat (const QgsNumericFormat *format)
 Sets the format to show in the dialog.
 

Detailed Description

A simple dialog for customizing a numeric format.

See also
QgsNumericFormatSelectorWidget()
Since
QGIS 3.40

Definition at line 104 of file qgsnumericformatselectorwidget.h.

Constructor & Destructor Documentation

◆ QgsNumericFormatSelectorDialog()

QgsNumericFormatSelectorDialog::QgsNumericFormatSelectorDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  flags = QgsGuiUtils::ModalDialogFlags 
)

Constructor for QgsNumericFormatSelectorDialog.

Parameters
parentparent widget
flagswindow flags for dialog

Definition at line 174 of file qgsnumericformatselectorwidget.cpp.

Member Function Documentation

◆ format()

QgsNumericFormat * QgsNumericFormatSelectorDialog::format ( ) const

Returns a new format object representing the settings currently configured in the dialog.

The caller takes ownership of the returned object.

Definition at line 200 of file qgsnumericformatselectorwidget.cpp.

◆ registerExpressionContextGenerator()

void QgsNumericFormatSelectorDialog::registerExpressionContextGenerator ( QgsExpressionContextGenerator generator)

Register an expression context generator class that will be used to retrieve an expression context for the dialog when required.

Ownership is not transferred, and the generator must exist for the lifetime of this dialog.

Definition at line 205 of file qgsnumericformatselectorwidget.cpp.

◆ setFormat()

void QgsNumericFormatSelectorDialog::setFormat ( const QgsNumericFormat format)

Sets the format to show in the dialog.

Definition at line 195 of file qgsnumericformatselectorwidget.cpp.


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