Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QGeoMapType Class Reference

#include <qgeomaptype_p.h>

Inheritance diagram for QGeoMapType:
Collaboration diagram for QGeoMapType:

Public Types

enum  MapStyle {
  NoMap = 0 , StreetMap , SatelliteMapDay , SatelliteMapNight ,
  TerrainMap , HybridMap , TransitMap , GrayStreetMap ,
  PedestrianMap , CarNavigationMap , CycleMap , CustomMap = 100
}

Public Member Functions

 QGeoMapType ()
 \qmltype mapType \inqmlmodule QtLocation
 QGeoMapType (const QGeoMapType &other) noexcept
 QGeoMapType (QGeoMapType &&other) noexcept=default
 QGeoMapType (MapStyle style, const QString &name, const QString &description, bool mobile, bool night, int mapId, const QByteArray &pluginName, const QGeoCameraCapabilities &cameraCapabilities, const QVariantMap &metadata=QVariantMap())
 ~QGeoMapType ()
QGeoMapType & operator= (const QGeoMapType &other) noexcept
void swap (QGeoMapType &other) noexcept
MapStyle style () const
 \qmlproperty enumeration mapType::style
QString name () const
 \qmlproperty string mapType::name
QString description () const
 \qmlproperty string mapType::description
bool mobile () const
 \qmlproperty bool mapType::mobile
bool night () const
 \qmlproperty bool mapType::night
int mapId () const
QByteArray pluginName () const
QGeoCameraCapabilities cameraCapabilities () const
 \qmlproperty CameraCapabilities mapType::cameraCapabilities
QVariantMap metadata () const
 \qmlproperty VariantMap mapType::metadata

Properties

QML_STRUCTURED_VALUEMapStyle style
QString name
QString description
bool mobile
bool night
QGeoCameraCapabilities cameraCapabilities
QVariantMap metadata

Friends

bool operator== (const QGeoMapType &lhs, const QGeoMapType &rhs) noexcept
bool operator!= (const QGeoMapType &lhs, const QGeoMapType &rhs) noexcept

Detailed Description

Definition at line 31 of file qgeomaptype_p.h.

Member Enumeration Documentation

◆ MapStyle

enum QGeoMapType::MapStyle
Enumerator
NoMap 
StreetMap 
SatelliteMapDay 
SatelliteMapNight 
TerrainMap 
HybridMap 
TransitMap 
GrayStreetMap 
PedestrianMap 
CarNavigationMap 
CycleMap 
CustomMap 

Definition at line 48 of file qgeomaptype_p.h.

Constructor & Destructor Documentation

◆ QGeoMapType() [1/4]

QT_BEGIN_NAMESPACE QGeoMapType::QGeoMapType ( )

\qmltype mapType \inqmlmodule QtLocation

Since
QtLocation 5.5

The mapType type holds information about a map type.

This includes the map type's \l name and \l description, the \l style and a flag to indicate if the map type is optimized for mobile devices (\l mobile).

Definition at line 23 of file qgeomaptype.cpp.

◆ QGeoMapType() [2/4]

QGeoMapType::QGeoMapType ( const QGeoMapType & other)
defaultnoexcept

◆ QGeoMapType() [3/4]

QGeoMapType::QGeoMapType ( QGeoMapType && other)
defaultnoexcept

◆ QGeoMapType() [4/4]

QGeoMapType::QGeoMapType ( QGeoMapType::MapStyle style,
const QString & name,
const QString & description,
bool mobile,
bool night,
int mapId,
const QByteArray & pluginName,
const QGeoCameraCapabilities & cameraCapabilities,
const QVariantMap & metadata = QVariantMap() )

Definition at line 28 of file qgeomaptype.cpp.

◆ ~QGeoMapType()

QGeoMapType::~QGeoMapType ( )
default

Member Function Documentation

◆ cameraCapabilities()

QGeoCameraCapabilities QGeoMapType::cameraCapabilities ( ) const

\qmlproperty CameraCapabilities mapType::cameraCapabilities

Since
QtLocation 5.10

This property holds the camera capabilities for this map type.

Definition at line 143 of file qgeomaptype.cpp.

