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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingtoolboxtreeview.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProcessingToolboxTreeView : QTreeView
{
%Docstring(signature="appended")
Processing toolbox tree view, showing algorithms and providers in a tree
structure.
.. warning::
Not part of stable API and may change in future QGIS releases.
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsprocessingtoolboxtreeview.h"
%End
public:
QgsProcessingToolboxTreeView( QWidget *parent /TransferThis/ = 0, QgsProcessingRegistry *registry = 0, QgsProcessingRecentAlgorithmLog *recentLog = 0, QgsProcessingFavoriteAlgorithmManager *favoriteManager = 0 );
%Docstring
Constructor for QgsProcessingToolboxTreeView, with the specified
``parent`` widget.
If ``registry`` is set, then the view will automatically be populated
with algorithms and providers from the registry. Otherwise, users must
manually call :py:func:`~QgsProcessingToolboxTreeView.setRegistry` to
associate a registry with the view.
If ``recentLog`` is specified then it will be used to create a "Recently
used" top level group containing recently used algorithms.
If ``favoriteManager`` is specified then it will be used to create a
"Favorites" top level group containing favorite algorithms. Since QGIS
3.40
%End
void setRegistry(
QgsProcessingRegistry *registry,
QgsProcessingRecentAlgorithmLog *recentLog = 0,
QgsProcessingFavoriteAlgorithmManager *favoriteManager = 0
);
%Docstring
Sets the processing ``registry`` associated with the view.
If ``recentLog`` is specified then it will be used to create a "Recently
used" top level group containing recently used algorithms.
If ``favoriteManager`` is specified then it will be used to create a
"Favorites" top level group containing favorite algorithms. Since QGIS
3.40
%End
void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ );
%Docstring
Sets the toolbox proxy model used to drive the view.
%End
const QgsProcessingAlgorithm *algorithmForIndex( const QModelIndex &index );
%Docstring
Returns the algorithm at the specified tree view ``index``, or ``None``
if the index does not correspond to an algorithm.
%End
const QgsProcessingAlgorithm *selectedAlgorithm();
%Docstring
Returns the currently selected algorithm in the tree view, or ``None``
if no algorithm is currently selected.
%End
const QgsProcessingParameterType *parameterTypeForIndex( const QModelIndex &index );
%Docstring
Returns the model parameter at the specified tree view ``index``, or
``None`` if the index does not correspond to a model parameter.
.. versionadded:: 3.44
%End
const QgsProcessingParameterType *selectedParameterType();
%Docstring
Returns the currently selected model parameter in the tree view, or
``None`` if no model parameter is currently selected.
.. versionadded:: 3.44
%End
void setFilters( QgsProcessingToolboxProxyModel::Filters filters );
%Docstring
Sets ``filters`` controlling the view's contents.
.. seealso:: :py:func:`filters`
%End
QgsProcessingToolboxProxyModel::Filters filters() const;
%Docstring
Returns the current filters controlling the view's contents.
.. seealso:: :py:func:`setFilters`
.. versionadded:: 3.8
%End
void setInPlaceLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector ``layer`` for the in-place algorithms
%End
public slots:
void setFilterString( const QString &filter );
%Docstring
Sets a ``filter`` string, used to filter out the contents of the view to
matching algorithms.
%End
virtual void reset();
%Docstring
Expands the tree view if a filter string is set after the view is reset.
%End
protected:
virtual void keyPressEvent( QKeyEvent *event );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingtoolboxtreeview.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
