QgsOptionsDialogHighlightButton Class Reference

A highlight widget for buttons. More...

#include <qgsoptionsdialoghighlightwidgetsimpl.h>

Inheritance diagram for QgsOptionsDialogHighlightButton:

Public Member Functions
	QgsOptionsDialogHighlightButton (QAbstractButton *button)
	constructs a highlight widget for a button.
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< QAbstractButton >	mButton
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 buttons.

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

Definition at line 81 of file qgsoptionsdialoghighlightwidgetsimpl.h.

Constructor & Destructor Documentation

QgsOptionsDialogHighlightButton()

QgsOptionsDialogHighlightButton::QgsOptionsDialogHighlightButton

(

QAbstractButton *

button

)

constructs a highlight widget for a button.

Definition at line 124 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Function Documentation

highlightText()

bool QgsOptionsDialogHighlightButton::highlightText ( const QString &  text )

overrideprotectedvirtual

Highlight the text in the widget.

Returns

true if the text could be highlighted.

Implements QgsOptionsDialogHighlightWidget.

Definition at line 145 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

reset()

void QgsOptionsDialogHighlightButton::reset ( )

overrideprotectedvirtual

reset the style of the widgets to its original state

Implements QgsOptionsDialogHighlightWidget.

Definition at line 154 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

searchText()

bool QgsOptionsDialogHighlightButton::searchText ( const QString &  text )

overrideprotectedvirtual

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

Implements QgsOptionsDialogHighlightWidget.

Definition at line 136 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Data Documentation

mButton

QPointer<QAbstractButton> QgsOptionsDialogHighlightButton::mButton

protected

Definition at line 90 of file qgsoptionsdialoghighlightwidgetsimpl.h.

mStyleSheet

QString QgsOptionsDialogHighlightButton::mStyleSheet

protected

Definition at line 91 of file qgsoptionsdialoghighlightwidgetsimpl.h.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsoptionsdialoghighlightwidgetsimpl.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/qgsoptionsdialoghighlightwidgetsimpl.cpp