Subgroup: Search

Class: QgsSearchHighlightOptionWidget

class qgis.gui.QgsSearchHighlightOptionWidget

Bases: PyQt5.QtCore.QObject

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: Methods

blockSignals
childEvent
children
connectNotify
customEvent
deleteLater
disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
event
eventFilter
findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
inherits
installEventFilter
isSignalConnected
isValid Returns if it valid: if the widget type is handled and if the widget is not still available
isWidgetType
isWindowType
killTimer
metaObject
moveToThread
objectName
parent
property
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
receivers
removeEventFilter
reset reset the style to the original state
searchHighlight search for a text pattern and highlight the widget if the text is found
sender
senderSignalIndex
setObjectName
setParent
setProperty
signalsBlocked
startTimer
thread
timerEvent
tr
widget return the widget

Attributes

destroyed destroyed(self, QObject = None) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
staticMetaObject
childEvent()
connectNotify()
customEvent()
disconnectNotify()
eventFilter(self, obj: QObject, event: QEvent) → bool
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 to the original state

searchHighlight(self, searchText: str) → bool

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

Returns:true if the text pattern is found
sender()
senderSignalIndex()
timerEvent()
widget(self) → QWidget

return the widget