Marble::AbstractDataPluginModel

#include <AbstractDataPluginModel.h>

Inheritance diagram for Marble::AbstractDataPluginModel:

Properties
QObject	favoritesModel

Properties inherited from QObject
	objectName

Signals
void	favoriteItemsChanged (const QStringList &favoriteItems)

void	favoriteItemsOnlyChanged ()

void	itemsUpdated ()

Public Slots
void	addItemsToList (const QList< AbstractDataPluginItem * > &items)

void	addItemToList (AbstractDataPluginItem *item)

void	clear ()

Public Member Functions
	AbstractDataPluginModel (const QString &name, const MarbleModel marbleModel, QObject parent=nullptr)

QStringList	favoriteItems () const

QObject *	favoritesModel ()

AbstractDataPluginItem *	findItem (const QString &id) const

bool	isFavoriteItemsOnly () const

bool	itemExists (const QString &id) const

QList< AbstractDataPluginItem * >	items (const ViewportParams *viewport, qint32 number=10)

const MarbleModel *	marbleModel () const

virtual void	setFavoriteItems (const QStringList &list)

void	setFavoriteItemsOnly (bool favoriteOnly)

void	setItemSettings (const QHash< QString, QVariant > &itemSettings)

QList< AbstractDataPluginItem * >	whichItemAt (const QPoint &curpos)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

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 ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, 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

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	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	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

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	setParent (QObject *parent)

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
void	downloadDescriptionFile (const QUrl &url)

void	downloadItem (const QUrl &url, const QString &type, AbstractDataPluginItem *item)

virtual void	getAdditionalItems (const GeoDataLatLonAltBox &box, qint32 number=10)=0

virtual void	getItem (const QString &id)

virtual void	parseFile (const QByteArray &file)

void	registerItemProperties (const QMetaObject &item)

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)

Additional Inherited Members
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)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

An abstract data model (not based on QAbstractModel) for a AbstractDataPlugin.

This class is an abstract model for a AbstractDataPlugin. It provides the storage and selection of added items and it is also responsible for downloading item data.

The functions getAdditionalItems() and parseFile() have to be reimplemented in a subclass.

Definition at line 39 of file AbstractDataPluginModel.h.

Property Documentation

◆ favoritesModel

QObject * Marble::AbstractDataPluginModel::favoritesModel

read

Todo:: FIXME Qt Quick segfaults if using the real class here instead of QObject

Definition at line 44 of file AbstractDataPluginModel.h.

Member Function Documentation

◆ addItemsToList

void Marble::AbstractDataPluginModel::addItemsToList ( const QList< AbstractDataPluginItem * > & items )

slot

Adds the items to the list of initialized items.

It checks if items with the same id are already in the list and ignores and deletes them in this case.

Definition at line 402 of file AbstractDataPluginModel.cpp.

◆ addItemToList

void Marble::AbstractDataPluginModel::addItemToList ( AbstractDataPluginItem * item )

slot

Convenience method to add one item to the list.

See addItemsToList

Definition at line 397 of file AbstractDataPluginModel.cpp.

◆ clear

void Marble::AbstractDataPluginModel::clear ( )

slot

Removes all items.

Definition at line 645 of file AbstractDataPluginModel.cpp.

◆ downloadDescriptionFile()

void Marble::AbstractDataPluginModel::downloadDescriptionFile ( const QUrl & url )

protected

Download the description file from the url.

Definition at line 386 of file AbstractDataPluginModel.cpp.

◆ downloadItem()

void Marble::AbstractDataPluginModel::downloadItem	(	const QUrl &	url,
		const QString &	type,
		AbstractDataPluginItem *	item
	)

protected

Downloads the file from url.

item -> addDownloadedFile() will be called when the download is finished.

Parameters

url	the file URL
type	The type of the download (to be specified by the subclasser)
item	the data plugin item

Definition at line 372 of file AbstractDataPluginModel.cpp.

◆ findItem()

AbstractDataPluginItem * Marble::AbstractDataPluginModel::findItem ( const QString & id ) const

Finds the item with id in the list.

Returns: The pointer to the item or (if no item has been found) 0

Definition at line 536 of file AbstractDataPluginModel.cpp.

◆ getAdditionalItems()

virtual void Marble::AbstractDataPluginModel::getAdditionalItems	(	const GeoDataLatLonAltBox &	box,
		qint32	number = `10`
	)

protectedpure virtual

Managing to get number additional items in box.

This includes generating a url and downloading the corresponding file. This method has to be implemented in a subclass.

◆ getItem()

void Marble::AbstractDataPluginModel::getItem ( const QString & id )

protectedvirtual

Retrieve data for a specific item.

Parameters

id	Item id of the item to retrieve

Definition at line 455 of file AbstractDataPluginModel.cpp.

◆ itemExists()

bool Marble::AbstractDataPluginModel::itemExists ( const QString & id ) const

Testing the existence of the item id in the list.

Definition at line 547 of file AbstractDataPluginModel.cpp.

◆ items()

QList< AbstractDataPluginItem * > Marble::AbstractDataPluginModel::items	(	const ViewportParams *	viewport,
		qint32	number = `10`
	)

Get the items on the viewport Returns the currently downloaded images in the viewport.

The maximum number of images can be specified with number, 0 means no limit.

Returns: The list of item with most important item first.

Definition at line 277 of file AbstractDataPluginModel.cpp.

◆ parseFile()

void Marble::AbstractDataPluginModel::parseFile ( const QByteArray & file )

protectedvirtual

Parse the file and generate items.

The items will be added to the list or the method starts additionally needed downloads. This method has to be implemented in a subclass.

Definition at line 367 of file AbstractDataPluginModel.cpp.

◆ setItemSettings()

void Marble::AbstractDataPluginModel::setItemSettings ( const QHash< QString, QVariant > & itemSettings )

Sets the settings for all items.

Sets the settings for all items before painting. This ensures that all items react on changed settings.

Definition at line 552 of file AbstractDataPluginModel.cpp.

◆ whichItemAt()

QList< AbstractDataPluginItem * > Marble::AbstractDataPluginModel::whichItemAt ( const QPoint & curpos )

Get all items that contain the given point Returns a list of all items that contain the point curpos.

Definition at line 353 of file AbstractDataPluginModel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Marble

Marble::AbstractDataPluginModel

Properties

Signals

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ favoritesModel

Member Function Documentation

◆ addItemsToList

◆ addItemToList

◆ clear

◆ downloadDescriptionFile()

◆ downloadItem()

◆ findItem()

◆ getAdditionalItems()

◆ getItem()

◆ itemExists()

◆ items()

◆ parseFile()

◆ setItemSettings()

◆ whichItemAt()