Subgroup: Relation

Class: QgsRelationWidgetWrapper¶

class qgis.gui.QgsRelationWidgetWrapper¶

Bases: qgis._gui.QgsWidgetWrapper

Note

not available in Python bindings

Methods

`blockSignals`
`childEvent`
`children`
`config`	Use this inside your overridden classes to access the configuration.
`connectNotify`
`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.
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`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`
`isSignalConnected`
`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`
`relation`	The relation for which this wrapper is created.
`removeEventFilter`
`sender`
`senderSignalIndex`
`setConfig`	Will set the config of this wrapper to the specified config.
`setContext`	Set the context in which this widget is shown
`setDataDefinedProperties`	Sets the editor widget’s property collection, used for data defined overrides.
`setEnabled`	Is used to enable or disable the edit functionality of the managed widget.
`setFeature`
`setObjectName`
`setParent`
`setProperty`
`setShowLabel`	Defines if a title lable should be shown for this widget.
`setShowLinkButton`	Determines if the “link feature” button should be shown
`setShowUnlinkButton`	Determines if the “unlink feature” button should be shown
`setVisible`	Sets the visibility of the wrapper’s widget.
`showLabel`	Defines if a title lable should be shown for this widget.
`showLinkButton`	Determines if the “link feature” button should be shown
`showUnlinkButton`	Determines if the “unlink feature” button should be shown
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`
`valid`
`widget`	Access the widget managed by this wrapper

Attributes

`DocumentViewerContent`
`RootPath`
`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

childEvent()¶

connectNotify()¶

createWidget(self, parent: QWidget) → QWidget¶

customEvent()¶

disconnectNotify()¶

initWidget(self, editor: QWidget)¶

isSignalConnected()¶

receivers()¶

relation(self) → QgsRelation¶: The relation for which this wrapper is created.

New in version 3.0.

sender()¶

senderSignalIndex()¶

setFeature(self, feature: QgsFeature)¶

setShowLabel(self, showLabel: bool)¶: Defines if a title lable should be shown for this widget. Only has an effect after widget() has been called at least once.

New in version 2.18.

setShowLinkButton(self, showLinkButton: bool)¶: Determines if the “link feature” button should be shown

New in version 2.18.

setShowUnlinkButton(self, showUnlinkButton: bool)¶: Determines if the “unlink feature” button should be shown

New in version 2.18.

setVisible(self, visible: bool)¶

Sets the visibility of the wrapper’s widget.

Parameters:	visible – set to true to show widget, false to hide widget

New in version 2.16.

showLabel(self) → bool¶: Defines if a title lable should be shown for this widget. Only has an effect after widget() has been called at least once.

New in version 2.18.

showLinkButton(self) → bool¶: Determines if the “link feature” button should be shown

New in version 2.18.

showUnlinkButton(self) → bool¶: Determines if the “unlink feature” button should be shown

New in version 2.18.

timerEvent()¶

valid(self) → bool¶