Subgroup: other

Class: QgsUserInputDockWidget

class qgis.gui.QgsUserInputDockWidget

Bases: qgis._gui.QgsDockWidget

The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs. It can be used by map tools, plugins, etc. Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically. The dock is automatically hidden if it contains no widget.

Methods

acceptDrops
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
addUserInputWidget	Add a widget to be displayed in the dock.
adjustSize
allowedAreas
autoFillBackground
backgroundRole
baseSize
blockSignals
changeEvent
childAt	childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
close
closeEvent
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
features
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
initPainter
initStyleOption
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isAreaAllowed
isEnabled
isEnabledTo
isFloating
isFullScreen
isHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isSignalConnected
isUserVisible	Returns true if the dock is both opened and raised to the front (ie not hidden by any other tabs.
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
keyPressEvent
keyReleaseEvent
keyboardGrabber
killTimer
layout
layoutDirection
leaveEvent
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
saveGeometry
scroll	scroll(self, int, int, QRect)
sender
senderSignalIndex
setAcceptDrops
setAccessibleDescription
setAccessibleName
setAllowedAreas
setAttribute
setAutoFillBackground
setBackgroundRole
setBaseSize	setBaseSize(self, QSize)
setContentsMargins	setContentsMargins(self, QMargins)
setContextMenuPolicy
setCursor
setDisabled
setEnabled
setFeatures
setFixedHeight
setFixedSize	setFixedSize(self, int, int)
setFixedWidth
setFloating
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
setShortcutAutoRepeat
setShortcutEnabled
setSizeIncrement	setSizeIncrement(self, QSize)
setSizePolicy	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
setStatusTip
setStyle
setStyleSheet
setTabOrder
setTabletTracking
setTitleBarWidget
setToolTip
setToolTipDuration
setUpdatesEnabled
setUserVisible	Sets the dock widget as visible to a user, ie both shown and raised to the front.
setVisible
setWhatsThis
setWidget
setWindowFilePath
setWindowFlag
setWindowFlags
setWindowIcon
setWindowIconText
setWindowModality
setWindowModified
setWindowOpacity
setWindowRole
setWindowState
setWindowTitle
sharedPainter
show
showEvent
showFullScreen
showMaximized
showMinimized
showNormal
signalsBlocked
size
sizeHint
sizeIncrement
sizePolicy
stackUnder
startTimer
statusTip
style
styleSheet
tabletEvent
testAttribute
thread
timerEvent
titleBarWidget
toggleViewAction
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
unsetCursor
unsetLayoutDirection
unsetLocale
update	update(self, QRect)
updateGeometry
updateMicroFocus
updatesEnabled
visibleRegion
whatsThis
wheelEvent
widget
width
widthMM
winId
window
windowFilePath
windowFlags
windowHandle
windowIcon
windowIconText
windowModality
windowOpacity
windowRole
windowState
windowTitle
windowType
x
y

Attributes

AllDockWidgetFeatures
DockWidgetClosable
DockWidgetFloatable
DockWidgetMovable
DockWidgetVerticalTitleBar
DrawChildren
DrawWindowBackground
IgnoreMask
NoDockWidgetFeatures
PdmDepth
PdmDevicePixelRatio
PdmDevicePixelRatioScaled
PdmDpiX
PdmDpiY
PdmHeight
PdmHeightMM
PdmNumColors
PdmPhysicalDpiX
PdmPhysicalDpiY
PdmWidth
PdmWidthMM
closed	Emitted when dock widget is closed.
closedStateChanged	Emitted when dock widget is closed (or opened).
customContextMenuRequested	customContextMenuRequested(self, QPoint) [signal]
destroyed	destroyed(self, QObject = None) [signal]
featuresChanged	featuresChanged(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) [signal]
objectNameChanged	objectNameChanged(self, str) [signal]
opened	Emitted when dock widget is opened.
openedStateChanged	Emitted when dock widget is opened (or closed).
staticMetaObject
topLevelChanged	topLevelChanged(self, bool) [signal]
visibilityChanged	visibilityChanged(self, bool) [signal]
windowIconChanged	windowIconChanged(self, QIcon) [signal]
windowIconTextChanged	windowIconTextChanged(self, str) [signal]
windowTitleChanged	windowTitleChanged(self, str) [signal]

actionEvent()

addUserInputWidget(self, widget: QWidget)

Add a widget to be displayed in the dock.

Parameters:widget – widget to add. Ownership is not transferred.

changeEvent()

childEvent()

closeEvent()

connectNotify()

contextMenuEvent()

create()

customEvent()

destroy()

disconnectNotify()

dragEnterEvent()

dragLeaveEvent()

dragMoveEvent()

dropEvent()

enterEvent()

event()

focusInEvent()

focusNextChild()

focusNextPrevChild()

focusOutEvent()

focusPreviousChild()

hideEvent()

initPainter()

initStyleOption()

inputMethodEvent()

isSignalConnected()

keyPressEvent()

keyReleaseEvent()

leaveEvent()

metric()

mouseDoubleClickEvent()

mouseMoveEvent()

mousePressEvent()

mouseReleaseEvent()

moveEvent()

nativeEvent()

paintEvent(self, event: QPaintEvent)

receivers()

resizeEvent()

sender()

senderSignalIndex()

sharedPainter()

showEvent()

tabletEvent()

timerEvent()

updateMicroFocus()

wheelEvent()