QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsOptionsDialogHighlightLabel Class Reference

A highlight widget for labels. More...

#include <qgsoptionsdialoghighlightwidgetsimpl.h>

Inheritance diagram for QgsOptionsDialogHighlightLabel:
Inheritance graph
[legend]

Public Member Functions

 QgsOptionsDialogHighlightLabel (QLabel *label)
 constructs a highlight widget for a label 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< QLabel > mLabel
 
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 labels.

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

Since
QGIS 3.0

Definition at line 43 of file qgsoptionsdialoghighlightwidgetsimpl.h.

Constructor & Destructor Documentation

◆ QgsOptionsDialogHighlightLabel()

QgsOptionsDialogHighlightLabel::QgsOptionsDialogHighlightLabel ( QLabel *  label)

constructs a highlight widget for a label

Definition at line 43 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Function Documentation

◆ highlightText()

bool QgsOptionsDialogHighlightLabel::highlightText ( const QString &  text)
overrideprotectedvirtual

Highlight the text in the widget.

Returns
true if the text could be highlighted.

Implements QgsOptionsDialogHighlightWidget.

Definition at line 62 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

◆ reset()

void QgsOptionsDialogHighlightLabel::reset ( )
overrideprotectedvirtual

reset the style of the widgets to its original state

Implements QgsOptionsDialogHighlightWidget.

Definition at line 71 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

◆ searchText()

bool QgsOptionsDialogHighlightLabel::searchText ( const QString &  text)
overrideprotectedvirtual

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

Implements QgsOptionsDialogHighlightWidget.

Definition at line 54 of file qgsoptionsdialoghighlightwidgetsimpl.cpp.

Member Data Documentation

◆ mLabel

QPointer<QLabel> QgsOptionsDialogHighlightLabel::mLabel
protected

Definition at line 53 of file qgsoptionsdialoghighlightwidgetsimpl.h.

◆ mStyleSheet

QString QgsOptionsDialogHighlightLabel::mStyleSheet
protected

Definition at line 54 of file qgsoptionsdialoghighlightwidgetsimpl.h.


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