Marble::GeoDataDocument

Marble::GeoDataDocument Class Reference

#include <GeoDataDocument.h>

Inheritance diagram for Marble::GeoDataDocument:

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
 
GeoDataFeatureclone () 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
 
GeoDataDocumentoperator= (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) const
 
GeoDataSchema & schema (const QString &schemaId)
 
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
 
GeoDataStyleMapstyleMap (const QString &styleId)
 
GeoDataStyleMap styleMap (const QString &styleId) const
 
QList< GeoDataStyleMapstyleMaps () const
 
QList< GeoDataStyle::Ptrstyles ()
 
QList< GeoDataStyle::ConstPtrstyles () 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)
 
GeoDataFeatureat (int pos)
 
const GeoDataFeatureat (int pos) const
 
QVector< GeoDataFeature * >::Iterator begin ()
 
GeoDataFeaturechild (int)
 
const GeoDataFeaturechild (int) const
 
int childPosition (const GeoDataFeature *child) const
 
void clear ()
 
QVector< GeoDataFeature * >::ConstIterator constBegin () const
 
QVector< GeoDataFeature * >::ConstIterator constEnd () const
 
QVector< GeoDataFeature * >::Iterator end ()
 
QVector< GeoDataFeature * > featureList () const
 
GeoDataFeaturefirst ()
 
const GeoDataFeaturefirst () const
 
QVector< GeoDataFolder * > folderList () const
 
void insert (int index, GeoDataFeature *feature)
 
GEODATA_DEPRECATED void insert (GeoDataFeature *other, int index)
 
bool isEmpty () const
 
GeoDataFeaturelast ()
 
const GeoDataFeaturelast () const
 
GeoDataLatLonAltBox latLonAltBox () const
 
GeoDataContaineroperator= (const GeoDataContainer &other)
 
void pack (QDataStream &stream) const override
 
QVector< 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 QString &name)
 
 GeoDataFeature (const GeoDataFeature &other)
 
const GeoDataAbstractViewabstractView () const
 
GeoDataAbstractViewabstractView ()
 
QString address () const
 
QSharedPointer< const GeoDataStylecustomStyle () const
 
QString description () const
 
bool descriptionIsCDATA () const
 
GeoDataExtendedDataextendedData ()
 
const GeoDataExtendedDataextendedData () const
 
EnumFeatureId featureId () const
 
bool isGloballyVisible () const
 
bool isVisible () const
 
QString name () const
 
bool operator!= (const GeoDataFeature &other) const
 
GeoDataFeatureoperator= (const GeoDataFeature &other)
 
bool operator== (const GeoDataFeature &other) const
 
void pack (QDataStream &stream) const override
 
QString phoneNumber () const
 
qint64 popularity () const
 
const GeoDataRegionregion () const
 
GeoDataRegionregion ()
 
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 GeoDataStylestyle () const
 
const GeoDataStyleMapstyleMap () const
 
QString styleUrl () const
 
const GeoDataTimeSpan & timeSpan () const
 
GeoDataTimeSpan & timeSpan ()
 
const GeoDataTimeStamp & timeStamp () const
 
GeoDataTimeStamp & timeStamp ()
 
void unpack (QDataStream &stream) override
 
int zoomLevel () const
 
- Public Member Functions inherited from Marble::GeoDataObject
 GeoDataObject (const GeoDataObject &)
 
QString id () const
 
GeoDataObjectoperator= (const GeoDataObject &)
 
void pack (QDataStream &stream) const override
 
const GeoDataObjectparent () const
 
GeoDataObjectparent ()
 
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 (GeoDataContainerPrivate *priv)
 
 GeoDataContainer (const GeoDataContainer &other, GeoDataContainerPrivate *priv)
 
bool equals (const GeoDataContainer &other) const
 
- Protected Member Functions inherited from Marble::GeoDataFeature
 GeoDataFeature (GeoDataFeaturePrivate *dd)
 
 GeoDataFeature (const GeoDataFeature &other, GeoDataFeaturePrivate *dd)
 
bool equals (const GeoDataFeature &other) const
 
- Protected Member Functions inherited from Marble::GeoDataObject
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 63 of file GeoDataDocument.h.

Member Function Documentation

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

Add a schema to simplemap storage.

Parameters
schemathe new schema

Definition at line 250 of file GeoDataDocument.cpp.

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

Add a style to the style storage.

Parameters
stylethe new style

Definition at line 173 of file GeoDataDocument.cpp.

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

Add a stylemap to the stylemap storage.

Parameters
mapthe new stylemap

Definition at line 219 of file GeoDataDocument.cpp.

QString Marble::GeoDataDocument::baseUri ( ) const

The URI relative paths should be resolved against.

Definition at line 149 of file GeoDataDocument.cpp.

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

Duplicate into another equal instance.

Implements Marble::GeoDataFeature.

Definition at line 108 of file GeoDataDocument.cpp.

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 137 of file GeoDataDocument.cpp.

bool Marble::GeoDataDocument::isGeoDataDocument ( ) const
inlineoverridevirtual

Provides type information for downcasting a GeoData.

Reimplemented from Marble::GeoDocument.

Definition at line 81 of file GeoDataDocument.h.

GeoDataNetworkLinkControl Marble::GeoDataDocument::networkLinkControl ( ) const

the NetworkLinkControl of the file

Definition at line 161 of file GeoDataDocument.cpp.

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

Provides type information for downcasting a GeoNode.

Implements Marble::GeoNode.

Definition at line 102 of file GeoDataDocument.cpp.

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

remove a schema from schema storage

Parameters
schemaIdthe of schema to be removed

Definition at line 257 of file GeoDataDocument.cpp.

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

Add a style to the style storage.

Parameters
styleIdthe new style

Definition at line 180 of file GeoDataDocument.cpp.

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

remove stylemap from storage

Parameters
mapIdthe styleId of the styleMap to be removed

Definition at line 226 of file GeoDataDocument.cpp.

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

Returns a schema with id = schemaId form schema storage.

Parameters
schemaIdThe id of schema to be returned

Definition at line 264 of file GeoDataDocument.cpp.

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

dump a vector of all schemas

Definition at line 276 of file GeoDataDocument.cpp.

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 155 of file GeoDataDocument.cpp.

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

Set a new file name for this document.

Parameters
valuethe new name

Definition at line 143 of file GeoDataDocument.cpp.

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

set the NetworkLinkControl of the file

Definition at line 167 of file GeoDataDocument.cpp.

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

Return a style in the style storage.

Parameters
styleIdthe id of the style

Definition at line 186 of file GeoDataDocument.cpp.

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

Return a style in the style storage.

Parameters
styleIdthe id of the style

Definition at line 232 of file GeoDataDocument.cpp.

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

dump a Vector of all stylemaps

Definition at line 244 of file GeoDataDocument.cpp.

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

dump a Vector of all styles

Definition at line 213 of file GeoDataDocument.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Sep 21 2020 23:20:58 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.