Marble::GeoDataDocument Class Reference

#include <GeoDataDocument.h>

Inheritance diagram for Marble::GeoDataDocument:

Public Member Functions
	GeoDataDocument ()
	GeoDataDocument (const GeoDataDocument &other)
	~GeoDataDocument ()
void	addSchema (const GeoDataSchema &schema)
void	addStyle (const GeoDataStyle &style)
void	addStyleMap (const GeoDataStyleMap &map)
QString	baseUri () const
DocumentRole	documentRole () const
QString	fileName () const
virtual bool	isGeoDataDocument () const
GeoDataNetworkLinkControl	networkLinkControl () const
bool	operator!= (const GeoDataDocument &other) const
bool	operator== (const GeoDataDocument &other) const
virtual void	pack (QDataStream &stream) const
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 (QString property)
GeoDataStyle &	style (const QString &styleId)
GeoDataStyle	style (const QString &styleId) const
GeoDataStyleMap &	styleMap (const QString &styleId)
GeoDataStyleMap	styleMap (const QString &styleId) const
QList< GeoDataStyleMap >	styleMaps () const
QList< GeoDataStyle >	styles () const
virtual void	unpack (QDataStream &stream)
Public Member Functions inherited from Marble::GeoDocument
virtual	~GeoDocument ()
virtual bool	isGeoSceneDocument () const
Public Member Functions inherited from Marble::GeoDataContainer
	GeoDataContainer ()
	GeoDataContainer (const GeoDataContainer &other)
