QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Container for a widget to be used to search text in the option dialog If the widget type is handled, it is valid. More...
#include <qgsoptionsdialoghighlightwidget.h>
Public Member Functions | |
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... | |
Static Public Member Functions | |
static QgsOptionsDialogHighlightWidget * | createWidget (QWidget *widget) |
create a highlight widget implementation for the proper widget type. More... | |
Protected Member Functions | |
QgsOptionsDialogHighlightWidget (QWidget *widget=nullptr) | |
Constructor. More... | |
virtual bool | highlightText (const QString &text)=0 |
Highlight the text in the widget. More... | |
virtual void | reset ()=0 |
reset the style of the widgets to its original state More... | |
virtual bool | searchText (const QString &text)=0 |
Search for the text in the widget and return true if it was found. More... | |
Protected Attributes | |
QPointer< QWidget > | mWidget |
Pointer to the widget. More... | |
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.
Definition at line 35 of file qgsoptionsdialoghighlightwidget.h.
|
explicitprotected |
Constructor.
widget | the widget used to search text into |
Definition at line 33 of file qgsoptionsdialoghighlightwidget.cpp.
|
static |
create a highlight widget implementation for the proper widget type.
For instance a QgsOptionsDialogHighlightButton for button.
nullptr
if there is no implementation for the given widget. Definition at line 38 of file qgsoptionsdialoghighlightwidget.cpp.
|
override |
Definition at line 120 of file qgsoptionsdialoghighlightwidget.cpp.
|
protectedpure virtual |
Highlight the text in the widget.
true
if the text could be highlighted. Implemented in QgsOptionsDialogHighlightTree, QgsOptionsDialogHighlightGroupBox, QgsOptionsDialogHighlightButton, QgsOptionsDialogHighlightCheckBox, and QgsOptionsDialogHighlightLabel.
|
inline |
Returns if it valid: if the widget type is handled and if the widget is not still available.
Definition at line 52 of file qgsoptionsdialoghighlightwidget.h.
|
protectedpure virtual |
reset the style of the widgets to its original state
Implemented in QgsOptionsDialogHighlightTree, QgsOptionsDialogHighlightGroupBox, QgsOptionsDialogHighlightButton, QgsOptionsDialogHighlightCheckBox, and QgsOptionsDialogHighlightLabel.
bool QgsOptionsDialogHighlightWidget::searchHighlight | ( | const QString & | text | ) |
search for a text pattern and highlight the widget if the text is found
true
if the text pattern is found Definition at line 78 of file qgsoptionsdialoghighlightwidget.cpp.
|
protectedpure virtual |
Search for the text in the widget and return true
if it was found.
Implemented in QgsOptionsDialogHighlightTree, QgsOptionsDialogHighlightGroupBox, QgsOptionsDialogHighlightButton, QgsOptionsDialogHighlightCheckBox, and QgsOptionsDialogHighlightLabel.
|
inline |
Returns the widget.
Definition at line 63 of file qgsoptionsdialoghighlightwidget.h.
|
protected |
Pointer to the widget.
Definition at line 94 of file qgsoptionsdialoghighlightwidget.h.