#include <GeoDataFeature.h>

Inheritance diagram for Marble::GeoDataFeature:

Public Types
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 }

Public Member Functions
	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)

virtual void	pack (QDataStream &stream) const

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

virtual void	unpack (QDataStream &stream)

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

Static Public Member Functions
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
	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
GeoDataFeaturePrivate *	d

Detailed Description

A base class for all geodata features.

GeoDataFeature is the base class for most geodata classes that correspond to places on a map. It is never instantiated by itself, but is always used as part of a derived class.

See also: GeoDataPlacemark; GeoDataContainer

Definition at line 57 of file GeoDataFeature.h.

Member Enumeration Documentation

enum Marble::GeoDataFeature::GeoDataVisualCategory

A categorization of a placemark as defined by ...FIXME.

Enumerator
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

Definition at line 77 of file GeoDataFeature.h.

Constructor & Destructor Documentation

Marble::GeoDataFeature::GeoDataFeature ( )

Definition at line 42 of file GeoDataFeature.cpp.

Marble::GeoDataFeature::GeoDataFeature ( const QString & name )

explicit

Create a new GeoDataFeature with name as its name.

Definition at line 55 of file GeoDataFeature.cpp.

Marble::GeoDataFeature::GeoDataFeature ( const GeoDataFeature & other )

Definition at line 48 of file GeoDataFeature.cpp.

Marble::GeoDataFeature::~GeoDataFeature ( )

virtual

Definition at line 68 of file GeoDataFeature.cpp.

Marble::GeoDataFeature::GeoDataFeature ( GeoDataFeaturePrivate * priv )

protected

Definition at line 62 of file GeoDataFeature.cpp.

Member Function Documentation

const GeoDataAbstractView * Marble::GeoDataFeature::abstractView ( ) const

Get the Abstract view of the feature.

Definition at line 610 of file GeoDataFeature.cpp.

GeoDataAbstractView * Marble::GeoDataFeature::abstractView ( )

Definition at line 615 of file GeoDataFeature.cpp.

QString Marble::GeoDataFeature::address ( ) const

Return the address of the feature.

Definition at line 566 of file GeoDataFeature.cpp.

const GeoDataStyle * Marble::GeoDataFeature::customStyle ( ) const

Return the style assigned to the placemark with setStyle (can be 0)

Definition at line 730 of file GeoDataFeature.cpp.

QFont Marble::GeoDataFeature::defaultFont ( )

static

Definition at line 522 of file GeoDataFeature.cpp.

QColor Marble::GeoDataFeature::defaultLabelColor ( )

static

Definition at line 533 of file GeoDataFeature.cpp.

QString Marble::GeoDataFeature::description ( ) const

Return the text description of the feature.

Definition at line 588 of file GeoDataFeature.cpp.

bool Marble::GeoDataFeature::descriptionIsCDATA ( ) const

test if the description is CDATA or not CDATA allows for special characters to be included in XML and also allows for other XML formats to be embedded in the XML without interfering with parser namespace.

Returns: if the description should be treated as CDATA if the description is a plain string

Definition at line 599 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::detach ( )

virtual

Definition at line 824 of file GeoDataFeature.cpp.

bool Marble::GeoDataFeature::equals ( const GeoDataFeature & other ) const

protected

Definition at line 94 of file GeoDataFeature.cpp.

GeoDataExtendedData & Marble::GeoDataFeature::extendedData ( ) const

Return the ExtendedData assigned to the feature.

Definition at line 743 of file GeoDataFeature.cpp.

EnumFeatureId Marble::GeoDataFeature::featureId ( ) const

Definition at line 163 of file GeoDataFeature.cpp.

bool Marble::GeoDataFeature::isGloballyVisible ( ) const

Return whether this feature is visible or not in the context of its parenting.

Definition at line 667 of file GeoDataFeature.cpp.

bool Marble::GeoDataFeature::isVisible ( ) const

Return whether this feature is visible or not.

Definition at line 656 of file GeoDataFeature.cpp.

QString Marble::GeoDataFeature::name ( ) const

The name of the feature.

The name of the feature should be a short string. It is often shown directly on the map and need therefore not take up much space.

Returns: The name of this feature

Definition at line 544 of file GeoDataFeature.cpp.

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

virtual

Provides type information for downcasting a GeoData.

Implements Marble::GeoDataObject.

Reimplemented in Marble::GeoDataNetworkLinkControl, Marble::GeoDataChange, Marble::GeoDataCreate, Marble::GeoDataDelete, Marble::GeoDataPhotoOverlay, Marble::GeoDataTour, Marble::GeoDataNetworkLink, Marble::GeoDataGroundOverlay, and Marble::GeoDataScreenOverlay.

Definition at line 158 of file GeoDataFeature.cpp.

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

Definition at line 80 of file GeoDataFeature.cpp.

GeoDataFeature::GeoDataVisualCategory Marble::GeoDataFeature::OsmVisualCategory ( const QString & keyValue )

static

Convenience categorization of placemarks for Osm key=value pairs.

Definition at line 875 of file GeoDataFeature.cpp.

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

virtual

Serialize the contents of the feature to stream.

Reimplemented from Marble::GeoDataObject.

Reimplemented in Marble::GeoDataDocument, Marble::GeoDataPlacemark, and Marble::GeoDataContainer.

Definition at line 844 of file GeoDataFeature.cpp.

QString Marble::GeoDataFeature::phoneNumber ( ) const

Return the phone number of the feature.

Definition at line 577 of file GeoDataFeature.cpp.

qint64 Marble::GeoDataFeature::popularity ( ) const

Return the popularity of the feature.

Definition at line 808 of file GeoDataFeature.cpp.

GeoDataRegion & Marble::GeoDataFeature::region ( ) const

Return the region assigned to the placemark.

