QGIS API Documentation 3.41.0-Master (181b2f43d8e)
|
Base class for widgets which allow control over the properties of QgsNumericFormat subclasses. More...
#include <qgsnumericformatwidget.h>
Signals | |
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. | |
Public Member Functions | |
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. | |
virtual QgsNumericFormat * | format ()=0 |
Returns the format defined by the current settings 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. | |
virtual void | setFormat (QgsNumericFormat *format)=0 |
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. | |
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. | |
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. | |
Base class for widgets which allow control over the properties of QgsNumericFormat subclasses.
Definition at line 34 of file qgsnumericformatwidget.h.
|
inline |
Constructor for QgsNumericFormatWidget.
Definition at line 43 of file qgsnumericformatwidget.h.
|
signal |
Emitted whenever the configuration of the numeric format is changed.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 35 of file qgsnumericformatwidget.cpp.
|
pure virtual |
Returns the format defined by the current settings in the widget.
Ownership of the returned object is transferred to the caller
Implemented in QgsBasicNumericFormatWidget, QgsBearingNumericFormatWidget, QgsGeographicCoordinateNumericFormatWidget, QgsCurrencyNumericFormatWidget, QgsPercentageNumericFormatWidget, QgsScientificNumericFormatWidget, QgsFractionNumericFormatWidget, and QgsExpressionBasedNumericFormatWidget.
void QgsNumericFormatWidget::registerExpressionContextGenerator | ( | QgsExpressionContextGenerator * | generator | ) |
Register an expression context generator class that will be used to retrieve an expression context for the widget when required.
Definition at line 30 of file qgsnumericformatwidget.cpp.
|
pure virtual |
Sets the format to show in the widget.
Ownership is not transferred.
Implemented in QgsBasicNumericFormatWidget, QgsBearingNumericFormatWidget, QgsGeographicCoordinateNumericFormatWidget, QgsCurrencyNumericFormatWidget, QgsPercentageNumericFormatWidget, QgsScientificNumericFormatWidget, QgsFractionNumericFormatWidget, and QgsExpressionBasedNumericFormatWidget.