QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsLabelSettingsWidgetBase Class Reference

Base class for widgets which allow customization of label engine properties, such as label placement settings. More...

#include <qgslabelsettingswidgetbase.h>

Inheritance diagram for QgsLabelSettingsWidgetBase:
Inheritance graph
[legend]

Signals

void auxiliaryFieldCreated ()
 Emitted when an auxiliary field is created in the widget. More...
 
void changed ()
 Emitted when any of the settings described by the widget are 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

 QgsLabelSettingsWidgetBase (QWidget *parent=nullptr, QgsVectorLayer *vl=nullptr)
 Constructor for QgsLabelSettingsWidgetBase. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
 
QgsPropertyCollection dataDefinedProperties () const
 Returns the current data defined properties state as specified in the widget. More...
 
virtual void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &dataDefinedProperties)
 Sets the current data defined properties to show in the widget. More...
 
virtual void setGeometryType (Qgis::GeometryType type)
 Sets the geometry type of the features to customize the widget accordingly. More...
 
virtual void updateDataDefinedProperties (QgsPropertyCollection &properties)
 Updates a data defined properties collection, correctly setting the values for any properties related to this 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...
 
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. 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...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
virtual QgsExpressionContext createExpressionContext () const =0
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 

Protected Member Functions

QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
void registerDataDefinedButton (QgsPropertyOverrideButton *button, QgsPalLayerSettings::Property key)
 Registers a data defined override button. 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...
 

Protected Attributes

QgsPropertyCollection mDataDefinedProperties
 Contains the data defined properties defined by the widget. 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...
 

Detailed Description

Base class for widgets which allow customization of label engine properties, such as label placement settings.

Since
QGIS 3.12

Definition at line 38 of file qgslabelsettingswidgetbase.h.

Constructor & Destructor Documentation

◆ QgsLabelSettingsWidgetBase()

QgsLabelSettingsWidgetBase::QgsLabelSettingsWidgetBase ( QWidget *  parent = nullptr,
QgsVectorLayer vl = nullptr 
)

Constructor for QgsLabelSettingsWidgetBase.

Parameters
parentparent widget
vlassociated vector layer

Definition at line 26 of file qgslabelsettingswidgetbase.cpp.

Member Function Documentation

◆ auxiliaryFieldCreated

void QgsLabelSettingsWidgetBase::auxiliaryFieldCreated ( )
signal

Emitted when an auxiliary field is created in the widget.

◆ changed

void QgsLabelSettingsWidgetBase::changed ( )
signal

Emitted when any of the settings described by the widget are changed.

◆ context()

QgsSymbolWidgetContext QgsLabelSettingsWidgetBase::context ( ) const

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also
setContext()

Definition at line 37 of file qgslabelsettingswidgetbase.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLabelSettingsWidgetBase::createExpressionContext ( ) const
overrideprotectedvirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 47 of file qgslabelsettingswidgetbase.cpp.

◆ dataDefinedProperties()

QgsPropertyCollection QgsLabelSettingsWidgetBase::dataDefinedProperties ( ) const

Returns the current data defined properties state as specified in the widget.

See also
updateDataDefinedProperties()
setDataDefinedProperties()

Definition at line 123 of file qgslabelsettingswidgetbase.cpp.

◆ registerDataDefinedButton()

void QgsLabelSettingsWidgetBase::registerDataDefinedButton ( QgsPropertyOverrideButton button,
QgsPalLayerSettings::Property  key 
)
protected

Registers a data defined override button.

Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

Definition at line 145 of file qgslabelsettingswidgetbase.cpp.

◆ setContext()

void QgsLabelSettingsWidgetBase::setContext ( const QgsSymbolWidgetContext context)
virtual

Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also
context()

Definition at line 32 of file qgslabelsettingswidgetbase.cpp.

◆ setDataDefinedProperties()

void QgsLabelSettingsWidgetBase::setDataDefinedProperties ( const QgsPropertyCollection dataDefinedProperties)

Sets the current data defined properties to show in the widget.

See also
dataDefinedProperties()

Definition at line 128 of file qgslabelsettingswidgetbase.cpp.

◆ setGeometryType()

void QgsLabelSettingsWidgetBase::setGeometryType ( Qgis::GeometryType  type)
virtual

Sets the geometry type of the features to customize the widget accordingly.

Reimplemented in QgsLabelObstacleSettingsWidget.

Definition at line 42 of file qgslabelsettingswidgetbase.cpp.

◆ updateDataDefinedProperties()

void QgsLabelSettingsWidgetBase::updateDataDefinedProperties ( QgsPropertyCollection properties)
virtual

Updates a data defined properties collection, correctly setting the values for any properties related to this widget.

See also
setDataDefinedProperties()
dataDefinedProperties()

Reimplemented in QgsLabelLineAnchorWidget, and QgsLabelObstacleSettingsWidget.

Definition at line 140 of file qgslabelsettingswidgetbase.cpp.

Member Data Documentation

◆ mDataDefinedProperties

QgsPropertyCollection QgsLabelSettingsWidgetBase::mDataDefinedProperties
protected

Contains the data defined properties defined by the widget.

Definition at line 118 of file qgslabelsettingswidgetbase.h.


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