QGIS API Documentation  3.24.2-Tisler (13c1a02865)
Public Member Functions | List of all members
QgsLabelObstacleSettingsWidget Class Reference

A widget for customising label obstacle settings. More...

#include <qgslabelobstaclesettingswidget.h>

Inheritance diagram for QgsLabelObstacleSettingsWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsLabelObstacleSettingsWidget (QWidget *parent=nullptr, QgsVectorLayer *vl=nullptr)
 Constructor for QgsLabelObstacleSettingsWidget. More...
 
void setGeometryType (QgsWkbTypes::GeometryType type) override
 Sets the geometry type of the features to customize the widget accordingly. More...
 
void setSettings (const QgsLabelObstacleSettings &settings)
 Sets the obstacle settings to show in the widget. More...
 
QgsLabelObstacleSettings settings () const
 Returns the obstacle settings defined by the widget. More...
 
void updateDataDefinedProperties (QgsPropertyCollection &properties) override
 Updates a data defined properties collection, correctly setting the values for any properties related to this widget. More...
 
- Public Member Functions inherited from QgsLabelSettingsWidgetBase
 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...
 
- 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
 

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

Detailed Description

A widget for customising label obstacle settings.

Since
QGIS 3.12

Definition at line 31 of file qgslabelobstaclesettingswidget.h.

Constructor & Destructor Documentation

◆ QgsLabelObstacleSettingsWidget()

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

Constructor for QgsLabelObstacleSettingsWidget.

Parameters
parentparent widget
vlassociated vector layer

Definition at line 20 of file qgslabelobstaclesettingswidget.cpp.

Member Function Documentation

◆ setGeometryType()

void QgsLabelObstacleSettingsWidget::setGeometryType ( QgsWkbTypes::GeometryType  type)
overridevirtual

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

Reimplemented from QgsLabelSettingsWidgetBase.

Definition at line 61 of file qgslabelobstaclesettingswidget.cpp.

◆ setSettings()

void QgsLabelObstacleSettingsWidget::setSettings ( const QgsLabelObstacleSettings settings)

Sets the obstacle settings to show in the widget.

See also
settings()

Definition at line 45 of file qgslabelobstaclesettingswidget.cpp.

◆ settings()

QgsLabelObstacleSettings QgsLabelObstacleSettingsWidget::settings ( ) const

Returns the obstacle settings defined by the widget.

See also
setSettings()

Definition at line 53 of file qgslabelobstaclesettingswidget.cpp.

◆ updateDataDefinedProperties()

void QgsLabelObstacleSettingsWidget::updateDataDefinedProperties ( QgsPropertyCollection properties)
overridevirtual

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

See also
setDataDefinedProperties()
dataDefinedProperties()

Reimplemented from QgsLabelSettingsWidgetBase.

Definition at line 67 of file qgslabelobstaclesettingswidget.cpp.


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