QGIS API Documentation  3.17.0-Master (a84647cf30)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsOptionsDialogHighlightButton Class Reference

A highlight widget for buttons. More...

#include <qgsoptionsdialoghighlightwidgetsimpl.h>

Inheritance diagram for QgsOptionsDialogHighlightButton:
Inheritance graph
[legend]

Public Member Functions

 QgsOptionsDialogHighlightButton (QAbstractButton *button)
 constructs a highlight widget for a button. More...
 
- Public Member Functions inherited from QgsOptionsDialogHighlightWidget
bool eventFilter (QObject *obj, QEvent *event) override
 
bool isValid ()
 Returns if it valid: if the widget type is handled and if the widget is not still available. More...
 
bool searchHighlight (const QString &text)
 search for a text pattern and highlight the widget if the text is found More...
 
QWidget * widget ()
 Returns the widget. More...
 

Protected Member Functions

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

Protected Attributes

QPointer< QAbstractButton > mButton
 
QString mStyleSheet
 
- Protected Attributes inherited from QgsOptionsDialogHighlightWidget
QPointer< QWidget > mWidget
 Pointer to the widget. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsOptionsDialogHighlightWidget
static QgsOptionsDialogHighlightWidgetcreateWidget (QWidget *widget)
 create a highlight widget implementation for the proper widget type. More...
 

Detailed Description

A highlight widget for buttons.

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

Since
QGIS 3.0

Definition at line 85 of file qgsoptionsdialoghighlightwidgetsimpl.h.

Constructor & Destructor Documentation

◆ QgsOptionsDialogHighlightButton()

QgsOptionsDialogHighlightButton::QgsOptionsDialogHighlightButton ( QAbstractButton *  button)

constructs a highlight widget for a button.

Definition at line 123 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 144 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

◆ reset()

void QgsOptionsDialogHighlightButton::reset ( )
overrideprotectedvirtual

reset the style of the widgets to its original state

Implements QgsOptionsDialogHighlightWidget.

Definition at line 153 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 135 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Data Documentation

◆ mButton

QPointer<QAbstractButton> QgsOptionsDialogHighlightButton::mButton
protected

Definition at line 95 of file qgsoptionsdialoghighlightwidgetsimpl.h.

◆ mStyleSheet

QString QgsOptionsDialogHighlightButton::mStyleSheet
protected

Definition at line 96 of file qgsoptionsdialoghighlightwidgetsimpl.h.


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