QGIS API Documentation  3.17.0-Master (a84647cf30)
Signals | Public Member Functions | List of all members
QgsNumericFormatWidget Class Referenceabstract

Base class for widgets which allow control over the properties of QgsNumericFormat subclasses. More...

#include <qgsnumericformatwidget.h>

Inheritance diagram for QgsNumericFormatWidget:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted whenever the configuration of the numeric format is changed. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsNumericFormatWidget (QWidget *parent=nullptr)
 Constructor for QgsNumericFormatWidget. More...
 
virtual QgsNumericFormatformat ()=0
 Returns the format defined by the current settings in the widget. More...
 
virtual void setFormat (QgsNumericFormat *format)=0
 Sets the format to show in the widget. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
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. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

Base class for widgets which allow control over the properties of QgsNumericFormat subclasses.

Since
QGIS 3.12

Definition at line 32 of file qgsnumericformatwidget.h.

Constructor & Destructor Documentation

◆ QgsNumericFormatWidget()

QgsNumericFormatWidget::QgsNumericFormatWidget ( QWidget *  parent = nullptr)
inline

Constructor for QgsNumericFormatWidget.

Definition at line 41 of file qgsnumericformatwidget.h.

Member Function Documentation

◆ changed

void QgsNumericFormatWidget::changed ( )
signal

Emitted whenever the configuration of the numeric format is changed.

◆ format()

virtual QgsNumericFormat* QgsNumericFormatWidget::format ( )
pure virtual

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

Ownership of the returned object is transferred to the caller

See also
setFormat()

Implemented in QgsFractionNumericFormatWidget, QgsScientificNumericFormatWidget, QgsPercentageNumericFormatWidget, QgsCurrencyNumericFormatWidget, QgsBearingNumericFormatWidget, and QgsBasicNumericFormatWidget.

◆ setFormat()

virtual void QgsNumericFormatWidget::setFormat ( QgsNumericFormat format)
pure virtual

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