Marble::GeoDataDocument

#include <GeoDataDocument.h>

Inheritance diagram for Marble::GeoDataDocument:

[legend]

Public Member Functions
	GeoDataDocument (const GeoDataDocument &other)

void	addSchema (const GeoDataSchema &schema)

void	addStyle (const GeoDataStyle::Ptr &style)

void	addStyleMap (const GeoDataStyleMap &map)

QString	baseUri () const

GeoDataFeature *	clone () const override

DocumentRole	documentRole () const

QString	fileName () const

bool	isGeoDataDocument () const override

GeoDataNetworkLinkControl	networkLinkControl () const

const char *	nodeType () const override

bool	operator!= (const GeoDataDocument &other) const

GeoDataDocument &	operator= (const GeoDataDocument &other)

bool	operator== (const GeoDataDocument &other) const

void	pack (QDataStream &stream) const override

QString	property () const

void	removeSchema (const QString &schemaId)

void	removeStyle (const QString &styleId)

void	removeStyleMap (const QString &mapId)

GeoDataSchema &	schema (const QString &schemaId)

GeoDataSchema	schema (const QString &schemaId) const

QList< GeoDataSchema >	schemas () const

void	setBaseUri (const QString &baseUri)

void	setDocumentRole (DocumentRole role)

void	setFileName (const QString &value)

void	setNetworkLinkControl (const GeoDataNetworkLinkControl &networkLinkControl)

void	setProperty (const QString &property)

GeoDataStyle::Ptr	style (const QString &styleId)

GeoDataStyle::ConstPtr	style (const QString &styleId) const

GeoDataStyleMap &	styleMap (const QString &styleId)

GeoDataStyleMap	styleMap (const QString &styleId) const

QList< GeoDataStyleMap >	styleMaps () const

QList< GeoDataStyle::Ptr >	styles ()

QList< GeoDataStyle::ConstPtr >	styles () const

void	unpack (QDataStream &stream) override

Public Member Functions inherited from Marble::GeoDocument
virtual bool	isGeoSceneDocument () const

Public Member Functions inherited from Marble::GeoDataContainer
	GeoDataContainer ()

	GeoDataContainer (const GeoDataContainer &other)

	~GeoDataContainer () override

void	append (GeoDataFeature *other)

GeoDataFeature &	at (int pos)

const GeoDataFeature &	at (int pos) const

QList< GeoDataFeature * >::Iterator	begin ()

GeoDataFeature *	child (int)

const GeoDataFeature *	child (int) const

int	childPosition (const GeoDataFeature *child) const

void	clear ()

QList< GeoDataFeature * >::ConstIterator	constBegin () const

QList< GeoDataFeature * >::ConstIterator	constEnd () const

QList< GeoDataFeature * >::Iterator	end ()

QList< GeoDataFeature * >	featureList () const

GeoDataFeature &	first ()

const GeoDataFeature &	first () const

QList< GeoDataFolder * >	folderList () const

GEODATA_DEPRECATED void	insert (GeoDataFeature *other, int index)

void	insert (int index, GeoDataFeature *feature)

bool	isEmpty () const

GeoDataFeature &	last ()

const GeoDataFeature &	last () const

GeoDataLatLonAltBox	latLonAltBox () const

GeoDataContainer &	operator= (const GeoDataContainer &other)

void	pack (QDataStream &stream) const override

QList< GeoDataPlacemark * >	placemarkList () const

void	remove (int index)

void	remove (int index, int count)

int	removeAll (GeoDataFeature *feature)

void	removeAt (int index)

void	removeFirst ()

void	removeLast ()

bool	removeOne (GeoDataFeature *feature)

int	size () const

void	unpack (QDataStream &stream) override

Public Member Functions inherited from Marble::GeoDataFeature
	GeoDataFeature (const GeoDataFeature &other)

	GeoDataFeature (const QString &name)

GeoDataAbstractView *	abstractView ()

const GeoDataAbstractView *	abstractView () const

QString	address () const

QSharedPointer< const GeoDataStyle >	customStyle () const

QString	description () const

bool	descriptionIsCDATA () const

