QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
Wraps a file name widget. More...
#include <qgsexternalresourcewidgetwrapper.h>
Public Slots | |
void | setEnabled (bool enabled) override |
void | setFeature (const QgsFeature &feature) override |
void | widgetValueChanged (const QString &attribute, const QVariant &newValue, bool attributeChanged) |
Will be called when a value in the current edited form or table row changes. | |
![]() | |
void | emitValueChanged () |
Will call the value() method to determine the emitted value. | |
virtual void | parentFormValueChanged (const QString &attribute, const QVariant &value) |
Is called in embedded form widgets when an attribute value in the parent form has changed. | |
void | setFeature (const QgsFeature &feature) override |
Will be called when the feature changes. | |
virtual void | setValue (const QVariant &value) |
Is called when the value of the widget needs to be changed. | |
void | setValues (const QVariant &value, const QVariantList &additionalValues) |
Is called when the value of the widget or additional field values needs to be changed. | |
![]() | |
virtual void | setFeature (const QgsFeature &feature)=0 |
Is called when the value of the widget needs to be changed. | |
Public Member Functions | |
QgsExternalResourceWidgetWrapper (QgsVectorLayer *layer, int fieldIdx, QWidget *editor=nullptr, QgsMessageBar *messageBar=nullptr, QWidget *parent=nullptr) | |
Constructor for QgsExternalResourceWidgetWrapper. | |
void | showIndeterminateState () override |
Sets the widget to display in an indeterminate "mixed value" state. | |
QVariant | value () const override |
Will be used to access the widget's value. | |
![]() | |
QgsEditorWidgetWrapper (QgsVectorLayer *vl, int fieldIdx, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Create a new widget wrapper. | |
virtual QStringList | additionalFields () const |
Returns the list of additional fields which the editor handles. | |
virtual QVariantList | additionalFieldValues () const |
Will be used to access the widget's values for potential additional fields handled by the widget. | |
QString | constraintFailureReason () const |
Returns the reason why a constraint check has failed (or an empty string if constraint check was successful). | |
ConstraintResult | constraintResult () const |
Returns the constraint result, which is the current result of the constraint on the widget influencing its visualization. | |
bool | constraintResultVisible () const |
Returns whether the constraint result is visible. | |
QVariant | defaultValue () const |
Access the default value of the field. | |
QgsField | field () const |
Access the field. | |
int | fieldIdx () const |
Access the field index. | |
bool | isBlockingCommit () const |
Returns true if the widget is preventing the feature from being committed. | |
bool | isValidConstraint () const |
Gets the current constraint status. | |
void | setConstraintResultVisible (bool constraintResultVisible) |
Sets whether the constraint result is visible. | |
void | setEnabled (bool enabled) override |
Is used to enable or disable the edit functionality of the managed widget. | |
virtual void | setHint (const QString &hintText) |
Add a hint text on the widget. | |
void | updateConstraint (const QgsFeature &featureContext, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet) |
Update constraint. | |
void | updateConstraint (const QgsVectorLayer *layer, int index, const QgsFeature &feature, QgsFieldConstraints::ConstraintOrigin constraintOrigin=QgsFieldConstraints::ConstraintOriginNotSet) |
Update constraint on a feature coming from a specific layer. | |
void | updateConstraint (QgsEditorWidgetWrapper::ConstraintResult constraintResult, const QString &constraintFailureReason) |
Update constraint manually by providing the constraint result value and failure reason(s). | |
![]() | |
QgsWidgetWrapper (QgsVectorLayer *vl, QWidget *editor=nullptr, QWidget *parent=nullptr) | |
Create a new widget wrapper. | |
QVariantMap | config () const |
Returns the whole config. | |
QVariant | config (const QString &key, const QVariant &defaultVal=QVariant()) const |
Use this inside your overridden classes to access the configuration. | |
const QgsAttributeEditorContext & | context () const |
Returns information about the context in which this widget is shown. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the editor widget's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the editor widget's property collection, used for data defined overrides. | |
QgsVectorLayer * | layer () const |
Returns the vector layer associated with the widget. | |
void | notifyAboutToSave () |
Notify this widget, that the containing form is about to save and that any pending changes should be pushed to the edit buffer or they might be lost. | |
void | setConfig (const QVariantMap &config) |
Will set the config of this wrapper to the specified config. | |
void | setContext (const QgsAttributeEditorContext &context) |
Set the context in which this widget is shown. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the editor widget's property collection, used for data defined overrides. | |
QWidget * | widget () |
Access the widget managed by this wrapper. | |
template<class T > | |
T * | widget () |
Access the widget managed by this wrapper and cast it to a given type. | |
Protected Member Functions | |
QWidget * | createWidget (QWidget *parent) override |
This method should create a new widget with the provided parent. | |
void | initWidget (QWidget *editor) override |
This method should initialize the editor widget with runtime data. | |
void | updateFileWidgetExpressionContext () |
Update file widget current expression context according to layer, feature, and parent feature. | |
bool | valid () const override |
Returns true if the widget has been properly initialized. | |
![]() | |
QgsFeature | formFeature () const |
The feature currently being edited, in its current state. | |
void | setFormFeature (const QgsFeature &feature) |
Set the feature currently being edited to feature. | |
bool | setFormFeatureAttribute (const QString &attributeName, const QVariant &attributeValue) |
Update the feature currently being edited by changing its attribute attributeName to attributeValue. | |
Friends | |
class | TestQgsExternalResourceWidgetWrapper |
Additional Inherited Members | |
![]() | |
enum | ConstraintResult { ConstraintResultPass = 0 , ConstraintResultFailHard , ConstraintResultFailSoft } |
Result of constraint checks. More... | |
![]() | |
enum class | Property : int { RootPath = 0 , DocumentViewerContent , StorageUrl } |
Data defined properties for different editor widgets. More... | |
![]() | |
void | constraintResultVisibleChanged (bool visible) |
Emit this signal when the constraint result visibility changed. | |
void | constraintStatusChanged (const QString &constraint, const QString &desc, const QString &err, QgsEditorWidgetWrapper::ConstraintResult status) |
Emit this signal when the constraint status changed. | |
Q_DECL_DEPRECATED void | valueChanged (const QVariant &value) |
Emit this signal, whenever the value changed. | |
void | valuesChanged (const QVariant &value, const QVariantList &additionalFieldValues=QVariantList()) |
Emit this signal, whenever the value changed. | |
![]() | |
void | contextChanged () |
Signal when QgsAttributeEditorContext mContext changed. | |
![]() | |
static QgsEditorWidgetWrapper * | fromWidget (QWidget *widget) |
Will return a wrapper for a given widget. | |
static bool | isInTable (const QWidget *parent) |
Check if the given widget or one of its parent is a QTableView. | |
![]() | |
static QgsWidgetWrapper * | fromWidget (QWidget *widget) |
Will return a wrapper for a given widget. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the editor widget property definitions. | |
![]() | |
QgsPropertyCollection | mPropertyCollection |
Data defined property collection. | |
![]() | |
ConstraintResult | constraintResult |
bool | constraintResultVisible |
Wraps a file name widget.
Will offer a file browser to choose files.
The QgsExternalResourceWidgetWrapper class wraps a external resource widget
Definition at line 41 of file qgsexternalresourcewidgetwrapper.h.
|
explicit |
Constructor for QgsExternalResourceWidgetWrapper.
The layer and fieldIdx arguments specify the vector layer field associated with the wrapper.
The editor argument indicates the editor widget to use with the wrapper. This can be nullptr
if a new widget should be autogenerated.
A parent widget for this widget wrapper and the created widget can also be specified. A messageBar to report messages can also be specified
Definition at line 30 of file qgsexternalresourcewidgetwrapper.cpp.
|
overrideprotectedvirtual |
This method should create a new widget with the provided parent.
This will only be called if the form did not already provide a widget, so it is not guaranteed to be called! You should not do initialization stuff, which also has to be done for custom editor widgets inside this method. Things like filling comboboxes and assigning other data which will also be used to make widgets on forms created in the QtDesigner usable should be assigned in initWidget().
parent | You should set this parent on the created widget. |
Implements QgsWidgetWrapper.
Definition at line 140 of file qgsexternalresourcewidgetwrapper.cpp.
|
overrideprotectedvirtual |
This method should initialize the editor widget with runtime data.
Fill your comboboxes here.
editor | The widget which will represent this attribute editor in a form. |
Reimplemented from QgsWidgetWrapper.
Definition at line 150 of file qgsexternalresourcewidgetwrapper.cpp.
|
overrideslot |
Definition at line 279 of file qgsexternalresourcewidgetwrapper.cpp.
|
overrideslot |
Definition at line 129 of file qgsexternalresourcewidgetwrapper.cpp.
|
overridevirtual |
Sets the widget to display in an indeterminate "mixed value" state.
Reimplemented from QgsEditorWidgetWrapper.
Definition at line 58 of file qgsexternalresourcewidgetwrapper.cpp.
|
protected |
Update file widget current expression context according to layer, feature, and parent feature.
Definition at line 333 of file qgsexternalresourcewidgetwrapper.cpp.
|
overrideprotectedvirtual |
Returns true
if the widget has been properly initialized.
This acts as hint for the calling party if this wrapper can be used after initializing it. If it cannot be used this is a hint to the caller that he may try to find another suitable widget type instead.
Implements QgsWidgetWrapper.
Definition at line 76 of file qgsexternalresourcewidgetwrapper.cpp.
|
overridevirtual |
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.
Implements QgsEditorWidgetWrapper.
Definition at line 36 of file qgsexternalresourcewidgetwrapper.cpp.
|
slot |
Will be called when a value in the current edited form or table row changes.
attribute | The name of the attribute that changed. |
newValue | The new value of the attribute. |
attributeChanged | If true , it corresponds to an actual change of the feature attribute |
Definition at line 288 of file qgsexternalresourcewidgetwrapper.cpp.
|
friend |
Definition at line 101 of file qgsexternalresourcewidgetwrapper.h.