QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
Main Page
Related Pages
Modules
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
w
z
Functions
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
w
z
Variables
Typedefs
Enumerations
Enumerator
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Functions
2
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Variables
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Typedefs
a
c
e
f
g
h
k
l
m
o
p
r
s
t
u
v
w
Enumerations
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Properties
a
b
c
d
e
f
g
h
i
l
m
n
o
p
r
s
t
u
v
w
x
y
z
Related Functions
3
a
c
d
e
f
g
i
l
m
n
o
p
q
r
s
t
v
Files
File List
File Members
All
3
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
y
z
Functions
_
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
q
r
s
t
u
v
w
z
Variables
a
b
c
d
e
f
g
h
i
l
n
o
p
q
r
s
t
u
w
Typedefs
3
a
c
d
e
f
g
h
i
l
m
n
o
p
q
r
s
t
u
v
w
Enumerations
Enumerator
c
l
s
t
Macros
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
w
y
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Modules
Pages
src
core
geocoding
qgsabstractgeocoderlocatorfilter.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsabstractgeocoderlocatorfilter.h
3
---------------
4
Date : August 2020
5
Copyright : (C) 2020 by Nyall Dawson
6
Email : nyall dot dawson at gmail dot 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 QGSABSTRACTGEOCODERLOCATORFILTER_H
17
#define QGSABSTRACTGEOCODERLOCATORFILTER_H
18
19
#include "qgis_core.h"
20
#include "
qgslocatorfilter.h
"
21
22
class
QgsGeocoderInterface
;
23
class
QgsGeocoderResult
;
24
39
class
CORE_EXPORT
QgsAbstractGeocoderLocatorFilter
:
public
QgsLocatorFilter
SIP_ABSTRACT
40
{
41
Q_OBJECT
42
43
public
:
44
61
QgsAbstractGeocoderLocatorFilter
(
const
QString &name,
const
QString &displayName,
62
const
QString &prefix,
63
QgsGeocoderInterface
*geocoder );
64
65
QString
name
()
const override
;
66
QString
displayName
()
const override
;
67
QString
prefix
()
const override
;
68
void
fetchResults
(
const
QString &
string
,
const
QgsLocatorContext
&context,
QgsFeedback
*feedback )
override
;
69
void
triggerResult
(
const
QgsLocatorResult
&result )
override
;
70
74
QgsGeocoderInterface
*geocoder()
const
;
75
81
QgsGeocoderResult
locatorResultToGeocoderResult(
const
QgsLocatorResult
&result )
const
;
82
88
QgsLocatorResult
geocoderResultToLocatorResult(
const
QgsGeocoderResult
&result );
89
90
private
:
91
95
virtual
void
handleGeocodeResult(
const
QgsGeocoderResult
&result ) = 0;
96
97
QString mName;
98
QString mDisplayName;
99
QString mPrefix;
100
QgsGeocoderInterface
*mGeocoder =
nullptr
;
101
102
};
103
104
#endif
// QGSABSTRACTGEOCODERLOCATORFILTER_H
QgsAbstractGeocoderLocatorFilter
An abstract base class which implements a locator filter populated from a QgsGeocoderInterface.
Definition:
qgsabstractgeocoderlocatorfilter.h:40
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition:
qgsfeedback.h:45
QgsGeocoderInterface
Interface for geocoders.
Definition:
qgsgeocoder.h:37
QgsGeocoderResult
Represents a matching result from a geocoder search.
Definition:
qgsgeocoderresult.h:41
QgsLocatorContext
Encapsulates the properties relating to the context of a locator search.
Definition:
qgslocatorcontext.h:33
QgsLocatorFilter
Abstract base class for filters which collect locator results.
Definition:
qgslocatorfilter.h:154
QgsLocatorFilter::prefix
virtual QString prefix() const
Returns the search prefix character(s) for this filter.
Definition:
qgslocatorfilter.h:223
QgsLocatorFilter::displayName
virtual QString displayName() const =0
Returns a translated, user-friendly name for the filter.
QgsLocatorFilter::name
virtual QString name() const =0
Returns the unique name for the filter.
QgsLocatorFilter::triggerResult
virtual void triggerResult(const QgsLocatorResult &result)=0
Triggers a filter result from this filter.
QgsLocatorFilter::fetchResults
virtual void fetchResults(const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback)=0
Retrieves the filter results for a specified search string.
QgsLocatorResult
Encapsulates properties of an individual matching result found by a QgsLocatorFilter.
Definition:
qgslocatorfilter.h:40
SIP_ABSTRACT
#define SIP_ABSTRACT
Definition:
qgis_sip.h:199
qgslocatorfilter.h
Generated on Sun Mar 21 2021 09:16:51 for QGIS API Documentation by
1.9.1