MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QLandmarkImportRequest Class Reference

The QLandmarkImportRequest class allows a client to asynchronously request that a landmark manager import a set of landmarks. More...

 #include <QLandmarkImportRequest>

Inherits: QLandmarkAbstractRequest.

This class was introduced in Qt Mobility 1.1.

Public Functions

QLandmarkImportRequest ( QLandmarkManager * manager, QObject * parent = 0 )
~QLandmarkImportRequest ()
QLandmarkCategoryId categoryId () const
QIODevice * device () const
QString fileName () const
QString format () const
QList<QLandmarkId> landmarkIds () const
void setCategoryId ( const QLandmarkCategoryId & categoryId )
void setDevice ( QIODevice * device )
void setFileName ( const QString & fileName )
void setFormat ( const QString & format )
void setTransferOption ( QLandmarkManager::TransferOption option )
QLandmarkManager::TransferOption transferOption () const

Additional Inherited Members

Detailed Description

The QLandmarkImportRequest class allows a client to asynchronously request that a landmark manager import a set of landmarks.

For a QLandmarkImportRequest, the resultsAvailable() signal will be emitted when landmarks have been successfully imported by the manager. The list of added landmarks may be retrieved by the landmarkIds() function. The resultsAvailable() signal may also be emitted if an overall operational error occurs.

Please see the class documentation for QLandmarkAbstractRequest for more information about the usage of request classes and ownership semantics.

Note that for S60 and Symbian platforms, the waitForFinished() function is not supported for import requests and will always return false.

Member Function Documentation

QLandmarkImportRequest::QLandmarkImportRequest ( QLandmarkManager * manager, QObject * parent = 0 )

Constructs a landmark import request with the given manager parent.

QLandmarkImportRequest::~QLandmarkImportRequest ()

Destroys the request object.

QLandmarkCategoryId QLandmarkImportRequest::categoryId () const

Returns identifier of the category which all landmarks are assigned to if QLandmarkManager::AttachSingleCategory is used as the import option.

This function was introduced in Qt Mobility 1.1.

See also setCategoryId().

QIODevice * QLandmarkImportRequest::device () const

Returns the device from which landmarks are read.

This function was introduced in Qt Mobility 1.1.

See also setDevice().

QString QLandmarkImportRequest::fileName () const

If the currently assigned device is a QFile, or if setFileName() has been called, this function returns the name of the file to be read from. In all other cases, it returns an empty string.

This function was introduced in Qt Mobility 1.1.

See also setFileName() and setDevice().

QString QLandmarkImportRequest::format () const

Returns the expected data format for the import operation. By default no format is set, indicating that the manager will try to automatically detect the format of the import file.

This function was introduced in Qt Mobility 1.1.

See also setFormat().

QList<QLandmarkId> QLandmarkImportRequest::landmarkIds () const

Returns a list of identifiers of landmarks that have been imported.

This function was introduced in Qt Mobility 1.1.

void QLandmarkImportRequest::setCategoryId ( const QLandmarkCategoryId & categoryId )

Sets the identifier of the category to which all landmarks are assigned to, if QLandmarkManager::AttachSingleCategory is used as the import option, to categoryId.

This function was introduced in Qt Mobility 1.1.

See also categoryId().

void QLandmarkImportRequest::setDevice ( QIODevice * device )

Sets the device from which landmarks are read.

This function was introduced in Qt Mobility 1.1.

See also device().

void QLandmarkImportRequest::setFileName ( const QString & fileName )

Sets the name of the file to be read from to fileName. Internally, QLandmarkImportRequest will create a QFile and use this as the device to import from.

This function was introduced in Qt Mobility 1.1.

See also fileName() and setDevice().

void QLandmarkImportRequest::setFormat ( const QString & format )

Sets the expected data format for the import operation. If an empty string is set, then during the import, an attempt is made to auto detect the format.

This function was introduced in Qt Mobility 1.1.

See also format().

void QLandmarkImportRequest::setTransferOption ( QLandmarkManager::TransferOption option )

Sets the transfer option of the import request. The transfer option defines how categories are treated during the import operation.

This function was introduced in Qt Mobility 1.1.

See also transferOption().

QLandmarkManager::TransferOption QLandmarkImportRequest::transferOption () const

Returns the transfer option of the import request. The transfer option defines how categories are treated during the import operation. The default option is QLandmarkManager::IncludeCategoryData.

This function was introduced in Qt Mobility 1.1.

See also setTransferOption().

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.