QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | List of all members
QgsBasicNumericFormatWidget Class Reference

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

#include <qgsnumericformatwidget.h>

Inheritance diagram for QgsBasicNumericFormatWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsBasicNumericFormatWidget (const QgsNumericFormat *format, QWidget *parent=nullptr)
 Constructor for QgsBasicNumericFormatWidget, initially showing the specified format. More...
 
 ~QgsBasicNumericFormatWidget () override
 
QgsNumericFormatformat () override
 Returns the format defined by the current settings in the widget. More...
 
void setFormat (QgsNumericFormat *format) override
 Sets the format to show in the widget. More...
 
- Public Member Functions inherited from QgsNumericFormatWidget
 QgsNumericFormatWidget (QWidget *parent=nullptr)
 Constructor for QgsNumericFormatWidget. 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...
 
- Signals inherited from QgsNumericFormatWidget
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...
 
- 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

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

Since
QGIS 3.12

Definition at line 80 of file qgsnumericformatwidget.h.

Constructor & Destructor Documentation

◆ QgsBasicNumericFormatWidget()

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

Constructor for QgsBasicNumericFormatWidget, initially showing the specified format.

Definition at line 30 of file qgsnumericformatwidget.cpp.

◆ ~QgsBasicNumericFormatWidget()

QgsBasicNumericFormatWidget::~QgsBasicNumericFormatWidget ( )
overridedefault

Member Function Documentation

◆ format()

QgsNumericFormat * QgsBasicNumericFormatWidget::format ( )
overridevirtual

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 130 of file qgsnumericformatwidget.cpp.

◆ setFormat()

void QgsBasicNumericFormatWidget::setFormat ( QgsNumericFormat format)
overridevirtual

Sets the format to show in the widget.

Ownership is not transferred.

See also
format()

Implements QgsNumericFormatWidget.

Definition at line 105 of file qgsnumericformatwidget.cpp.


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