Class: QgsOptionsDialogHighlightWidget

class qgis.gui.QgsOptionsDialogHighlightWidget

Bases: sip.wrapper

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.

QgsOptionsDialogHighlightWidget(widget: QWidget = None) Constructor

Parameters:

widget – the widget used to search text into

QgsOptionsDialogHighlightWidget(QgsOptionsDialogHighlightWidget)

Methods

createWidget

create a highlight widget implementation for the proper widget type.

highlightText

Highlight the text in the widget.

isValid

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

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

widget

Returns the widget

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) –

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) –

isValid(self) bool

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

Return type:

bool

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

widget(self) QWidget

Returns the widget

Return type:

QWidget