KGAPI2::StaticMapPath

KGAPI2::StaticMapPath Class Reference

#include <staticmappath.h>

Public Types

enum  LocationType { Undefined = -1, String, KABCAddress, KABCGeo }
 

Public Member Functions

 StaticMapPath ()
 
 StaticMapPath (const QStringList &locations, const quint8 weight=5, const QColor &color=Qt::blue, const QColor &fillColor=QColor())
 
 StaticMapPath (const KContacts::Address::List &locations, const quint8 weight=5, const QColor &color=Qt::blue, const QColor &fillColor=QColor())
 
 StaticMapPath (const QList< KContacts::Geo > &locations, const quint8 weight=5, const QColor &color=Qt::blue, const QColor &fillColor=QColor())
 
 StaticMapPath (const StaticMapPath &other)
 
 ~StaticMapPath ()
 
QColor color () const
 
QColor fillColor () const
 
bool isValid () const
 
KContacts::Address::List locationsAddress () const
 
QList< KContacts::GeolocationsGeo () const
 
QStringList locationsString () const
 
LocationType locationType () const
 
StaticMapPathoperator= (const StaticMapPath &other)
 
void setColor (const QColor &color)
 
void setFillColor (const QColor &color)
 
void setLocations (const QStringList &locations)
 
void setLocations (const KContacts::Address::List &locations)
 
void setLocations (const QList< KContacts::Geo > &locations)
 
void setWeight (const quint8 weight)
 
QString toString () const
 
quint8 weight () const
 

Detailed Description

Represents path with defined locations, weight, color and color for filled area.

Author
Jan Grulich grulj[email protected][email protected][email protected]ail.c[email protected]om
Since
0.4

Definition at line 28 of file staticmappath.h.

Constructor & Destructor Documentation

StaticMapPath::StaticMapPath ( )
explicit

Constructs an empty path.

Definition at line 54 of file staticmappath.cpp.

StaticMapPath::StaticMapPath ( const QStringList locations,
const quint8  weight = 5,
const QColor color = Qt::blue,
const QColor fillColor = QColor() 
)
explicit

Constructs a new path.

Parameters
locationsThe path locations in QString
weightThe thickness of the path in pixels
colorThe color of the path
fillColorThe color of filled area

Definition at line 64 of file staticmappath.cpp.

StaticMapPath::StaticMapPath ( const KContacts::Address::List locations,
const quint8  weight = 5,
const QColor color = Qt::blue,
const QColor fillColor = QColor() 
)
explicit

Constructs a new path.

Parameters
locationsThe path locations in KContacts::Address
weightThe thickness of the path in pixels
colorColor of the path
fillColorThe color of filled area

Definition at line 75 of file staticmappath.cpp.

StaticMapPath::StaticMapPath ( const QList< KContacts::Geo > &  locations,
const quint8  weight = 5,
const QColor color = Qt::blue,
const QColor fillColor = QColor() 
)
explicit

Constructs a new path.

Parameters
locationsThe path locations in KContacts::Geo
weightThe thickness of the path in pixels
colorThe color of the path
fillColorThe color of filled area

Definition at line 86 of file staticmappath.cpp.

StaticMapPath::StaticMapPath ( const StaticMapPath other)

Copy constructor.

Definition at line 59 of file staticmappath.cpp.

StaticMapPath::~StaticMapPath ( )

Destructor.

Definition at line 97 of file staticmappath.cpp.

Member Function Documentation

QColor StaticMapPath::color ( ) const

Returns the color of path.

Definition at line 107 of file staticmappath.cpp.

QColor StaticMapPath::fillColor ( ) const

Returns the color of filled area.

Definition at line 122 of file staticmappath.cpp.

bool StaticMapPath::isValid ( ) const

Returns whether the path is valid.

This means that path has at least two locations

Definition at line 117 of file staticmappath.cpp.

KContacts::Address::List StaticMapPath::locationsAddress ( ) const

Returns locations in KContacts::Address.

Returns empty list if is not defined

Definition at line 145 of file staticmappath.cpp.

QList< KContacts::Geo > StaticMapPath::locationsGeo ( ) const

Returns locations in KContacts::Geo.

Returns empty list if is not defined

Definition at line 158 of file staticmappath.cpp.

QStringList StaticMapPath::locationsString ( ) const

Returns locations in QString.

Returns empty list if is not defined

Definition at line 132 of file staticmappath.cpp.

StaticMapPath::LocationType StaticMapPath::locationType ( ) const

Location type.

Definition at line 102 of file staticmappath.cpp.

StaticMapPath & StaticMapPath::operator= ( const StaticMapPath other)

Assignment operator.

Definition at line 222 of file staticmappath.cpp.

void StaticMapPath::setColor ( const QColor color)

Sets color of the path.

Parameters
colorColor for path

Definition at line 112 of file staticmappath.cpp.

void StaticMapPath::setFillColor ( const QColor color)

Sets color for filled area in path.

Parameters
colorThe color for filled area

Definition at line 127 of file staticmappath.cpp.

void StaticMapPath::setLocations ( const QStringList locations)

Sets locations for path.

Parameters
locationsLocations for path in QString

Definition at line 137 of file staticmappath.cpp.

void StaticMapPath::setLocations ( const KContacts::Address::List locations)

Sets locations for path.

Parameters
locationsLocations for path in KContacts::Address

Definition at line 150 of file staticmappath.cpp.

void StaticMapPath::setLocations ( const QList< KContacts::Geo > &  locations)

Sets locations for path.

Parameters
locationsLocations for path in KContacts::Geo

Definition at line 163 of file staticmappath.cpp.

void StaticMapPath::setWeight ( const quint8  weight)

Sets weight of the path.

Parameters
weightThe thickness of the path in pixels

Definition at line 217 of file staticmappath.cpp.

QString StaticMapPath::toString ( ) const

Returns all locations and path preferences in format to URL query.

Definition at line 171 of file staticmappath.cpp.

quint8 StaticMapPath::weight ( ) const

Returns weight of the path.

Definition at line 212 of file staticmappath.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 Wed Aug 12 2020 23:09:49 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.