Subgroup: Relation

Class: QgsRelationReferenceWidgetWrapper

class qgis.gui.QgsRelationReferenceWidgetWrapper

Bases: qgis._gui.QgsEditorWidgetWrapper

Wraps a relation reference widget.

Options: <ul> <li><b>ShowForm</b> <i>If True, an embedded form with the referenced feature will be shown.</i></li> <li><b>MapIdentification</b> <i>Will offer a map tool to pick a referenced feature on the map canvas. Only use for layers with geometry.</i></li> <li><b>ReadOnly</b> <i>If True, will represent the referenced widget in a read-only line edit. Can speed up loading.</i></li> <li><b>AllowNULL</b> <i>Will offer NULL as a value.</i></li> <li><b>Relation</b> <i>The ID of the relation that will be used to define this widget.</i></li> ReadOnly </ul>

Methods

blockSignals
childEvent
children
config	Use this inside your overridden classes to access the configuration.
connectNotify
constraintFailureReason	Returns the reason why a constraint check has failed (or an empty string if constraint check was successful).
constraintResult	Getter of constraintResult It’s the current result of the constraint on the widget influencing it’s visualization.
constraintResultVisible	Getter of constraintResultVisible Defines if the constraint result should be visualized on the widget (with color).
context	Returns information about the context in which this widget is shown
createWidget
customEvent
dataDefinedProperties	Returns a reference to the editor widget’s property collection, used for data defined overrides.
defaultValue	Access the default value of the field.
deleteLater
disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
emitValueChanged	Will call the value() method to determine the emitted value
event
eventFilter
field	Access the field.
fieldIdx	Access the field index.
findChild	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
fromWidget	Will return a wrapper for a given widget
inherits
initWidget
installEventFilter
isBlockingCommit	Returns true if the widget is preventing the feature from being committed.
isInTable	Check if the given widget or one of its parent is a QTableView.
isSignalConnected
isValidConstraint	Get the current constraint status.
isWidgetType
isWindowType
killTimer
layer	Access the QgsVectorLayer, you are working on
metaObject
moveToThread
objectName
parent
property
propertyDefinitions	Returns the editor widget property definitions.
pyqtConfigure	Each keyword argument is either the name of a Qt property or a Qt signal.
receivers
removeEventFilter
sender
senderSignalIndex
setConfig	Will set the config of this wrapper to the specified config.
setConstraintResultVisible	Setter of constraintResultVisible Defines if the constraint result should be visualized on the widget (with color).
setContext	Set the context in which this widget is shown
setDataDefinedProperties	Sets the editor widget’s property collection, used for data defined overrides.
setEnabled
setFeature	Will be called when the feature changes
setHint	Add a hint text on the widget
setObjectName
setParent
setProperty
setValue
showIndeterminateState
signalsBlocked
startTimer
thread
timerEvent
tr
updateConstraint	Update constraint.
updateConstraintWidgetStatus
valid
value
widget	Access the widget managed by this wrapper

Attributes

ConstraintResultFailHard
ConstraintResultFailSoft
ConstraintResultPass
DocumentViewerContent
RootPath
constraintResultVisibleChanged	Emit this signal when the constraint result visibility changed.
constraintStatusChanged	Emit this signal when the constraint status changed.
destroyed	destroyed(self, QObject = None) [signal]
objectNameChanged	objectNameChanged(self, str) [signal]
staticMetaObject
valueChanged	Emit this signal, whenever the value changed.

childEvent()

connectNotify()

createWidget(self, parent: QWidget) → QWidget

customEvent()

disconnectNotify()

initWidget(self, editor: QWidget)

isSignalConnected()

receivers()

sender()

senderSignalIndex()

setEnabled(self, enabled: bool)

setValue(self, value: Any)

showIndeterminateState(self)

timerEvent()

updateConstraintWidgetStatus(self)

valid(self) → bool

value(self) → Any