GeoDataExtendedData &	extendedData ()

const GeoDataExtendedData &	extendedData () const

EnumFeatureId	featureId () const

bool	isGloballyVisible () const

bool	isVisible () const

QString	name () const

bool	operator!= (const GeoDataFeature &other) const

GeoDataFeature &	operator= (const GeoDataFeature &other)

bool	operator== (const GeoDataFeature &other) const

void	pack (QDataStream &stream) const override

QString	phoneNumber () const

qint64	popularity () const

GeoDataRegion &	region ()

const GeoDataRegion &	region () const

const QString	role () const

void	setAbstractView (GeoDataAbstractView *abstractView)

void	setAddress (const QString &value)

void	setDescription (const QString &value)

void	setDescriptionCDATA (bool cdata)

void	setExtendedData (const GeoDataExtendedData &extendedData)

void	setName (const QString &value)

void	setPhoneNumber (const QString &value)

void	setPopularity (qint64 popularity)

void	setRegion (const GeoDataRegion &region)

void	setRole (const QString &role)

void	setSnippet (const GeoDataSnippet &value)

void	setStyle (const QSharedPointer< GeoDataStyle > &style)

void	setStyleMap (const GeoDataStyleMap *map)

void	setStyleUrl (const QString &value)

void	setTimeSpan (const GeoDataTimeSpan &timeSpan)

void	setTimeStamp (const GeoDataTimeStamp &timeStamp)

void	setVisible (bool value)

void	setZoomLevel (int index)

GeoDataSnippet	snippet () const

QSharedPointer< const GeoDataStyle >	style () const

const GeoDataStyleMap *	styleMap () const

QString	styleUrl () const

GeoDataTimeSpan &	timeSpan ()

const GeoDataTimeSpan &	timeSpan () const

GeoDataTimeStamp &	timeStamp ()

const GeoDataTimeStamp &	timeStamp () const

void	unpack (QDataStream &stream) override

int	zoomLevel () const

Public Member Functions inherited from Marble::GeoDataObject
	GeoDataObject (const GeoDataObject &)

QString	id () const

GeoDataObject &	operator= (const GeoDataObject &)

void	pack (QDataStream &stream) const override

GeoDataObject *	parent ()

const GeoDataObject *	parent () const

QString	resolvePath (const QString &relativePath) const

void	setId (const QString &value)

void	setParent (GeoDataObject *parent)

void	setTargetId (const QString &value)

QString	targetId () const

void	unpack (QDataStream &steam) override

Additional Inherited Members
Protected Member Functions inherited from Marble::GeoDataContainer
	GeoDataContainer (const GeoDataContainer &other, GeoDataContainerPrivate *priv)

	GeoDataContainer (GeoDataContainerPrivate *priv)

bool	equals (const GeoDataContainer &other) const

bool	equals (const GeoDataFeature &other) const

Protected Member Functions inherited from Marble::GeoDataFeature
	GeoDataFeature (const GeoDataFeature &other, GeoDataFeaturePrivate *dd)

	GeoDataFeature (GeoDataFeaturePrivate *dd)

bool	equals (const GeoDataFeature &other) const

virtual bool	equals (const GeoDataObject &other) const

Protected Attributes inherited from Marble::GeoDataFeature
GeoDataFeaturePrivate *const	d_ptr

Detailed Description

A container for Features, Styles and in the future Schemas.

A GeoDataDocument is a container for features, styles, and schemas. This element is required if your KML file uses schemas or shared styles. It is recommended that all Styles be defined in a Document, each with an id, and then later referenced by a styleUrl for a given Feature or StyleMap.

Definition at line 47 of file GeoDataDocument.h.

Constructor & Destructor Documentation

◆ GeoDataDocument() [1/2]

Marble::GeoDataDocument::GeoDataDocument ( )

Definition at line 22 of file GeoDataDocument.cpp.

◆ GeoDataDocument() [2/2]

Marble::GeoDataDocument::GeoDataDocument ( const GeoDataDocument & other )

Definition at line 27 of file GeoDataDocument.cpp.

Member Function Documentation

