Class: QgsSubsetStringEditorProviderRegistry

A registry for subset string editor providers.

QgsSubsetStringEditorProviderRegistry is not usually directly created, but rather accessed through QgsGui.subsetStringEditorProvideRegistry().

Added in version 3.18.

Methods

addProvider	Add a provider implementation.
createDialog	Creates a new dialog to edit the subset string of the provided layer.
initializeFromProviderGuiRegistry	Initializes the registry.
providerByName	Returns a provider by name or None if not found
providers	Gets list of available providers
providersByKey	Returns a (possibly empty) list of providers by data providerkey
removeProvider	Remove provider implementation from the list (provider object is deleted)

class qgis.gui.QgsSubsetStringEditorProviderRegistry

Bases: object

addProvider(self, provider: QgsSubsetStringEditorProvider | None)

Add a provider implementation. Takes ownership of the object.

Parameters:

provider (Optional[QgsSubsetStringEditorProvider])

createDialog(self, layer: QgsVectorLayer | None, parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = QgsGuiUtils.ModalDialogFlags) → QgsSubsetStringEditorInterface | None

Creates a new dialog to edit the subset string of the provided layer. It will default to returning a QgsQueryBuilder if no provider was found. The returned object must be destroyed by the caller.

Parameters:

• layer (Optional[QgsVectorLayer])

• parent (Optional[QWidget] = None)

• fl (Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags)

Return type:

Optional[QgsSubsetStringEditorInterface]

initializeFromProviderGuiRegistry(self, providerGuiRegistry: QgsProviderGuiRegistry | None)

Initializes the registry. The registry needs to be passed explicitly (instead of using singleton) because this gets called from QgsGui constructor.

Parameters:

providerGuiRegistry (Optional[QgsProviderGuiRegistry])

providerByName(self, name: str | None) → QgsSubsetStringEditorProvider | None

Returns a provider by name or None if not found

Parameters:

name (Optional[str])

Return type:

Optional[QgsSubsetStringEditorProvider]

providers(self) → List[QgsSubsetStringEditorProvider]

Gets list of available providers

Return type:

List[QgsSubsetStringEditorProvider]

providersByKey(self, providerKey: str | None) → List[QgsSubsetStringEditorProvider]

Returns a (possibly empty) list of providers by data providerkey

Parameters:

providerKey (Optional[str])

Return type:

List[QgsSubsetStringEditorProvider]

removeProvider(self, provider: QgsSubsetStringEditorProvider | None) → bool

Remove provider implementation from the list (provider object is deleted)

Return type:

bool

Returns:

True if the provider was actually removed and deleted

Parameters:

provider (Optional[QgsSubsetStringEditorProvider])