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

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

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

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])