QGIS API Documentation  2.99.0-Master (37c43df)
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | List of all members
QgsEditorWidgetWrapper Class Referenceabstract

Manages an editor widget Widget and wrapper share the same parent. More...

#include <qgseditorwidgetwrapper.h>

Inheritance diagram for QgsEditorWidgetWrapper:
Inheritance graph
[legend]

Public Types

enum  ConstraintResult { ConstraintResultPass = 0, ConstraintResultFailHard, ConstraintResultFailSoft }
 Result of constraint checks. More...
 

Public Slots

void setFeature (const QgsFeature &feature) override
 Will be called when the feature changes. More...
 
virtual void setValue (const QVariant &value)=0
 Is called, when the value of the widget needs to be changed. More...
 
- Public Slots inherited from QgsWidgetWrapper
virtual void setFeature (const QgsFeature &feature)=0
 Is called, when the value of the widget needs to be changed. More...
 

Signals

void constraintStatusChanged (const QString &constraint, const QString &desc, const QString &err, ConstraintResult status)
 Emit this signal when the constraint status changed. More...
 
void valueChanged (const QVariant &value)
 Emit this signal, whenever the value changed. More...
 

Public Member Functions

 QgsEditorWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=nullptr, QWidget *parent=nullptr)
 Create a new widget wrapper. More...
 
QString constraintFailureReason () const
 Returns the reason why a constraint check has failed (or an empty string if constraint check was successful). More...
 
QVariant defaultValue () const
 Access the default value of the field. More...
 
QgsField field () const
 Access the field. More...
 
int fieldIdx () const
 Access the field index. More...
 
bool isBlockingCommit () const
 Returns true if the widget is preventing the feature from being committed. More...
 
bool isValidConstraint () const
 Get the current constraint status. More...
 
void setEnabled (bool enabled) override
 Is used to enable or disable the edit functionality of the managed widget. More...
 
virtual void showIndeterminateState ()
 Sets the widget to display in an indeterminate "mixed value" state. More...
 
void updateConstraint (const QgsFeature &featureContext, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet)
 Update constraint. More...
 
virtual QVariant value () const =0
 Will be used to access the widget's value. More...
 
- Public Member Functions inherited from QgsWidgetWrapper
 QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr)
 Create a new widget wrapper. More...
 
QVariant config (const QString &key, const QVariant &defaultVal=QVariant()) const
 Use this inside your overridden classes to access the configuration. More...
 
QgsEditorWidgetConfig config () const
 Returns the whole config. More...
 
const QgsAttributeEditorContextcontext () const
 Returns information about the context in which this widget is shown. More...
 
QgsVectorLayerlayer () const
 Access the QgsVectorLayer, you are working on. More...
 
void setConfig (const QgsEditorWidgetConfig &config)
 Will set the config of this wrapper to the specified config. More...
 
void setContext (const QgsAttributeEditorContext &context)
 Set the context in which this widget is shown. More...
 
virtual bool valid () const =0
 Return true if the widget has been properly initialized. More...
 
QWidget * widget ()
 Access the widget managed by this wrapper. More...
 
template<class T >
T * widget ()
 Access the widget managed by this wrapper and cast it to a given type Example: QPushButton* pb = wrapper->widget<QPushButton*>();. More...
 

Static Public Member Functions

static QgsEditorWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 
static bool isInTable (const QWidget *parent)
 Check if the given widget or one of its parent is a QTableView. More...
 
- Static Public Member Functions inherited from QgsWidgetWrapper
static QgsWidgetWrapperfromWidget (QWidget *widget)
 Will return a wrapper for a given widget. More...
 

Protected Slots

