Class: QgsOptionsPageWidget

class qgis.gui.QgsOptionsPageWidget

Bases: PyQt5.QtWidgets.QWidget

Base class for widgets for pages included in the options dialog.

New in version 3.0.

QgsOptionsPageWidget(parent: QWidget = None) Constructor for QgsOptionsPageWidget.

Methods

actionEvent
apply	Called to permanently apply the settings shown in the options page (e.g. save them to QgsSettings objects).
cancel	Called to cancel settings changed in the options page (e.g. save them to QgsSettings objects).
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
helpKey	Returns the optional help key for the options page.
hideEvent
initPainter
inputMethodEvent
isSignalConnected
isValid	Validates the current state of the widget.
keyPressEvent
keyReleaseEvent
leaveEvent
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
receivers
registerHighlightWidget	Register a highlight widget to be used to search and highlight text in options dialogs.
resizeEvent
sender
senderSignalIndex
sharedPainter
showEvent
tabletEvent
timerEvent
updateMicroFocus
wheelEvent

actionEvent(self, QActionEvent)

apply(self)

Called to permanently apply the settings shown in the options page (e.g. save them to QgsSettings objects). This is usually called when the options dialog is accepted.

cancel(self)

Called to cancel settings changed in the options page (e.g. save them to QgsSettings objects). This is usually called when the options dialog is canceled.

changeEvent(self, QEvent)

childEvent(self, QChildEvent)

closeEvent(self, QCloseEvent)

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)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

enterEvent(self, QEvent)

event(self, QEvent) → bool

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPreviousChild(self) → bool

helpKey(self) → str

Returns the optional help key for the options page. The default implementation returns an empty string.

If a non-empty string is returned by this method, it will be used as the help key retrieved when the “help” button is clicked while this options page is active.

If an empty string is returned by this method the default QGIS options help will be retrieved.

Return type:

str

hideEvent(self, QHideEvent)

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

isSignalConnected(self, QMetaMethod) → bool

isValid(self) → bool

Validates the current state of the widget.

Subclasses should return True if the widget state is currently valid and acceptable to apply().

The default implementation returns True.

New in version 3.24.

Return type:

bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

leaveEvent(self, QEvent)

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]

paintEvent(self, QPaintEvent)

receivers(self, PYQT_SIGNAL) → int

registerHighlightWidget(self, highlightWidget: QgsOptionsDialogHighlightWidget)

Register a highlight widget to be used to search and highlight text in options dialogs. This can be used to provide a custom implementation of QgsOptionsDialogHighlightWidget.

Parameters:

highlightWidget (QgsOptionsDialogHighlightWidget) –

resizeEvent(self, QResizeEvent)

sender(self) → QObject

senderSignalIndex(self) → int

sharedPainter(self) → QPainter

showEvent(self, QShowEvent)

tabletEvent(self, QTabletEvent)

timerEvent(self, QTimerEvent)

updateMicroFocus(self)

wheelEvent(self, QWheelEvent)