Qt Mobility Reference Documentation

QGeoNavigationInstruction Class Reference

The QGeoNavigationInstruction class represents a navigation instruction. More...

 #include <QGeoNavigationInstruction>

Public Functions

QGeoNavigationInstruction ()
QGeoNavigationInstruction ( const QGeoNavigationInstruction & other )
~QGeoNavigationInstruction ()
qreal distanceToNextInstruction () const
QString instructionText () const
QGeoCoordinate position () const
void setDistanceToNextInstruction ( qreal distance )
void setInstructionText ( const QString & instructionText )
void setPosition ( const QGeoCoordinate & position )
void setTimeToNextInstruction ( int secs )
int timeToNextInstruction () const
bool operator!= ( const QGeoNavigationInstruction & other ) const
QGeoNavigationInstruction & operator= ( const QGeoNavigationInstruction & other )
bool operator== ( const QGeoNavigationInstruction & other ) const

Detailed Description

The QGeoNavigationInstruction class represents a navigation instruction.

A QGeoNavigationInstruction instance has a position at which the instruction applies and a textual instruction to provide at that position.


Member Function Documentation

QGeoNavigationInstruction::QGeoNavigationInstruction ()

Constructs a navigation instruction object.

QGeoNavigationInstruction::QGeoNavigationInstruction ( const QGeoNavigationInstruction & other )

Constructs a navigation instruction object from the contents of other.

QGeoNavigationInstruction::~QGeoNavigationInstruction ()

Destroys this navigation instruction object.

qreal QGeoNavigationInstruction::distanceToNextInstruction () const

Returns the distance, in metres, between the point at which this instruction was issued and the point that the next instruction should be issued.

See also setDistanceToNextInstruction().

QString QGeoNavigationInstruction::instructionText () const

Returns the textual navigation instructions.

See also setInstructionText().

QGeoCoordinate QGeoNavigationInstruction::position () const

Returns the position where the instructions should be provided.

See also setPosition().

void QGeoNavigationInstruction::setDistanceToNextInstruction ( qreal distance )

Sets the distance, in metres, between the point at which this instruction was issued and the point that the next instruction should be issued to distance.

See also distanceToNextInstruction().

void QGeoNavigationInstruction::setInstructionText ( const QString & instructionText )

Sets the textual navigation instructions to instructionText.

See also instructionText().

void QGeoNavigationInstruction::setPosition ( const QGeoCoordinate & position )

Sets the position where the instructions should be provided to position.

See also position().

void QGeoNavigationInstruction::setTimeToNextInstruction ( int secs )

Sets the estimated time it will take to travel from the point at which this instruction was issued and the point that the next instruction should be issued, in seconds, to secs.

See also timeToNextInstruction().

int QGeoNavigationInstruction::timeToNextInstruction () const

Returns the estimated time it will take to travel from the point at which this instruction was issued and the point that the next instruction should be issued, in seconds.

See also setTimeToNextInstruction().

bool QGeoNavigationInstruction::operator!= ( const QGeoNavigationInstruction & other ) const

Returns whether this navigation instruction is not equal to other.

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

Assigns other to this navigation instruction object and then returns a reference to this navigation instruction object.

bool QGeoNavigationInstruction::operator== ( const QGeoNavigationInstruction & other ) const

Returns whether this navigation instruction is equal to other.


Copyright © 2009-2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.1.0