Marble::AbstractDataPlugin
#include <AbstractDataPlugin.h>
Properties | |
bool | favoriteItemsOnly |
QObject * | favoritesModel |
int | numberOfItems |
Properties inherited from Marble::RenderPlugin | |
QString | description |
bool | enabled |
QString | name |
QString | nameId |
bool | userCheckable |
QString | version |
bool | visible |
Properties inherited from QObject | |
objectName | |
Signals | |
void | changedNumberOfItems (quint32 number) |
void | favoriteItemsOnlyChanged () |
void | favoritesModelChanged () |
Signals inherited from Marble::RenderPlugin | |
void | actionGroupsChanged () |
void | enabledChanged (bool enable) |
void | repaintNeeded (const QRegion &dirtyRegion=QRegion()) |
void | settingsChanged (const QString &nameId) |
void | userCheckableChanged (bool isUserCheckable) |
void | visibilityChanged (bool visible, const QString &nameId) |
Public Member Functions | |
AbstractDataPlugin (const MarbleModel *marbleModel) | |
QStringList | backendTypes () const override |
QObject * | favoritesModel () |
bool | isFavoriteItemsOnly () const |
bool | isInitialized () const override |
AbstractDataPluginModel * | model () |
const AbstractDataPluginModel * | model () const |
quint32 | numberOfItems () const |
bool | render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos=QLatin1String("NONE"), GeoSceneLayer *layer=nullptr) override |
QString | renderPolicy () const override |
QStringList | renderPosition () const override |
RenderType | renderType () const override |
void | setFavoriteItemsOnly (bool favoriteOnly) |
void | setModel (AbstractDataPluginModel *model) |
void | setNumberOfItems (quint32 number) |
QList< AbstractDataPluginItem * > | whichItemAt (const QPoint &curpos) |
Public Member Functions inherited from Marble::RenderPlugin | |
RenderPlugin (const MarbleModel *marbleModel) | |
virtual const QList< QActionGroup * > * | actionGroups () const |
bool | enabled () const |
virtual QString | guiString () const =0 |
bool | isUserCheckable () const |
const MarbleModel * | marbleModel () const |
virtual RenderPlugin * | newInstance (const MarbleModel *marbleModel) const =0 |
RenderState | renderState () const override |
QString | runtimeTrace () const override |
virtual void | setSettings (const QHash< QString, QVariant > &settings) |
virtual QHash< QString, QVariant > | settings () const |
virtual const QList< QActionGroup * > * | toolbarActionGroups () const |
bool | visible () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
T | 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 QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () 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 | |
T | qobject_cast (const QObject *object) |
T | 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) |
QThread * | thread () const const |
Public Member Functions inherited from Marble::RenderPluginInterface | |
virtual void | initialize ()=0 |
Public Member Functions inherited from Marble::PluginInterface | |
virtual QString | aboutDataText () const |
virtual QString | copyrightYears () const =0 |
virtual QString | description () const =0 |
virtual QIcon | icon () const =0 |
virtual QString | name () const =0 |
virtual QString | nameId () const =0 |
virtual QList< PluginAuthor > | pluginAuthors () const =0 |
virtual QString | version () const =0 |
Additional Inherited Members | |
Public Types inherited from Marble::RenderPlugin | |
enum | RenderType { UnknownRenderType , TopLevelRenderType , PanelRenderType , OnlineRenderType , ThemeRenderType } |
Public Types inherited from QObject | |
typedef | QObjectList |
Public Slots inherited from Marble::RenderPlugin | |
QAction * | action () const |
void | restoreDefaultSettings () |
void | setEnabled (bool enabled) |
bool | setSetting (const QString &key, const QVariant &value) |
QVariant | setting (const QString &key) const |
QStringList | settingKeys () const |
void | setUserCheckable (bool isUserCheckable) |
void | setVisible (bool visible) |
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) |
Protected Member Functions inherited from Marble::RenderPlugin | |
bool | eventFilter (QObject *, QEvent *) override |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
An abstract class for plugins that show data that has a geo coordinate.
This is the abstract class for plugins that show data on Marble map. It takes care of painting all items it gets from the corresponding AbstractDataPluginModel that has to be set on initialisation.
The user has to set the nameId as well as the number of items to fetch. Additionally it should be useful to set standard values via setEnabled (often true) and setVisible (often false) in the constructor of a subclass.
Definition at line 33 of file AbstractDataPlugin.h.
Property Documentation
◆ favoriteItemsOnly
|
readwrite |
Definition at line 37 of file AbstractDataPlugin.h.
◆ favoritesModel
|
read |
Definition at line 39 of file AbstractDataPlugin.h.
◆ numberOfItems
|
readwrite |
Definition at line 40 of file AbstractDataPlugin.h.
Constructor & Destructor Documentation
◆ AbstractDataPlugin()
|
explicit |
Definition at line 45 of file AbstractDataPlugin.cpp.
◆ ~AbstractDataPlugin()
|
override |
Definition at line 52 of file AbstractDataPlugin.cpp.
Member Function Documentation
◆ backendTypes()
|
overridevirtual |
Returns the name(s) of the backend that the plugin can render.
Implements Marble::RenderPluginInterface.
Definition at line 62 of file AbstractDataPlugin.cpp.
◆ isFavoriteItemsOnly()
bool Marble::AbstractDataPlugin::isFavoriteItemsOnly | ( | ) | const |
Definition at line 155 of file AbstractDataPlugin.cpp.
◆ isInitialized()
|
overridevirtual |
Implements Marble::RenderPluginInterface.
Definition at line 57 of file AbstractDataPlugin.cpp.
◆ model() [1/2]
AbstractDataPluginModel * Marble::AbstractDataPlugin::model | ( | ) |
- Returns
- The model associated with the plugin.
Definition at line 95 of file AbstractDataPlugin.cpp.
◆ model() [2/2]
const AbstractDataPluginModel * Marble::AbstractDataPlugin::model | ( | ) | const |
Definition at line 100 of file AbstractDataPlugin.cpp.
◆ numberOfItems()
quint32 Marble::AbstractDataPlugin::numberOfItems | ( | ) | const |
- Returns
- The number of items to be shown at the same time.
Definition at line 120 of file AbstractDataPlugin.cpp.
◆ render()
|
override |
Renders the content provided by the plugin on the viewport.
- Returns
true
Returns whether the rendering has been successful
Definition at line 77 of file AbstractDataPlugin.cpp.
◆ renderPolicy()
|
overridevirtual |
Return how the plugin settings should be used.
Implements Marble::RenderPluginInterface.
Definition at line 67 of file AbstractDataPlugin.cpp.
◆ renderPosition()
|
override |
Preferred level in the layer stack for the rendering.
Definition at line 72 of file AbstractDataPlugin.cpp.
◆ renderType()
|
overridevirtual |
Function for returning the type of plugin this is for.
This affects where in the menu tree the action() is placed.
- Returns
- : The type of render plugin this is.
Reimplemented from Marble::RenderPlugin.
Definition at line 143 of file AbstractDataPlugin.cpp.
◆ setFavoriteItemsOnly()
void Marble::AbstractDataPlugin::setFavoriteItemsOnly | ( | bool | favoriteOnly | ) |
Convenience method to set the favorite item state on the current model.
Definition at line 148 of file AbstractDataPlugin.cpp.
◆ setModel()
void Marble::AbstractDataPlugin::setModel | ( | AbstractDataPluginModel * | model | ) |
Set the model of the plugin.
Definition at line 105 of file AbstractDataPlugin.cpp.
◆ setNumberOfItems()
void Marble::AbstractDataPlugin::setNumberOfItems | ( | quint32 | number | ) |
Set the number of items to be shown at the same time.
Definition at line 125 of file AbstractDataPlugin.cpp.
◆ whichItemAt()
This function returns all items at the position curpos
.
Depending on where they have been painted the last time.
- Returns
- The items at the given position.
Definition at line 134 of file AbstractDataPlugin.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:37:04 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.