◆ description()

QString QGeoMapType::description ( ) const

\qmlproperty string mapType::description

This read-only property holds the description of the map type as a single formatted string.

Definition at line 95 of file qgeomaptype.cpp.

◆ mapId()

int QGeoMapType::mapId ( ) const

Definition at line 126 of file qgeomaptype.cpp.

◆ metadata()

QVariantMap QGeoMapType::metadata ( ) const

\qmlproperty VariantMap mapType::metadata

Since
QtLocation 5.10

This property holds optional, extra metadata related to a specific map type. The content of this property is entirely plugin-specific.

Definition at line 155 of file qgeomaptype.cpp.

◆ mobile()

bool QGeoMapType::mobile ( ) const

\qmlproperty bool mapType::mobile

Whether the map type is optimized for the use on a mobile device.

Map types for mobile devices usually have higher constrast to counteract the effects of sunlight and a reduced color for improved readability.

Definition at line 108 of file qgeomaptype.cpp.

◆ name()

QString QGeoMapType::name ( ) const

\qmlproperty string mapType::name

This read-only property holds the name of the map type as a single formatted string.

Definition at line 84 of file qgeomaptype.cpp.

◆ night()

bool QGeoMapType::night ( ) const

\qmlproperty bool mapType::night

Since
QtLocation 5.4

Whether the map type is optimized for use at night.

Map types suitable for use at night usually have a dark background.

Definition at line 121 of file qgeomaptype.cpp.

◆ operator=()

QGeoMapType & QGeoMapType::operator= ( const QGeoMapType & other)
noexcept

Definition at line 39 of file qgeomaptype.cpp.

◆ pluginName()

QByteArray QGeoMapType::pluginName ( ) const

Definition at line 131 of file qgeomaptype.cpp.

◆ style()

QGeoMapType::MapStyle QGeoMapType::style ( ) const

\qmlproperty enumeration mapType::style

This read-only property gives access to the style of the map type.

\list

  • MapType.NoMap - No map.
  • MapType.StreetMap - A street map.
  • MapType.SatelliteMapDay - A map with day-time satellite imagery.
  • MapType.SatelliteMapNight - A map with night-time satellite imagery.
  • MapType.TerrainMap - A terrain map.
  • MapType.HybridMap - A map with satellite imagery and street information.
  • MapType.GrayStreetMap - A gray-shaded street map.
  • MapType.PedestrianMap - A street map suitable for pedestriants.
  • MapType.CarNavigationMap - A street map suitable for car navigation.
  • MapType.CycleMap - A street map suitable for cyclists.
  • MapType.CustomMap - A custom map type. \endlist

Definition at line 73 of file qgeomaptype.cpp.

◆ swap()

void QGeoMapType::swap ( QGeoMapType & other)
inlinenoexcept

Definition at line 75 of file qgeomaptype_p.h.

◆ operator!=

bool operator!= ( const QGeoMapType & lhs,
const QGeoMapType & rhs )
friend

Definition at line 79 of file qgeomaptype_p.h.

◆ operator==

bool operator== ( const QGeoMapType & lhs,
const QGeoMapType & rhs )
friend

Definition at line 77 of file qgeomaptype_p.h.

Property Documentation

◆ cameraCapabilities

QGeoCameraCapabilities QGeoMapType::cameraCapabilities
read

Definition at line 43 of file qgeomaptype_p.h.

◆ description

QString QGeoMapType::description
read

Definition at line 40 of file qgeomaptype_p.h.

◆ metadata

QVariantMap QGeoMapType::metadata
read

Definition at line 44 of file qgeomaptype_p.h.

◆ mobile

bool QGeoMapType::mobile
read

Definition at line 41 of file qgeomaptype_p.h.

◆ name

QString QGeoMapType::name
read

Definition at line 39 of file qgeomaptype_p.h.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

◆ night

bool QGeoMapType::night
read

Definition at line 42 of file qgeomaptype_p.h.

◆ style

QML_STRUCTURED_VALUEMapStyle QGeoMapType::style
read

Definition at line 38 of file qgeomaptype_p.h.

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