QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Member Functions | Protected Member Functions | List of all members
QgsProcessingHiddenWidgetWrapper Class Reference

An widget wrapper for hidden widgets. More...

#include <qgsprocessingwidgetwrapper.h>

Inheritance diagram for QgsProcessingHiddenWidgetWrapper:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingHiddenWidgetWrapper (const QgsProcessingParameterDefinition *parameter=nullptr, QgsProcessingGui::WidgetType type=QgsProcessingGui::Standard, QObject *parent=nullptr)
 Constructor for QgsProcessingHiddenWidgetWrapper, for the specified parameter definition and dialog type. More...
 
const QgsVectorLayerlinkedVectorLayer () const override
 Returns the optional vector layer associated with this widget wrapper, or nullptr if no vector layer is applicable. More...
 
void setLinkedVectorLayer (const QgsVectorLayer *layer)
 Sets the vector layer linked to the wrapper. More...
 
void setWidgetValue (const QVariant &value, QgsProcessingContext &context) override
 Sets the current value for the parameter to show in the widget. More...
 
QVariant widgetValue () const override
 Returns the current value of the parameter. More...
 
- Public Member Functions inherited from QgsAbstractProcessingParameterWidgetWrapper
 QgsAbstractProcessingParameterWidgetWrapper (const QgsProcessingParameterDefinition *parameter=nullptr, QgsProcessingGui::WidgetType type=QgsProcessingGui::Standard, QObject *parent=nullptr)
 Constructor for QgsAbstractProcessingParameterWidgetWrapper, for the specified parameter definition and dialog type. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
QLabel * createWrappedLabel ()
 Creates and returns a new label to accompany widgets created by the wrapper. More...
 
QWidget * createWrappedWidget (QgsProcessingContext &context)
 Creates and return a new wrapped widget which allows customization of the parameter's value. More...
 
virtual QVariantMap customProperties () const
 Returns any custom properties set by the wrapper. More...
 
const QgsProcessingParameterDefinitionparameterDefinition () const
 Returns the parameter definition associated with this wrapper. More...
 
QVariant parameterValue () const
 Returns the current value of the parameter. More...
 
virtual void postInitialize (const QList< QgsAbstractProcessingParameterWidgetWrapper * > &wrappers)
 Called after all wrappers have been created within a particular dialog or context, allowing the wrapper to connect to the wrappers of other, related parameters. More...
 
void registerProcessingContextGenerator (QgsProcessingContextGenerator *generator)
 Registers a Processing context generator class that will be used to retrieve a Processing context for the wrapper when required. More...
 
