QgsOptionsDialogHighlightGroupBox Class Reference

A highlight widget for group boxes. More...

#include <qgsoptionsdialoghighlightwidgetsimpl.h>

Inheritance diagram for QgsOptionsDialogHighlightGroupBox:

Public Member Functions
	QgsOptionsDialogHighlightGroupBox (QGroupBox *groupBox)
	constructs a highlight widget for a group box.
Public Member Functions inherited from QgsOptionsDialogHighlightWidget
virtual	~QgsOptionsDialogHighlightWidget ()=default
bool	isValid ()
	Returns if it valid: if the widget type is handled and if the widget is not still available.
bool	searchHighlight (const QString &text)
	search for a text pattern and highlight the widget if the text is found
QWidget *	widget ()
	Returns the widget.

Protected Member Functions
bool	highlightText (const QString &text) override
	Highlight the text in the widget.
void	reset () override
	reset the style of the widgets to its original state
bool	searchText (const QString &text) override
	Search for the text in the widget and return true if it was found.
Protected Member Functions inherited from QgsOptionsDialogHighlightWidget
	QgsOptionsDialogHighlightWidget (QWidget *widget=nullptr)
	Constructor.

Protected Attributes
QPointer< QGroupBox >	mGroupBox
QString	mStyleSheet
Protected Attributes inherited from QgsOptionsDialogHighlightWidget
QPointer< QWidget >	mWidget
	Pointer to the widget.

Additional Inherited Members
Static Public Member Functions inherited from QgsOptionsDialogHighlightWidget
static QgsOptionsDialogHighlightWidget *	createWidget (QWidget *widget)
	create a highlight widget implementation for the proper widget type.

Detailed Description

A highlight widget for group boxes.

This is used to search and highlight text in QgsOptionsDialogBase implementations.

Since

QGIS 3.0

Definition at line 104 of file qgsoptionsdialoghighlightwidgetsimpl.h.

Constructor & Destructor Documentation

QgsOptionsDialogHighlightGroupBox()

QgsOptionsDialogHighlightGroupBox::QgsOptionsDialogHighlightGroupBox

(

QGroupBox *

groupBox

)

constructs a highlight widget for a group box.

Definition at line 165 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Function Documentation

highlightText()

bool QgsOptionsDialogHighlightGroupBox::highlightText ( const QString &  text )

overrideprotectedvirtual

Highlight the text in the widget.

Returns

true if the text could be highlighted.

Implements QgsOptionsDialogHighlightWidget.

Definition at line 185 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

reset()

void QgsOptionsDialogHighlightGroupBox::reset ( )

overrideprotectedvirtual

reset the style of the widgets to its original state

Implements QgsOptionsDialogHighlightWidget.

Definition at line 195 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

searchText()

bool QgsOptionsDialogHighlightGroupBox::searchText ( const QString &  text )

overrideprotectedvirtual

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

Implements QgsOptionsDialogHighlightWidget.

Definition at line 177 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Data Documentation

mGroupBox

QPointer<QGroupBox> QgsOptionsDialogHighlightGroupBox::mGroupBox

protected

Definition at line 113 of file qgsoptionsdialoghighlightwidgetsimpl.h.

mStyleSheet

QString QgsOptionsDialogHighlightGroupBox::mStyleSheet

protected

Definition at line 114 of file qgsoptionsdialoghighlightwidgetsimpl.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.34.0+99sid/src/gui/qgsoptionsdialoghighlightwidgetsimpl.h
• /build/qgis-3.34.0+99sid/src/gui/qgsoptionsdialoghighlightwidgetsimpl.cpp