Class: QgsProcessingFavoriteAlgorithmManager

A manager for tracking favorite Processing algorithms.

QgsProcessingFavoriteAlgorithmManager is not usually directly created, instead use the instance accessible through QgsGui.processingFavoriteAlgorithmManager().

The favorite algorithms are saved and restored via QgsSettings.

Note

Not stable API

Added in version 3.40.

Class Hierarchy

Base classes

QObject

Methods

add	Adds the algorithm with matching id to the favorite algorithms list.
clear	Clears list of favorite Processing algorithms
favoriteAlgorithmIds	Returns a list of the IDs of favorite Processing algorithms.
isFavorite	Returns True if the algorithm with matching id is in a favorite list.
remove	Removes the algorithm with matching id from the favorite algorithms list.

Signals

changed

Emitted when the list of favorite algorithms is changed, e.g. when a new algorithm ID is added to the list or an existing algorithm ID is removed from the list.

class qgis.gui.QgsProcessingFavoriteAlgorithmManager

Bases: QObject

__init__(parent: QObject | None = None)

Constructor for QgsProcessingFavoriteAlgorithmManager, with the specified parent object.

Parameters:

parent (Optional[QObject] = None)

add(self, id: str | None)

Adds the algorithm with matching id to the favorite algorithms list.

If this changes the list of favorite algorithm IDs then the changed() signal will be emitted.

Parameters:

id (Optional[str])

signal changed

Emitted when the list of favorite algorithms is changed, e.g. when a new algorithm ID is added to the list or an existing algorithm ID is removed from the list.

clear(self)

Clears list of favorite Processing algorithms

favoriteAlgorithmIds(self) → List[str]

Returns a list of the IDs of favorite Processing algorithms.

Return type:

List[str]

isFavorite(self, id: str | None) → bool

Returns True if the algorithm with matching id is in a favorite list.

Parameters:

id (Optional[str])

Return type:

bool

remove(self, id: str | None)

Removes the algorithm with matching id from the favorite algorithms list.

If this changes the list of favorite algorithm IDs then the changed() signal will be emitted.

Parameters:

id (Optional[str])