A widget which allows choice of numeric formats and the properties of them. More...

#include <qgsnumericformatselectorwidget.h>

Inheritance diagram for QgsNumericFormatSelectorWidget:

[legend]

Signals
void	changed ()
	Emitted whenever the format configured55 in the widget 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.

Public Member Functions
	QgsNumericFormatSelectorWidget (QWidget *parent=nullptr)
	Constructor for QgsNumericFormatSelectorWidget with the specified parent widget.

	~QgsNumericFormatSelectorWidget () override

QgsNumericFormat *	format () const
	Returns a new format object representing the settings currently configured in the widget.

void	registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for the widget when required.

void	setFormat (const QgsNumericFormat *format)
	Sets the format to show in the widget.

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.

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.

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 allows choice of numeric formats and the properties of them.

Since: QGIS 3.12

Definition at line 37 of file qgsnumericformatselectorwidget.h.

Constructor & Destructor Documentation

◆ QgsNumericFormatSelectorWidget()

QgsNumericFormatSelectorWidget::QgsNumericFormatSelectorWidget ( QWidget * parent = nullptr )

Constructor for QgsNumericFormatSelectorWidget with the specified parent widget.

Definition at line 29 of file qgsnumericformatselectorwidget.cpp.

◆ ~QgsNumericFormatSelectorWidget()

QgsNumericFormatSelectorWidget::~QgsNumericFormatSelectorWidget ( )

overridedefault

Member Function Documentation

◆ changed

void QgsNumericFormatSelectorWidget::changed ( )

signal

Emitted whenever the format configured55 in the widget is changed.

◆ format()

QgsNumericFormat * QgsNumericFormatSelectorWidget::format ( ) const

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

The caller takes ownership of the returned object.

Definition at line 73 of file qgsnumericformatselectorwidget.cpp.

◆ registerExpressionContextGenerator()

void QgsNumericFormatSelectorWidget::registerExpressionContextGenerator ( QgsExpressionContextGenerator * generator )

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

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

Since: QGIS 3.40

Definition at line 78 of file qgsnumericformatselectorwidget.cpp.

◆ setFormat()

void QgsNumericFormatSelectorWidget::setFormat ( const QgsNumericFormat * format )

Sets the format to show in the widget.

Definition at line 51 of file qgsnumericformatselectorwidget.cpp.

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

/build/qgis-3.40.0+99sid/src/gui/numericformats/qgsnumericformatselectorwidget.h
/build/qgis-3.40.0+99sid/src/gui/numericformats/qgsnumericformatselectorwidget.cpp

Signals

Public Member Functions

Additional Inherited Members