Class: QgsAttributeForm¶
-
class
qgis.gui.
QgsAttributeForm
(vl: QgsVectorLayer, feature: QgsFeature = QgsFeature(), context: QgsAttributeEditorContext = QgsAttributeEditorContext(), parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidget
- Parameters
vl (QgsVectorLayer) –
feature (
QgsFeature
= QgsFeature()) –context (
QgsAttributeEditorContext
= QgsAttributeEditorContext()) –parent –
-
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
(self, QActionEvent)¶
-
addInterface
(self, iface: QgsAttributeFormInterface)¶ Takes ownership
- Parameters
iface (QgsAttributeFormInterface) –
-
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.
- Return type
str
-
attributeChanged
¶ Notifies about changes of attributes, this signal is not emitted when the value is set back to the original one.
- Parameters
attribute (str) – The name of the attribute that changed.
value (Any) – 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 (str) – The field to change
value (Any) – The new value
hintText (str = '') – A hint text for non existent joined features
-
changeEvent
(self, QEvent)¶
-
childEvent
(self, QChildEvent)¶
-
closeEvent
(self, QCloseEvent)¶
-
closed
¶ Emitted when the user selects the close option from the form’s button bar.
New in version 2.16: [signal]
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
create
(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
-
customEvent
(self, QEvent)¶
-
destroy
(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
-
disconnectButtonBox
(self)¶ Disconnects the button box (OK/Cancel) from the accept/resetValues slots If this method is called, you have to create these connections from outside
-
disconnectNotify
(self, QMetaMethod)¶
-
displayWarning
(self, message: str)¶ Displays a warning message in the form message bar
- Parameters
message (str) – message string
See also
New in version 3.12.
-
dragEnterEvent
(self, QDragEnterEvent)¶
-
dragLeaveEvent
(self, QDragLeaveEvent)¶
-
dragMoveEvent
(self, QDragMoveEvent)¶
-
dropEvent
(self, QDropEvent)¶
-
editable
(self) → bool¶ Returns if the form is currently in editable mode.
- Return type
bool
- Returns
Editable mode of this form
-
enterEvent
(self, QEvent)¶
-
event
(self, QEvent) → bool¶
-
eventFilter
(self, object: QObject, event: QEvent) → bool¶ Intercepts keypress on custom form (escape should not close it)
- Parameters
object (QObject) – The object for which the event has been sent
event (QEvent) – The event which is being filtered
- Return type
bool
- Returns
True
if the event has been handled (key was ESC)
-
feature
(self) → QgsFeature¶ - Return type
-
featureSaved
¶ Emitted when a feature is changed or added [signal]
- Parameters
feature (QgsFeature) –
-
filterExpressionSet
¶ Emitted when a filter expression is set using the form.
- Parameters
expression (str) – filter expression
type (QgsAttributeForm.FilterType) – 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]
- Parameters
filter (str) –
-
focusInEvent
(self, QFocusEvent)¶
-
focusNextChild
(self) → bool¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
focusPreviousChild
(self) → bool¶
-
hideButtonBox
(self)¶ Hides the button box (OK/Cancel) and enables auto-commit
Note
set Embed in
QgsAttributeEditorContext
in constructor instead
-
hideEvent
(self, QHideEvent)¶
-
initPainter
(self, QPainter)¶
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
layer
(self) → QgsVectorLayer¶ Returns the layer for which this form is shown
- Return type
- Returns
Layer
-
leaveEvent
(self, QEvent)¶
-
metric
(self, QPaintDevice.PaintDeviceMetric) → int¶
-
mode
(self) → QgsAttributeEditorContext.Mode¶ Returns the current mode of the form.
See also
New in version 2.16.
- Return type
-
modeChanged
¶ Emitted when the form changes mode.
- Parameters
mode (QgsAttributeEditorContext.Mode) – new mode [signal]
-
mouseDoubleClickEvent
(self, QMouseEvent)¶
-
mouseMoveEvent
(self, QMouseEvent)¶
-
mousePressEvent
(self, QMouseEvent)¶
-
mouseReleaseEvent
(self, QMouseEvent)¶
-
moveEvent
(self, QMoveEvent)¶
-
nativeEvent
(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶
-
paintEvent
(self, QPaintEvent)¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
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
(self, QResizeEvent)¶
-
save
(self) → bool¶ Save all the values from the editors to the layer.
- Return type
bool
- Returns
True
if successful
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setEditCommandMessage
(self, message: str)¶ Sets the edit command message (Undo) that will be used when the dialog is accepted
- Parameters
message (str) – The message
-
setFeature
(self, feature: QgsFeature)¶ Update all editors to correspond to a different feature.
- Parameters
feature (QgsFeature) – 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 (QgsMessageBar) – target message bar
New in version 2.16.
-
setMode
(self, mode: QgsAttributeEditorContext.Mode)¶ Sets the current mode of the form.
- Parameters
mode (QgsAttributeEditorContext.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 (object) – feature ID list
New in version 2.16.
-
showButtonBox
(self)¶ Shows the button box (OK/Cancel) and disables auto-commit
Note
set Embed in
QgsAttributeEditorContext
in constructor instead
-
showEvent
(self, QShowEvent)¶
-
tabletEvent
(self, QTabletEvent)¶
-
timerEvent
(self, QTimerEvent)¶
-
updateMicroFocus
(self)¶
-
wheelEvent
(self, QWheelEvent)¶
-
widgetValueChanged
¶ Notifies about changes of attributes
- Parameters
attribute (str) – The name of the attribute that changed.
value (Any) – The new value of the attribute.
attributeChanged (bool) – 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]
- Parameters
filter (str) –