void registerProcessingParametersGenerator (QgsProcessingParametersGenerator *generator)
 Registers a Processing parameters generator class that will be used to retrieve algorithm parameters for the wrapper when required (e.g. More...
 
virtual void setDialog (QDialog *dialog)
 Sets the parent dialog in which the wrapper is shown. More...
 
void setParameterValue (const QVariant &value, QgsProcessingContext &context)
 Sets the current value for the parameter. More...
 
virtual void setWidgetContext (const QgsProcessingParameterWidgetContext &context)
 Sets the context in which the Processing parameter widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior. More...
 
virtual int stretch () const
 Returns the Qt layout "stretch" factor to use when adding this widget to a layout. More...
 
QgsProcessingGui::WidgetType type () const
 Returns the dialog type for which widgets and labels will be created by this wrapper. More...
 
const QgsProcessingParameterWidgetContextwidgetContext () const
 Returns the context in which the Processing parameter widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior. More...
 
QLabel * wrappedLabel ()
 Returns the current wrapped label, if any. More...
 
QWidget * wrappedWidget ()
 Returns the current wrapped widget, if any. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Protected Member Functions

QLabel * createLabel () override
 Creates a new label to accompany widgets created by the wrapper. More...
 
QWidget * createWidget () override
 Creates a new widget which allows customization of the parameter's value. More...
 

Additional Inherited Members

- Signals inherited from QgsAbstractProcessingParameterWidgetWrapper
void widgetValueHasChanged (QgsAbstractProcessingParameterWidgetWrapper *wrapper)
 Emitted whenever the parameter value (as defined by the wrapped widget) is changed. More...
 
- Protected Attributes inherited from QgsAbstractProcessingParameterWidgetWrapper
QgsProcessingParametersGeneratormParametersGenerator = nullptr
 
QgsProcessingContextGeneratormProcessingContextGenerator = nullptr
 
QgsProcessingParameterWidgetContext mWidgetContext
 

Detailed Description

An widget wrapper for hidden widgets.

The hidden widget wrapper allows for creation of a widget wrapper which does not provide a graphical widget, yet still implements the QgsAbstractProcessingParameterWidgetWrapper interface.

Since
QGIS 3.14

Definition at line 661 of file qgsprocessingwidgetwrapper.h.

Constructor & Destructor Documentation

◆ QgsProcessingHiddenWidgetWrapper()

QgsProcessingHiddenWidgetWrapper::QgsProcessingHiddenWidgetWrapper ( const QgsProcessingParameterDefinition parameter = nullptr,
QgsProcessingGui::WidgetType  type = QgsProcessingGui::Standard,
QObject *  parent = nullptr 
)

Constructor for QgsProcessingHiddenWidgetWrapper, for the specified parameter definition and dialog type.

Definition at line 438 of file qgsprocessingwidgetwrapper.cpp.

Member Function Documentation

◆ createLabel()

QLabel * QgsProcessingHiddenWidgetWrapper::createLabel ( )
overrideprotectedvirtual

Creates a new label to accompany widgets created by the wrapper.

The caller takes ownership of the returned label. Some parameter type and dialog type combinations will return nullptr for this method. If NULLPTR is returned, then no label should be shown for the parameter's widget (i.e. the label is embedded inside the widget itself).

See also
createWidget()

Reimplemented from QgsAbstractProcessingParameterWidgetWrapper.

Definition at line 474 of file qgsprocessingwidgetwrapper.cpp.

◆ createWidget()

QWidget * QgsProcessingHiddenWidgetWrapper::createWidget ( )
overrideprotectedvirtual

Creates a new widget which allows customization of the parameter's value.

The caller takes ownership of the returned widget.

See also
createLabel()

Implements QgsAbstractProcessingParameterWidgetWrapper.

Definition at line 468 of file qgsprocessingwidgetwrapper.cpp.

◆ linkedVectorLayer()

const QgsVectorLayer * QgsProcessingHiddenWidgetWrapper::linkedVectorLayer ( ) const
overridevirtual

Returns the optional vector layer associated with this widget wrapper, or nullptr if no vector layer is applicable.

This is used to correctly generate expression contexts within the GUI, e.g. to allow expression buttons and property override buttons to correctly show the appropriate vector layer fields.

Since
QGIS 3.6

Reimplemented from QgsAbstractProcessingParameterWidgetWrapper.

Definition at line 458 of file qgsprocessingwidgetwrapper.cpp.

◆ setLinkedVectorLayer()

void QgsProcessingHiddenWidgetWrapper::setLinkedVectorLayer ( const QgsVectorLayer layer)

Sets the vector layer linked to the wrapper.

Definition at line 463 of file qgsprocessingwidgetwrapper.cpp.

◆ setWidgetValue()

void QgsProcessingHiddenWidgetWrapper::setWidgetValue ( const QVariant &  value,
QgsProcessingContext context 
)
overridevirtual

Sets the current value for the parameter to show in the widget.

The context argument is used to specify the wider Processing context which the current value is associated with.

See also
widgetValue()

Implements QgsAbstractProcessingParameterWidgetWrapper.

Definition at line 444 of file qgsprocessingwidgetwrapper.cpp.

◆ widgetValue()

QVariant QgsProcessingHiddenWidgetWrapper::widgetValue ( ) const
overridevirtual

Returns the current value of the parameter.

See also
setWidgetValue()

Implements QgsAbstractProcessingParameterWidgetWrapper.

Definition at line 453 of file qgsprocessingwidgetwrapper.cpp.


The documentation for this class was generated from the following files: