Subgroup: Relation

Class: QgsRelationEditorWidget

class qgis.gui.QgsRelationEditorWidget(parent: QWidget = None)

Bases: qgis._gui.QgsCollapsibleGroupBox

Parameters:parent

parent widget

Methods

acceptDrops
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
adjustSize
alignment
autoFillBackground
backgroundRole
baseSize
blockSignals
changeEvent
checkClicked
checkToggled
childAt childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
clearModifiers
close
closeEvent
collapseExpandFixes
colorCount
connectNotify
contentsMargins
contentsRect
contextMenuEvent
contextMenuPolicy
create
createWindowContainer
cursor
customEvent
deleteLater
depth
destroy
devType
devicePixelRatio
devicePixelRatioF
devicePixelRatioFScale
disconnect
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
effectiveWinId
ensurePolished
enterEvent
event
eventFilter
featureSelectionManager The feature selection manager is responsible for the selected features which are currently being edited.
find
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]
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPolicy
focusPreviousChild
focusProxy
focusWidget
font
fontInfo
fontMetrics
foregroundRole
frameGeometry
frameSize
geometry
getContentsMargins
grab
grabGesture
grabKeyboard
grabMouse grabMouse(self, Union[QCursor, Qt.CursorShape])
grabShortcut
graphicsEffect
graphicsProxyWidget
hasFocus
hasHeightForWidth
hasMouseTracking
hasTabletTracking
height
heightForWidth
heightMM
hide
hideEvent
inherits
init
initPainter
initStyleOption
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isCheckable
isChecked
isCollapsed Returns the current collapsed state of this group box
isEnabled
isEnabledTo
isFlat
isFullScreen
isHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isSignalConnected
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
keyPressEvent
keyReleaseEvent
keyboardGrabber
killTimer
layout
layoutDirection
leaveEvent
loadState
locale
logicalDpiX
logicalDpiY
lower
mapFrom
mapFromGlobal
mapFromParent
mapTo
mapToGlobal
mapToParent
mask
maximumHeight
maximumSize
maximumWidth
metaObject
metric
minimumHeight
minimumSize
minimumSizeHint
minimumWidth
mouseDoubleClickEvent
mouseGrabber
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
move move(self, int, int)
moveEvent
moveToThread
nativeEvent
nativeParentWidget
nextInFocusChain
normalGeometry
objectName
overrideWindowFlags
overrideWindowState
paintEngine
paintEvent
paintingActive
palette
parent
parentWidget
physicalDpiX
physicalDpiY
pos
previousInFocusChain
property
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
raise_
receivers
rect
releaseKeyboard
releaseMouse
releaseShortcut
removeAction
removeEventFilter
render render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))
repaint repaint(self, int, int, int, int)
resize resize(self, int, int)
resizeEvent
restoreGeometry
saveCheckedState
saveCollapsedState
saveGeometry
saveKey
saveState
scroll scroll(self, int, int, QRect)
scrollOnExpand If this is set to false the parent QScrollArea will not be automatically scrolled to this widget’s contents when expanded
sender
senderSignalIndex
setAcceptDrops
setAccessibleDescription
setAccessibleName
setAlignment
setAttribute
setAutoFillBackground
setBackgroundRole
setBaseSize setBaseSize(self, QSize)
setCheckable
setChecked
setCollapsed Collapse or uncollapse this groupbox
setContentsMargins setContentsMargins(self, QMargins)
setContextMenuPolicy
setCursor
setDisabled
setEditorContext
setEnabled
setFeature
setFixedHeight
setFixedSize setFixedSize(self, int, int)
setFixedWidth
setFlat
setFocus setFocus(self, Qt.FocusReason)
setFocusPolicy
setFocusProxy
setFont
setForegroundRole
setGeometry setGeometry(self, int, int, int, int)
setGraphicsEffect
setHidden
setInputMethodHints
setLayout
setLayoutDirection
setLocale
setMask setMask(self, QRegion)
setMaximumHeight
setMaximumSize setMaximumSize(self, QSize)
setMaximumWidth
setMinimumHeight
setMinimumSize setMinimumSize(self, QSize)
setMinimumWidth
setMouseTracking
setObjectName
setPalette
setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
setProperty
setRelationFeature
setRelations Set the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required.
setSaveCheckedState Set this to true to save/restore checked state
setSaveCollapsedState set this to false to not save/restore collapsed state
setScrollOnExpand Set this to false to not automatically scroll parent QScrollArea to this widget’s contents when expanded
setSettingGroup Set this to a defined string to share save/restore states across different parent dialogs
setSettings
setShortcutAutoRepeat
setShortcutEnabled
setShowLabel Defines if a title label 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
setSizeIncrement setSizeIncrement(self, QSize)
setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
setStatusTip
setStyle
setStyleSheet
setSyncGroup Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key
setTabOrder
setTabletTracking
setTitle
setToolTip
setToolTipDuration
setUpdatesEnabled
setViewMode Define the view mode for the dual view
setVisible
setWhatsThis
setWindowFilePath
setWindowFlag
setWindowFlags
setWindowIcon
setWindowIconText
setWindowModality
setWindowModified
setWindowOpacity
setWindowRole
setWindowState
setWindowTitle
settingGroup Returns the name of the setting group in which the collapsed state will be saved
sharedPainter
show
showEvent
showFullScreen
showLabel Defines if a title label should be shown for this widget.
showLinkButton Determines if the “link feature” button should be shown
showMaximized
showMinimized
showNormal
showUnlinkButton Determines if the “unlink feature” button should be shown
signalsBlocked
size
sizeHint
sizeIncrement
sizePolicy
stackUnder
startTimer
statusTip
style
styleSheet
syncGroup Named group which synchronizes collapsing action when triangle is clicked while holding alt modifier key
tabletEvent
testAttribute
thread
timerEvent
title
titleRect
toggleCollapsed
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
unsetCursor
unsetLayoutDirection
unsetLocale
update update(self, QRect)
updateGeometry
updateMicroFocus
updateStyle
updatesEnabled
viewMode Get the view mode for the dual view
visibleRegion
whatsThis
wheelEvent
width
widthMM
winId
window
windowFilePath
windowFlags
windowHandle
windowIcon
windowIconText
windowModality
windowOpacity
windowRole
windowState
windowTitle
windowType
x
y

Attributes

DrawChildren
DrawWindowBackground
IgnoreMask
PdmDepth
PdmDevicePixelRatio
PdmDevicePixelRatioScaled
PdmDpiX
PdmDpiY
PdmHeight
PdmHeightMM
PdmNumColors
PdmPhysicalDpiX
PdmPhysicalDpiY
PdmWidth
PdmWidthMM
clicked clicked(self, bool = False) [signal]
collapsedStateChanged Signal emitted when groupbox collapsed/expanded state is changed, and when first shown [signal]
customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]
destroyed destroyed(self, QObject = None) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
staticMetaObject
toggled toggled(self, bool) [signal]
windowIconChanged windowIconChanged(self, QIcon) [signal]
windowIconTextChanged windowIconTextChanged(self, str) [signal]
windowTitleChanged windowTitleChanged(self, str) [signal]
actionEvent()
changeEvent()
childEvent()
clearModifiers()
closeEvent()
collapseExpandFixes()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
featureSelectionManager(self) → QgsIFeatureSelectionManager

The feature selection manager is responsible for the selected features which are currently being edited.

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
init()
initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadState()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
saveKey()
saveState()
sender()
senderSignalIndex()
setEditorContext(self, context: QgsAttributeEditorContext)
setFeature(self, feature: QgsFeature)
setRelationFeature(self, relation: QgsRelation, feature: QgsFeature)
setRelations(self, relation: QgsRelation, nmrelation: QgsRelation)

Set the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required.

Parameters:
  • relation – Relation referencing the edited table
  • nmrelation – Optional reference from the referencing table to a 3rd N:M table
setShowLabel(self, showLabel: bool)

Defines if a title label should be shown for this widget.

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.

setViewMode(self, mode: QgsDualView.ViewMode)

Define the view mode for the dual view

sharedPainter()
showEvent()
showLabel(self) → bool

Defines if a title label should be shown for this widget.

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.

tabletEvent()
timerEvent()
titleRect()
updateMicroFocus()
updateStyle()
viewMode(self) → QgsDualView.ViewMode

Get the view mode for the dual view

wheelEvent()