void valueChanged (const QString &value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (int value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (double value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (bool value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged (qlonglong value)
 If you emit to this slot in your implementation, an appropriate change notification will be broadcasted. More...
 
void valueChanged ()
 Will call the value() method to determine the emitted value. More...
 

Protected Member Functions

virtual void updateConstraintWidgetStatus (ConstraintResult status)
 This should update the widget with a visual cue if a constraint status changed. More...
 
- Protected Member Functions inherited from QgsWidgetWrapper
virtual QWidget * createWidget (QWidget *parent)=0
 This method should create a new widget with the provided parent. More...
 
virtual void initWidget (QWidget *editor)
 This method should initialize the editor widget with runtime data. More...
 

Detailed Description

Manages an editor widget Widget and wrapper share the same parent.

A wrapper controls one attribute editor widget and is able to create a default widget or use a pre-existent widget. It is able to set the widget to the value implied by a field of a vector layer, or return the value it currently holds. Every time it is changed it has to emit a valueChanged signal. If it fails to do so, there is no guarantee that the changed status of the widget will be saved.

Definition at line 39 of file qgseditorwidgetwrapper.h.

Member Enumeration Documentation

§ ConstraintResult

Result of constraint checks.

Note
added in QGIS 3.0
Enumerator
ConstraintResultPass 

Widget passed constraints successfully.

ConstraintResultFailHard 

Widget failed at least one hard (enforced) constraint.

ConstraintResultFailSoft 

Widget failed at least one soft (non-enforced) constraint.

Definition at line 48 of file qgseditorwidgetwrapper.h.

Constructor & Destructor Documentation

§ QgsEditorWidgetWrapper()

QgsEditorWidgetWrapper::QgsEditorWidgetWrapper ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  editor = nullptr,
QWidget *  parent = nullptr 
)
explicit

Create a new widget wrapper.

Parameters
vlThe layer on which the field is
fieldIdxThe field which will be controlled
editorAn editor widget. Can be NULL if one should be autogenerated.
parentA parent widget for this widget wrapper and the created widget.

Definition at line 24 of file qgseditorwidgetwrapper.cpp.

Member Function Documentation

§ constraintFailureReason()

QString QgsEditorWidgetWrapper::constraintFailureReason ( ) const

Returns the reason why a constraint check has failed (or an empty string if constraint check was successful).

See also
isValidConstraint()
Note
added in QGIS 3.0

Definition at line 203 of file qgseditorwidgetwrapper.cpp.

§ constraintStatusChanged

void QgsEditorWidgetWrapper::constraintStatusChanged ( const QString &  constraint,
const QString &  desc,
const QString &  err,
ConstraintResult  status 
)
signal

Emit this signal when the constraint status changed.

constraintStatusChanged

Parameters
constraintrepresented as a string
descis the constraint description
errthe error represented as a string. Empty if none.
status

§ defaultValue()

QVariant QgsEditorWidgetWrapper::defaultValue ( ) const

Access the default value of the field.

Returns
the default value of the field
See also
layer()

Definition at line 45 of file qgseditorwidgetwrapper.cpp.

§ field()

QgsField QgsEditorWidgetWrapper::field ( ) const

Access the field.

Returns
The field you are working on
See also
layer()

Definition at line 37 of file qgseditorwidgetwrapper.cpp.

§ fieldIdx()

int QgsEditorWidgetWrapper::fieldIdx ( ) const

Access the field index.

Returns
The index of the field you are working on
See also
layer()

Definition at line 32 of file qgseditorwidgetwrapper.cpp.

§ fromWidget()

QgsEditorWidgetWrapper * QgsEditorWidgetWrapper::fromWidget ( QWidget *  widget)
static

Will return a wrapper for a given widget.

Parameters
widgetThe widget which was created by a wrapper
Returns
The wrapper for the widget or NULL

Definition at line 52 of file qgseditorwidgetwrapper.cpp.

§ isBlockingCommit()

bool QgsEditorWidgetWrapper::isBlockingCommit ( ) const

Returns true if the widget is preventing the feature from being committed.

This may be true as a result of attribute values failing enforced field constraints.

Note
added in QGIS 3.0
See also
isValidConstraint()

Definition at line 198 of file qgseditorwidgetwrapper.cpp.

§ isInTable()

bool QgsEditorWidgetWrapper::isInTable ( const QWidget *  parent)
static

Check if the given widget or one of its parent is a QTableView.

Parameters
parentthe widget to check
Returns
true if yes

Definition at line 208 of file qgseditorwidgetwrapper.cpp.

§ isValidConstraint()

bool QgsEditorWidgetWrapper::isValidConstraint ( ) const

Get the current constraint status.

Returns
true if the constraint is valid or if there's no constraint, false otherwise
Note
added in QGIS 2.16
See also
constraintFailureReason()
isBlockingCommit()

Definition at line 193 of file qgseditorwidgetwrapper.cpp.

§ setEnabled()

void QgsEditorWidgetWrapper::setEnabled ( bool  enabled)
overridevirtual

Is used to enable or disable the edit functionality of the managed widget.

By default this will enable or disable the whole widget

Parameters
enabledEnable or Disable?

Reimplemented from QgsWidgetWrapper.

Definition at line 57 of file qgseditorwidgetwrapper.cpp.

§ setFeature

void QgsEditorWidgetWrapper::setFeature ( const QgsFeature feature)
overrideslot

Will be called when the feature changes.

Is forwarded to the slot setValue()

Parameters
featureThe new feature

Definition at line 66 of file qgseditorwidgetwrapper.cpp.

§ setValue

virtual void QgsEditorWidgetWrapper::setValue ( const QVariant &  value)
pure virtualslot

Is called, when the value of the widget needs to be changed.

Update the widget representation to reflect the new value.

Parameters
valueThe new value of the attribute

§ showIndeterminateState()

virtual void QgsEditorWidgetWrapper::showIndeterminateState ( )
inlinevirtual

§ updateConstraint()

void QgsEditorWidgetWrapper::updateConstraint ( const QgsFeature featureContext,
QgsFieldConstraints::ConstraintOrigin  constraintOrigin = QgsFieldConstraints::ConstraintOriginNotSet 
)

Update constraint.

Parameters
featureContextthe feature to use to evaluate the constraint
constraintOriginoptional origin for constraints to check. This can be used to limit the constraints tested to only provider or layer based constraints.
Note
added in QGIS 2.16

Definition at line 120 of file qgseditorwidgetwrapper.cpp.

§ updateConstraintWidgetStatus()

void QgsEditorWidgetWrapper::updateConstraintWidgetStatus ( ConstraintResult  status)
protectedvirtual

This should update the widget with a visual cue if a constraint status changed.

By default a stylesheet will be applied on the widget that changes the background color to red.

This can be overwritten in subclasses to allow individual widgets to change the visual cue.

Parameters
statusThe current constraint status.
Note
added in QGIS 2.16

Reimplemented in QgsRelationReferenceWidgetWrapper.

Definition at line 102 of file qgseditorwidgetwrapper.cpp.

§ value()

virtual QVariant QgsEditorWidgetWrapper::value ( ) const
pure virtual

Will be used to access the widget's value.

Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Returns
The current value the widget represents

Implemented in QgsValueRelationWidgetWrapper, QgsDateTimeEditWrapper, QgsRelationReferenceWidgetWrapper, QgsPhotoWidgetWrapper, QgsRangeWidgetWrapper, QgsCheckboxWidgetWrapper, QgsExternalResourceWidgetWrapper, QgsTextEditWrapper, QgsValueMapWidgetWrapper, QgsFileNameWidgetWrapper, QgsUniqueValuesWidgetWrapper, QgsKeyValueWidgetWrapper, QgsListWidgetWrapper, QgsWebViewWidgetWrapper, QgsUuidWidgetWrapper, QgsClassificationWidgetWrapper, QgsColorWidgetWrapper, QgsEnumerationWidgetWrapper, and QgsHiddenWidgetWrapper.

§ valueChanged [1/7]

void QgsEditorWidgetWrapper::valueChanged ( const QVariant &  value)
signal

Emit this signal, whenever the value changed.

Parameters
valueThe new value

§ valueChanged [2/7]

void QgsEditorWidgetWrapper::valueChanged ( const QString &  value)
protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for string type widgets.

Parameters
valueThe value

Definition at line 72 of file qgseditorwidgetwrapper.cpp.

§ valueChanged [3/7]

void QgsEditorWidgetWrapper::valueChanged ( int  value)
protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for int type widgets.

Parameters
valueThe value
Note
python name valueChangedInt

Definition at line 77 of file qgseditorwidgetwrapper.cpp.

§ valueChanged [4/7]

void QgsEditorWidgetWrapper::valueChanged ( double  value)
protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for double type widgets.

Parameters
valueThe value
Note
python name valueChangedDouble

Definition at line 82 of file qgseditorwidgetwrapper.cpp.

§ valueChanged [5/7]

void QgsEditorWidgetWrapper::valueChanged ( bool  value)
protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for bool type widgets.

Parameters
valueThe value
Note
python name valueChangedBool

Definition at line 87 of file qgseditorwidgetwrapper.cpp.

§ valueChanged [6/7]

void QgsEditorWidgetWrapper::valueChanged ( qlonglong  value)
protectedslot

If you emit to this slot in your implementation, an appropriate change notification will be broadcasted.

Helper for longlong type widgets.

Parameters
valueThe value

Definition at line 92 of file qgseditorwidgetwrapper.cpp.

§ valueChanged [7/7]

void QgsEditorWidgetWrapper::valueChanged ( )
protectedslot

Will call the value() method to determine the emitted value.

Definition at line 97 of file qgseditorwidgetwrapper.cpp.


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