Class: QgsLayerPropertiesDialog¶

Base class for “layer properties” dialogs, containing common utilities for handling functionality in these dialog.

Warning

This is exposed to SIP bindings for legacy reasons only, and is NOT to be considered as stable API.

Added in version 3.34.

Class Hierarchy¶

`QgsOptionsDialogBase`	A base dialog for options and properties dialogs that offers vertical tabs. It handles saving/restoring of geometry, splitter and current tab states, switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left), and connecting QDialogButtonBox’s accepted/rejected signals to dialog’s accept/reject slots
QDialog
QWidget
QObject
QPaintDevice

`QgsMeshLayerProperties`	Property sheet for a mesh map layer. Contains information, source and style tabs
`QgsRasterLayerProperties`	Property sheet for a raster map layer
`QgsVectorLayerProperties`
`QgsVectorTileLayerProperties`	Vectortile layer properties dialog

Methods

`addPropertiesPageFactory`	Adds properties page from a factory.
`loadDefaultMetadata`	Reloads the default layer metadata for the layer.
`loadDefaultStyle`	Reloads the default style for the layer.
`loadMetadataFromFile`	Allows the user to load layer metadata from a file.
`loadStyle`	Triggers a dialog to load a saved style
`loadStyleFromFile`	Allows the user to load layer style from a file.
`saveDefaultStyle`	Saves the default style when appropriate button is pressed
`saveMetadataAsDefault`	Saves the current layer metadata as the default for the layer.
`saveMetadataToFile`	Allows the user to save the layer's metadata as a file.
`saveStyleAs`	Saves a style when appriate button is pressed
`saveStyleAsDefault`	Saves the current layer style as the default for the layer.
`saveStyleToFile`	Allows the user to save the layer's style to a file.
`setMetadataWidget`	Sets the metadata widget and page associated with the dialog.

class qgis.gui.QgsLayerPropertiesDialog[source]¶

Constructor for QgsLayerPropertiesDialog.

Parameters:

layer (Optional[QgsMapLayer]) – associated map layer
canvas (Optional[QgsMapCanvas]) – associated map canvas
settingsKey (Optional[str]) – QgsSettings subgroup key for saving/restore ui states, e.g. “VectorLayerProperties”.
parent (Optional[QWidget] = None) – parent object (owner)
fl (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags()) – widget flags
settings (Optional[QgsSettings] = None) – custom QgsSettings pointer

addPropertiesPageFactory(self, factory: QgsMapLayerConfigWidgetFactory | None)[source]¶

Adds properties page from a factory.

loadDefaultMetadata(self)[source]¶: Reloads the default layer metadata for the layer.

See also

saveMetadataAsDefault()

loadMetadataFromFile(self)[source]¶: Allows the user to load layer metadata from a file.

See also

saveMetadataToFile()

loadStyle(self)[source]¶: Triggers a dialog to load a saved style

Added in version 3.30.

loadStyleFromFile(self)[source]¶: Allows the user to load layer style from a file.

See also

saveStyleToFile()

saveDefaultStyle(self)[source]¶: Saves the default style when appropriate button is pressed

Added in version 3.30.

saveMetadataAsDefault(self)[source]¶

Saves the current layer metadata as the default for the layer.

saveMetadataToFile(self)[source]¶: Allows the user to save the layer’s metadata as a file.

See also

loadMetadataFromFile()

saveStyleAs(self)[source]¶: Saves a style when appriate button is pressed

Added in version 3.30.

saveStyleAsDefault(self)[source]¶

Saves the current layer style as the default for the layer.

saveStyleToFile(self)[source]¶: Allows the user to save the layer’s style to a file.

See also

loadStyleFromFile()

setMetadataWidget(self, widget: QgsMetadataWidget | None, page: QWidget | None)[source]¶

Sets the metadata widget and page associated with the dialog.

This must be called in order for the standard metadata loading/saving functionality to be available.

Parameters: