#include <qdeclarativegeoserviceprovider_p.h>

Inheritance diagram for QDeclarativeGeoServiceProvider:

Collaboration diagram for QDeclarativeGeoServiceProvider:

Public Types
enum	RoutingFeature { NoRoutingFeatures = QGeoServiceProvider::NoRoutingFeatures , OnlineRoutingFeature = QGeoServiceProvider::OnlineRoutingFeature , OfflineRoutingFeature = QGeoServiceProvider::OfflineRoutingFeature , LocalizedRoutingFeature = QGeoServiceProvider::LocalizedRoutingFeature , RouteUpdatesFeature = QGeoServiceProvider::RouteUpdatesFeature , AlternativeRoutesFeature = QGeoServiceProvider::AlternativeRoutesFeature , ExcludeAreasRoutingFeature = QGeoServiceProvider::ExcludeAreasRoutingFeature , AnyRoutingFeatures = QGeoServiceProvider::AnyRoutingFeatures }

enum	GeocodingFeature { NoGeocodingFeatures = QGeoServiceProvider::NoGeocodingFeatures , OnlineGeocodingFeature = QGeoServiceProvider::OnlineGeocodingFeature , OfflineGeocodingFeature = QGeoServiceProvider::OfflineGeocodingFeature , ReverseGeocodingFeature = QGeoServiceProvider::ReverseGeocodingFeature , LocalizedGeocodingFeature = QGeoServiceProvider::LocalizedGeocodingFeature , AnyGeocodingFeatures = QGeoServiceProvider::AnyGeocodingFeatures }

enum	MappingFeature { NoMappingFeatures = QGeoServiceProvider::NoMappingFeatures , OnlineMappingFeature = QGeoServiceProvider::OnlineMappingFeature , OfflineMappingFeature = QGeoServiceProvider::OfflineMappingFeature , LocalizedMappingFeature = QGeoServiceProvider::LocalizedMappingFeature , AnyMappingFeatures = QGeoServiceProvider::AnyMappingFeatures }

enum	PlacesFeature { NoPlacesFeatures = QGeoServiceProvider::NoPlacesFeatures , OnlinePlacesFeature = QGeoServiceProvider::OnlinePlacesFeature , OfflinePlacesFeature = QGeoServiceProvider::OfflinePlacesFeature , SavePlaceFeature = QGeoServiceProvider::SavePlaceFeature , RemovePlaceFeature = QGeoServiceProvider::RemovePlaceFeature , SaveCategoryFeature = QGeoServiceProvider::SaveCategoryFeature , RemoveCategoryFeature = QGeoServiceProvider::RemoveCategoryFeature , PlaceRecommendationsFeature = QGeoServiceProvider::PlaceRecommendationsFeature , SearchSuggestionsFeature = QGeoServiceProvider::SearchSuggestionsFeature , LocalizedPlacesFeature = QGeoServiceProvider::LocalizedPlacesFeature , NotificationsFeature = QGeoServiceProvider::NotificationsFeature , PlaceMatchingFeature = QGeoServiceProvider::PlaceMatchingFeature , AnyPlacesFeatures = QGeoServiceProvider::AnyPlacesFeatures }

enum	NavigationFeature { NoNavigationFeatures = QGeoServiceProvider::NoNavigationFeatures , OnlineNavigationFeature = QGeoServiceProvider::OnlineNavigationFeature , OfflineNavigationFeature = QGeoServiceProvider::OfflineNavigationFeature , AnyNavigationFeatures = QGeoServiceProvider::AnyNavigationFeatures }

Signals
void	nameChanged (const QString &name)

void	localesChanged ()

void	attached ()

void	preferredChanged (const QStringList &preferences)

void	allowExperimentalChanged (bool allow)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QDeclarativeGeoServiceProvider (QObject *parent=nullptr)
	The Plugin type describes a Location based services plugin.

	~QDeclarativeGeoServiceProvider ()

void	classBegin () override
	Invoked after class creation, but before any properties have been set.

