QgsExpressionBasedNumericFormatWidget Class Reference

A widget which allow control over the properties of a QgsExpressionBasedNumericFormat. More...

#include <qgsnumericformatwidget.h>

Inheritance diagram for QgsExpressionBasedNumericFormatWidget:

Public Member Functions
	QgsExpressionBasedNumericFormatWidget (const QgsNumericFormat *format, QWidget *parent=nullptr)
	Constructor for QgsExpressionBasedNumericFormatWidget, initially showing the specified format.
	~QgsExpressionBasedNumericFormatWidget () override
QgsExpressionContext	createExpressionContext () const final
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
QgsNumericFormat *	format () final
	Returns the format defined by the current settings in the widget.
void	setFormat (QgsNumericFormat *format) final
	Sets the format to show in the widget.
Public Member Functions inherited from QgsNumericFormatWidget
	QgsNumericFormatWidget (QWidget *parent=nullptr)
	Constructor for QgsNumericFormatWidget.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
void	registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for the widget when required.
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete ()
	The the auto delete property on the widget.
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool	dockMode ()
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle ()
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.
void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
Signals inherited from QgsNumericFormatWidget
void	changed ()
	Emitted whenever the configuration of the numeric format is changed.
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
void	widgetChanged ()
	Emitted when the widget state changes.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

A widget which allow control over the properties of a QgsExpressionBasedNumericFormat.

Since

QGIS 3.40

Definition at line 384 of file qgsnumericformatwidget.h.

Constructor & Destructor Documentation

QgsExpressionBasedNumericFormatWidget()

QgsExpressionBasedNumericFormatWidget::QgsExpressionBasedNumericFormatWidget	(	const QgsNumericFormat *	format,
		QWidget *	parent = nullptr
	)

Constructor for QgsExpressionBasedNumericFormatWidget, initially showing the specified format.

Definition at line 625 of file qgsnumericformatwidget.cpp.

~QgsExpressionBasedNumericFormatWidget()

QgsExpressionBasedNumericFormatWidget::~QgsExpressionBasedNumericFormatWidget ( )

overridedefault

Member Function Documentation

createExpressionContext()

QgsExpressionContext QgsExpressionBasedNumericFormatWidget::createExpressionContext ( ) const

finalvirtual

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

Implements QgsExpressionContextGenerator.

Definition at line 643 of file qgsnumericformatwidget.cpp.

format()

QgsNumericFormat * QgsExpressionBasedNumericFormatWidget::format ( )

finalvirtual

Returns the format defined by the current settings in the widget.

Ownership of the returned object is transferred to the caller

See also

setFormat()

Implements QgsNumericFormatWidget.

Definition at line 665 of file qgsnumericformatwidget.cpp.

setFormat()

void QgsExpressionBasedNumericFormatWidget::setFormat ( QgsNumericFormat *  format )

finalvirtual

Sets the format to show in the widget.

Ownership is not transferred.

See also

format()

Implements QgsNumericFormatWidget.

Definition at line 656 of file qgsnumericformatwidget.cpp.

---

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

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/numericformats/qgsnumericformatwidget.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/numericformats/qgsnumericformatwidget.cpp