Class: QgsOptionsDialogHighlightWidget

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

Bases: PyQt5.QtCore.QObject

Constructor

Parameters

widget (QWidget = None) – 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.

Methods

childEvent

connectNotify

createWidget

create a highlight widget implementation for the proper widget type.

customEvent

disconnectNotify

eventFilter

param obj

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

childEvent()
connectNotify()
createWidget(widget: QWidget) → QgsOptionsDialogHighlightWidget

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

Return type

QgsOptionsDialogHighlightWidget

Returns

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

Parameters

widget (QWidget) –

customEvent()
disconnectNotify()
eventFilter(self, obj: QObject, event: QEvent) → bool
Parameters
  • obj (QObject) –

  • event (QEvent) –

Return type

bool

highlightText(self, text: str) → bool

Highlight the text in the widget.

Return type

bool

Returns

True if the text could be highlighted.

Parameters

text (str) –

isSignalConnected()
isValid(self) → bool

Returns if it valid: if the widget type is handled and if the widget is not still available

Return type

bool

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

Return type

bool

Returns

True if the text pattern is found

Parameters

text (str) –

searchText(self, text: str) → bool

Search for the text in the widget and return True if it was found

Parameters

text (str) –

Return type

bool

sender()
senderSignalIndex()
timerEvent()
widget(self) → QWidget

Returns the widget

Return type

QWidget