QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Contains configuration settings for an editor form. More...
#include <qgseditformconfig.h>
Classes | |
struct | GroupData |
struct | TabData |
Public Types | |
enum class | DataDefinedProperty : int { NoProperty = 0 , AllProperties = 1 , Alias = 2 , Editable = 3 } |
Data defined properties. More... | |
Public Member Functions | |
QgsEditFormConfig () | |
Create a new edit form config. | |
QgsEditFormConfig (const QgsEditFormConfig &o) | |
~QgsEditFormConfig () | |
void | addTab (QgsAttributeEditorElement *data) |
Adds a new element to the invisible root container in the layout. | |
Q_DECL_DEPRECATED QgsAttributeEditorElement * | attributeEditorElementFromDomElement (QDomElement &elem, QgsAttributeEditorElement *parent, const QString &layerId=QString(), const QgsReadWriteContext &context=QgsReadWriteContext()) |
Deserialize drag and drop designer elements. | |
void | clearTabs () |
Clears all the tabs for the attribute editor form with EditorLayout::TabLayout. | |
QgsPropertyCollection | dataDefinedFieldProperties (const QString &fieldName) const |
Returns data defined properties for fieldName. | |
QString | initCode () const |
Gets Python code for edit form initialization. | |
Qgis::AttributeFormPythonInitCodeSource | initCodeSource () const |
Returns Python code source for edit form initialization (if it shall be loaded from a file, read from the provided dialog editor or inherited from the environment) | |
QString | initFilePath () const |
Gets Python external file path for edit form initialization. | |
QString | initFunction () const |
Gets Python function for edit form initialization. | |
QgsAttributeEditorContainer * | invisibleRootContainer () |
Gets the invisible root container for the drag and drop designer form (EditorLayout::TabLayout). | |
bool | labelOnTop (int idx) const |
If this returns true , the widget at the given index will receive its label on the previous line while if it returns false , the widget will receive its label on the left hand side. | |
Qgis::AttributeFormLayout | layout () const |
Gets the active layout style for the attribute editor for this layer. | |
QgsEditFormConfig & | operator= (const QgsEditFormConfig &o) |
bool | operator== (const QgsEditFormConfig &o) const |
bool | readOnly (int idx) const |
This returns true if the field is manually set to read only or if the field does not support editing like joins or virtual fields. | |
void | readXml (const QDomNode &node, QgsReadWriteContext &context) |
Read XML information Deserialize on project load. | |
bool | removeWidgetConfig (const QString &widgetName) |
Remove the configuration for the editor widget with the given name. | |
bool | reuseLastValue (int index) const |
If this returns true , the widget at the given index will remember the previously entered value from this QGIS session when creating new features. | |
void | setDataDefinedFieldProperties (const QString &fieldName, const QgsPropertyCollection &properties) |
Set data defined properties for fieldName to properties. | |
void | setInitCode (const QString &code) |
Set Python code for edit form initialization. | |
void | setInitCodeSource (Qgis::AttributeFormPythonInitCodeSource initCodeSource) |
Sets if Python code shall be used for edit form initialization and its origin. | |
void | setInitFilePath (const QString &filePath) |
Set Python external file path for edit form initialization. | |
void | setInitFunction (const QString &function) |
Set Python function for edit form initialization. | |
void | setLabelOnTop (int idx, bool onTop) |
If this is set to true , the widget at the given index will receive its label on the previous line while if it is set to false , the widget will receive its label on the left hand side. | |
void | setLayout (Qgis::AttributeFormLayout editorLayout) |
Sets the active layout style for the attribute editor for this layer. | |
void | setReadOnly (int idx, bool readOnly=true) |
If set to false , the widget at the given index will be read-only. | |
void | setReuseLastValue (int index, bool reuse) |
Sets whether the widget at the given index will remember the previously entered value from this QGIS session when creating new features. | |
void | setSuppress (Qgis::AttributeFormSuppression s) |
Sets type of feature form pop-up suppression after feature creation (overrides app setting) | |
void | setUiForm (const QString &ui) |
Set path to the .ui form. | |
bool | setWidgetConfig (const QString &widgetName, const QVariantMap &config) |
Set the editor widget config for a widget which is not for a simple field. | |
Qgis::AttributeFormSuppression | suppress () const |
Type of feature form pop-up suppression after feature creation (overrides app setting) | |
QList< QgsAttributeEditorElement * > | tabs () const |
Returns a list of tabs for EditorLayout::TabLayout obtained from the invisible root container. | |
QString | uiForm () const |
Returns the path or URL to the .ui form. | |
QVariantMap | widgetConfig (const QString &widgetName) const |
Gets the configuration for the editor widget with the given name. | |
void | writeXml (QDomNode &node, const QgsReadWriteContext &context) const |
Write XML information Serialize on project save. | |
Static Public Member Functions | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns data defined property definitions. | |
Friends | |
class | QgsVectorLayer |
Contains configuration settings for an editor form.
Definition at line 40 of file qgseditformconfig.h.
|
strong |
Data defined properties.
Form data defined overrides are stored in a property collection and they can be retrieved using the indexes specified in this enum.
Enumerator | |
---|---|
NoProperty | No property. |
AllProperties | All properties for item. |
Alias | Alias. |
Editable | Editable state.
|
Definition at line 80 of file qgseditformconfig.h.
QgsEditFormConfig::QgsEditFormConfig | ( | const QgsEditFormConfig & | o | ) |
Definition at line 155 of file qgseditformconfig.cpp.
QgsEditFormConfig::~QgsEditFormConfig | ( | ) |
Definition at line 160 of file qgseditformconfig.cpp.
|
explicit |
Create a new edit form config.
Normally invoked by QgsVectorLayer
Definition at line 32 of file qgseditformconfig.cpp.
void QgsEditFormConfig::addTab | ( | QgsAttributeEditorElement * | data | ) |
Adds a new element to the invisible root container in the layout.
This is only useful in combination with EditorLayout::TabLayout.
Definition at line 174 of file qgseditformconfig.cpp.
QgsAttributeEditorElement * QgsEditFormConfig::attributeEditorElementFromDomElement | ( | QDomElement & | elem, |
QgsAttributeEditorElement * | parent, | ||
const QString & | layerId = QString() , |
||
const QgsReadWriteContext & | context = QgsReadWriteContext() |
||
) |
Deserialize drag and drop designer elements.
Definition at line 673 of file qgseditformconfig.cpp.
void QgsEditFormConfig::clearTabs | ( | ) |
Clears all the tabs for the attribute editor form with EditorLayout::TabLayout.
Definition at line 185 of file qgseditformconfig.cpp.
QgsPropertyCollection QgsEditFormConfig::dataDefinedFieldProperties | ( | const QString & | fieldName | ) | const |
Returns data defined properties for fieldName.
Definition at line 43 of file qgseditformconfig.cpp.
QString QgsEditFormConfig::initCode | ( | ) | const |
Gets Python code for edit form initialization.
Definition at line 303 of file qgseditformconfig.cpp.
Qgis::AttributeFormPythonInitCodeSource QgsEditFormConfig::initCodeSource | ( | ) | const |
Returns Python code source for edit form initialization (if it shall be loaded from a file, read from the provided dialog editor or inherited from the environment)
Definition at line 332 of file qgseditformconfig.cpp.
QString QgsEditFormConfig::initFilePath | ( | ) | const |
Gets Python external file path for edit form initialization.
Definition at line 314 of file qgseditformconfig.cpp.
QString QgsEditFormConfig::initFunction | ( | ) | const |
Gets Python function for edit form initialization.
Will be looked up in a Python file relative to the project folder if it includes a module name or if it's a pure function name it will searched in the Python code set with setInitCode().
Definition at line 292 of file qgseditformconfig.cpp.
QgsAttributeEditorContainer * QgsEditFormConfig::invisibleRootContainer | ( | ) |
Gets the invisible root container for the drag and drop designer form (EditorLayout::TabLayout).
Definition at line 191 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::labelOnTop | ( | int | idx | ) | const |
If this returns true
, the widget at the given index will receive its label on the previous line while if it returns false
, the widget will receive its label on the left hand side.
Labeling on top leaves more horizontal space for the widget itself.
Definition at line 249 of file qgseditformconfig.cpp.
Qgis::AttributeFormLayout QgsEditFormConfig::layout | ( | ) | const |
Gets the active layout style for the attribute editor for this layer.
Definition at line 196 of file qgseditformconfig.cpp.
QgsEditFormConfig & QgsEditFormConfig::operator= | ( | const QgsEditFormConfig & | o | ) |
Definition at line 163 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::operator== | ( | const QgsEditFormConfig & | o | ) | const |
Definition at line 169 of file qgseditformconfig.cpp.
|
static |
Returns data defined property definitions.
Definition at line 48 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::readOnly | ( | int | idx | ) | const |
This returns true
if the field is manually set to read only or if the field does not support editing like joins or virtual fields.
Definition at line 234 of file qgseditformconfig.cpp.
void QgsEditFormConfig::readXml | ( | const QDomNode & | node, |
QgsReadWriteContext & | context | ||
) |
Read XML information Deserialize on project load.
Definition at line 354 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::removeWidgetConfig | ( | const QString & | widgetName | ) |
Remove the configuration for the editor widget with the given name.
widgetName | The name of the widget. |
true
if a configuration has been removed Definition at line 149 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::reuseLastValue | ( | int | index | ) | const |
If this returns true
, the widget at the given index will remember the previously entered value from this QGIS session when creating new features.
Definition at line 275 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setDataDefinedFieldProperties | ( | const QString & | fieldName, |
const QgsPropertyCollection & | properties | ||
) |
Set data defined properties for fieldName to properties.
Definition at line 37 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setInitCode | ( | const QString & | code | ) |
Set Python code for edit form initialization.
Make sure that you also set the appropriate function name in setInitFunction().
Definition at line 308 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setInitCodeSource | ( | Qgis::AttributeFormPythonInitCodeSource | initCodeSource | ) |
Sets if Python code shall be used for edit form initialization and its origin.
Definition at line 337 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setInitFilePath | ( | const QString & | filePath | ) |
Set Python external file path for edit form initialization.
Make sure that you also set the appropriate function name in setInitFunction().
Definition at line 319 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setInitFunction | ( | const QString & | function | ) |
Set Python function for edit form initialization.
Will be looked up in a Python file relative to the project folder if it includes a module name or if it's a pure function name it will searched in the Python code set with setInitCode().
Definition at line 297 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setLabelOnTop | ( | int | idx, |
bool | onTop | ||
) |
If this is set to true
, the widget at the given index will receive its label on the previous line while if it is set to false
, the widget will receive its label on the left hand side.
Labeling on top leaves more horizontal space for the widget itself.
Definition at line 266 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setLayout | ( | Qgis::AttributeFormLayout | editorLayout | ) |
Sets the active layout style for the attribute editor for this layer.
Definition at line 201 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setReadOnly | ( | int | idx, |
bool | readOnly = true |
||
) |
If set to false
, the widget at the given index will be read-only.
Definition at line 257 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setReuseLastValue | ( | int | index, |
bool | reuse | ||
) |
Sets whether the widget at the given index will remember the previously entered value from this QGIS session when creating new features.
Definition at line 283 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setSuppress | ( | Qgis::AttributeFormSuppression | s | ) |
Sets type of feature form pop-up suppression after feature creation (overrides app setting)
Definition at line 348 of file qgseditformconfig.cpp.
void QgsEditFormConfig::setUiForm | ( | const QString & | ui | ) |
Set path to the .ui form.
When a string is provided in ui, the layout style will be set to EditorLayout::UiFileLayout, if an empty or a null string is provided, the layout style will be set to EditorLayout::GeneratedLayout. If ui is a URL, a local copy of the file will be made and will be used to create the forms context is provided to save error messages
Definition at line 215 of file qgseditformconfig.cpp.
bool QgsEditFormConfig::setWidgetConfig | ( | const QString & | widgetName, |
const QVariantMap & | config | ||
) |
Set the editor widget config for a widget which is not for a simple field.
widgetName | The name of the widget to configure |
config | The config to set for this widget |
false
if a field exists with the provided widgetName. In this case QgsVectorLayer::setEditorWidgetSetup should be used.Definition at line 129 of file qgseditformconfig.cpp.
Qgis::AttributeFormSuppression QgsEditFormConfig::suppress | ( | ) | const |
Type of feature form pop-up suppression after feature creation (overrides app setting)
Definition at line 343 of file qgseditformconfig.cpp.
QList< QgsAttributeEditorElement * > QgsEditFormConfig::tabs | ( | ) | const |
Returns a list of tabs for EditorLayout::TabLayout obtained from the invisible root container.
Definition at line 180 of file qgseditformconfig.cpp.
QString QgsEditFormConfig::uiForm | ( | ) | const |
Returns the path or URL to the .ui form.
Only meaningful with EditorLayout::UiFileLayout
Definition at line 210 of file qgseditformconfig.cpp.
QVariantMap QgsEditFormConfig::widgetConfig | ( | const QString & | widgetName | ) | const |
Gets the configuration for the editor widget with the given name.
widgetName | The name of the widget. |
Definition at line 53 of file qgseditformconfig.cpp.
void QgsEditFormConfig::writeXml | ( | QDomNode & | node, |
const QgsReadWriteContext & | context | ||
) | const |
Write XML information Serialize on project save.
Definition at line 547 of file qgseditformconfig.cpp.
|
friend |
Definition at line 347 of file qgseditformconfig.h.