QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Slots | Public Member Functions | List of all members
QgsLabelEngineConfigWidget Class Reference

Widget for configuring the labeling engine. More...

#include <qgslabelengineconfigdialog.h>

Inheritance diagram for QgsLabelEngineConfigWidget:
Inheritance graph
[legend]

Public Slots

void apply ()
 Applies the changes. More...
 
void setDefaults ()
 Resets the settings to the defaults. More...
 
void showHelp ()
 Shows the help. More...
 
- 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...
 

Public Member Functions

 QgsLabelEngineConfigWidget (QgsMapCanvas *canvas, QWidget *parent=nullptr)
 constructor More...
 
QMenu * menuButtonMenu () override
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
QString menuButtonTooltip () const override
 Returns the (translated) tooltip text to use for the menu button for this panel. 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...
 
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

- 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

Widget for configuring the labeling engine.

Note
This class is not a part of public API
Since
QGIS 3.14

Definition at line 37 of file qgslabelengineconfigdialog.h.

Constructor & Destructor Documentation

◆ QgsLabelEngineConfigWidget()

QgsLabelEngineConfigWidget::QgsLabelEngineConfigWidget ( QgsMapCanvas canvas,
QWidget *  parent = nullptr 
)

constructor

Definition at line 31 of file qgslabelengineconfigdialog.cpp.

Member Function Documentation

◆ apply

void QgsLabelEngineConfigWidget::apply ( )
slot

Applies the changes.

Definition at line 108 of file qgslabelengineconfigdialog.cpp.

◆ menuButtonMenu()

QMenu * QgsLabelEngineConfigWidget::menuButtonMenu ( )
overridevirtual

Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.

Since
QGIS 3.12

Reimplemented from QgsPanelWidget.

Definition at line 98 of file qgslabelengineconfigdialog.cpp.

◆ menuButtonTooltip()

QString QgsLabelEngineConfigWidget::menuButtonTooltip ( ) const
overridevirtual

Returns the (translated) tooltip text to use for the menu button for this panel.

This is only used when the panel returns a menuButtonMenu().

Since
QGIS 3.12

Reimplemented from QgsPanelWidget.

Definition at line 103 of file qgslabelengineconfigdialog.cpp.

◆ setDefaults

void QgsLabelEngineConfigWidget::setDefaults ( )
slot

Resets the settings to the defaults.

Definition at line 131 of file qgslabelengineconfigdialog.cpp.

◆ showHelp

void QgsLabelEngineConfigWidget::showHelp ( )
slot

Shows the help.

Definition at line 143 of file qgslabelengineconfigdialog.cpp.


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