1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingfavoritealgorithmmanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingFavoriteAlgorithmManager : QObject
{
%Docstring(signature="appended")
A manager for tracking favorite Processing algorithms.
:py:class:`QgsProcessingFavoriteAlgorithmManager` is not usually
directly created, instead use the instance accessible through
:py:func:`QgsGui.processingFavoriteAlgorithmManager()`.
The favorite algorithms are saved and restored via
:py:class:`QgsSettings`.
.. note::
Not stable API
.. versionadded:: 3.40
%End
%TypeHeaderCode
#include "qgsprocessingfavoritealgorithmmanager.h"
%End
public:
QgsProcessingFavoriteAlgorithmManager( QObject *parent = 0 );
%Docstring
Constructor for QgsProcessingFavoriteAlgorithmManager, with the
specified ``parent`` object.
%End
QStringList favoriteAlgorithmIds() const;
%Docstring
Returns a list of the IDs of favorite Processing algorithms.
%End
void add( const QString &id );
%Docstring
Adds the algorithm with matching ``id`` to the favorite algorithms list.
If this changes the list of favorite algorithm IDs then the
:py:func:`~QgsProcessingFavoriteAlgorithmManager.changed` signal will be
emitted.
%End
void remove( const QString &id );
%Docstring
Removes the algorithm with matching ``id`` from the favorite algorithms
list.
If this changes the list of favorite algorithm IDs then the
:py:func:`~QgsProcessingFavoriteAlgorithmManager.changed` signal will be
emitted.
%End
void clear();
%Docstring
Clears list of favorite Processing algorithms
%End
bool isFavorite( const QString &id );
%Docstring
Returns ``True`` if the algorithm with matching ``id`` is in a favorite
list.
%End
signals:
void changed();
%Docstring
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.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingfavoritealgorithmmanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
