Class: QgsPanelWidget¶
- class qgis.gui.QgsPanelWidget¶
Bases:
PyQt5.QtWidgets.QWidget
Base class for any widget that can be shown as a inline panel
QgsPanelWidget(parent: QWidget = None) Base class for any widget that can be shown as a inline panel
- Parameters:
parent –
Parent widget.
Methods
Accept the panel.
Returns
True
if the size constraints and hints for the panel widget should be applied to the parentQgsPanelWidgetStack
which this panel is shown in.The the auto delete property on the widget.
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
Returns the dock mode state.
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
Overridden key press event to handle the esc event on the widget.
Returns the menu to use for the menu button for this panel, or
None
if no menu button is required.Returns the (translated) tooltip text to use for the menu button for this panel.
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.The title of the panel.
The the auto delete property on the widget.
Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
Set the title of the panel when shown in the interface.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_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(self, QActionEvent)¶
- applySizeConstraintsToStack(self) bool ¶
Returns
True
if the size constraints and hints for the panel widget should be applied to the parentQgsPanelWidgetStack
which this panel is shown in.The default behavior is to return
False
.New in version 3.20.
- Return type:
bool
- 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.- Return type:
bool
- Returns:
The auto delete value for the widget.
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- 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 (QgsPanelWidget) – The panel to connect.
- connectChildPanels(self, panels: Iterable[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:
panels (Iterable[QgsPanelWidget]) – A list of panel widgets to connect.
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dockMode(self) bool ¶
Returns the dock mode state.
- Return type:
bool
- Returns:
True
if in dock mode. If in dock mode the widget will emit the showPanel signal to handle panel opening IfFalse
it will open dialogs when openPanel is called.
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- findParentPanel(widget: QWidget) QgsPanelWidget ¶
Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.
- Parameters:
widget (QWidget) – widget which may be contained within a panel widget
- Return type:
- Returns:
parent panel widget if found, otherwise
None
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, event: QKeyEvent)¶
Overridden key press event to handle the esc event on the widget.
- Parameters:
event (QKeyEvent) – The key event
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
Returns the menu to use for the menu button for this panel, or
None
if no menu button is required.New in version 3.12.
- Return type:
QMenu
Returns the (translated) tooltip text to use for the menu button for this panel.
This is only used when the panel returns a
menuButtonMenu()
.New in version 3.12.
- Return type:
str
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- 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 (QgsPanelWidget) – The panel widget to open.
- paintEvent(self, QPaintEvent)¶
- panelAccepted¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- panelTitle(self) str ¶
The title of the panel.
- Return type:
str
- Returns:
The title pf the panel.
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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 (bool) – 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 (bool) –
True
to enable dock mode.
- setPanelTitle(self, panelTitle: str)¶
Set the title of the panel when shown in the interface.
- Parameters:
panelTitle (str) – The panel title.
- showEvent(self, QShowEvent)¶
- showPanel¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶
- widgetChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL