Marble::ReverseGeocodingRunnerPlugin

Search for usage in LXR

Marble::ReverseGeocodingRunnerPlugin Class Referenceabstract

#include <ReverseGeocodingRunnerPlugin.h>

Inheritance diagram for Marble::ReverseGeocodingRunnerPlugin:

Public Member Functions

 ReverseGeocodingRunnerPlugin (QObject *parent=nullptr)
 
 ~ReverseGeocodingRunnerPlugin () override
 
virtual bool canWork () const
 
bool canWorkOffline () const
 
virtual QString guiString () const =0
 
QIcon icon () const override
 
virtual ReverseGeocodingRunner * newRunner () const =0
 
bool supportsCelestialBody (const QString &celestialBodyId) const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from Marble::PluginInterface
virtual QString aboutDataText () const
 
virtual QString copyrightYears () const =0
 
virtual QString description () const =0
 
virtual QString name () const =0
 
virtual QString nameId () const =0
 
virtual QVector< PluginAuthor > pluginAuthors () const =0
 
virtual QString version () const =0
 

Protected Member Functions

void setCanWorkOffline (bool canWorkOffline)
 
void setSupportedCelestialBodies (const QStringList &celestialBodies)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

A plugin for Marble to execute a reverse geocoding task.

Definition at line 22 of file ReverseGeocodingRunnerPlugin.h.

Constructor & Destructor Documentation

◆ ReverseGeocodingRunnerPlugin()

Marble::ReverseGeocodingRunnerPlugin::ReverseGeocodingRunnerPlugin ( QObject * parent = nullptr)
explicit

Constructor with optional parent object.

Definition at line 31 of file ReverseGeocodingRunnerPlugin.cpp.

◆ ~ReverseGeocodingRunnerPlugin()

Marble::ReverseGeocodingRunnerPlugin::~ReverseGeocodingRunnerPlugin ( )
override

Destructor.

Definition at line 37 of file ReverseGeocodingRunnerPlugin.cpp.

Member Function Documentation

◆ canWork()

bool Marble::ReverseGeocodingRunnerPlugin::canWork ( ) const
virtual

Returns.

true

if the plugin is able to perform its claimed task.

The default implementation returns

true

. This method can be overridden for example to indicate an incomplete installation.

Definition at line 71 of file ReverseGeocodingRunnerPlugin.cpp.

◆ canWorkOffline()

bool Marble::ReverseGeocodingRunnerPlugin::canWorkOffline ( ) const

True if the plugin can execute its tasks without network access.

Definition at line 66 of file ReverseGeocodingRunnerPlugin.cpp.

◆ guiString()

virtual QString Marble::ReverseGeocodingRunnerPlugin::guiString ( ) const
pure virtual

Returns the string that should appear in the user interface.

For example, "Nominatim" should be returned for the Nominatim reverse geocoding plugin.

◆ icon()

QIcon Marble::ReverseGeocodingRunnerPlugin::icon ( ) const
overridevirtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 42 of file ReverseGeocodingRunnerPlugin.cpp.

◆ newRunner()

virtual ReverseGeocodingRunner * Marble::ReverseGeocodingRunnerPlugin::newRunner ( ) const
pure virtual

Plugin factory method to create a new runner instance.

Method caller gets ownership of the returned object

◆ setCanWorkOffline()

void Marble::ReverseGeocodingRunnerPlugin::setCanWorkOffline ( bool canWorkOffline)
protected

Definition at line 61 of file ReverseGeocodingRunnerPlugin.cpp.

◆ setSupportedCelestialBodies()

void Marble::ReverseGeocodingRunnerPlugin::setSupportedCelestialBodies ( const QStringList & celestialBodies)
protected

Definition at line 56 of file ReverseGeocodingRunnerPlugin.cpp.

◆ supportsCelestialBody()

bool Marble::ReverseGeocodingRunnerPlugin::supportsCelestialBody ( const QString & celestialBodyId) const

True if the plugin supports its tasks on the given planet.

Definition at line 47 of file ReverseGeocodingRunnerPlugin.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:49:24 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.