QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
qgsoptionsdialoghighlightwidget.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsoptionsdialoghighlightwidget.h
3
-------------------------------
4
Date : February 2018
5
Copyright : (C) 2018 Denis Rouzaud
6
Email : denis.rouzaud@gmail.com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H
17
#define QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H
18
19
#include "qgis_gui.h"
20
#include "
qgis_sip.h
"
21
22
#include <QObject>
23
#include <QPointer>
24
#include <QWidget>
25
26
class
QgsOptionsDialogHighlightWidget
;
27
28
#ifndef SIP_RUN
29
31
38
class
QgsOptionsDialogHighlightWidgetEventFilter :
public
QObject
39
{
40
Q_OBJECT
41
public
:
43
QgsOptionsDialogHighlightWidgetEventFilter( QgsOptionsDialogHighlightWidget *highlightWidget );
44
bool
eventFilter( QObject *obj, QEvent *event )
override
;
45
46
private
:
47
QgsOptionsDialogHighlightWidget *mHighlightWidget;
48
};
49
51
52
#endif
53
64
class
GUI_EXPORT
QgsOptionsDialogHighlightWidget
65
{
66
public
:
73
static
QgsOptionsDialogHighlightWidget
*
createWidget
( QWidget *
widget
)
SIP_FACTORY
;
74
75
virtual
~QgsOptionsDialogHighlightWidget
() =
default
;
76
80
bool
isValid
() {
return
!
mWidget
.isNull(); }
81
86
bool
searchHighlight(
const
QString &text );
87
91
QWidget *
widget
() {
return
mWidget
; }
92
93
protected
:
97
virtual
bool
searchText
(
const
QString &text ) = 0;
98
103
virtual
bool
highlightText
(
const
QString &text ) = 0;
104
108
virtual
void
reset
() = 0;
109
114
explicit
QgsOptionsDialogHighlightWidget
( QWidget *
widget
=
nullptr
);
115
117
QPointer<QWidget>
mWidget
;
118
119
private
:
120
friend
class
QgsOptionsDialogHighlightWidgetEventFilter
;
121
122
QString mSearchText = QString();
123
bool
mChangedStyle =
false
;
124
QgsOptionsDialogHighlightWidgetEventFilter
*mEventFilter =
nullptr
;
125
};
126
127
#endif
// QGSOPTIONSDIALOGHIGHLIGHTWIDGET_H
QgsOptionsDialogHighlightWidget
Container for a widget to be used to search text in the option dialog.
Definition
qgsoptionsdialoghighlightwidget.h:65
QgsOptionsDialogHighlightWidget::QgsOptionsDialogHighlightWidgetEventFilter
friend class QgsOptionsDialogHighlightWidgetEventFilter
Definition
qgsoptionsdialoghighlightwidget.h:120
QgsOptionsDialogHighlightWidget::~QgsOptionsDialogHighlightWidget
virtual ~QgsOptionsDialogHighlightWidget()=default
QgsOptionsDialogHighlightWidget::reset
virtual void reset()=0
reset the style of the widgets to its original state
QgsOptionsDialogHighlightWidget::mWidget
QPointer< QWidget > mWidget
Pointer to the widget.
Definition
qgsoptionsdialoghighlightwidget.h:117
QgsOptionsDialogHighlightWidget::searchText
virtual bool searchText(const QString &text)=0
Search for the text in the widget and return true if it was found.
QgsOptionsDialogHighlightWidget::highlightText
virtual bool highlightText(const QString &text)=0
Highlight the text in the widget.
QgsOptionsDialogHighlightWidget::createWidget
static QgsOptionsDialogHighlightWidget * createWidget(QWidget *widget)
create a highlight widget implementation for the proper widget type.
Definition
qgsoptionsdialoghighlightwidget.cpp:38
QgsOptionsDialogHighlightWidget::widget
QWidget * widget()
Returns the widget.
Definition
qgsoptionsdialoghighlightwidget.h:91
QgsOptionsDialogHighlightWidget::isValid
bool isValid()
Returns if it valid: if the widget type is handled and if the widget is not still available.
Definition
qgsoptionsdialoghighlightwidget.h:80
QgsOptionsDialogHighlightWidget::QgsOptionsDialogHighlightWidget
QgsOptionsDialogHighlightWidget(QWidget *widget=nullptr)
Constructor.
Definition
qgsoptionsdialoghighlightwidget.cpp:34
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
Generated on
for QGIS API Documentation by
1.17.0