virtual	~GeoDataContainer ()
void	append (GeoDataFeature *other)
GeoDataFeature &	at (int pos)
const GeoDataFeature &	at (int pos) const
QVector< GeoDataFeature * > ::Iterator	begin ()
GeoDataFeature *	child (int)
const GeoDataFeature *	child (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
GeoDataFeature &	first ()
const GeoDataFeature &	first () const
QVector< GeoDataFolder * >	folderList () const
void	insert (GeoDataFeature *other, int index)
GeoDataFeature &	last ()
const GeoDataFeature &	last () const
GeoDataLatLonAltBox	latLonAltBox () const
QVector< GeoDataPlacemark * >	placemarkList () const
void	remove (int index)
int	size () const
Public Member Functions inherited from Marble::GeoDataFeature
	GeoDataFeature ()
	GeoDataFeature (const QString &name)
	GeoDataFeature (const GeoDataFeature &other)
virtual	~GeoDataFeature ()
const GeoDataAbstractView *	abstractView () const
GeoDataAbstractView *	abstractView ()
QString	address () const
const GeoDataStyle *	customStyle () const
QString	description () const
bool	descriptionIsCDATA () const
virtual void	detach ()
GeoDataExtendedData &	extendedData () const
EnumFeatureId	featureId () const
bool	isGloballyVisible () const
bool	isVisible () const
QString	name () const
virtual const char *	nodeType () const
GeoDataFeature &	operator= (const GeoDataFeature &other)
QString	phoneNumber () const
qint64	popularity () 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 (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	setVisualCategory (GeoDataVisualCategory category)
void	setZoomLevel (int index)
GeoDataSnippet	snippet () const
const GeoDataStyle *	style () const
const GeoDataStyleMap *	styleMap () const
QString	styleUrl () const
const GeoDataTimeSpan &	timeSpan () const
GeoDataTimeSpan &	timeSpan ()
const GeoDataTimeStamp &	timeStamp () const
GeoDataTimeStamp &	timeStamp ()
GeoDataVisualCategory	visualCategory () const
int	zoomLevel () const
Public Member Functions inherited from Marble::GeoDataObject
	GeoDataObject ()
	GeoDataObject (const GeoDataObject &)
virtual	~GeoDataObject ()
QString	id () const
GeoDataObject &	operator= (const GeoDataObject &)
virtual GeoDataObject *	parent () const
QString	resolvePath (const QString &relativePath) const
void	setId (const QString &value)
virtual void	setParent (GeoDataObject *parent)
void	setTargetId (const QString &value)
QString	targetId () const
Public Member Functions inherited from Marble::GeoNode
	GeoNode ()
virtual	~GeoNode ()
Public Member Functions inherited from Marble::Serializable
virtual	~Serializable ()

Additional Inherited Members
Public Types inherited from Marble::GeoDataFeature
enum	GeoDataVisualCategory {   None, Default, Unknown, SmallCity,   SmallCountyCapital, SmallStateCapital, SmallNationCapital, MediumCity,   MediumCountyCapital, MediumStateCapital, MediumNationCapital, BigCity,   BigCountyCapital, BigStateCapital, BigNationCapital, LargeCity,   LargeCountyCapital, LargeStateCapital, LargeNationCapital, Nation,   Mountain, Volcano, Mons, Valley,   Continent, Ocean, OtherTerrain, Crater,   Mare, GeographicPole, MagneticPole, ShipWreck,   AirPort, Observatory, Wikipedia, OsmSite,   Coordinate, MannedLandingSite, RoboticRover, UnmannedSoftLandingSite,   UnmannedHardLandingSite, Folder, Bookmark, NaturalWater,   NaturalWood, HighwaySteps, HighwayUnknown, HighwayPath,   HighwayTrack, HighwayPedestrian, HighwayService, HighwayRoad,   HighwayTertiaryLink, HighwayTertiary, HighwaySecondaryLink, HighwaySecondary,   HighwayPrimaryLink, HighwayPrimary, HighwayTrunkLink, HighwayTrunk,   HighwayMotorwayLink, HighwayMotorway, Building, AccomodationCamping,   AccomodationHostel, AccomodationHotel, AccomodationMotel, AccomodationYouthHostel,   AmenityLibrary, EducationCollege, EducationSchool, EducationUniversity,   FoodBar, FoodBiergarten, FoodCafe, FoodFastFood,   FoodPub, FoodRestaurant, HealthDoctors, HealthHospital,   HealthPharmacy, MoneyAtm, MoneyBank, ShoppingBeverages,   ShoppingHifi, ShoppingSupermarket, TouristAttraction, TouristCastle,   TouristCinema, TouristMonument, TouristMuseum, TouristRuin,   TouristTheatre, TouristThemePark, TouristViewPoint, TouristZoo,   TransportAerodrome, TransportAirportTerminal, TransportBusStation, TransportBusStop,   TransportCarShare, TransportFuel, TransportParking, TransportRentalBicycle,   TransportRentalCar, TransportTaxiRank, TransportTrainStation, TransportTramStop,   ReligionPlaceOfWorship, ReligionBahai, ReligionBuddhist, ReligionChristian,   ReligionHindu, ReligionJain, ReligionJewish, ReligionShinto,   ReligionSikh, LeisurePark, LanduseAllotments, LanduseBasin,   LanduseCemetery, LanduseCommercial, LanduseConstruction, LanduseFarmland,   LanduseFarmyard, LanduseGarages, LanduseGrass, LanduseIndustrial,   LanduseLandfill, LanduseMeadow, LanduseMilitary, LanduseQuarry,   LanduseRailway, LanduseReservoir, LanduseResidential, LanduseRetail,   RailwayRail, RailwayTram, RailwayLightRail, RailwayAbandoned,   RailwaySubway, RailwayPreserved, RailwayMiniature, RailwayConstruction,   RailwayMonorail, RailwayFunicular, Satellite, LastIndex }
Static Public Member Functions inherited from Marble::GeoDataFeature
static QFont	defaultFont ()
static QColor	defaultLabelColor ()
static GeoDataVisualCategory	OsmVisualCategory (const QString &keyValue)
static void	resetDefaultStyles ()
static void	setDefaultFont (const QFont &font)
static void	setDefaultLabelColor (const QColor &color)
Protected Member Functions inherited from Marble::GeoDocument
	GeoDocument ()
Protected Member Functions inherited from Marble::GeoDataContainer
	GeoDataContainer (GeoDataContainerPrivate *priv)
bool	equals (const GeoDataContainer &other) const
Protected Member Functions inherited from Marble::GeoDataFeature
	GeoDataFeature (GeoDataFeaturePrivate *priv)
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 *	d

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 65 of file GeoDataDocument.h.

Constructor & Destructor Documentation

Marble::GeoDataDocument::GeoDataDocument

(

)

Definition at line 39 of file GeoDataDocument.cpp.

Marble::GeoDataDocument::GeoDataDocument

(

const GeoDataDocument &

other

)

Definition at line 44 of file GeoDataDocument.cpp.

Marble::GeoDataDocument::~GeoDataDocument

(

)

Definition at line 49 of file GeoDataDocument.cpp.

Member Function Documentation

void Marble::GeoDataDocument::addSchema

(

const GeoDataSchema &

schema

)

Add a schema to simplemap storage.

Parameters

schema

the new schema

Definition at line 194 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::addStyle

(

const GeoDataStyle &

style

)

Add a style to the style storage.

Parameters

style

the new style

Definition at line 134 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::addStyleMap

(

const GeoDataStyleMap &

map

)

Add a stylemap to the stylemap storage.

Parameters

map	the new stylemap

Definition at line 166 of file GeoDataDocument.cpp.

QString Marble::GeoDataDocument::baseUri

(

)

const

The URI relative paths should be resolved against.

Definition at line 112 of file GeoDataDocument.cpp.

DocumentRole Marble::GeoDataDocument::documentRole

(

)

const

Definition at line 81 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 101 of file GeoDataDocument.cpp.

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

inlinevirtual

Provides type information for downcasting a GeoData.

Reimplemented from Marble::GeoDocument.

Definition at line 77 of file GeoDataDocument.h.

GeoDataNetworkLinkControl Marble::GeoDataDocument::networkLinkControl

(

)

const

the NetworkLinkControl of the file

Definition at line 123 of file GeoDataDocument.cpp.

bool Marble::GeoDataDocument::operator!=

(

const GeoDataDocument &

other

)

const

Definition at line 76 of file GeoDataDocument.cpp.

bool Marble::GeoDataDocument::operator==

(

const GeoDataDocument &

other

)

const

Definition at line 63 of file GeoDataDocument.cpp.

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

virtual

Serialize the container to a stream.

Parameters

stream

the stream

Reimplemented from Marble::GeoDataContainer.

Definition at line 223 of file GeoDataDocument.cpp.

QString Marble::GeoDataDocument::property

(

)

const

Definition at line 91 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::removeSchema

(

const QString &

schemaId

)

remove a schema from schema storage

Parameters

schemaId

the of schema to be removed

Definition at line 201 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::removeStyle

(

const QString &

styleId

)

Add a style to the style storage.

Parameters

style

the new style

Definition at line 141 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::removeStyleMap

(

const QString &

mapId

)

remove stylemap from storage

Parameters

mapId

the styleId of the styleMap to be removed

Definition at line 173 of file GeoDataDocument.cpp.

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

GeoDataSchema & Marble::GeoDataDocument::schema

(

const QString &

schemaId

)

Definition at line 213 of file GeoDataDocument.cpp.

QList< GeoDataSchema > Marble::GeoDataDocument::schemas

(

)

const

dump a vector of all schemas

Definition at line 218 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::setBaseUri

(

const QString &

baseUri

)

Change the URI for resolving relative paths.

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

Definition at line 117 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::setDocumentRole

(

DocumentRole

role

)

Definition at line 86 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::setFileName

(

const QString &

value

)

Set a new file name for this document.

Parameters

value

the new name

Definition at line 106 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::setNetworkLinkControl

(

const GeoDataNetworkLinkControl &

networkLinkControl

)

set the NetworkLinkControl of the file

Definition at line 128 of file GeoDataDocument.cpp.

void Marble::GeoDataDocument::setProperty

(

QString

property

)

Definition at line 96 of file GeoDataDocument.cpp.

GeoDataStyle & Marble::GeoDataDocument::style

(

const QString &

styleId

)

Return a style in the style storage.

Parameters

styleId

the id of the style

Definition at line 147 of file GeoDataDocument.cpp.

GeoDataStyle Marble::GeoDataDocument::style

(

const QString &

styleId

)

const

Definition at line 156 of file GeoDataDocument.cpp.

GeoDataStyleMap & Marble::GeoDataDocument::styleMap

(

const QString &

styleId

)

Return a style in the style storage.

Parameters

styleId

the id of the style

Definition at line 179 of file GeoDataDocument.cpp.

GeoDataStyleMap Marble::GeoDataDocument::styleMap

(

const QString &

styleId

)

const

Definition at line 184 of file GeoDataDocument.cpp.

QList< GeoDataStyleMap > Marble::GeoDataDocument::styleMaps

(

)

const

dump a Vector of all styles

Definition at line 189 of file GeoDataDocument.cpp.

QList< GeoDataStyle > Marble::GeoDataDocument::styles

(

)

const

dump a Vector of all styles

Definition at line 161 of file GeoDataDocument.cpp.

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

virtual

Unserialize the container from a stream.

Parameters

stream

the stream

Reimplemented from Marble::GeoDataContainer.

Definition at line 239 of file GeoDataDocument.cpp.

---

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

• GeoDataDocument.h
• GeoDataDocument.cpp