Subgroup: Attribute
Class: QgsAttributeForm¶
-
class
qgis.gui.
QgsAttributeForm
(vl: QgsVectorLayer, feature: QgsFeature = QgsFeature(), context: QgsAttributeEditorContext = QgsAttributeEditorContext(), parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidget
Methods
actionEvent
addInterface
Takes ownership aggregateFilter
The aggregate filter is only useful if the form is in AggregateFilter mode. changeAttribute
Call this to change the content of a given attribute. changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectButtonBox
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
editable
Returns if the form is currently in editable mode. enterEvent
event
eventFilter
Intercepts keypress on custom form (escape should not close it) feature
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideButtonBox
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
layer
Returns the layer for which this form is shown leaveEvent
metric
mode
Returns the current mode of the form. mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
refreshFeature
reload current feature resetSearch
Resets the search/filter form values. resetValues
Sets all values to the values of the current feature resizeEvent
save
Save all the values from the editors to the layer. sender
senderSignalIndex
setEditCommandMessage
Sets the edit command message (Undo) that will be used when the dialog is accepted setFeature
Update all editors to correspond to a different feature. setMessageBar
Sets the message bar to display feedback from the form in. setMode
Sets the current mode of the form. setMultiEditFeatureIds
Sets all feature IDs which are to be edited if the form is in multiedit mode sharedPainter
showButtonBox
showEvent
tabletEvent
timerEvent
updateMicroFocus
wheelEvent
Signals
attributeChanged
Notifies about changes of attributes, this signal is not emitted when the value is set back to the original one. closed
Emitted when the user selects the close option from the form’s button bar. featureSaved
Is emitted, when a feature is changed or added [signal] filterExpressionSet
Is emitted when a filter expression is set using the form. flashFeatures
Emitted when the user chooses to flash a filtered set of features. modeChanged
Emitted when the form changes mode. widgetValueChanged
Notifies about changes of attributes zoomToFeatures
Emitted when the user chooses to zoom to a filtered set of features. Attributes
AddFeatureMode
AggregateSearchMode
FilterAnd
FilterOr
IdentifyMode
MultiEditMode
ReplaceFilter
SearchMode
SingleEditMode
-
AddFeatureMode
= 1¶
-
AggregateSearchMode
= 4¶
-
FilterAnd
= 1¶
-
FilterOr
= 2¶
-
class
FilterType
¶ Bases:
int
-
IdentifyMode
= 5¶
-
class
Mode
¶ Bases:
int
-
MultiEditMode
= 2¶
-
ReplaceFilter
= 0¶
-
SearchMode
= 3¶
-
SingleEditMode
= 0¶
-
actionEvent
()¶
-
addInterface
(self, iface: QgsAttributeFormInterface)¶ Takes ownership
Parameters: iface –
-
aggregateFilter
(self) → str¶ The aggregate filter is only useful if the form is in AggregateFilter mode. In this case it will return a combined expression according to the chosen filters on all attribute widgets.
New in version 3.0.
-
attributeChanged
¶ Notifies about changes of attributes, this signal is not emitted when the value is set back to the original one.
Parameters: - attribute – The name of the attribute that changed.
- value – The new value of the attribute.
Deprecated since version since: 3.0 [signal]
-
changeAttribute
(self, field: str, value: Any, hintText: str = '')¶ Call this to change the content of a given attribute. Will update the editor(s) related to this field.
Parameters: - field – The field to change
- value – The new value
- hintText – A hint text for non existent joined features
-
changeEvent
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
closed
¶ Emitted when the user selects the close option from the form’s button bar.
New in version 2.16: [signal]
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
()¶
-
customEvent
()¶
-
destroy
()¶
-
disconnectButtonBox
(self)¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
editable
(self) → bool¶ Returns if the form is currently in editable mode.
Returns: Editable mode of this form
-
enterEvent
()¶
-
event
()¶
-
eventFilter
(self, object: QObject, event: QEvent) → bool¶ Intercepts keypress on custom form (escape should not close it)
Parameters: - object – The object for which the event has been sent
- event – The event which is being filtered
Returns: true if the event has been handled (key was ESC)
-
feature
(self) → QgsFeature¶
-
featureSaved
¶ Is emitted, when a feature is changed or added [signal]
-
filterExpressionSet
¶ Is emitted when a filter expression is set using the form.
Parameters: - expression – filter expression
- type – filter type
New in version 2.16: [signal]
-
flashFeatures
¶ Emitted when the user chooses to flash a filtered set of features.
New in version 3.0: [signal]
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideButtonBox
(self)¶
-
hideEvent
()¶
-
initPainter
()¶
-
inputMethodEvent
()¶
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
layer
(self) → QgsVectorLayer¶ Returns the layer for which this form is shown
Returns: Layer
-
leaveEvent
()¶
-
metric
()¶
-
mode
(self) → QgsAttributeForm.Mode¶ Returns the current mode of the form.
See also
New in version 2.16.
-
modeChanged
¶ Emitted when the form changes mode.
Parameters: mode – new mode [signal]
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
()¶
-
receivers
()¶
-
refreshFeature
(self)¶ reload current feature
-
resetSearch
(self)¶ Resets the search/filter form values.
New in version 2.16.
-
resetValues
(self)¶ Sets all values to the values of the current feature
-
resizeEvent
()¶
-
save
(self) → bool¶ Save all the values from the editors to the layer.
Returns: True if successful
-
sender
()¶
-
senderSignalIndex
()¶
-
setEditCommandMessage
(self, message: str)¶ Sets the edit command message (Undo) that will be used when the dialog is accepted
Parameters: message – The message
-
setFeature
(self, feature: QgsFeature)¶ Update all editors to correspond to a different feature.
Parameters: feature – The feature which will be represented by the form
-
setMessageBar
(self, messageBar: QgsMessageBar)¶ Sets the message bar to display feedback from the form in. This is used in the search/filter mode to display the count of selected features.
Parameters: messageBar – target message bar New in version 2.16.
-
setMode
(self, mode: QgsAttributeForm.Mode)¶ Sets the current mode of the form.
Parameters: mode – form mode See also
New in version 2.16.
-
setMultiEditFeatureIds
(self, fids: object)¶ Sets all feature IDs which are to be edited if the form is in multiedit mode
Parameters: fids – feature ID list New in version 2.16.
-
showButtonBox
(self)¶
-
showEvent
()¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶
-
widgetValueChanged
¶ Notifies about changes of attributes
Parameters: - attribute – The name of the attribute that changed.
- value – The new value of the attribute.
- attributeChanged – If true, it corresponds to an actual change of the feature attribute
New in version 3.0.1: [signal]
-
zoomToFeatures
¶ Emitted when the user chooses to zoom to a filtered set of features.
New in version 3.0: [signal]
-