Subgroup: Panel

Class: QgsPanelWidget

class qgis.gui.QgsPanelWidget

Bases: PyQt5.QtWidgets.QWidget

Base class for any widget that can be shown as a inline panel

Methods

acceptDrops
acceptPanel	Accept the panel.
accessibleDescription
accessibleName
actionEvent
actions
activateWindow
addAction
addActions
adjustSize
autoDelete	The the auto delete property on the widget.
autoFillBackground
backgroundRole
baseSize
blockSignals
changeEvent
childAt	childAt(self, int, int) -> QWidget
childEvent
children
childrenRect
childrenRegion
clearFocus
clearMask
close
closeEvent
colorCount
connectChildPanel	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
connectChildPanels	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
connectNotify
contentsMargins
contentsRect
contextMenuEvent
contextMenuPolicy
create
createWindowContainer
cursor
customEvent
deleteLater
depth
destroy
devType
devicePixelRatio
devicePixelRatioF
devicePixelRatioFScale
disconnect
disconnectNotify
dockMode	Return the dock mode state.
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
effectiveWinId
ensurePolished
enterEvent
event
eventFilter
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]
findParentPanel	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
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
inputMethodEvent
inputMethodHints
inputMethodQuery
insertAction
insertActions
installEventFilter
isActiveWindow
isAncestorOf
isEnabled
isEnabledTo
isFullScreen
isHidden
isLeftToRight
isMaximized
isMinimized
isModal
isRightToLeft
isSignalConnected
isVisible
isVisibleTo
isWidgetType
isWindow
isWindowModified
isWindowType
keyPressEvent	Overridden key press event to handle the esc event on the widget.
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
openPanel	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
overrideWindowFlags
overrideWindowState
paintEngine
paintEvent
paintingActive
palette
panelTitle	The title of the panel.
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
setAttribute
setAutoDelete	The the auto delete property on the widget.
setAutoFillBackground
setBackgroundRole
setBaseSize	setBaseSize(self, QSize)
setContentsMargins	setContentsMargins(self, QMargins)
setContextMenuPolicy
setCursor
setDisabled
setDockMode	Set the widget in dock mode which tells the widget to emit panel
setEnabled
setFixedHeight
setFixedSize	setFixedSize(self, int, int)
setFixedWidth
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
setPanelTitle	Set the title of the panel when shown in the interface.
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
setToolTip
setToolTipDuration
setUpdatesEnabled
setVisible
setWhatsThis
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
toolTip
toolTipDuration
tr
underMouse
ungrabGesture
unsetCursor
unsetLayoutDirection
unsetLocale
update	update(self, QRect)
updateGeometry
updateMicroFocus
updatesEnabled
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
customContextMenuRequested	customContextMenuRequested(self, QPoint) [signal]
destroyed	destroyed(self, QObject = None) [signal]
objectNameChanged	objectNameChanged(self, str) [signal]
panelAccepted	Emitted when the panel is accepted by the user.
showPanel	Emit when you require a panel to be show in the interface.
staticMetaObject
widgetChanged	Emitted when the widget state changes.
windowIconChanged	windowIconChanged(self, QIcon) [signal]
windowIconTextChanged	windowIconTextChanged(self, str) [signal]
windowTitleChanged	windowTitleChanged(self, str) [signal]

acceptPanel(self)

Accept the panel. Causes panelAccepted to be emitted. Widgets are normally removed form the interface using the panel manager or the caller.

actionEvent()

autoDelete(self) → bool

The the auto delete property on the widget. True by default. When auto delete is enabled when a panel is removed from the stack it will be deleted.

Returns:The auto delete value for the widget.

changeEvent()

childEvent()

closeEvent()

connectChildPanel(self, panel: QgsPanelWidget)

Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

Use this method if you have children widgets that need to show a panel to the user.

Parameters:panel – The panel to connect.

connectChildPanels(self, panels: object)

Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

Use this method if you have children widgets that need to show a panel to the user.

Parameters:panels – A list of panel widgets to connect.

connectNotify()

contextMenuEvent()

create()

customEvent()

destroy()

disconnectNotify()

dockMode(self) → bool

Return the dock mode state.

Returns:True if in dock mode. If in dock mode the widget

will emit the showPanel signal to handle panel opening If false it will open dialogs when openPanel is called.

dragEnterEvent()

dragLeaveEvent()

dragMoveEvent()

dropEvent()

enterEvent()

event()

findParentPanel(widget: QWidget) → QgsPanelWidget

Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Parameters:widget – widget which may be contained within a panel widget Returns:parent panel widget if found, otherwise None

New in version 3.0.

focusInEvent()

focusNextChild()

focusNextPrevChild()

focusOutEvent()

focusPreviousChild()

hideEvent()

initPainter()

inputMethodEvent()

isSignalConnected()

keyPressEvent(self, event: QKeyEvent)

Overridden key press event to handle the esc event on the widget.

Parameters:event – The key event

keyReleaseEvent()

leaveEvent()

metric()

mouseDoubleClickEvent()

mouseMoveEvent()

mousePressEvent()

mouseReleaseEvent()

moveEvent()

nativeEvent()

openPanel(self, panel: QgsPanelWidget)

Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.

If dock mode is false this method will open a dialog and block the user.

Parameters:panel – The panel widget to open.

paintEvent()

panelAccepted

Emitted when the panel is accepted by the user.

Parameters:panel – The panel widget that was accepted.

Note

This argument is normally raised with emit panelAccepted(this) so that callers can retrieve the widget easier in calling code.

Note

this is emitted only when this panel is accepted, and is not emitted for child panels. For example, if this panel opens a second stacked panel, then this panel will not emit panelAccepted when the second panel is accepted. [signal]

panelTitle(self) → str

The title of the panel.

Returns:The title pf the panel.

receivers()

resizeEvent()

sender()

senderSignalIndex()

setAutoDelete(self, autoDelete: bool)

The the auto delete property on the widget. True by default. When auto delete is enabled when a panel is removed from the stack it will be deleted.

Parameters:autoDelete – Enable or disable auto delete on the panel.

setDockMode(self, dockMode: bool)

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs

Parameters:dockMode – True to enable dock mode.

setPanelTitle(self, panelTitle: str)

Set the title of the panel when shown in the interface.

Parameters:panelTitle – The panel title.

sharedPainter()

showEvent()

showPanel

Emit when you require a panel to be show in the interface.

Parameters:panel – The panel widget to show.

Note

If you are connected to this signal you should also connect given panels showPanel signal as they can be nested. [signal]

tabletEvent()

timerEvent()

updateMicroFocus()

wheelEvent()

widgetChanged

Emitted when the widget state changes. Connect to this to pull any changes off the widget when needed. As panels are non blocking “dialogs” you should listen to this signal to give the user feedback when something changes. [signal]