• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

marble/src

GeoDataFeature Class Reference

#include <GeoDataFeature.h>

Inheritance diagram for GeoDataFeature:

Inheritance graph
[legend]

List of all members.

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 41 of file GeoDataFeature.h.


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, Continent, Ocean,
  GeographicPole, MagneticPole, ShipWreck, AirPort,
  LastIndex
}

Public Member Functions

 GeoDataFeature ()
virtual ~GeoDataFeature ()
QString name () const
void setName (const QString &value)
QString address () const
void setAddress (const QString &value)
QString phoneNumber () const
void setPhoneNumber (const QString &value)
QString description () const
void setDescription (const QString &value)
bool isVisible () const
void setVisible (bool value)
GeoDataStyle * style () const
void setStyle (GeoDataStyle *style)
const GeoDataVisualCategory visualCategory () const
void setVisualCategory (GeoDataVisualCategory category)
const QChar role () const
void setRole (const QChar &role)
const int popularityIndex () const
void setPopularityIndex (int index)
const qint64 popularity () const
void setPopularity (qint64 popularity)
const QSize symbolSize () const
const QPixmap symbolPixmap () const
virtual void pack (QDataStream &stream) const
virtual void unpack (QDataStream &stream)

Static Public Member Functions

static void resetDefaultStyles ()

Protected Member Functions

 GeoDataFeature (const QString &name)

Protected Attributes

GeoDataVisualCategory m_visualCategory

Member Enumeration Documentation

enum 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 
Continent 
Ocean 
GeographicPole 
MagneticPole 
ShipWreck 
AirPort 
LastIndex 

Definition at line 48 of file GeoDataFeature.h.

Constructor & Destructor Documentation

GeoDataFeature::GeoDataFeature (  ) 

Definition at line 28 of file GeoDataFeature.cpp.

GeoDataFeature::~GeoDataFeature (  )  [virtual]

Definition at line 49 of file GeoDataFeature.cpp.

GeoDataFeature::GeoDataFeature ( const QString &  name  )  [protected]

Create a new GeoDataFeature with name as its name.

Definition at line 38 of file GeoDataFeature.cpp.

Member Function Documentation

QString 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 217 of file GeoDataFeature.cpp.

void GeoDataFeature::setName ( const QString &  value  ) 

Set a new name for this feature.

Parameters:
value the new name

Definition at line 222 of file GeoDataFeature.cpp.

QString GeoDataFeature::address (  )  const

Return the address of the feature.

Definition at line 227 of file GeoDataFeature.cpp.

void GeoDataFeature::setAddress ( const QString &  value  ) 

Set the address of this feature to value.

Definition at line 232 of file GeoDataFeature.cpp.

QString GeoDataFeature::phoneNumber (  )  const

Return the phone number of the feature.

Definition at line 237 of file GeoDataFeature.cpp.

void GeoDataFeature::setPhoneNumber ( const QString &  value  ) 

Set the phone number of this feature to value.

Definition at line 242 of file GeoDataFeature.cpp.

QString GeoDataFeature::description (  )  const

Return the text description of the feature.

Definition at line 247 of file GeoDataFeature.cpp.

void GeoDataFeature::setDescription ( const QString &  value  ) 

Set the description of this feature to value.

Definition at line 252 of file GeoDataFeature.cpp.

bool GeoDataFeature::isVisible (  )  const

Return whether this feature is visible or not.

Definition at line 257 of file GeoDataFeature.cpp.

void 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 262 of file GeoDataFeature.cpp.

GeoDataStyle * GeoDataFeature::style (  )  const

Return the style assigned to the placemark.

Definition at line 267 of file GeoDataFeature.cpp.

void GeoDataFeature::setStyle ( GeoDataStyle *  style  ) 

Sets the style of the placemark.

Parameters:
style the new style to be used.

Definition at line 290 of file GeoDataFeature.cpp.

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

Return the symbol index of the placemark.

Definition at line 295 of file GeoDataFeature.cpp.

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

Sets the symbol index of the placemark.

Parameters:
category the new category to be used.

Definition at line 300 of file GeoDataFeature.cpp.

const QChar GeoDataFeature::role (  )  const

Return the role of the placemark.

FIXME: describe roles here!

Definition at line 305 of file GeoDataFeature.cpp.

void GeoDataFeature::setRole ( const QChar &  role  ) 

Sets the role of the placemark.

Parameters:
role the new role to be used.

Definition at line 310 of file GeoDataFeature.cpp.

const int GeoDataFeature::popularityIndex (  )  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 315 of file GeoDataFeature.cpp.

void GeoDataFeature::setPopularityIndex ( int  index  ) 

Sets the popularity index of the placemark.

Parameters:
index the new index to be used.

Definition at line 320 of file GeoDataFeature.cpp.

const qint64 GeoDataFeature::popularity (  )  const

Return the popularity of the feature.

Definition at line 325 of file GeoDataFeature.cpp.

void GeoDataFeature::setPopularity ( qint64  popularity  ) 

Sets the popularity of the feature.

Parameters:
popularity the new popularity value

Definition at line 330 of file GeoDataFeature.cpp.

const QSize GeoDataFeature::symbolSize (  )  const

Return the symbol size of the feature in pixels.

Definition at line 335 of file GeoDataFeature.cpp.

const QPixmap GeoDataFeature::symbolPixmap (  )  const

Return the symbol of the feature as a pixmap.

Note that the pixmaps are shared between all features with the same visual category

Definition at line 343 of file GeoDataFeature.cpp.

void GeoDataFeature::resetDefaultStyles (  )  [static]

Return the label font of the placemark.

Definition at line 351 of file GeoDataFeature.cpp.

void GeoDataFeature::pack ( QDataStream &  stream  )  const [virtual]

Serialize the contents of the feature to stream.

Reimplemented from GeoDataObject.

Reimplemented in GeoDataContainer, and GeoDataPlacemark.

Definition at line 356 of file GeoDataFeature.cpp.

void GeoDataFeature::unpack ( QDataStream &  stream  )  [virtual]

Unserialize the contents of the feature from stream.

Reimplemented from GeoDataObject.

Reimplemented in GeoDataContainer, and GeoDataPlacemark.

Definition at line 368 of file GeoDataFeature.cpp.

Member Data Documentation

GeoDataVisualCategory GeoDataFeature::m_visualCategory [protected]

The visual category of this feature.

See also:
GeoDataVisualCategory

Definition at line 224 of file GeoDataFeature.h.

The documentation for this class was generated from the following files:
  • GeoDataFeature.h
  • GeoDataFeature.cpp

marble/src

Skip menu "marble/src"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal