Class: QgsOptionsDialogHighlightWidget¶

class qgis.gui.QgsOptionsDialogHighlightWidget(widget: QWidget = None)¶

Bases: PyQt5.QtCore.QObject

Constructor

Parameters: widget – the widget used to search text into

Container for a widget to be used to search text in the option dialog If the widget type is handled, it is valid. It can perform a text search in the widget and highlight it in case of success. This uses stylesheets.

New in version 3.0: Enums

Methods

`childEvent`
`connectNotify`
`createWidget`	create a highlight widget implementation for the proper widget type.
`customEvent`
`disconnectNotify`
`eventFilter`
`highlightText`	Highlight the `text` in the widget.
`isSignalConnected`
`isValid`	Returns if it valid: if the widget type is handled and if the widget is not still available
`receivers`
`reset`	reset the style of the widgets to its original state
`searchHighlight`	search for a text pattern and highlight the widget if the text is found
`searchText`	Search for the `text` in the widget and return `True` if it was found
`sender`
`senderSignalIndex`
`timerEvent`
`widget`	Returns the widget

Signals

Attributes

childEvent()¶

connectNotify()¶

createWidget(widget: QWidget) → QgsOptionsDialogHighlightWidget¶

create a highlight widget implementation for the proper widget type. For instance a QgsOptionsDialogHighlightButton for button.

Returns: a QgsOptionsDialogHighlightWidget or None if there is no implementation for the given widget.

customEvent()¶

disconnectNotify()¶

eventFilter(self, obj: QObject, event: QEvent) → bool¶

highlightText(self, text: str) → bool¶

Highlight the text in the widget.

Returns: True if the text could be highlighted.

isSignalConnected()¶

isValid(self) → bool¶: Returns if it valid: if the widget type is handled and if the widget is not still available

receivers()¶

reset(self)¶: reset the style of the widgets to its original state

searchHighlight(self, text: str) → bool¶

search for a text pattern and highlight the widget if the text is found

Returns: True if the text pattern is found

searchText(self, text: str) → bool¶: Search for the text in the widget and return True if it was found

sender()¶

senderSignalIndex()¶

timerEvent()¶

widget(self) → QWidget¶: Returns the widget