◆ addSchema()

void Marble::GeoDataDocument::addSchema ( const GeoDataSchema & schema )

Add a schema to simplemap storage.

Parameters

schema the new schema

Definition at line 226 of file GeoDataDocument.cpp.

◆ addStyle()

void Marble::GeoDataDocument::addStyle ( const GeoDataStyle::Ptr & style )

Add a style to the style storage.

Parameters

style the new style

Definition at line 149 of file GeoDataDocument.cpp.

◆ addStyleMap()

void Marble::GeoDataDocument::addStyleMap ( const GeoDataStyleMap & map )

Add a stylemap to the stylemap storage.

Parameters

map	the new stylemap

Definition at line 195 of file GeoDataDocument.cpp.

◆ baseUri()

QString Marble::GeoDataDocument::baseUri ( ) const

The URI relative paths should be resolved against.

Definition at line 125 of file GeoDataDocument.cpp.

◆ clone()

GeoDataFeature * Marble::GeoDataDocument::clone ( ) const

overridevirtual

Duplicate into another equal instance.

Implements Marble::GeoDataFeature.

Definition at line 84 of file GeoDataDocument.cpp.

◆ documentRole()

DocumentRole Marble::GeoDataDocument::documentRole ( ) const

Definition at line 89 of file GeoDataDocument.cpp.

◆ fileName()

QString Marble::GeoDataDocument::fileName ( ) const

The filename of the document.

The filename of the document is used internally to identify the files. it should never be empty as this could lead to potential collisions.

Returns: The filename of this document

Definition at line 113 of file GeoDataDocument.cpp.

◆ isGeoDataDocument()

bool Marble::GeoDataDocument::isGeoDataDocument ( ) const

inlineoverridevirtual

Provides type information for downcasting a GeoData.

Reimplemented from Marble::GeoDocument.

Definition at line 64 of file GeoDataDocument.h.

◆ networkLinkControl()

GeoDataNetworkLinkControl Marble::GeoDataDocument::networkLinkControl ( ) const

the NetworkLinkControl of the file

Definition at line 137 of file GeoDataDocument.cpp.

◆ nodeType()

const char * Marble::GeoDataDocument::nodeType ( ) const

overridevirtual

Provides type information for downcasting a GeoNode.

Implements Marble::GeoNode.

Definition at line 79 of file GeoDataDocument.cpp.

◆ operator!=()

bool Marble::GeoDataDocument::operator!= ( const GeoDataDocument & other ) const

Definition at line 74 of file GeoDataDocument.cpp.

◆ operator=()

GeoDataDocument & Marble::GeoDataDocument::operator= ( const GeoDataDocument & other )

Definition at line 35 of file GeoDataDocument.cpp.

◆ operator==()

bool Marble::GeoDataDocument::operator== ( const GeoDataDocument & other ) const

Definition at line 45 of file GeoDataDocument.cpp.

◆ pack()

void Marble::GeoDataDocument::pack ( QDataStream & stream ) const

override

Definition at line 258 of file GeoDataDocument.cpp.

◆ property()

QString Marble::GeoDataDocument::property ( ) const

Definition at line 101 of file GeoDataDocument.cpp.

◆ removeSchema()

void Marble::GeoDataDocument::removeSchema ( const QString & schemaId )

remove a schema from schema storage

Parameters

schemaId the of schema to be removed

Definition at line 233 of file GeoDataDocument.cpp.

◆ removeStyle()

void Marble::GeoDataDocument::removeStyle ( const QString & styleId )

Add a style to the style storage.

Parameters

styleId the new style

Definition at line 156 of file GeoDataDocument.cpp.

◆ removeStyleMap()

void Marble::GeoDataDocument::removeStyleMap ( const QString & mapId )

remove stylemap from storage

Parameters

mapId the styleId of the styleMap to be removed

Definition at line 202 of file GeoDataDocument.cpp.

◆ schema() [1/2]

GeoDataSchema & Marble::GeoDataDocument::schema ( const QString & schemaId )

Definition at line 246 of file GeoDataDocument.cpp.

◆ schema() [2/2]

