mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-08 00:05:09 -04:00
140 lines
4.5 KiB
Plaintext
140 lines
4.5 KiB
Plaintext
/************************************************************************
|
|
* 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
|
|
|
|
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 *
|
|
************************************************************************/
|