Definition at line 754 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::resetDefaultStyles ( )

static

Return the label font of the placemark.

Definition at line 819 of file GeoDataFeature.cpp.

const QString Marble::GeoDataFeature::role ( ) const

Return the role of the placemark.

FIXME: describe roles here!

Definition at line 776 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setAbstractView ( GeoDataAbstractView * abstractView )

Set the abstract view of the feature.

Definition at line 620 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setAddress ( const QString & value )

Set the address of this feature to value.

Definition at line 571 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setDefaultFont ( const QFont & font )

static

Definition at line 527 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setDefaultLabelColor ( const QColor & color )

static

Definition at line 538 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setDescription ( const QString & value )

Set the description of this feature to value.

Definition at line 593 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setDescriptionCDATA ( bool cdata )

Set the description to be CDATA See:

See also: descriptionIsCDATA()

Definition at line 604 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setExtendedData ( const GeoDataExtendedData & extendedData )

Sets the ExtendedData of the feature.

Parameters

extendedData the new ExtendedData to be used.

Definition at line 748 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setName ( const QString & value )

Set a new name for this feature.

Parameters

value the new name

Definition at line 549 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setPhoneNumber ( const QString & value )

Set the phone number of this feature to value.

Definition at line 582 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setPopularity ( qint64 popularity )

Sets the popularity of the feature.

Parameters

popularity the new popularity value

Definition at line 813 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setRegion ( const GeoDataRegion & region )

Sets the region of the placemark.

Parameters

region new value for the region

The feature is only shown when the region if active.

Definition at line 759 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setRole ( const QString & role )

Sets the role of the placemark.

Parameters

role	the new role to be used.

Definition at line 781 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setSnippet ( const GeoDataSnippet & value )

Set a new name for this feature.

Parameters

value the new name

Definition at line 560 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setStyle ( GeoDataStyle * style )

Sets the style of the placemark.

Parameters

style the new style to be used.

Definition at line 735 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setStyleMap ( const GeoDataStyleMap * map )

Sets the styleMap of the feature.

Definition at line 792 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setStyleUrl ( const QString & value )

Set the styleUrl of this feature to value.

Definition at line 631 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setTimeSpan ( const GeoDataTimeSpan & timeSpan )

Set the timespan of the feature.

Parameters

timeSpan new of timespan.

Definition at line 687 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setTimeStamp ( const GeoDataTimeStamp & timeStamp )

Set the timestamp of the feature.

Parameters

timeStamp new of the timestamp.

Definition at line 703 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setVisible ( bool value )

Set a new value for visibility.

Parameters

value new value for the visibility

This function sets the visibility, i.e. whether this feature should be shown or not. This can be changed either from a GUI or through some action of the program.

Definition at line 661 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setVisualCategory ( GeoDataFeature::GeoDataVisualCategory index )

Sets the symbol index of the placemark.

Parameters

category the new category to be used.

Definition at line 770 of file GeoDataFeature.cpp.

void Marble::GeoDataFeature::setZoomLevel ( int index )

Sets the popularity index of the placemark.

Parameters

index the new index to be used.

Definition at line 802 of file GeoDataFeature.cpp.

GeoDataSnippet Marble::GeoDataFeature::snippet ( ) const

A short description of the feature.

HTML markup is not supported. When the Snippet is not supplied, the first lines of description should be used.

Returns: The name of this feature

Definition at line 555 of file GeoDataFeature.cpp.

const GeoDataStyle * Marble::GeoDataFeature::style ( ) const

Return the style assigned to the placemark, or a default style if none has been set.

Definition at line 709 of file GeoDataFeature.cpp.

const GeoDataStyleMap * Marble::GeoDataFeature::styleMap ( ) const

Return a pointer to a GeoDataStyleMap object which represents the styleMap of this feature.

A styleMap is simply a QMap<QString,QString> which can connect two styles with a keyword. This can be used to have a highlighted and a normal style.

See also: GeoDataStyleMap

Definition at line 787 of file GeoDataFeature.cpp.

QString Marble::GeoDataFeature::styleUrl ( ) const

Return the styleUrl of the feature.

Definition at line 626 of file GeoDataFeature.cpp.

const GeoDataTimeSpan & Marble::GeoDataFeature::timeSpan ( ) const

Return the timespan of the feature.

Definition at line 677 of file GeoDataFeature.cpp.

GeoDataTimeSpan & Marble::GeoDataFeature::timeSpan ( )

Definition at line 682 of file GeoDataFeature.cpp.

const GeoDataTimeStamp & Marble::GeoDataFeature::timeStamp ( ) const

Return the timestamp of the feature.

Definition at line 693 of file GeoDataFeature.cpp.

GeoDataTimeStamp & Marble::GeoDataFeature::timeStamp ( )

Definition at line 698 of file GeoDataFeature.cpp.

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

virtual

Unserialize the contents of the feature from stream.

Reimplemented from Marble::GeoDataObject.

Reimplemented in Marble::GeoDataPlacemark, Marble::GeoDataDocument, and Marble::GeoDataContainer.

Definition at line 859 of file GeoDataFeature.cpp.

GeoDataFeature::GeoDataVisualCategory Marble::GeoDataFeature::visualCategory ( ) const

Return the symbol index of the placemark.

Definition at line 765 of file GeoDataFeature.cpp.

int Marble::GeoDataFeature::zoomLevel ( ) const

Return the popularity index of the placemark.

The popularity index is a value which describes at which zoom level the placemark will be shown.

Definition at line 797 of file GeoDataFeature.cpp.

Member Data Documentation

GeoDataFeaturePrivate* Marble::GeoDataFeature::d

protected

Definition at line 506 of file GeoDataFeature.h.

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

marble

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

marble

kdeedu API Reference

Search