GeoDataSchema Marble::GeoDataDocument::schema ( const QString & schemaId ) const

Returns a schema with id = schemaId form schema storage.

Parameters

schemaId The id of schema to be returned

Definition at line 240 of file GeoDataDocument.cpp.

◆ schemas()

QList< GeoDataSchema > Marble::GeoDataDocument::schemas ( ) const

dump a vector of all schemas

Definition at line 252 of file GeoDataDocument.cpp.

◆ setBaseUri()

void Marble::GeoDataDocument::setBaseUri ( const QString & baseUri )

Change the URI for resolving relative paths.

See https://tools.ietf.org/html/rfc3986#section-5

Definition at line 131 of file GeoDataDocument.cpp.

◆ setDocumentRole()

void Marble::GeoDataDocument::setDocumentRole ( DocumentRole role )

Definition at line 95 of file GeoDataDocument.cpp.

◆ setFileName()

void Marble::GeoDataDocument::setFileName ( const QString & value )

Set a new file name for this document.

Parameters

value the new name

Definition at line 119 of file GeoDataDocument.cpp.

◆ setNetworkLinkControl()

void Marble::GeoDataDocument::setNetworkLinkControl ( const GeoDataNetworkLinkControl & networkLinkControl )

set the NetworkLinkControl of the file

Definition at line 143 of file GeoDataDocument.cpp.

◆ setProperty()

void Marble::GeoDataDocument::setProperty ( const QString & property )

Definition at line 107 of file GeoDataDocument.cpp.

◆ style() [1/2]

GeoDataStyle::Ptr Marble::GeoDataDocument::style ( const QString & styleId )

Return a style in the style storage.

Parameters

styleId the id of the style

Definition at line 162 of file GeoDataDocument.cpp.

◆ style() [2/2]

GeoDataStyle::ConstPtr Marble::GeoDataDocument::style ( const QString & styleId ) const

Definition at line 172 of file GeoDataDocument.cpp.

◆ styleMap() [1/2]

GeoDataStyleMap & Marble::GeoDataDocument::styleMap ( const QString & styleId )

Return a style in the style storage.

Parameters

styleId the id of the style

Definition at line 208 of file GeoDataDocument.cpp.

◆ styleMap() [2/2]

GeoDataStyleMap Marble::GeoDataDocument::styleMap ( const QString & styleId ) const

Definition at line 214 of file GeoDataDocument.cpp.

◆ styleMaps()

QList< GeoDataStyleMap > Marble::GeoDataDocument::styleMaps ( ) const

dump a Vector of all stylemaps

Definition at line 220 of file GeoDataDocument.cpp.

◆ styles() [1/2]

QList< GeoDataStyle::Ptr > Marble::GeoDataDocument::styles ( )

dump a Vector of all styles

Definition at line 189 of file GeoDataDocument.cpp.

◆ styles() [2/2]

QList< GeoDataStyle::ConstPtr > Marble::GeoDataDocument::styles ( ) const

Definition at line 178 of file GeoDataDocument.cpp.

◆ unpack()

void Marble::GeoDataDocument::unpack ( QDataStream & stream )

override

Definition at line 270 of file GeoDataDocument.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::GeoDataDocument

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GeoDataDocument() [1/2]

◆ GeoDataDocument() [2/2]

Member Function Documentation

◆ addSchema()

◆ addStyle()

◆ addStyleMap()

◆ baseUri()

◆ clone()

◆ documentRole()

◆ fileName()

◆ isGeoDataDocument()

◆ networkLinkControl()

◆ nodeType()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ pack()

◆ property()

◆ removeSchema()

◆ removeStyle()

◆ removeStyleMap()

◆ schema() [1/2]

◆ schema() [2/2]

◆ schemas()

◆ setBaseUri()

◆ setDocumentRole()

◆ setFileName()

◆ setNetworkLinkControl()

◆ setProperty()

◆ style() [1/2]

◆ style() [2/2]

◆ styleMap() [1/2]

◆ styleMap() [2/2]

◆ styleMaps()

◆ styles() [1/2]

◆ styles() [2/2]

◆ unpack()