void	componentComplete () override

void	setName (const QString &name)
	\qmlproperty string Plugin::name

QString	name () const

QQmlListProperty< QDeclarativePluginParameter >	parameters ()

QVariantMap	parameterMap () const

QStringList	availableServiceProviders ()

QDeclarativeGeoServiceProviderRequirements *	requirements () const
	\qmlproperty enumeration Plugin::required

void	setRequirements (QDeclarativeGeoServiceProviderRequirements *req)

QStringList	preferred () const
	\qmlproperty stringlist Plugin::preferred

void	setPreferred (const QStringList &val)

QGeoServiceProvider *	sharedGeoServiceProvider () const

Q_INVOKABLE bool	supportsRouting (const RoutingFeatures &feature=AnyRoutingFeatures) const
	\qmlmethod bool Plugin::supportsRouting(RoutingFeatures features)

Q_INVOKABLE bool	supportsGeocoding (const GeocodingFeatures &feature=AnyGeocodingFeatures) const
	\qmlmethod bool Plugin::supportsGeocoding(GeocodingFeatures features)

Q_INVOKABLE bool	supportsMapping (const MappingFeatures &feature=AnyMappingFeatures) const
	\qmlmethod bool Plugin::supportsMapping(MappingFeatures features)

Q_INVOKABLE bool	supportsPlaces (const PlacesFeatures &feature=AnyPlacesFeatures) const
	\qmlmethod bool Plugin::supportsPlaces(PlacesFeatures features)

	Q_REVISION (11) Q_INVOKABLE bool supportsNavigation(const NavigationFeature &feature

QStringList	locales () const
	\qmlproperty stringlist Plugin::locales

void	setLocales (const QStringList &locales)

bool	isAttached () const
	\qmlproperty bool Plugin::isAttached

void	setAllowExperimental (bool allow)

bool	allowExperimental () const
	\qmlproperty bool Plugin::allowExperimental

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Properties
QString	name

QStringList	availableServiceProviders
	\qmlproperty stringlist Plugin::availableServiceProviders

QQmlListProperty< QDeclarativePluginParameter >	parameters
	\qmlproperty list<PluginParameter> Plugin::parameters \qmldefault

QDeclarativeGeoServiceProviderRequirements *	required

QStringList	locales

QStringList	preferred

bool	allowExperimental

bool	isAttached

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 43 of file qdeclarativegeoserviceprovider_p.h.

Member Enumeration Documentation

◆ GeocodingFeature

enum QDeclarativeGeoServiceProvider::GeocodingFeature

Enumerator
NoGeocodingFeatures
OnlineGeocodingFeature
OfflineGeocodingFeature
ReverseGeocodingFeature
LocalizedGeocodingFeature
AnyGeocodingFeatures

Definition at line 80 of file qdeclarativegeoserviceprovider_p.h.

◆ MappingFeature

enum QDeclarativeGeoServiceProvider::MappingFeature

Enumerator
NoMappingFeatures
OnlineMappingFeature
OfflineMappingFeature
LocalizedMappingFeature
AnyMappingFeatures

Definition at line 89 of file qdeclarativegeoserviceprovider_p.h.

◆ NavigationFeature

enum QDeclarativeGeoServiceProvider::NavigationFeature

Enumerator
NoNavigationFeatures
OnlineNavigationFeature
OfflineNavigationFeature
AnyNavigationFeatures

Definition at line 113 of file qdeclarativegeoserviceprovider_p.h.

◆ PlacesFeature

enum QDeclarativeGeoServiceProvider::PlacesFeature

Enumerator
NoPlacesFeatures
OnlinePlacesFeature
OfflinePlacesFeature
SavePlaceFeature
RemovePlaceFeature
SaveCategoryFeature
RemoveCategoryFeature
PlaceRecommendationsFeature
SearchSuggestionsFeature
LocalizedPlacesFeature
NotificationsFeature
PlaceMatchingFeature
AnyPlacesFeatures

Definition at line 97 of file qdeclarativegeoserviceprovider_p.h.

◆ RoutingFeature

enum QDeclarativeGeoServiceProvider::RoutingFeature

Enumerator
NoRoutingFeatures
OnlineRoutingFeature
OfflineRoutingFeature
LocalizedRoutingFeature
RouteUpdatesFeature
AlternativeRoutesFeature
ExcludeAreasRoutingFeature
AnyRoutingFeatures

Definition at line 69 of file qdeclarativegeoserviceprovider_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeGeoServiceProvider()

QT_BEGIN_NAMESPACE QDeclarativeGeoServiceProvider::QDeclarativeGeoServiceProvider ( QObject * parent = nullptr )

explicit

The Plugin type describes a Location based services plugin.

\qmltype Plugin

! \instantiates QDeclarativeGeoServiceProvider \inqmlmodule QtLocation

Since: QtLocation 5.5

The Plugin type is used to declaratively specify which available GeoServices plugin should be used for various tasks in the Location API. Plugins are used by \l Map, \l RouteModel, and \l GeocodeModel types, as well as a variety of others.

Plugins recognized by the system have a \l name property, a simple string normally indicating the name of the service that the Plugin retrieves data from. They also have a variety of features, which can be test for using the \l {supportsRouting()}, \l {supportsGeocoding()}, \l {supportsMapping()}, \l {supportsPlaces()} and \l {supportsNavigation()} methods.

When a Plugin object is created, it is "detached" and not associated with any actual service plugin. Once it has received information via setting its \l name, \l preferred, or \l required properties, it will choose an appropriate service plugin to attach to. Plugin objects can only be attached once; to use multiple plugins, create multiple Plugin objects.

Definition at line 53 of file qdeclarativegeoserviceprovider.cpp.

References name.

◆ ~QDeclarativeGeoServiceProvider()

QDeclarativeGeoServiceProvider::~QDeclarativeGeoServiceProvider ( )

Definition at line 59 of file qdeclarativegeoserviceprovider.cpp.

Member Function Documentation

◆ allowExperimental()

bool QDeclarativeGeoServiceProvider::allowExperimental ( ) const

\qmlproperty bool Plugin::allowExperimental

This property indicates if experimental plugins can be used.

Definition at line 484 of file qdeclarativegeoserviceprovider.cpp.

◆ allowExperimentalChanged

void QDeclarativeGeoServiceProvider::allowExperimentalChanged ( bool allow )

signal

Referenced by setAllowExperimental().

Here is the caller graph for this function:

◆ attached

void QDeclarativeGeoServiceProvider::attached ( )

signal

Referenced by QDeclarativeGeocodeModel::setPlugin(), QDeclarativeGeoRouteModel::setPlugin(), QDeclarativeCategory::setPlugin(), QDeclarativePlace::setPlugin(), QDeclarativeSupportedCategoriesModel::setPlugin(), and QDeclarativeGeoMap::setPlugin().

Here is the caller graph for this function:

◆ availableServiceProviders()

QStringList QDeclarativeGeoServiceProvider::availableServiceProviders ( )

◆ classBegin()

void QDeclarativeGeoServiceProvider::classBegin ( )

inlineoverridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 136 of file qdeclarativegeoserviceprovider_p.h.

◆ componentComplete()

void QDeclarativeGeoServiceProvider::componentComplete ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 139 of file qdeclarativegeoserviceprovider.cpp.

References QGeoServiceProvider::availableServiceProviders(), QObject::connect(), QDeclarativePluginParameter::initialized(), QString::isEmpty(), NoGeocodingFeatures, NoMappingFeatures, NoNavigationFeatures, NoPlacesFeatures, NoRoutingFeatures, parameterMap(), qmlWarning(), setName(), and sp.

Here is the call graph for this function:

◆ isAttached()

bool QDeclarativeGeoServiceProvider::isAttached ( ) const

\qmlproperty bool Plugin::isAttached

This property indicates if the Plugin item is attached to a geoservice provider plugin.

Definition at line 474 of file qdeclarativegeoserviceprovider.cpp.

◆ locales()

QStringList QDeclarativeGeoServiceProvider::locales ( ) const

\qmlproperty stringlist Plugin::locales

This property contains an ordered list of preferred plugin locales. If the first locale cannot be accommodated, then the backend falls back to using the second, and so on. By default the locales property contains the system locale.

The locales are specified as strings which have the format "language[_script][_country]" or "C", where:

\list

language is a lowercase, two-letter, ISO 639 language code,
script is a titlecase, four-letter, ISO 15924 script code,
country is an uppercase, two- or three-letter, ISO 3166 country code (also "419" as defined by United Nations),
the "C" locale is identical in behavior to English/UnitedStates as per QLocale \endlist

If the first specified locale cannot be accommodated, the \l {Plugin} falls back to the next and so forth. Some \l {Plugin} backends may not support a set of locales which are rigidly defined. An arbitrary example is that some \l {Place}'s in France could have French and English localizations, while certain areas in America may only have the English localization available. In the above scenario, the set of supported locales is context dependent on the search location.

If the \l {Plugin} cannot accommodate any of the preferred locales, the manager falls back to using a supported language that is backend specific.

For \l {Plugin}'s that do not support locales, the locales list is always empty.

The following code demonstrates how to set a single and multiple locales:

Definition at line 539 of file qdeclarativegeoserviceprovider.cpp.

◆ localesChanged

void QDeclarativeGeoServiceProvider::localesChanged ( )

signal

Referenced by setLocales(), and QDeclarativeGeoRouteModel::setPlugin().

Here is the caller graph for this function:

◆ name()

QString QDeclarativeGeoServiceProvider::name ( ) const

Definition at line 117 of file qdeclarativegeoserviceprovider.cpp.

◆ nameChanged

void QDeclarativeGeoServiceProvider::nameChanged ( const QString & name )

signal

Referenced by QDeclarativeSearchModelBase::initializePlugin(), and setName().

Here is the caller graph for this function:

◆ parameterMap()

QVariantMap QDeclarativeGeoServiceProvider::parameterMap ( ) const

Definition at line 617 of file qdeclarativegeoserviceprovider.cpp.

References QMap< Key, T >::insert(), map, QDeclarativePluginParameter::name, and QDeclarativePluginParameter::value.

Referenced by componentComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parameters()

QQmlListProperty< QDeclarativePluginParameter > QDeclarativeGeoServiceProvider::parameters ( )

◆ preferred()

QStringList QDeclarativeGeoServiceProvider::preferred ( ) const

\qmlproperty stringlist Plugin::preferred

This property contains an ordered list of preferred plugin names, which will be checked for the required features set in \l{Plugin::required}{required} before any other available plugins are checked.

Definition at line 458 of file qdeclarativegeoserviceprovider.cpp.

◆ preferredChanged

void QDeclarativeGeoServiceProvider::preferredChanged ( const QStringList & preferences )

signal

Referenced by setPreferred().

Here is the caller graph for this function:

◆ Q_REVISION()

QDeclarativeGeoServiceProvider::Q_REVISION ( 11 ) const &

◆ requirements()

QDeclarativeGeoServiceProviderRequirements * QDeclarativeGeoServiceProvider::requirements ( ) const

\qmlproperty enumeration Plugin::required

This property contains the set of features that will be required by the Plugin object when choosing which service plugin to attach to. If the \l name property is set, this has no effect.

Any of the following values or a bitwise combination of multiple values may be set:

\list

Plugin.NoFeatures
Plugin.GeocodingFeature
Plugin.ReverseGeocodingFeature
Plugin.RoutingFeature
Plugin.MappingFeature
Plugin.AnyPlacesFeature \endlist

Definition at line 434 of file qdeclarativegeoserviceprovider.cpp.

◆ setAllowExperimental()

void QDeclarativeGeoServiceProvider::setAllowExperimental ( bool allow )

Definition at line 489 of file qdeclarativegeoserviceprovider.cpp.

References allowExperimentalChanged(), and emit.

Here is the call graph for this function:

◆ setLocales()

void QDeclarativeGeoServiceProvider::setLocales ( const QStringList & locales )

Definition at line 544 of file qdeclarativegeoserviceprovider.cpp.

References emit, locales, localesChanged(), and name.

Here is the call graph for this function:

◆ setName()

void QDeclarativeGeoServiceProvider::setName ( const QString & name )

\qmlproperty string Plugin::name

This property holds the name of the plugin. Setting this property will cause the Plugin to only attach to a plugin with exactly this name. The value of \l required will be ignored.

Definition at line 72 of file qdeclarativegeoserviceprovider.cpp.

References emit, name, and nameChanged().

Referenced by componentComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPreferred()

void QDeclarativeGeoServiceProvider::setPreferred ( const QStringList & val )

Definition at line 463 of file qdeclarativegeoserviceprovider.cpp.

References emit, and preferredChanged().

Here is the call graph for this function:

◆ setRequirements()

void QDeclarativeGeoServiceProvider::setRequirements ( QDeclarativeGeoServiceProviderRequirements * req )

Definition at line 439 of file qdeclarativegeoserviceprovider.cpp.

References QJSEngine::CppOwnership, name, and QJSEngine::setObjectOwnership().

Here is the call graph for this function:

◆ sharedGeoServiceProvider()

QGeoServiceProvider * QDeclarativeGeoServiceProvider::sharedGeoServiceProvider ( ) const

Definition at line 504 of file qdeclarativegeoserviceprovider.cpp.

Referenced by QDeclarativeSearchModelBase::initializePlugin(), QDeclarativeSearchResultModel::initializePlugin(), QDeclarativeGeoRouteModel::measurementSystem(), QDeclarativeGeocodeModel::pluginReady(), QDeclarativeSearchResultModel::queryFinished(), QDeclarativeSearchResultModel::setFavoritesPlugin(), QDeclarativeGeoRouteModel::setMeasurementSystem(), QDeclarativeSupportedCategoriesModel::setPlugin(), supportsGeocoding(), supportsMapping(), supportsPlaces(), supportsRouting(), QDeclarativeGeocodeModel::update(), QDeclarativeGeoRouteModel::update(), QDeclarativeSearchModelBase::update(), and QDeclarativeSupportedCategoriesModel::update().

Here is the caller graph for this function:

◆ supportsGeocoding()

bool QDeclarativeGeoServiceProvider::supportsGeocoding ( const GeocodingFeatures & feature = AnyGeocodingFeatures ) const

\qmlmethod bool Plugin::supportsGeocoding(GeocodingFeatures features)

This method returns a boolean indicating whether the specified set of features are supported by the geo service provider plugin. True is returned if all specified features are supported; otherwise false is returned.

The features parameter can be any flag combination of: \table \header

Feature
Description \row
Plugin.NoGeocodingFeatures
No geocoding features are supported. \row
Plugin.OnlineGeocodingFeature
Online geocoding is supported. \row
Plugin.OfflineGeocodingFeature
Offline geocoding is supported. \row
Plugin.ReverseGeocodingFeature
Reverse geocoding is supported. \row
Plugin.LocalizedGeocodingFeature
Supports returning geocoding results with localized addresses. \row
Plugin.AnyGeocodingFeatures
Matches a geo service provider that provides any geocoding features. \endtable

Definition at line 220 of file qdeclarativegeoserviceprovider.cpp.

References QGeoServiceProvider::AnyGeocodingFeatures, QGeoServiceProvider::NoGeocodingFeatures, sharedGeoServiceProvider(), and sp.

Here is the call graph for this function:

◆ supportsMapping()

bool QDeclarativeGeoServiceProvider::supportsMapping ( const MappingFeatures & feature = AnyMappingFeatures ) const

\qmlmethod bool Plugin::supportsMapping(MappingFeatures features)

This method returns a boolean indicating whether the specified set of features are supported by the geo service provider plugin. True is returned if all specified features are supported; otherwise false is returned.

The features parameter can be any flag combination of: \table \header

Feature
Description \row
Plugin.NoMappingFeatures
No mapping features are supported. \row
Plugin.OnlineMappingFeature
Online mapping is supported. \row
Plugin.OfflineMappingFeature
Offline mapping is supported. \row
Plugin.LocalizedMappingFeature
Supports returning localized map data. \row
Plugin.AnyMappingFeatures
Matches a geo service provider that provides any mapping features. \endtable

Definition at line 260 of file qdeclarativegeoserviceprovider.cpp.

References QGeoServiceProvider::AnyMappingFeatures, QGeoServiceProvider::NoMappingFeatures, sharedGeoServiceProvider(), and sp.

Here is the call graph for this function:

◆ supportsPlaces()

bool QDeclarativeGeoServiceProvider::supportsPlaces ( const PlacesFeatures & feature = AnyPlacesFeatures ) const

\qmlmethod bool Plugin::supportsPlaces(PlacesFeatures features)

This method returns a boolean indicating whether the specified set of features are supported by the geo service provider plugin. True is returned if all specified features are supported; otherwise false is returned.

The features parameter can be any flag combination of: \table \header

Feature
Description \row
Plugin.NoPlacesFeatures
No places features are supported. \row
Plugin.OnlinePlacesFeature
Online places is supported. \row
Plugin.OfflinePlacesFeature
Offline places is supported. \row
Plugin.SavePlaceFeature
Saving categories is supported. \row
Plugin.RemovePlaceFeature
Removing or deleting places is supported. \row
Plugin.PlaceRecommendationsFeature
Searching for recommended places similar to another place is supported. \row
Plugin.SearchSuggestionsFeature
Search suggestions is supported. \row
Plugin.LocalizedPlacesFeature
Supports returning localized place data. \row
Plugin.NotificationsFeature
Notifications of place and category changes is supported. \row
Plugin.PlaceMatchingFeature
Supports matching places from two different geo service providers. \row
Plugin.AnyPlacesFeatures
Matches a geo service provider that provides any places features. \endtable

Definition at line 367 of file qdeclarativegeoserviceprovider.cpp.

References QGeoServiceProvider::AnyPlacesFeatures, QGeoServiceProvider::NoPlacesFeatures, sharedGeoServiceProvider(), and sp.

Here is the call graph for this function:

◆ supportsRouting()

bool QDeclarativeGeoServiceProvider::supportsRouting ( const RoutingFeatures & feature = AnyRoutingFeatures ) const

\qmlmethod bool Plugin::supportsRouting(RoutingFeatures features)

This method returns a boolean indicating whether the specified set of features are supported by the geo service provider plugin. True is returned if all specified features are supported; otherwise false is returned.

The features parameter can be any flag combination of: \table \header

Feature
Description \row
Plugin.NoRoutingFeatures
No routing features are supported. \row
Plugin.OnlineRoutingFeature
Online routing is supported. \row
Plugin.OfflineRoutingFeature
Offline routing is supported. \row
Plugin.LocalizedRoutingFeature
Supports returning routes with localized addresses and instructions. \row
Plugin.RouteUpdatesFeature
Updating an existing route based on the current position is supported. \row
Plugin.AlternativeRoutesFeature
Supports returning alternative routes. \row
Plugin.ExcludeAreasRoutingFeature
Supports specifying a areas which the returned route must not cross. \row
Plugin.AnyRoutingFeatures
Matches a geo service provider that provides any routing features. \endtable

Definition at line 309 of file qdeclarativegeoserviceprovider.cpp.

References QGeoServiceProvider::AnyRoutingFeatures, QGeoServiceProvider::NoRoutingFeatures, sharedGeoServiceProvider(), and sp.

Here is the call graph for this function:

Property Documentation

◆ allowExperimental

bool QDeclarativeGeoServiceProvider::allowExperimental

readwrite

Definition at line 59 of file qdeclarativegeoserviceprovider_p.h.

◆ availableServiceProviders

QStringList QDeclarativeGeoServiceProvider::availableServiceProviders

read

\qmlproperty stringlist Plugin::availableServiceProviders

This property holds a list of all available service plugins' names. This can be used to manually enumerate the available plugins if the control provided by \l name and \l required is not sufficient for your needs.

Definition at line 54 of file qdeclarativegeoserviceprovider_p.h.

◆ isAttached

bool QDeclarativeGeoServiceProvider::isAttached

read

Definition at line 60 of file qdeclarativegeoserviceprovider_p.h.

Referenced by QDeclarativeGeocodeModel::setPlugin(), QDeclarativeGeoRouteModel::setPlugin(), QDeclarativeCategory::setPlugin(), QDeclarativePlace::setPlugin(), QDeclarativeSupportedCategoriesModel::setPlugin(), and QDeclarativeGeoMap::setPlugin().

◆ locales

QStringList QDeclarativeGeoServiceProvider::locales

readwrite

Definition at line 57 of file qdeclarativegeoserviceprovider_p.h.

Referenced by QDeclarativeGeoRouteModel::measurementSystem(), and setLocales().

◆ name

QString QDeclarativeGeoServiceProvider::name

readwrite

Definition at line 53 of file qdeclarativegeoserviceprovider_p.h.

Referenced by QDeclarativeGeoServiceProvider(), QDeclarativeSearchResultModel::queryFinished(), QDeclarativeGeoMap::setActiveMapType(), setLocales(), setName(), setRequirements(), QDeclarativeSearchModelBase::update(), and QDeclarativeSupportedCategoriesModel::update().

◆ parameters

QQmlListProperty< QDeclarativePluginParameter > QDeclarativeGeoServiceProvider::parameters

read

\qmlproperty list<PluginParameter> Plugin::parameters \qmldefault

This property holds the list of plugin parameters.

Definition at line 55 of file qdeclarativegeoserviceprovider_p.h.

◆ preferred

QStringList QDeclarativeGeoServiceProvider::preferred

readwrite

Definition at line 58 of file qdeclarativegeoserviceprovider_p.h.

◆ required

QDeclarativeGeoServiceProviderRequirements * QDeclarativeGeoServiceProvider::required

readwrite

Definition at line 56 of file qdeclarativegeoserviceprovider_p.h.

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

qtlocation/src/location/declarativemaps/qdeclarativegeoserviceprovider_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
qtlocation/src/location/declarativemaps/qdeclarativegeoserviceprovider.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GeocodingFeature

◆ MappingFeature

◆ NavigationFeature

◆ PlacesFeature

◆ RoutingFeature

Constructor & Destructor Documentation

◆ QDeclarativeGeoServiceProvider()

◆ ~QDeclarativeGeoServiceProvider()

Member Function Documentation

◆ allowExperimental()

◆ allowExperimentalChanged

◆ attached

◆ availableServiceProviders()

◆ classBegin()

◆ componentComplete()

◆ isAttached()

◆ locales()

◆ localesChanged

◆ name()

◆ nameChanged

◆ parameterMap()

◆ parameters()

◆ preferred()

◆ preferredChanged

◆ Q_REVISION()

◆ requirements()

◆ setAllowExperimental()

◆ setLocales()

◆ setName()

◆ setPreferred()

◆ setRequirements()

◆ sharedGeoServiceProvider()

◆ supportsGeocoding()

◆ supportsMapping()

◆ supportsPlaces()

◆ supportsRouting()

Property Documentation

◆ allowExperimental

◆ availableServiceProviders

◆ isAttached

◆ locales

◆ name

◆ parameters

◆ preferred

◆ required