summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Yard <peter.yard@nokia.com>2011-05-16 14:13:47 +1000
committerPeter Yard <peter.yard@nokia.com>2011-05-16 14:13:47 +1000
commit092b10c6ac4e5accfe965700c41bfcc55443b932 (patch)
tree26a844a895ab7bf54d918139b2c6e8fd17f33038
parent35b6870adc585c9b0c18ff4d9a2c34a034dcb320 (diff)
Docs: QTMOBILITY-790 organizer, publish&subscribe, service frameworks, sensors.
-rw-r--r--src/organizer/qorganizerabstractrequest.cpp30
-rw-r--r--src/organizer/qorganizercollection.cpp18
-rw-r--r--src/organizer/qorganizercollectionchangeset.cpp21
-rw-r--r--src/organizer/qorganizercollectionengineid.cpp8
-rw-r--r--src/organizer/qorganizercollectionid.cpp27
-rw-r--r--src/organizer/qorganizeritem.cpp67
-rw-r--r--src/organizer/qorganizeritemchangeset.cpp19
-rw-r--r--src/organizer/qorganizeritemdetail.cpp57
-rw-r--r--src/organizer/qorganizeritemdetaildefinition.cpp49
-rw-r--r--src/organizer/qorganizeritemdetailfielddefinition.cpp12
-rw-r--r--src/organizer/qorganizeritemengineid.cpp8
-rw-r--r--src/organizer/qorganizeritemfetchhint.cpp8
-rw-r--r--src/organizer/qorganizeritemfilter.cpp23
-rw-r--r--src/organizer/qorganizeritemid.cpp28
-rw-r--r--src/organizer/qorganizeritemobserver.cpp5
-rw-r--r--src/organizer/qorganizeritemsortorder.cpp21
-rw-r--r--src/organizer/qorganizermanager.cpp73
-rw-r--r--src/organizer/qorganizermanagerengine.cpp77
-rw-r--r--src/organizer/qorganizermanagerenginefactory.cpp8
-rw-r--r--src/organizer/qorganizermanagerenginev2wrapper_p.cpp10
-rw-r--r--src/organizer/qorganizerrecurrencerule.cpp29
-rw-r--r--src/publishsubscribe/qvaluespace.cpp33
-rw-r--r--src/publishsubscribe/qvaluespacepublisher.cpp11
-rw-r--r--src/publishsubscribe/qvaluespacesubscriber.cpp18
-rw-r--r--src/publishsubscribe/sharedmemorylayer.cpp27
-rw-r--r--src/sensors/qaccelerometer.cpp12
-rw-r--r--src/sensors/qambientlightsensor.cpp8
-rw-r--r--src/sensors/qcompass.cpp10
-rw-r--r--src/sensors/qgyroscope.cpp12
-rw-r--r--src/sensors/qlightsensor.cpp11
-rw-r--r--src/sensors/qmagnetometer.cpp15
-rw-r--r--src/sensors/qorientationsensor.cpp8
-rw-r--r--src/sensors/qproximitysensor.cpp8
-rw-r--r--src/sensors/qrotationsensor.cpp13
-rw-r--r--src/sensors/qsensor.cpp43
-rw-r--r--src/sensors/qsensorbackend.cpp16
-rw-r--r--src/sensors/qsensormanager.cpp11
-rw-r--r--src/sensors/qsensorplugin.cpp6
-rw-r--r--src/sensors/qtapsensor.cpp11
-rw-r--r--src/serviceframework/qabstractsecuritysession.cpp1
-rw-r--r--src/serviceframework/qremoteserviceregister.cpp90
-rw-r--r--src/serviceframework/qservicecontext.cpp9
-rw-r--r--src/serviceframework/qservicefilter.cpp18
-rw-r--r--src/serviceframework/qserviceinterfacedescriptor.cpp15
-rw-r--r--src/serviceframework/qservicemanager.cpp20
-rw-r--r--src/serviceframework/qserviceplugininterface.cpp5
46 files changed, 934 insertions, 95 deletions
diff --git a/src/organizer/qorganizerabstractrequest.cpp b/src/organizer/qorganizerabstractrequest.cpp
index 5253dcbb3e..e07ca9dff9 100644
--- a/src/organizer/qorganizerabstractrequest.cpp
+++ b/src/organizer/qorganizerabstractrequest.cpp
@@ -82,6 +82,7 @@ QTM_BEGIN_NAMESPACE
\fn QOrganizerAbstractRequest::stateChanged(QOrganizerAbstractRequest::State newState)
This signal is emitted when the state of the request is changed. The new state of
the request will be contained in \a newState.
+ \since 1.1
*/
@@ -91,6 +92,7 @@ QTM_BEGIN_NAMESPACE
the operation error which may be accessed via error(), or derived-class-specific
results which are accessible through the derived class API.
+ \since 1.1
\sa error()
*/
@@ -145,6 +147,7 @@ QOrganizerAbstractRequest::~QOrganizerAbstractRequest()
/*!
Returns true if the request is in the \c QOrganizerAbstractRequest::InactiveState state; otherwise, returns false
+ \since 1.1
\sa state()
*/
bool QOrganizerAbstractRequest::isInactive() const
@@ -156,6 +159,7 @@ bool QOrganizerAbstractRequest::isInactive() const
/*!
Returns true if the request is in the \c QOrganizerAbstractRequest::ActiveState state; otherwise, returns false
+ \since 1.1
\sa state()
*/
bool QOrganizerAbstractRequest::isActive() const
@@ -167,6 +171,7 @@ bool QOrganizerAbstractRequest::isActive() const
/*!
Returns true if the request is in the \c QOrganizerAbstractRequest::FinishedState; otherwise, returns false
+ \since 1.1
\sa state()
*/
bool QOrganizerAbstractRequest::isFinished() const
@@ -178,6 +183,7 @@ bool QOrganizerAbstractRequest::isFinished() const
/*!
Returns true if the request is in the \c QOrganizerAbstractRequest::CanceledState; otherwise, returns false
+ \since 1.1
\sa state()
*/
bool QOrganizerAbstractRequest::isCanceled() const
@@ -186,7 +192,9 @@ bool QOrganizerAbstractRequest::isCanceled() const
return (d_ptr->m_state == QOrganizerAbstractRequest::CanceledState);
}
-/*! Returns the overall error of the most recent asynchronous operation */
+/*! Returns the overall error of the most recent asynchronous operation
+ \since 1.1
+*/
QOrganizerManager::Error QOrganizerAbstractRequest::error() const
{
QMutexLocker ml(&d_ptr->m_mutex);
@@ -195,6 +203,7 @@ QOrganizerManager::Error QOrganizerAbstractRequest::error() const
/*!
Returns the type of this asynchronous request
+ \since 1.1
*/
QOrganizerAbstractRequest::RequestType QOrganizerAbstractRequest::type() const
{
@@ -204,6 +213,7 @@ QOrganizerAbstractRequest::RequestType QOrganizerAbstractRequest::type() const
/*!
Returns the current state of the request.
+ \since 1.1
*/
QOrganizerAbstractRequest::State QOrganizerAbstractRequest::state() const
{
@@ -211,14 +221,18 @@ QOrganizerAbstractRequest::State QOrganizerAbstractRequest::state() const
return d_ptr->m_state;
}
-/*! Returns a pointer to the manager of which this request instance requests operations */
+/*! Returns a pointer to the manager of which this request instance requests operations
+ \since 1.1
+*/
QOrganizerManager* QOrganizerAbstractRequest::manager() const
{
QMutexLocker ml(&d_ptr->m_mutex);
return d_ptr->m_manager;
}
-/*! Sets the manager of which this request instance requests operations to \a manager */
+/*! Sets the manager of which this request instance requests operations to \a manager
+ \since 1.1
+*/
void QOrganizerAbstractRequest::setManager(QOrganizerManager* manager)
{
QMutexLocker ml(&d_ptr->m_mutex);
@@ -230,7 +244,9 @@ void QOrganizerAbstractRequest::setManager(QOrganizerManager* manager)
}
/*! Attempts to start the request. Returns false if the request is not in the \c QOrganizerAbstractRequest::Inactive, \c QOrganizerAbstractRequest::Finished or \c QOrganizerAbstractRequest::Cancelled states,
- or if the request was unable to be performed by the manager engine; otherwise returns true. */
+ or if the request was unable to be performed by the manager engine; otherwise returns true.
+ \since 1.1
+*/
bool QOrganizerAbstractRequest::start()
{
QMutexLocker ml(&d_ptr->m_mutex);
@@ -245,7 +261,9 @@ bool QOrganizerAbstractRequest::start()
}
/*! Attempts to cancel the request. Returns false if the request is not in the \c QOrganizerAbstractRequest::Active state,
- or if the request is unable to be cancelled by the manager engine; otherwise returns true. */
+ or if the request is unable to be cancelled by the manager engine; otherwise returns true.
+ \since 1.1
+*/
bool QOrganizerAbstractRequest::cancel()
{
QMutexLocker ml(&d_ptr->m_mutex);
@@ -261,6 +279,7 @@ bool QOrganizerAbstractRequest::cancel()
If \a msecs is zero or negative, this function will block until the request is complete, regardless of how long it takes.
Returns true if the request was cancelled or completed successfully within the given period, otherwise false.
Some backends are unable to support this operation safely, and will return false immediately.
+ \since 1.1
*/
bool QOrganizerAbstractRequest::waitForFinished(int msecs)
{
@@ -284,6 +303,7 @@ bool QOrganizerAbstractRequest::waitForFinished(int msecs)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a request to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerAbstractRequest& request)
{
diff --git a/src/organizer/qorganizercollection.cpp b/src/organizer/qorganizercollection.cpp
index 0c2d708cbf..27b88382b9 100644
--- a/src/organizer/qorganizercollection.cpp
+++ b/src/organizer/qorganizercollection.cpp
@@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE
\brief The QOrganizerCollection class represents a collection of items in a manager.
\inmodule QtOrganizer
\ingroup organizer-main
+ \since 1.1
A collection has an id and optionally some metadata, and contains zero or more items.
Each different manager will have different requirements before a collection may be saved
@@ -112,6 +113,7 @@ QOrganizerCollection::~QOrganizerCollection()
/*!
Constructs a new copy of the \a other collection
+ \since 1.1
*/
QOrganizerCollection::QOrganizerCollection(const QOrganizerCollection& other)
: d(other.d)
@@ -120,6 +122,7 @@ QOrganizerCollection::QOrganizerCollection(const QOrganizerCollection& other)
/*!
Assigns this collection to be equal to the \a other collection
+ \since 1.1
*/
QOrganizerCollection& QOrganizerCollection::operator=(const QOrganizerCollection& other)
{
@@ -130,6 +133,7 @@ QOrganizerCollection& QOrganizerCollection::operator=(const QOrganizerCollection
/*!
Returns true if the id of the collection is the same as that of the \a other collection.
Does not check that the metadata of the collections is equal.
+ \since 1.1
*/
bool QOrganizerCollection::operator==(const QOrganizerCollection &other) const
{
@@ -141,10 +145,12 @@ bool QOrganizerCollection::operator==(const QOrganizerCollection &other) const
Returns true if the id of the collection is not the same as that of the \a other collection.
Does not check that the metadata of the collections is not equal.
+ \since 1.1
*/
/*!
Returns the complete id of the collection, which includes the manager uri and the manager id of the collection
+ \since 1.1
*/
QOrganizerCollectionId QOrganizerCollection::id() const
{
@@ -155,6 +161,7 @@ QOrganizerCollectionId QOrganizerCollection::id() const
Sets the id of the collection to \a id.
If the id is set to a null (default-constructed) id, saving the collection will cause the manager to save the
collection as a new collection (if it supports that operation).
+ \since 1.1
*/
void QOrganizerCollection::setId(const QOrganizerCollectionId& id)
{
@@ -167,6 +174,7 @@ void QOrganizerCollection::setId(const QOrganizerCollectionId& id)
is compatible with the manager by calling \l QOrganizerManager::compatibleCollection().
Attempting to save a collection with unsupported meta data in a manager will cause an error
in the operation.
+ \since 1.1
*/
void QOrganizerCollection::setMetaData(const QVariantMap& metaData)
{
@@ -175,6 +183,7 @@ void QOrganizerCollection::setMetaData(const QVariantMap& metaData)
/*!
Returns the meta data of the collection
+ \since 1.1
*/
QVariantMap QOrganizerCollection::metaData() const
{
@@ -188,6 +197,7 @@ QVariantMap QOrganizerCollection::metaData() const
all possible data types for the meta data \a value.
Attempting to save a collection with unsupported meta data in a manager will cause an error
in the operation.
+ \since 1.1
*/
void QOrganizerCollection::setMetaData(const QString& key, const QVariant& value)
{
@@ -196,13 +206,16 @@ void QOrganizerCollection::setMetaData(const QString& key, const QVariant& value
/*!
Returns the meta data of the collection for the given \a key
+ \since 1.1
*/
QVariant QOrganizerCollection::metaData(const QString& key) const
{
return d->m_metaData.value(key);
}
-/*! Returns the hash value for \a key. */
+/*! Returns the hash value for \a key.
+ \since 1.1
+*/
uint qHash(const QOrganizerCollection &key)
{
uint hash = qHash(key.id());
@@ -219,6 +232,7 @@ uint qHash(const QOrganizerCollection &key)
#ifndef QT_NO_DEBUG_STREAM
/*!
Streams the \a collection to the given debug stream \a dbg, and returns the stream.
+ \since 1.1
*/
QDebug operator<<(QDebug dbg, const QOrganizerCollection& collection)
{
@@ -236,6 +250,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerCollection& collection)
#ifndef QT_NO_DATASTREAM
/*!
* Writes \a collection to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerCollection& collection)
{
@@ -247,6 +262,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerCollection& collection
/*!
* Reads an organizer collection from stream \a in into \a collection.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerCollection& collection)
{
diff --git a/src/organizer/qorganizercollectionchangeset.cpp b/src/organizer/qorganizercollectionchangeset.cpp
index 1fb2afbc84..e2698374a4 100644
--- a/src/organizer/qorganizercollectionchangeset.cpp
+++ b/src/organizer/qorganizercollectionchangeset.cpp
@@ -51,10 +51,11 @@ QTM_BEGIN_NAMESPACE
\brief The QOrganizerCollectionChangeSet class provides a simple API to
simplify the emission of state-change signals from QOrganizerManagerEngine
implementations.
+ \since 1.1
\inmodule QtOrganizer
-
+
This class can be utilized by backend implementations to ensure
correct emission of the \l QOrganizerManagerEngine::dataChanged(),
@@ -75,6 +76,7 @@ QOrganizerCollectionChangeSet::QOrganizerCollectionChangeSet()
/*!
Constructs a copy of the \a other change set
+ \since 1.1
*/
QOrganizerCollectionChangeSet::QOrganizerCollectionChangeSet(const QOrganizerCollectionChangeSet& other)
: d(other.d)
@@ -90,6 +92,7 @@ QOrganizerCollectionChangeSet::~QOrganizerCollectionChangeSet()
/*!
Assigns this change set to be equal to \a other
+ \since 1.1
*/
QOrganizerCollectionChangeSet& QOrganizerCollectionChangeSet::operator=(const QOrganizerCollectionChangeSet& other)
{
@@ -101,6 +104,7 @@ QOrganizerCollectionChangeSet& QOrganizerCollectionChangeSet::operator=(const QO
Sets the data changed flag to \a dataChanged. If this is set to true prior to calling \l emitSignals(),
only the \l QOrganizerManagerEngine::dataChanged() signal will be emitted; otherwise, the appropriate
finer-grained signals will be emitted.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::setDataChanged(bool dataChanged)
{
@@ -109,6 +113,7 @@ void QOrganizerCollectionChangeSet::setDataChanged(bool dataChanged)
/*!
Returns the value of the data changed flag
+ \since 1.1
*/
bool QOrganizerCollectionChangeSet::dataChanged()
{
@@ -118,6 +123,7 @@ bool QOrganizerCollectionChangeSet::dataChanged()
/*!
Returns the set of ids of collections which have been added to
the database.
+ \since 1.1
*/
QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::addedCollections() const
{
@@ -127,6 +133,7 @@ QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::addedCollections() c
/*!
Inserts the given collection id \a addedOrganizerCollectionId into the set of ids of collections
which have been added to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertAddedCollection(const QOrganizerCollectionId& addedOrganizerCollectionId)
{
@@ -136,6 +143,7 @@ void QOrganizerCollectionChangeSet::insertAddedCollection(const QOrganizerCollec
/*!
Inserts each of the given collection ids \a addedOrganizerCollectionIds into
the set of ids of collections which have been added to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertAddedCollections(const QList<QOrganizerCollectionId>& addedOrganizerCollectionIds)
{
@@ -145,6 +153,7 @@ void QOrganizerCollectionChangeSet::insertAddedCollections(const QList<QOrganize
/*!
Clears the set of ids of collections which have been added to the database
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::clearAddedCollections()
{
@@ -154,6 +163,7 @@ void QOrganizerCollectionChangeSet::clearAddedCollections()
/*!
Returns the set of ids of collections which have been changed in
the database.
+ \since 1.1
*/
QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::changedCollections() const
{
@@ -163,6 +173,7 @@ QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::changedCollections()
/*!
Inserts the given collection id \a changedOrganizerCollectionId into the set of ids of collections
which have been changed to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertChangedCollection(const QOrganizerCollectionId& changedOrganizerCollectionId)
{
@@ -172,6 +183,7 @@ void QOrganizerCollectionChangeSet::insertChangedCollection(const QOrganizerColl
/*!
Inserts each of the given collection ids \a changedOrganizerCollectionIds into the set of ids of collections
which have been changed to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertChangedCollections(const QList<QOrganizerCollectionId>& changedOrganizerCollectionIds)
{
@@ -181,6 +193,7 @@ void QOrganizerCollectionChangeSet::insertChangedCollections(const QList<QOrgani
/*!
Clears the set of ids of collections which have been changed to the database
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::clearChangedCollections()
{
@@ -190,6 +203,7 @@ void QOrganizerCollectionChangeSet::clearChangedCollections()
/*!
Returns the set of ids of collections which have been removed from
the database.
+ \since 1.1
*/
QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::removedCollections() const
{
@@ -199,6 +213,7 @@ QSet<QOrganizerCollectionId> QOrganizerCollectionChangeSet::removedCollections()
/*!
Inserts the given collection id \a removedOrganizerCollectionId into the set of ids of collections
which have been removed to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertRemovedCollection(const QOrganizerCollectionId& removedOrganizerCollectionId)
{
@@ -208,6 +223,7 @@ void QOrganizerCollectionChangeSet::insertRemovedCollection(const QOrganizerColl
/*!
Inserts each of the given collection ids \a removedOrganizerCollectionIds into the set of ids of collections
which have been removed to the database.
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::insertRemovedCollections(const QList<QOrganizerCollectionId>& removedOrganizerCollectionIds)
{
@@ -217,6 +233,7 @@ void QOrganizerCollectionChangeSet::insertRemovedCollections(const QList<QOrgani
/*!
Clears the set of ids of collections which have been removed to the database
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::clearRemovedCollections()
{
@@ -226,6 +243,7 @@ void QOrganizerCollectionChangeSet::clearRemovedCollections()
/*!
Clears all flags and sets of ids in this change set
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::clearAll()
{
@@ -237,6 +255,7 @@ void QOrganizerCollectionChangeSet::clearAll()
/*!
Emits the appropriate signals from the given \a engine given the state of the change set
+ \since 1.1
*/
void QOrganizerCollectionChangeSet::emitSignals(QOrganizerManagerEngine *engine)
{
diff --git a/src/organizer/qorganizercollectionengineid.cpp b/src/organizer/qorganizercollectionengineid.cpp
index 9957dc9762..6aa092d76f 100644
--- a/src/organizer/qorganizercollectionengineid.cpp
+++ b/src/organizer/qorganizercollectionengineid.cpp
@@ -46,6 +46,7 @@
\relates QOrganizerCollectionId
\brief The QOrganizerCollectionEngineId class uniquely identifies an item within a
particular engine plugin.
+ \since 1.1
\inmodule QtOrganizer
\ingroup organizer-backends
@@ -69,6 +70,7 @@
Returns true if this id is equal to the \a other id; false otherwise.
Note that when implementing this function, you do not have to check that the type is the same,
since the function which calls this function (in QOrganizerCollectionId) does that check for you.
+ \since 1.1
*/
/*!
@@ -76,6 +78,7 @@
Returns true if this id is less than the \a other id; false otherwise.
Note that when implementing this function, you do not have to check that the type is the same,
since the function which calls this function (in QOrganizerCollectionId) does that check for you.
+ \since 1.1
*/
/*!
@@ -84,6 +87,7 @@
the id. If the collection which the id identifies has not been deleted,
the id should still be valid in the manager identified by the
manager URI returned by this function.
+ \since 1.1
*/
/*!
@@ -92,20 +96,24 @@
required to identify a particular collection in the manager which created
the id, formatted according to the serialization format of the
manager.
+ \since 1.1
*/
/*!
\fn QOrganizerCollectionEngineId::clone() const
Returns a deep-copy clone of this id.
The caller takes ownership of the returned engine collection id.
+ \since 1.1
*/
/*!
\fn QOrganizerCollectionEngineId::debugStreamOut(QDebug& dbg) const
Streams this id out to the debug stream \a dbg.
+ \since 1.1
*/
/*!
\fn QOrganizerCollectionEngineId::hash() const
Returns the hash value of this id.
+ \since 1.1
*/
diff --git a/src/organizer/qorganizercollectionid.cpp b/src/organizer/qorganizercollectionid.cpp
index 89861fd049..9989e656b7 100644
--- a/src/organizer/qorganizercollectionid.cpp
+++ b/src/organizer/qorganizercollectionid.cpp
@@ -58,6 +58,7 @@ QTM_BEGIN_NAMESPACE
\class QOrganizerCollectionId
\brief The QOrganizerCollectionId class provides information that uniquely identifies
a collection in a particular manager.
+ \since 1.1
\inmodule QtOrganizer
@@ -87,26 +88,33 @@ QOrganizerCollectionId::~QOrganizerCollectionId()
\a engineItemId. This id takes ownership of the engine-unique item id and
will delete it when the id goes out of scope. Engine implementors must not
delete the \a engineItemId or undefined behaviour will occur.
+ \since 1.1
*/
QOrganizerCollectionId::QOrganizerCollectionId(QOrganizerCollectionEngineId* engineItemId)
: d(engineItemId)
{
}
-/*! Constructs a new collection id as a copy of \a other */
+/*! Constructs a new collection id as a copy of \a other
+ \since 1.1
+*/
QOrganizerCollectionId::QOrganizerCollectionId(const QOrganizerCollectionId& other)
: d(other.d)
{
}
-/*! Assigns the collection id to be equal to \a other */
+/*! Assigns the collection id to be equal to \a other
+ \since 1.1
+*/
QOrganizerCollectionId& QOrganizerCollectionId::operator=(const QOrganizerCollectionId& other)
{
d = other.d;
return *this;
}
-/*! Returns true if the collection id has the same manager URI and id as \a other */
+/*! Returns true if the collection id has the same manager URI and id as \a other
+ \since 1.1
+*/
bool QOrganizerCollectionId::operator==(const QOrganizerCollectionId& other) const
{
// if both ids are null then they are equal.
@@ -122,7 +130,9 @@ bool QOrganizerCollectionId::operator==(const QOrganizerCollectionId& other) con
return false;
}
-/*! Returns true if either the manager URI or id of the collection id is different to that of \a other */
+/*! Returns true if either the manager URI or id of the collection id is different to that of \a other
+ \since 1.1
+*/
bool QOrganizerCollectionId::operator!=(const QOrganizerCollectionId& other) const
{
return !(*this == other);
@@ -141,6 +151,7 @@ bool QOrganizerCollectionId::operator!=(const QOrganizerCollectionId& other) con
This operator is provided primarily to allow use of a QOrganizerCollectionId
as a key in a QMap.
+ \since 1.1
*/
bool QOrganizerCollectionId::operator<(const QOrganizerCollectionId& other) const
{
@@ -163,6 +174,7 @@ bool QOrganizerCollectionId::operator<(const QOrganizerCollectionId& other) cons
/*!
Returns true if the id part of this id is a null (default constructed) id; otherwise, returns false.
+ \since 1.1
*/
bool QOrganizerCollectionId::isNull() const
{
@@ -171,6 +183,7 @@ bool QOrganizerCollectionId::isNull() const
/*!
* Returns the hash value for \a key.
+ \since 1.1
*/
uint qHash(const QOrganizerCollectionId &key)
{
@@ -182,6 +195,7 @@ uint qHash(const QOrganizerCollectionId &key)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a id to the debug stream \a dbg
+ \since 1.1
*/
QDebug operator<<(QDebug dbg, const QOrganizerCollectionId& id)
{
@@ -197,6 +211,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerCollectionId& id)
#ifndef QT_NO_DATASTREAM
/*!
Streams \a collectionId to the data stream \a out
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerCollectionId& collectionId)
{
@@ -206,6 +221,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerCollectionId& collecti
/*!
Streams \a collectionId in from the data stream \a in
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerCollectionId& collectionId)
{
@@ -226,6 +242,7 @@ QString QOrganizerCollectionId::managerUri() const
/*!
Builds a string from the given \a managerName, \a params and \a engineIdString
+ \since 1.1
*/
inline QString buildIdString(const QString& managerName, const QMap<QString, QString>& params, const QString& engineIdString)
{
@@ -319,6 +336,7 @@ inline bool parseIdString(const QString& idString, QString* managerName, QMap<QS
/*!
Serializes the id to a string. The format of the string will be:
"qtorganizer:managerName:constructionParams:serializedEngineLocalItemId"
+ \since 1.1
*/
QString QOrganizerCollectionId::toString() const
{
@@ -339,6 +357,7 @@ QString QOrganizerCollectionId::toString() const
Deserializes the given \a idString. Returns a default-constructed (null)
item id if the given \a idString is not a valid, serialized item id, or
if the manager engine from which the id came could not be found.
+ \since 1.1
*/
QOrganizerCollectionId QOrganizerCollectionId::fromString(const QString& idString)
{
diff --git a/src/organizer/qorganizeritem.cpp b/src/organizer/qorganizeritem.cpp
index 0d7ca7f18b..9d05c8e9ff 100644
--- a/src/organizer/qorganizeritem.cpp
+++ b/src/organizer/qorganizeritem.cpp
@@ -109,23 +109,27 @@ QTM_BEGIN_NAMESPACE
* \fn QList<T> QOrganizerItem::details() const
* Returns a list of details of the template parameter type. The type must be
* a subclass of QOrganizerItemDetail.
+ \since 1.1
*/
/*!
* \fn QList<T> QOrganizerItem::details(const QString& fieldName, const QString& value) const
* Returns a list of details of the template parameter type which have field called \a fieldName, with matching \a value.
* The type must be a subclass of QOrganizerItemDetail.
+ \since 1.1
*/
/*!
* \fn T QOrganizerItem::detail() const
* Returns the first detail of the template parameter type, as returned by the template details() function.
* The type must be a subclass of QOrganizerItemDetail.
+ \since 1.1
*/
/*!
* \fn QOrganizerItem::operator!=(const QOrganizerItem &other) const
* Returns true if this organizer item's id or details are different to those of the \a other organizer item.
+ \since 1.1
*/
/*!
@@ -134,6 +138,7 @@ QTM_BEGIN_NAMESPACE
The organizer item will have an empty display label, an empty id, and an empty description
and have type \l QOrganizerItemType::TypeNote.
The isEmpty() function will return true.
+ \since 1.1
*/
QOrganizerItem::QOrganizerItem()
: d(new QOrganizerItemData)
@@ -141,7 +146,9 @@ QOrganizerItem::QOrganizerItem()
clearDetails();
}
-/*! Initializes this QOrganizerItem from \a other */
+/*! Initializes this QOrganizerItem from \a other
+ \since 1.1
+*/
QOrganizerItem::QOrganizerItem(const QOrganizerItem& other)
: d(other.d)
{
@@ -151,6 +158,7 @@ QOrganizerItem::QOrganizerItem(const QOrganizerItem& other)
\internal
Constructs a new, empty item of the given type \a type.
+ \since 1.1
*/
QOrganizerItem::QOrganizerItem(const char* type)
{
@@ -167,6 +175,7 @@ QOrganizerItem::QOrganizerItem(const char* type)
type identified by the \a expectedType.
The \a expectedType pointer must be valid for the lifetime of the program.
+ \since 1.1
*/
QOrganizerItem::QOrganizerItem(const QOrganizerItem& other, const char* expectedType)
{
@@ -184,6 +193,7 @@ QOrganizerItem::QOrganizerItem(const QOrganizerItem& other, const char* expected
Assigns this item to \a other if the type of \a other is that identified
by the given \a expectedType, else assigns this item to be a new, empty
item of the type identified by the given \a expectedType
+ \since 1.1
*/
QOrganizerItem& QOrganizerItem::assign(const QOrganizerItem& other, const char* expectedType)
{
@@ -204,6 +214,7 @@ QOrganizerItem& QOrganizerItem::assign(const QOrganizerItem& other, const char*
*
* An empty QOrganizerItem has an empty label and no extra details.
* The type of the organizer item is irrelevant.
+ \since 1.1
*/
bool QOrganizerItem::isEmpty() const
{
@@ -228,6 +239,7 @@ bool QOrganizerItem::isEmpty() const
* This function does not modify the id or type of the organizer item.
* Calling isEmpty() after calling this function will return true.
* The empty item becomes a \l QOrganizerNote.
+ \since 1.1
*/
void QOrganizerItem::clearDetails()
{
@@ -240,7 +252,9 @@ void QOrganizerItem::clearDetails()
d->m_details.insert(0, organizeritemType);
}
-/*! Replace the contents of this QOrganizerItem with \a other */
+/*! Replace the contents of this QOrganizerItem with \a other
+ \since 1.1
+*/
QOrganizerItem& QOrganizerItem::operator=(const QOrganizerItem& other)
{
d = other.d;
@@ -260,6 +274,7 @@ QOrganizerItem::~QOrganizerItem()
in a manager. The QOrganizerItemId is only valid within a specific
manager. See \l QOrganizerManager::saveItem() for more
information.
+ \since 1.1
*/
QOrganizerItemId QOrganizerItem::id() const
{
@@ -282,6 +297,7 @@ QOrganizerItemId QOrganizerItem::id() const
if the move operation is supported by the manager; otherwise, the
\l QOrganizerManager::saveItem() operation will fail and calling
\l QOrganizerManager::error() will return \c QOrganizerManager::NotSupportedError.
+ \since 1.1
*/
QOrganizerCollectionId QOrganizerItem::collectionId() const
{
@@ -305,6 +321,7 @@ QOrganizerCollectionId QOrganizerItem::collectionId() const
\l QOrganizerManager::saveItem() will move the item from its original
collection to the collection whose id is \a collectionId, if \a collectionId
identifies a valid collection and the operation is supported by the manager.
+ \since 1.1
*/
void QOrganizerItem::setCollectionId(const QOrganizerCollectionId& collectionId)
{
@@ -323,6 +340,7 @@ void QOrganizerItem::setCollectionId(const QOrganizerCollectionId& collectionId)
* of an existing organizer item, or to save a organizer item in a different manager.
*
* \sa QOrganizerManager::saveItem()
+ \since 1.1
*/
void QOrganizerItem::setId(const QOrganizerItemId& id)
{
@@ -338,6 +356,7 @@ void QOrganizerItem::setId(const QOrganizerItemId& id)
It would usually be more convenient to use the template version of this function.
+ \since 1.1
*/
/*!
@@ -348,11 +367,13 @@ void QOrganizerItem::setId(const QOrganizerItemId& id)
specific subclass of QOrganizerItemDetail.
It would usually be more convenient to use the template version of this function.
+ \since 1.1
*/
/*!
\fn QList<QOrganizerItemDetail> QOrganizerItem::details(const QLatin1Constant& definitionName, const QLatin1Constant& fieldName, const QString& value)
Returns a list of details of the given \a definitionName, with fields named \a fieldName and with value \a value.
+ \since 1.1
*/
/*!
@@ -360,10 +381,12 @@ void QOrganizerItem::setId(const QOrganizerItemId& id)
\internal
Returns a list of details of the template type which match the \a fieldName and \a value criteria
+ \since 1.1
*/
/*!
Returns the first detail stored in the organizer item with the given \a definitionName
+ \since 1.1
*/
QOrganizerItemDetail QOrganizerItem::detail(const QString& definitionName) const
{
@@ -387,7 +410,9 @@ QOrganizerItemDetail QOrganizerItem::detail(const QString& definitionName) const
requesting a list of all the definition names using
\l {QOrganizerManager::detailDefinitions()}{detailDefinitions()} or the
asynchronous \l
- {QOrganizerItemDetailDefinitionFetchRequest::definitionNames()}{definitionNames()}.*/
+ {QOrganizerItemDetailDefinitionFetchRequest::definitionNames()}{definitionNames()}.
+ \since 1.1
+*/
QList<QOrganizerItemDetail> QOrganizerItem::details(const QString& definitionName) const
{
// build the sub-list of matching details.
@@ -415,7 +440,9 @@ QList<QOrganizerItemDetail> QOrganizerItem::details(const QString& definitionNam
requesting a list of all the definition names using
\l {QOrganizerManager::detailDefinitions()}{detailDefinitions()} or the
asynchronous \l
- {QOrganizerItemDetailDefinitionFetchRequest::definitionNames()}{definitionNames()}.*/
+ {QOrganizerItemDetailDefinitionFetchRequest::definitionNames()}{definitionNames()}.
+ \since 1.1
+*/
QList<QOrganizerItemDetail> QOrganizerItem::details(const QString& definitionName, const QString& fieldName, const QString& value) const
{
// build the sub-list of matching details.
@@ -440,6 +467,7 @@ QList<QOrganizerItemDetail> QOrganizerItem::details(const QString& definitionNam
/*!
\internal
Returns the first detail stored in the organizer item which with the given \a definitionName
+ \since 1.1
*/
QOrganizerItemDetail QOrganizerItem::detail(const char* definitionName) const
{
@@ -460,6 +488,7 @@ QOrganizerItemDetail QOrganizerItem::detail(const char* definitionName) const
/*!
\internal
Returns a list of details with the given \a definitionName
+ \since 1.1
*/
QList<QOrganizerItemDetail> QOrganizerItem::details(const char* definitionName) const
{
@@ -484,6 +513,7 @@ QList<QOrganizerItemDetail> QOrganizerItem::details(const char* definitionName)
/*!
\internal
Returns a list of details with the given \a definitionName, \a fieldName and field \a value
+ \since 1.1
*/
QList<QOrganizerItemDetail> QOrganizerItem::details(const char* definitionName, const char* fieldName, const QString& value) const
{
@@ -528,6 +558,7 @@ QList<QOrganizerItemDetail> QOrganizerItem::details(const char* definitionName,
* Returns true if the detail was saved successfully, otherwise returns false.
*
* Note that the caller retains ownership of the detail.
+ \since 1.1
*/
bool QOrganizerItem::saveDetail(QOrganizerItemDetail* detail)
{
@@ -613,6 +644,7 @@ bool QOrganizerItem::saveDetail(QOrganizerItemDetail* detail)
* Returns true if the detail was removed successfully, false if an error occurred.
*
* Note that the caller retains ownership of the detail.
+ \since 1.1
*/
bool QOrganizerItem::removeDetail(QOrganizerItemDetail* detail)
{
@@ -643,7 +675,9 @@ bool QOrganizerItem::removeDetail(QOrganizerItemDetail* detail)
return true;
}
-/*! Returns true if this organizer item is equal to the \a other organizer item, false if either the id, collection id or stored details are not the same */
+/*! Returns true if this organizer item is equal to the \a other organizer item, false if either the id, collection id or stored details are not the same
+ \since 1.1
+*/
bool QOrganizerItem::operator==(const QOrganizerItem& other) const
{
// work around, as this function is "const" that we can't sort m_details
@@ -660,6 +694,7 @@ bool QOrganizerItem::operator==(const QOrganizerItem& other) const
/*!
\relates QOrganizerItem
Returns the hash value for \a key.
+ \since 1.1
*/
uint qHash(const QOrganizerItem &key)
{
@@ -674,6 +709,7 @@ uint qHash(const QOrganizerItem &key)
#ifndef QT_NO_DEBUG_STREAM
/*!
Streams the \a organizeritem to the given debug stream \a dbg, and returns the stream.
+ \since 1.1
*/
QDebug operator<<(QDebug dbg, const QOrganizerItem& organizeritem)
{
@@ -688,6 +724,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerItem& organizeritem)
#ifndef QT_NO_DATASTREAM
/*!
* Writes \a item to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItem& item)
{
@@ -701,6 +738,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItem& item)
/*!
* Reads an item from stream \a in into \a item.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItem& item)
{
@@ -728,6 +766,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItem& item)
* in the organizer item, or by calling \l setType()) or synthesized automatically.
*
* \sa QOrganizerItemType
+ \since 1.1
*/
QString QOrganizerItem::type() const
{
@@ -739,6 +778,7 @@ QString QOrganizerItem::type() const
* Sets the type of the organizer item to the given \a type.
*
* \sa QOrganizerItemType
+ \since 1.1
*/
void QOrganizerItem::setType(const QString& type)
{
@@ -750,6 +790,7 @@ void QOrganizerItem::setType(const QString& type)
/*!
* Sets the type of the organizer item to the given \a type detail.
+ \since 1.1
*/
void QOrganizerItem::setType(const QOrganizerItemType& type)
{
@@ -762,6 +803,7 @@ void QOrganizerItem::setType(const QOrganizerItemType& type)
/*!
* Returns the display label of the item
+ \since 1.1
*/
QString QOrganizerItem::displayLabel() const
{
@@ -773,6 +815,7 @@ QString QOrganizerItem::displayLabel() const
* Sets the display label of the item to \a label
*
* \sa QOrganizerItemDisplayLabel
+ \since 1.1
*/
void QOrganizerItem::setDisplayLabel(const QString& label)
{
@@ -783,6 +826,7 @@ void QOrganizerItem::setDisplayLabel(const QString& label)
/*!
* Sets the display label of the item to \a label
+ \since 1.1
*/
void QOrganizerItem::setDisplayLabel(const QOrganizerItemDisplayLabel& label)
{
@@ -795,6 +839,7 @@ void QOrganizerItem::setDisplayLabel(const QOrganizerItemDisplayLabel& label)
* Returns the human-readable description of the item
*
* \sa QOrganizerItemDescription
+ \since 1.1
*/
QString QOrganizerItem::description() const
{
@@ -806,6 +851,7 @@ QString QOrganizerItem::description() const
* Sets the human-readable description of the item to \a description
*
* \sa QOrganizerItemDescription
+ \since 1.1
*/
void QOrganizerItem::setDescription(const QString& description)
{
@@ -816,6 +862,7 @@ void QOrganizerItem::setDescription(const QString& description)
/*!
* Sets the human-readable description of the item to \a description
+ \since 1.1
*/
void QOrganizerItem::setDescription(const QOrganizerItemDescription& description)
{
@@ -829,6 +876,7 @@ void QOrganizerItem::setDescription(const QOrganizerItemDescription& description
* which pertain to this item.
*
* \sa QOrganizerItemComment
+ \since 1.1
*/
QStringList QOrganizerItem::comments() const
{
@@ -844,6 +892,7 @@ QStringList QOrganizerItem::comments() const
* Removes all comments (arbitrary notes) about this item
*
* \sa QOrganizerItemComment
+ \since 1.1
*/
void QOrganizerItem::clearComments()
{
@@ -857,6 +906,7 @@ void QOrganizerItem::clearComments()
* Sets the list of comments associated with the item to \a comments.
*
* \sa QOrganizerItemTag
+ \since 1.2
*/
void QOrganizerItem::setComments(const QStringList& comments)
{
@@ -870,6 +920,7 @@ void QOrganizerItem::setComments(const QStringList& comments)
* Adds the comment \a comment to this item
*
* \sa QOrganizerItemComment
+ \since 1.1
*/
void QOrganizerItem::addComment(const QString& comment)
{
@@ -882,6 +933,7 @@ void QOrganizerItem::addComment(const QString& comment)
* Returns the list of tags for this item. Tags are used for non-exclusive categorization.
*
* \sa QOrganizerItemTag
+ \since 1.2
*/
QStringList QOrganizerItem::tags() const
{
@@ -896,6 +948,7 @@ QStringList QOrganizerItem::tags() const
* Removes all tags associated with the item.
*
* \sa QOrganizerItemTag
+ \since 1.1
*/
void QOrganizerItem::clearTags()
{
@@ -906,6 +959,7 @@ void QOrganizerItem::clearTags()
* Adds the \a tag to this item.
*
* \sa QOrganizerItemTag
+ \since 1.2
*/
void QOrganizerItem::addTag(const QString& tag)
{
@@ -918,6 +972,7 @@ void QOrganizerItem::addTag(const QString& tag)
* Sets the list of tags associated with the item to \a tags.
*
* \sa QOrganizerItemTag
+ \since 1.2
*/
void QOrganizerItem::setTags(const QStringList& tags)
{
@@ -930,6 +985,7 @@ void QOrganizerItem::setTags(const QStringList& tags)
/*!
* Returns the globally unique identifier which identifies this item,
* which is used for synchronization purposes.
+ \since 1.1
*/
QString QOrganizerItem::guid() const
{
@@ -939,6 +995,7 @@ QString QOrganizerItem::guid() const
/*!
* Sets the item's globally unique identifier to \a guid
+ \since 1.1
*/
void QOrganizerItem::setGuid(const QString& guid)
{
diff --git a/src/organizer/qorganizeritemchangeset.cpp b/src/organizer/qorganizeritemchangeset.cpp
index 75c8be7982..8527072821 100644
--- a/src/organizer/qorganizeritemchangeset.cpp
+++ b/src/organizer/qorganizeritemchangeset.cpp
@@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE
\brief The QOrganizerItemChangeSet class provides a simple API to
simplify the emission of state-change signals from
QOrganizerManagerEngine implementations.
+ \since 1.1
\inmodule QtOrganizer
@@ -73,6 +74,7 @@ QOrganizerItemChangeSet::QOrganizerItemChangeSet()
/*!
Constructs a copy of the \a other change set
+ \since 1.1
*/
QOrganizerItemChangeSet::QOrganizerItemChangeSet(const QOrganizerItemChangeSet& other)
: d(other.d)
@@ -88,6 +90,7 @@ QOrganizerItemChangeSet::~QOrganizerItemChangeSet()
/*!
Assigns this change set to be equal to \a other
+ \since 1.1
*/
QOrganizerItemChangeSet& QOrganizerItemChangeSet::operator=(const QOrganizerItemChangeSet& other)
{
@@ -99,6 +102,7 @@ QOrganizerItemChangeSet& QOrganizerItemChangeSet::operator=(const QOrganizerItem
Sets the data changed flag to \a dataChanged. If this is set to true prior to calling \l emitSignals(),
only the \l QOrganizerManagerEngine::dataChanged() signal will be emitted; otherwise, the appropriate
finer-grained signals will be emitted.
+ \since 1.1
*/
void QOrganizerItemChangeSet::setDataChanged(bool dataChanged)
{
@@ -107,6 +111,7 @@ void QOrganizerItemChangeSet::setDataChanged(bool dataChanged)
/*!
Returns the value of the data changed flag
+ \since 1.1
*/
bool QOrganizerItemChangeSet::dataChanged()
{
@@ -116,6 +121,7 @@ bool QOrganizerItemChangeSet::dataChanged()
/*!
Returns the set of ids of organizer items which have been added to
the database.
+ \since 1.1
*/
QSet<QOrganizerItemId> QOrganizerItemChangeSet::addedItems() const
{
@@ -125,6 +131,7 @@ QSet<QOrganizerItemId> QOrganizerItemChangeSet::addedItems() const
/*!
Inserts the given organizer item id \a addedOrganizerItemId into the set of ids of organizer items
which have been added to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertAddedItem(const QOrganizerItemId& addedOrganizerItemId)
{
@@ -134,6 +141,7 @@ void QOrganizerItemChangeSet::insertAddedItem(const QOrganizerItemId& addedOrgan
/*!
Inserts each of the given organizer item ids \a addedOrganizerItemIds into the set of ids of organizer items
which have been added to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertAddedItems(const QList<QOrganizerItemId>& addedOrganizerItemIds)
{
@@ -143,6 +151,7 @@ void QOrganizerItemChangeSet::insertAddedItems(const QList<QOrganizerItemId>& ad
/*!
Clears the set of ids of organizer items which have been added to the database
+ \since 1.1
*/
void QOrganizerItemChangeSet::clearAddedItems()
{
@@ -152,6 +161,7 @@ void QOrganizerItemChangeSet::clearAddedItems()
/*!
Returns the set of ids of organizer items which have been changed in
the database.
+ \since 1.1
*/
QSet<QOrganizerItemId> QOrganizerItemChangeSet::changedItems() const
{
@@ -161,6 +171,7 @@ QSet<QOrganizerItemId> QOrganizerItemChangeSet::changedItems() const
/*!
Inserts the given organizer item id \a changedOrganizerItemId into the set of ids of organizer items
which have been changed to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertChangedItem(const QOrganizerItemId& changedOrganizerItemId)
{
@@ -170,6 +181,7 @@ void QOrganizerItemChangeSet::insertChangedItem(const QOrganizerItemId& changedO
/*!
Inserts each of the given organizer item ids \a changedOrganizerItemIds into the set of ids of organizer items
which have been changed to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertChangedItems(const QList<QOrganizerItemId>& changedOrganizerItemIds)
{
@@ -179,6 +191,7 @@ void QOrganizerItemChangeSet::insertChangedItems(const QList<QOrganizerItemId>&
/*!
Clears the set of ids of organizer items which have been changed to the database
+ \since 1.1
*/
void QOrganizerItemChangeSet::clearChangedItems()
{
@@ -188,6 +201,7 @@ void QOrganizerItemChangeSet::clearChangedItems()
/*!
Returns the set of ids of organizer items which have been removed from
the database.
+ \since 1.1
*/
QSet<QOrganizerItemId> QOrganizerItemChangeSet::removedItems() const
{
@@ -197,6 +211,7 @@ QSet<QOrganizerItemId> QOrganizerItemChangeSet::removedItems() const
/*!
Inserts the given organizer item id \a removedOrganizerItemId into the set of ids of organizer items
which have been removed to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertRemovedItem(const QOrganizerItemId& removedOrganizerItemId)
{
@@ -206,6 +221,7 @@ void QOrganizerItemChangeSet::insertRemovedItem(const QOrganizerItemId& removedO
/*!
Inserts each of the given organizer item ids \a removedOrganizerItemIds into the set of ids of organizer items
which have been removed to the database.
+ \since 1.1
*/
void QOrganizerItemChangeSet::insertRemovedItems(const QList<QOrganizerItemId>& removedOrganizerItemIds)
{
@@ -215,6 +231,7 @@ void QOrganizerItemChangeSet::insertRemovedItems(const QList<QOrganizerItemId>&
/*!
Clears the set of ids of organizer items which have been removed to the database
+ \since 1.1
*/
void QOrganizerItemChangeSet::clearRemovedItems()
{
@@ -224,6 +241,7 @@ void QOrganizerItemChangeSet::clearRemovedItems()
/*!
Clears all flags and sets of ids in this change set
+ \since 1.1
*/
void QOrganizerItemChangeSet::clearAll()
{
@@ -235,6 +253,7 @@ void QOrganizerItemChangeSet::clearAll()
/*!
Emits the appropriate signals from the given \a engine given the state of the change set
+ \since 1.1
*/
void QOrganizerItemChangeSet::emitSignals(QOrganizerManagerEngine *engine)
{
diff --git a/src/organizer/qorganizeritemdetail.cpp b/src/organizer/qorganizeritemdetail.cpp
index cf02ed3b44..dbf762f4f3 100644
--- a/src/organizer/qorganizeritemdetail.cpp
+++ b/src/organizer/qorganizeritemdetail.cpp
@@ -170,6 +170,7 @@ Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash)
/*!
\fn QOrganizerItemDetail::operator!=(const QOrganizerItemDetail& other) const
Returns true if the values or id of this detail is different to those of the \a other detail
+ \since 1.1
*/
/*!
@@ -183,6 +184,7 @@ QOrganizerItemDetail::QOrganizerItemDetail()
/*!
Constructs a new, empty detail of the definition identified by \a thisDefinitionId.
The definitionId must be restricted to the Latin 1 character set.
+ \since 1.1
*/
QOrganizerItemDetail::QOrganizerItemDetail(const QString& thisDefinitionId)
: d(new QOrganizerItemDetailPrivate)
@@ -196,6 +198,7 @@ QOrganizerItemDetail::QOrganizerItemDetail(const QString& thisDefinitionId)
The supplied pointer must be valid for the lifetime of the program. In general
this means it should be a constant, and not allocated on the stack. If you cannot
meet this requirement, use the alternative constructor that takes a QString instead.
+ \since 1.1
*/
QOrganizerItemDetail::QOrganizerItemDetail(const char* thisDefinitionId)
: d(new QOrganizerItemDetailPrivate)
@@ -217,6 +220,7 @@ QOrganizerItemDetail::QOrganizerItemDetail(const QOrganizerItemDetail& other)
definition identified by the \a expectedDefinitionId.
The \a expectedDefinitionId pointer must be valid for the lifetime of the program.
+ \since 1.1
*/
QOrganizerItemDetail::QOrganizerItemDetail(const QOrganizerItemDetail& other, const char* expectedDefinitionId)
{
@@ -234,6 +238,7 @@ QOrganizerItemDetail::QOrganizerItemDetail(const QOrganizerItemDetail& other, co
Constructs a detail that is a copy of \a other if \a other is of the expected definition
identified by \a expectedDefinitionId, else constructs a new, empty detail of the
definition identified by the \a expectedDefinitionId
+ \since 1.1
*/
QOrganizerItemDetail::QOrganizerItemDetail(const QOrganizerItemDetail& other, const QString& expectedDefinitionId)
{
@@ -245,7 +250,9 @@ QOrganizerItemDetail::QOrganizerItemDetail(const QOrganizerItemDetail& other, co
}
}
-/*! Assigns this detail to \a other */
+/*! Assigns this detail to \a other
+ \since 1.1
+*/
QOrganizerItemDetail& QOrganizerItemDetail::operator=(const QOrganizerItemDetail& other)
{
if (this != &other)
@@ -259,6 +266,7 @@ QOrganizerItemDetail& QOrganizerItemDetail::operator=(const QOrganizerItemDetail
Assigns this detail to \a other if the definition of \a other is that identified
by the given \a expectedDefinitionId, else assigns this detail to be a new, empty
detail of the definition identified by the given \a expectedDefinitionId
+ \since 1.1
*/
QOrganizerItemDetail& QOrganizerItemDetail::assign(const QOrganizerItemDetail& other, const char* expectedDefinitionId)
{
@@ -279,6 +287,7 @@ QOrganizerItemDetail& QOrganizerItemDetail::assign(const QOrganizerItemDetail& o
Assigns this detail to \a other if the definition of \a other is that identified
by the given \a expectedDefinitionId, else assigns this detail to be a new, empty
detail of the definition identified by the given \a expectedDefinitionId
+ \since 1.1
*/
QOrganizerItemDetail& QOrganizerItemDetail::assign(const QOrganizerItemDetail& other, const QString& expectedDefinitionId)
{
@@ -301,6 +310,7 @@ QOrganizerItemDetail::~QOrganizerItemDetail()
/*!
Returns the (unique) name of the definition which defines the semantics and structure of this detail.
The actual QOrganizerItemDetailDefinition should be retrieved from the relevant QOrganizerManager using this name.
+ \since 1.1
*/
QString QOrganizerItemDetail::definitionName() const
{
@@ -311,6 +321,7 @@ QString QOrganizerItemDetail::definitionName() const
Compares this detail to \a other. Returns true if the definition, access constraints and values of \a other are equal to those of this detail.
The keys of each detail are not considered during the comparison, in order to allow details from different organizer items to
be compared according to their values.
+ \since 1.1
*/
bool QOrganizerItemDetail::operator==(const QOrganizerItemDetail& other) const
{
@@ -353,7 +364,9 @@ uint qHash(const QOrganizerItemStringHolder& key)
return h;
}
-/*! Returns the hash value for \a key. */
+/*! Returns the hash value for \a key.
+ \since 1.1
+*/
uint qHash(const QOrganizerItemDetail &key)
{
const QOrganizerItemDetailPrivate* dptr= QOrganizerItemDetailPrivate::detailPrivate(key);
@@ -385,6 +398,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerItemDetail& detail)
#ifndef QT_NO_DATASTREAM
/*!
* Writes \a detail to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetail& detail)
{
@@ -397,6 +411,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetail& detail)
/*!
* Reads aan organizer item detail from stream \a in into \a detail.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemDetail& detail)
{
@@ -426,6 +441,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemDetail& detail)
/*!
Returns true if no values are contained in this detail. Note that context is stored as a value; hence, if a context is set, this function will return false.
+ \since 1.1
*/
bool QOrganizerItemDetail::isEmpty() const
{
@@ -434,7 +450,9 @@ bool QOrganizerItemDetail::isEmpty() const
return false;
}
-/*! Returns the key of this detail. */
+/*! Returns the key of this detail.
+ \since 1.1
+*/
int QOrganizerItemDetail::key() const
{
return d->m_id;
@@ -442,7 +460,9 @@ int QOrganizerItemDetail::key() const
/*! Causes the implicitly-shared detail to be detached from any other copies, and generates a new key for it.
This ensures that calling QOrganizerItem::saveDetail() will result in a new detail being saved, rather than
- another detail being updated. */
+ another detail being updated.
+ \since 1.1
+*/
void QOrganizerItemDetail::resetKey()
{
d->m_id = QOrganizerItemDetailPrivate::lastDetailKey.fetchAndAddOrdered(1);
@@ -450,7 +470,9 @@ void QOrganizerItemDetail::resetKey()
/*! \overload
Returns the value stored in this detail for the given \a key as a QString, or an empty QString if
- no value for the given \a key exists */
+ no value for the given \a key exists
+ \since 1.1
+*/
QString QOrganizerItemDetail::value(const QString& key) const
{
return d.constData()->m_values.value(QOrganizerItemStringHolder(key)).toString();
@@ -461,6 +483,7 @@ QString QOrganizerItemDetail::value(const QString& key) const
\overload
Returns the value stored in this detail for the given \a key as a QString, or an empty QString if
no value for the given \a key exists
+ \since 1.1
*/
QString QOrganizerItemDetail::value(const char* key) const
{
@@ -471,9 +494,12 @@ QString QOrganizerItemDetail::value(const char* key) const
\fn T QOrganizerItemDetail::value(const char* key) const
\internal
\overload
+ \since 1.1
*/
-/*! Returns the value stored in this detail for the given \a key as a QVariant, or an invalid QVariant if no value for the given \a key exists */
+/*! Returns the value stored in this detail for the given \a key as a QVariant, or an invalid QVariant if no value for the given \a key exists
+ \since 1.1
+*/
QVariant QOrganizerItemDetail::variantValue(const QString& key) const
{
return d.constData()->m_values.value(QOrganizerItemStringHolder(key));
@@ -482,6 +508,7 @@ QVariant QOrganizerItemDetail::variantValue(const QString& key) const
/*!
\internal
Returns the value stored in this detail for the given \a key as a QVariant, or an invalid QVariant if no value for the given \a key exists
+ \since 1.1
*/
QVariant QOrganizerItemDetail::variantValue(const char* key) const
{
@@ -490,6 +517,7 @@ QVariant QOrganizerItemDetail::variantValue(const char* key) const
/*!
Returns true if this detail has a field with the given \a key, or false otherwise.
+ \since 1.1
*/
bool QOrganizerItemDetail::hasValue(const QString& key) const
{
@@ -499,6 +527,7 @@ bool QOrganizerItemDetail::hasValue(const QString& key) const
/*!
\internal
Returns true if this detail has a field with the given \a key, or false otherwise.
+ \since 1.1
*/
bool QOrganizerItemDetail::hasValue(const char * key) const
{
@@ -508,7 +537,9 @@ bool QOrganizerItemDetail::hasValue(const char * key) const
/*! Inserts \a value into the detail for the given \a key if \a value is valid. If \a value is invalid,
removes the field with the given \a key from the detail. Returns true if the given \a value was set
for the \a key (if the \a value was valid), or if the given \a key was removed from detail (if the
- \a value was invalid), and returns false if the key was unable to be removed (and the \a value was invalid) */
+ \a value was invalid), and returns false if the key was unable to be removed (and the \a value was invalid)
+ \since 1.1
+*/
bool QOrganizerItemDetail::setValue(const QString& key, const QVariant& value)
{
if (!value.isValid())
@@ -525,6 +556,7 @@ bool QOrganizerItemDetail::setValue(const QString& key, const QVariant& value)
removes the field with the given \a key from the detail. Returns true if the given \a value was set
for the \a key (if the \a value was valid), or if the given \a key was removed from detail (if the
\a value was invalid), and returns false if the key was unable to be removed (and the \a value was invalid)
+ \since 1.1
*/
bool QOrganizerItemDetail::setValue(const char* key, const QVariant& value)
{
@@ -538,6 +570,7 @@ bool QOrganizerItemDetail::setValue(const char* key, const QVariant& value)
/*!
Removes the value stored in this detail for the given \a key. Returns true if a value was stored
for the given \a key and the operation succeeded, and false otherwise.
+ \since 1.1
*/
bool QOrganizerItemDetail::removeValue(const QString& key)
{
@@ -550,6 +583,7 @@ bool QOrganizerItemDetail::removeValue(const QString& key)
\internal
Removes the value stored in this detail for the given \a key. Returns true if a value was stored
for the given \a key and the operation succeeded, and false otherwise.
+ \since 1.1
*/
bool QOrganizerItemDetail::removeValue(const char * key)
{
@@ -560,6 +594,7 @@ bool QOrganizerItemDetail::removeValue(const char * key)
/*!
Returns the values stored in this detail as a map from value key to value
+ \since 1.1
*/
QVariantMap QOrganizerItemDetail::variantValues() const
{
@@ -581,37 +616,44 @@ QVariantMap QOrganizerItemDetail::variantValues() const
removes the field with the given \a key from the detail. Returns true if the given \a value was set
for the \a key (if the \a value was valid), or if the given \a key was removed from detail (if the
\a value was invalid), and returns false if the key was unable to be removed (and the \a value was invalid)
+ \since 1.1
*/
/*!
\fn bool QOrganizerItemDetail::removeValue(const QLatin1Constant& key)
Removes the value stored in this detail for the given \a key. Returns true if a value was stored
for the given \a key and the operation succeeded, and false otherwise.
+ \since 1.1
*/
/*!
\fn bool QOrganizerItemDetail::hasValue(const QLatin1Constant& key) const
Returns true if this detail has a field with the given \a key, or false otherwise.
+ \since 1.1
*/
/*!
\fn QVariant QOrganizerItemDetail::variantValue(const QLatin1Constant& key) const
Returns the value stored in this detail for the given \a key as a QVariant, or an invalid QVariant if no value for the given \a key exists
+ \since 1.1
*/
/*!
\fn T QOrganizerItemDetail::value(const QLatin1Constant& key) const
\overload
Returns the value of the template type associated with the given \a key
+ \since 1.1
*/
/*!
\fn QString QOrganizerItemDetail::value(const QLatin1Constant& key) const
Returns the value stored in this detail for the given \a key as a QString, or an empty QString if
no value for the given \a key exists
+ \since 1.1
*/
/*!
\fn T QOrganizerItemDetail::value(const QString& key) const
Returns the value of the template type associated with the given \a key
+ \since 1.1
*/
/*!
@@ -632,6 +674,7 @@ QVariantMap QOrganizerItemDetail::variantValues() const
Some details may not be written to, while other details may
not be removed from an organizer item.
+ \since 1.1
\sa QOrganizerItemDetail::AccessConstraints
*/
QOrganizerItemDetail::AccessConstraints QOrganizerItemDetail::accessConstraints() const
diff --git a/src/organizer/qorganizeritemdetaildefinition.cpp b/src/organizer/qorganizeritemdetaildefinition.cpp
index 3742455f5f..0e2299f623 100644
--- a/src/organizer/qorganizeritemdetaildefinition.cpp
+++ b/src/organizer/qorganizeritemdetaildefinition.cpp
@@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE
\class QOrganizerItemDetailDefinition
\brief The QOrganizerItemDetailDefinition class provides the specification for fields in a detail.
\inmodule QtOrganizer
+ \since 1.1
The QOrganizerItemDetailDefinition class provides the specification for
a detail that can be included in any particular QOrganizerItem.
@@ -63,6 +64,7 @@ QTM_BEGIN_NAMESPACE
/*!
\fn QOrganizerItemDetailDefinition::operator!=(const QOrganizerItemDetailDefinition& other) const
Returns true if this detail definition has different allowable field types or uniqueness to the \a other definition
+ \since 1.1
*/
/*! Construct a new, invalid QOrganizerItemDetailDefinition */
@@ -71,13 +73,17 @@ QOrganizerItemDetailDefinition::QOrganizerItemDetailDefinition()
{
}
-/*! Constructs a new QOrganizerItemDetailDefinition from \a other */
+/*! Constructs a new QOrganizerItemDetailDefinition from \a other
+ \since 1.1
+*/
QOrganizerItemDetailDefinition::QOrganizerItemDetailDefinition(const QOrganizerItemDetailDefinition& other)
: d(other.d)
{
}
-/*! Assigns this QOrganizerItemDetailDefinition to \a other */
+/*! Assigns this QOrganizerItemDetailDefinition to \a other
+ \since 1.1
+*/
QOrganizerItemDetailDefinition& QOrganizerItemDetailDefinition::operator=(const QOrganizerItemDetailDefinition& other)
{
d = other.d;
@@ -89,7 +95,9 @@ QOrganizerItemDetailDefinition::~QOrganizerItemDetailDefinition()
{
}
-/*! Returns true if the definition has the same type, uniqueness and allowable value datatypes as \a other */
+/*! Returns true if the definition has the same type, uniqueness and allowable value datatypes as \a other
+ \since 1.1
+*/
bool QOrganizerItemDetailDefinition::operator==(const QOrganizerItemDetailDefinition& other) const
{
if (d->m_name != other.d->m_name)
@@ -101,7 +109,9 @@ bool QOrganizerItemDetailDefinition::operator==(const QOrganizerItemDetailDefini
return true;
}
-/*! Returns true if the id and fields of this definition are empty */
+/*! Returns true if the id and fields of this definition are empty
+ \since 1.1
+*/
bool QOrganizerItemDetailDefinition::isEmpty() const
{
if (!d->m_name.isEmpty())
@@ -114,6 +124,7 @@ bool QOrganizerItemDetailDefinition::isEmpty() const
#ifndef QT_NO_DATASTREAM
/*!
* Writes \a definition to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetailDefinition& definition)
{
@@ -126,6 +137,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetailDefinition&
/*!
* Reads a detail definition from stream \a in into \a definition.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemDetailDefinition& definition)
{
@@ -169,7 +181,9 @@ QDebug operator<<(QDebug dbg, const QOrganizerItemDetailDefinition& definition)
}
#endif
-/*! Sets the unique identifier of this detail type to \a definitionName. */
+/*! Sets the unique identifier of this detail type to \a definitionName.
+ \since 1.1
+*/
void QOrganizerItemDetailDefinition::setName(const QString& definitionName)
{
d->m_name = definitionName;
@@ -179,44 +193,57 @@ void QOrganizerItemDetailDefinition::setName(const QString& definitionName)
Sets whether an organizer item can have more than one detail of this type.
If \a unique is true, only one detail of this type can be added.
Otherwise, any number can be added.
+ \since 1.1
*/
void QOrganizerItemDetailDefinition::setUnique(bool unique)
{
d->m_unique = unique;
}
-/*! Returns the identifier of this detail definition */
+/*! Returns the identifier of this detail definition
+ \since 1.1
+*/
QString QOrganizerItemDetailDefinition::name() const
{
return d->m_name;
}
-/*! Returns the per-organizer item uniqueness of this definition */
+/*! Returns the per-organizer item uniqueness of this definition
+ \since 1.1
+*/
bool QOrganizerItemDetailDefinition::isUnique() const
{
return d->m_unique;
}
-/*! Sets the fields which constitute the data of details of this this definition to \a fields */
+/*! Sets the fields which constitute the data of details of this this definition to \a fields
+ \since 1.1
+*/
void QOrganizerItemDetailDefinition::setFields(const QMap<QString, QOrganizerItemDetailFieldDefinition>& fields)
{
d->m_fields = fields;
}
-/*! Returns the map of keys to fields which are present in details of this definition */
+/*! Returns the map of keys to fields which are present in details of this definition
+ \since 1.1
+*/
QMap<QString, QOrganizerItemDetailFieldDefinition> QOrganizerItemDetailDefinition::fields() const
{
return d->m_fields;
}
/*! Inserts the field \a field into the map of fields which constitute the data of details of this definition for the given field key \a key.
- If another field for that key already exists in the definition, it will be overwritten. */
+ If another field for that key already exists in the definition, it will be overwritten.
+ \since 1.1
+*/
void QOrganizerItemDetailDefinition::insertField(const QString& key, const QOrganizerItemDetailFieldDefinition& field)
{
d->m_fields.insert(key, field);
}
-/*! Removes the field associated with the given field key \a key from the map of fields which constitute the data of details of this definition. */
+/*! Removes the field associated with the given field key \a key from the map of fields which constitute the data of details of this definition.
+ \since 1.1
+*/
void QOrganizerItemDetailDefinition::removeField(const QString& key)
{
d->m_fields.remove(key);
diff --git a/src/organizer/qorganizeritemdetailfielddefinition.cpp b/src/organizer/qorganizeritemdetailfielddefinition.cpp
index 33efff62f1..680b3800a2 100644
--- a/src/organizer/qorganizeritemdetailfielddefinition.cpp
+++ b/src/organizer/qorganizeritemdetailfielddefinition.cpp
@@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerItemDetailFieldDefinition
\brief The QOrganizerItemDetailFieldDefinition class provides a field in a QOrganizerItemDetail.
+ \since 1.1
\inmodule QtOrganizer
@@ -75,6 +76,7 @@ QOrganizerItemDetailFieldDefinition::~QOrganizerItemDetailFieldDefinition()
/*!
* Constructs a copy of the \a other field
+ \since 1.1
*/
QOrganizerItemDetailFieldDefinition::QOrganizerItemDetailFieldDefinition(const QOrganizerItemDetailFieldDefinition& other)
: d(other.d)
@@ -83,6 +85,7 @@ QOrganizerItemDetailFieldDefinition::QOrganizerItemDetailFieldDefinition(const Q
/*!
* Assigns the field to be equal to the \a other field
+ \since 1.1
*/
QOrganizerItemDetailFieldDefinition& QOrganizerItemDetailFieldDefinition::operator=(const QOrganizerItemDetailFieldDefinition& other)
{
@@ -92,6 +95,7 @@ QOrganizerItemDetailFieldDefinition& QOrganizerItemDetailFieldDefinition::operat
/*!
* Returns the data type of the field
+ \since 1.1
*/
int QOrganizerItemDetailFieldDefinition::dataType() const
{
@@ -100,6 +104,7 @@ int QOrganizerItemDetailFieldDefinition::dataType() const
/*!
* Sets the data type of the field to \a type
+ \since 1.1
*/
void QOrganizerItemDetailFieldDefinition::setDataType(int type)
{
@@ -108,6 +113,7 @@ void QOrganizerItemDetailFieldDefinition::setDataType(int type)
/*!
* Returns the list of allowable values which this field may store
+ \since 1.1
*/
QVariantList QOrganizerItemDetailFieldDefinition::allowableValues() const
{
@@ -116,6 +122,7 @@ QVariantList QOrganizerItemDetailFieldDefinition::allowableValues() const
/*!
* Sets the list of allowable values which this field may store to \a values
+ \since 1.1
*/
void QOrganizerItemDetailFieldDefinition::setAllowableValues(const QVariantList values)
{
@@ -124,6 +131,7 @@ void QOrganizerItemDetailFieldDefinition::setAllowableValues(const QVariantList
/*!
* Returns true if the allowable values and data type of the \a other field are equal to those of this field
+ \since 1.1
*/
bool QOrganizerItemDetailFieldDefinition::operator==(const QOrganizerItemDetailFieldDefinition& other) const
{
@@ -136,6 +144,7 @@ bool QOrganizerItemDetailFieldDefinition::operator==(const QOrganizerItemDetailF
/*!
* Returns true if the allowable values or data type of the \a other field differ from those of this field
+ \since 1.1
*/
bool QOrganizerItemDetailFieldDefinition::operator!=(const QOrganizerItemDetailFieldDefinition& other) const
{
@@ -145,6 +154,7 @@ bool QOrganizerItemDetailFieldDefinition::operator!=(const QOrganizerItemDetailF
#ifndef QT_NO_DATASTREAM
/*!
* Writes the detail field definition \a definition to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetailFieldDefinition& definition)
{
@@ -154,6 +164,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemDetailFieldDefinit
/*!
* Reads a detail field definition from stream \a in into \a definition.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemDetailFieldDefinition& definition)
{
@@ -175,6 +186,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemDetailFieldDefinition& de
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a definition to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerItemDetailFieldDefinition& definition)
{
diff --git a/src/organizer/qorganizeritemengineid.cpp b/src/organizer/qorganizeritemengineid.cpp
index 2ae29e35b2..d415147c69 100644
--- a/src/organizer/qorganizeritemengineid.cpp
+++ b/src/organizer/qorganizeritemengineid.cpp
@@ -46,6 +46,7 @@
\relates QOrganizerItemId
\brief The QOrganizerItemEngineId class uniquely identifies an item within a
particular engine plugin.
+ \since 1.1
\inmodule QtOrganizer
\ingroup organizer-backends
@@ -69,6 +70,7 @@
Returns true if this id is equal to the \a other id; false otherwise.
Note that when implementing this function, you do not have to check that the type is the same,
since the function which calls this function (in QOrganizerItemId) does that check for you.
+ \since 1.1
*/
/*!
@@ -76,6 +78,7 @@
Returns true if this id is less than the \a other id; false otherwise.
Note that when implementing this function, you do not have to check that the type is the same,
since the function which calls this function (in QOrganizerItemId) does that check for you.
+ \since 1.1
*/
/*!
@@ -84,6 +87,7 @@
the id. If the item which the id identifies has not been deleted,
the id should still be valid in the manager identified by the
manager URI returned by this function.
+ \since 1.1
*/
/*!
@@ -92,21 +96,25 @@
required to identify a particular item in the manager which created
the id, formatted according to the serialization format of the
manager.
+ \since 1.1
*/
/*!
\fn QOrganizerItemEngineId::clone() const
Returns a deep-copy clone of this id.
The caller takes ownership of the returned engine item id.
+ \since 1.1
*/
/*!
\fn QOrganizerItemEngineId::debugStreamOut(QDebug& dbg) const
Streams this id out to the debug stream \a dbg.
+ \since 1.1
*/
/*!
\fn QOrganizerItemEngineId::hash() const
Returns the hash value of this id.
+ \since 1.1
*/
diff --git a/src/organizer/qorganizeritemfetchhint.cpp b/src/organizer/qorganizeritemfetchhint.cpp
index 0ac698df09..9bfd2a6cb1 100644
--- a/src/organizer/qorganizeritemfetchhint.cpp
+++ b/src/organizer/qorganizeritemfetchhint.cpp
@@ -55,6 +55,7 @@ QTM_BEGIN_NAMESPACE
\brief The QOrganizerItemFetchHint class provides hints to the manager about which organizer item
information needs to be retrieved in an asynchronous fetch request or a synchronous
function call.
+ \since 1.1
\inmodule QtOrganizer
@@ -98,6 +99,7 @@ QOrganizerItemFetchHint::QOrganizerItemFetchHint()
/*!
Constructs a new organizer item fetch hint as a copy of \a other
+ \since 1.1
*/
QOrganizerItemFetchHint::QOrganizerItemFetchHint(const QOrganizerItemFetchHint &other)
: d(other.d)
@@ -113,6 +115,7 @@ QOrganizerItemFetchHint::~QOrganizerItemFetchHint()
/*!
Assigns this fetch hint to be equal to the \a other fetch hint
+ \since 1.1
*/
QOrganizerItemFetchHint& QOrganizerItemFetchHint::operator=(const QOrganizerItemFetchHint& other)
{
@@ -126,6 +129,7 @@ QOrganizerItemFetchHint& QOrganizerItemFetchHint::operator=(const QOrganizerItem
This hint may be ignored by the backend, in which case it will return the full set of details for
each organizer item retrieved.
+ \since 1.1
\sa setDetailDefinitionsHint()
*/
QStringList QOrganizerItemFetchHint::detailDefinitionsHint() const
@@ -139,6 +143,7 @@ QStringList QOrganizerItemFetchHint::detailDefinitionsHint() const
This hint may be ignored by the backend, in which case it will return the full set of details for
each organizer item retrieved.
+ \since 1.1
\sa detailDefinitionsHint()
*/
void QOrganizerItemFetchHint::setDetailDefinitionsHint(const QStringList& definitionNames)
@@ -151,6 +156,7 @@ void QOrganizerItemFetchHint::setDetailDefinitionsHint(const QStringList& defini
These hints may be ignored by the backend, in which case it will return
the full set of information accessible in an organizer item.
+ \since 1.1
\sa setOptimizationHints()
*/
QOrganizerItemFetchHint::OptimizationHints QOrganizerItemFetchHint::optimizationHints() const
@@ -163,6 +169,7 @@ QOrganizerItemFetchHint::OptimizationHints QOrganizerItemFetchHint::optimization
These hints may be ignored by the backend, in which case it will return
the full set of information accessible in an organizer item.
+ \since 1.1
\sa optimizationHints()
*/
void QOrganizerItemFetchHint::setOptimizationHints(OptimizationHints hints)
@@ -199,6 +206,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemFetchHint& hint)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a hint to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerItemFetchHint& hint)
{
diff --git a/src/organizer/qorganizeritemfilter.cpp b/src/organizer/qorganizeritemfilter.cpp
index c5f28c330c..d8b74304d3 100644
--- a/src/organizer/qorganizeritemfilter.cpp
+++ b/src/organizer/qorganizeritemfilter.cpp
@@ -54,6 +54,7 @@
\class QOrganizerItemFilter
\brief The QOrganizerItemFilter class is used to select organizer items made available
through a QOrganizerManager.
+ \since 1.1
\inmodule QtOrganizer
@@ -92,6 +93,7 @@
/*!
\fn QOrganizerItemFilter::operator!=(const QOrganizerItemFilter& other) const
Returns true if this filter is not identical to the \a other filter.
+ \since 1.1
\sa operator==()
*/
@@ -110,13 +112,17 @@ QOrganizerItemFilter::QOrganizerItemFilter()
{
}
-/*! Constructs a new copy of \a other */
+/*! Constructs a new copy of \a other
+ \since 1.1
+*/
QOrganizerItemFilter::QOrganizerItemFilter(const QOrganizerItemFilter& other)
: d_ptr(other.d_ptr)
{
}
-/*! Assigns this filter to be \a other */
+/*! Assigns this filter to be \a other
+ \since 1.1
+*/
QOrganizerItemFilter& QOrganizerItemFilter::operator=(const QOrganizerItemFilter& other)
{
if (this != &other) {
@@ -130,7 +136,9 @@ QOrganizerItemFilter::~QOrganizerItemFilter()
{
}
-/*! Returns the type of the filter */
+/*! Returns the type of the filter
+ \since 1.1
+*/
QOrganizerItemFilter::FilterType QOrganizerItemFilter::type() const
{
if (!d_ptr)
@@ -138,7 +146,9 @@ QOrganizerItemFilter::FilterType QOrganizerItemFilter::type() const
return d_ptr->type();
}
-/*! Returns true if the filter has the same type and criteria as \a other */
+/*! Returns true if the filter has the same type and criteria as \a other
+ \since 1.1
+*/
bool QOrganizerItemFilter::operator==(const QOrganizerItemFilter& other) const
{
/* A default filter is only equal to other default filters */
@@ -158,6 +168,7 @@ bool QOrganizerItemFilter::operator==(const QOrganizerItemFilter& other) const
* Writes \a filter to the stream \a out.
*
* A QOrganizerItemIdFilter will not be preserved if streamed to a QDataStream.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemFilter& filter)
{
@@ -172,6 +183,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemFilter& filter)
* Reads an organizer item filter from stream \a in into \a filter.
*
* A QOrganizerItemIdFilter will not be preserved if streamed from a QDataStream.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemFilter& filter)
{
@@ -220,6 +232,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemFilter& filter)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a filter to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerItemFilter& filter)
{
@@ -246,6 +259,7 @@ QOrganizerItemFilter::QOrganizerItemFilter(QOrganizerItemFilterPrivate *d)
/*!
\relates QOrganizerItemFilter
Returns a filter which is the intersection of the \a left and \a right filters
+ \since 1.1
\sa QOrganizerItemIntersectionFilter
*/
const QOrganizerItemFilter operator&(const QOrganizerItemFilter& left, const QOrganizerItemFilter& right)
@@ -274,6 +288,7 @@ const QOrganizerItemFilter operator&(const QOrganizerItemFilter& left, const QOr
/*!
\relates QOrganizerItemFilter
Returns a filter which is the union of the \a left and \a right filters
+ \since 1.1
\sa QOrganizerItemUnionFilter
*/
const QOrganizerItemFilter operator|(const QOrganizerItemFilter& left, const QOrganizerItemFilter& right)
diff --git a/src/organizer/qorganizeritemid.cpp b/src/organizer/qorganizeritemid.cpp
index de0999d342..589f3a8f27 100644
--- a/src/organizer/qorganizeritemid.cpp
+++ b/src/organizer/qorganizeritemid.cpp
@@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE
\class QOrganizerItemId
\brief The QOrganizerItemId class provides information that uniquely identifies
an organizer item in a particular manager.
+ \since 1.1
\inmodule QtOrganizer
@@ -81,6 +82,7 @@ QOrganizerItemId::QOrganizerItemId()
\a engineItemId. This id takes ownership of the engine-unique item id and
will delete it when the id goes out of scope. Engine implementors must not
delete the \a engineItemId or undefined behaviour will occur.
+ \since 1.1
*/
QOrganizerItemId::QOrganizerItemId(QOrganizerItemEngineId* engineItemId)
: d(engineItemId)
@@ -94,20 +96,26 @@ QOrganizerItemId::~QOrganizerItemId()
{
}
-/*! Constructs a new organizer item id as a copy of \a other */
+/*! Constructs a new organizer item id as a copy of \a other
+ \since 1.1
+*/
QOrganizerItemId::QOrganizerItemId(const QOrganizerItemId& other)
: d(other.d)
{
}
-/*! Assigns the organizer item id to be equal to \a other */
+/*! Assigns the organizer item id to be equal to \a other
+ \since 1.1
+*/
QOrganizerItemId& QOrganizerItemId::operator=(const QOrganizerItemId& other)
{
d = other.d;
return *this;
}
-/*! Returns true if the organizer item id has the same manager URI and id as \a other */
+/*! Returns true if the organizer item id has the same manager URI and id as \a other
+ \since 1.1
+*/
bool QOrganizerItemId::operator==(const QOrganizerItemId& other) const
{
// if both ids are null then they are equal.
@@ -123,7 +131,9 @@ bool QOrganizerItemId::operator==(const QOrganizerItemId& other) const
return false;
}
-/*! Returns true if either the manager URI or id of the organizer item id is different to that of \a other */
+/*! Returns true if either the manager URI or id of the organizer item id is different to that of \a other
+ \since 1.1
+*/
bool QOrganizerItemId::operator!=(const QOrganizerItemId& other) const
{
return !(*this == other);
@@ -142,6 +152,7 @@ bool QOrganizerItemId::operator!=(const QOrganizerItemId& other) const
This operator is provided primarily to allow use of a QOrganizerItemId
as a key in a QMap.
+ \since 1.1
*/
bool QOrganizerItemId::operator<(const QOrganizerItemId& other) const
{
@@ -164,6 +175,7 @@ bool QOrganizerItemId::operator<(const QOrganizerItemId& other) const
/*!
* Returns the hash value for \a key.
+ \since 1.1
*/
uint qHash(const QOrganizerItemId &key)
{
@@ -187,6 +199,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerItemId& id)
#ifndef QT_NO_DATASTREAM
/*!
Streams \a itemId to the data stream \a out
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemId& itemId)
{
@@ -196,6 +209,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemId& itemId)
/*!
Streams \a collectionId in from the data stream \a in
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemId& itemId)
{
@@ -209,6 +223,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemId& itemId)
/*!
Returns true if the local id part of the id is a null (default constructed) local id; otherwise, returns false.
+ \since 1.1
*/
bool QOrganizerItemId::isNull() const
{
@@ -217,6 +232,7 @@ bool QOrganizerItemId::isNull() const
/*!
* Returns the URI of the manager which contains the organizer item identified by this id
+ \since 1.1
*/
QString QOrganizerItemId::managerUri() const
{
@@ -225,6 +241,7 @@ QString QOrganizerItemId::managerUri() const
/*!
Builds a string from the given \a managerName, \a params and \a engineIdString
+ \since 1.1
*/
inline QString buildIdString(const QString& managerName, const QMap<QString, QString>& params, const QString& engineIdString)
{
@@ -258,6 +275,7 @@ inline QString buildIdString(const QString& managerName, const QMap<QString, QSt
/*!
Parses the individual components of the given \a idString and fills the \a managerName, \a params and \a engineIdString.
Returns true if the parts could be parsed successfully, false otherwise.
+ \since 1.1
*/
inline bool parseIdString(const QString& idString, QString* managerName, QMap<QString, QString>* params, QString* engineIdString)
{
@@ -318,6 +336,7 @@ inline bool parseIdString(const QString& idString, QString* managerName, QMap<QS
/*!
Serializes the id to a string. The format of the string will be:
"qtorganizer:managerName:constructionParams:serializedEngineLocalItemId"
+ \since 1.1
*/
QString QOrganizerItemId::toString() const
{
@@ -338,6 +357,7 @@ QString QOrganizerItemId::toString() const
Deserializes the given \a idString. Returns a default-constructed (null)
item id if the given \a idString is not a valid, serialized item id, or
if the manager engine from which the id came could not be found.
+ \since 1.1
*/
QOrganizerItemId QOrganizerItemId::fromString(const QString& idString)
{
diff --git a/src/organizer/qorganizeritemobserver.cpp b/src/organizer/qorganizeritemobserver.cpp
index 666cafbd14..06e9b93bdb 100644
--- a/src/organizer/qorganizeritemobserver.cpp
+++ b/src/organizer/qorganizeritemobserver.cpp
@@ -60,12 +60,14 @@ QTM_USE_NAMESPACE
\brief The QOrganizerItemObserver class is a simple class that emits a signal when a single
particular item is updated or deleted.
\inmodule QtOrganizer
+ \since 1.2
\ingroup organizer-main
*/
/*!
Constructs a QOrganizerItemObserver to observe the item in \a manager with the given \a itemId.
+ \since 1.2
*/
QOrganizerItemObserver::QOrganizerItemObserver(QOrganizerManager* manager,
const QOrganizerItemId& itemId,
@@ -92,6 +94,7 @@ QOrganizerItemObserver::~QOrganizerItemObserver()
/*!
Returns the id of the item that this object observes.
+ \since 1.2
*/
QOrganizerItemId QOrganizerItemObserver::itemId() const {
return d->m_id;
@@ -101,12 +104,14 @@ QOrganizerItemId QOrganizerItemObserver::itemId() const {
\fn void QOrganizerItemObserver::itemChanged()
This signal is emitted when the observed item is changed in the manager.
+ \since 1.2
*/
/*!
\fn void QOrganizerItemObserver::itemRemoved()
This signal is emitted when the observed item is removed from the manager.
+ \since 1.2
*/
#include "moc_qorganizeritemobserver.cpp"
diff --git a/src/organizer/qorganizeritemsortorder.cpp b/src/organizer/qorganizeritemsortorder.cpp
index eeeec667c0..8d0e620484 100644
--- a/src/organizer/qorganizeritemsortorder.cpp
+++ b/src/organizer/qorganizeritemsortorder.cpp
@@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerItemSortOrder
\brief The QOrganizerItemSortOrder class defines how a list of organizer items should be ordered according to some criteria
+ \since 1.1
\inmodule QtOrganizer
*/
@@ -65,11 +66,13 @@ QTM_BEGIN_NAMESPACE
/*!
* \fn QOrganizerItemSortOrder::operator QList<QOrganizerItemSortOrder>() const
* Constructs a new list of sort orders containing only the current sort order
+ \since 1.1
*/
/*!
* \fn QOrganizerItemSortOrder::operator!=(const QOrganizerItemSortOrder& other) const
* Returns true if this sort order is not identical to the \a other sort order
+ \since 1.1
* \sa operator==()
*/
@@ -90,6 +93,7 @@ QOrganizerItemSortOrder::~QOrganizerItemSortOrder()
/*!
* Constructs a copy of the \a other sort order
+ \since 1.1
*/
QOrganizerItemSortOrder::QOrganizerItemSortOrder(const QOrganizerItemSortOrder& other)
: d(other.d)
@@ -99,6 +103,7 @@ QOrganizerItemSortOrder::QOrganizerItemSortOrder(const QOrganizerItemSortOrder&
/*!
* Assigns this sort order to be equal to \a other
+ \since 1.1
*/
QOrganizerItemSortOrder& QOrganizerItemSortOrder::operator=(const QOrganizerItemSortOrder& other)
{
@@ -110,6 +115,7 @@ QOrganizerItemSortOrder& QOrganizerItemSortOrder::operator=(const QOrganizerItem
/*!
* Returns true if the sort order is able to be used to sort a list of organizer items; otherwise, returns false
+ \since 1.1
*/
bool QOrganizerItemSortOrder::isValid() const
{
@@ -122,6 +128,7 @@ bool QOrganizerItemSortOrder::isValid() const
/*!
* Returns true if this sort order is identical to the \a other sort order
* \sa operator!=()
+ \since 1.1
*/
bool QOrganizerItemSortOrder::operator ==(const QOrganizerItemSortOrder& other) const
{
@@ -137,6 +144,7 @@ bool QOrganizerItemSortOrder::operator ==(const QOrganizerItemSortOrder& other)
#ifndef QT_NO_DATASTREAM
/*!
* Writes \a sortOrder to the stream \a out.
+ \since 1.1
*/
QDataStream& operator<<(QDataStream& out, const QOrganizerItemSortOrder& sortOrder)
{
@@ -151,6 +159,7 @@ QDataStream& operator<<(QDataStream& out, const QOrganizerItemSortOrder& sortOrd
/*!
* Reads a sort order from stream \a in into \a sortOrder.
+ \since 1.1
*/
QDataStream& operator>>(QDataStream& in, QOrganizerItemSortOrder& sortOrder)
{
@@ -177,6 +186,7 @@ QDataStream& operator>>(QDataStream& in, QOrganizerItemSortOrder& sortOrder)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a sortOrder to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerItemSortOrder& sortOrder)
{
@@ -189,7 +199,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerItemSortOrder& sortOrder)
dbg.nospace() << ",";
dbg.nospace() << "blankPolicy=";
dbg.nospace() << static_cast<quint32>(sortOrder.blankPolicy());
- dbg.nospace() << ",";
+ dbg.nospace() << ",";
dbg.nospace() << "direction=";
dbg.nospace() << static_cast<quint32>(sortOrder.direction());
dbg.nospace() << ",";
@@ -204,6 +214,7 @@ QDebug operator<<(QDebug dbg, const QOrganizerItemSortOrder& sortOrder)
* Sets the definition name of the details which will be inspected to perform sorting to \a definitionName,
* and the name of those details' fields which contains the value which organizer items will be sorted by to \a fieldName
* \sa detailDefinitionName(), detailFieldName()
+ \since 1.1
*/
void QOrganizerItemSortOrder::setDetailDefinitionName(const QString& definitionName, const QString& fieldName)
{
@@ -219,6 +230,7 @@ void QOrganizerItemSortOrder::setDetailDefinitionName(const QString& definitionN
/*!
* Sets the sort order's policy on blank values with respect to sorting to \a blankPolicy
* \sa blankPolicy()
+ \since 1.1
*/
void QOrganizerItemSortOrder::setBlankPolicy(BlankPolicy blankPolicy)
{
@@ -228,6 +240,7 @@ void QOrganizerItemSortOrder::setBlankPolicy(BlankPolicy blankPolicy)
/*!
* Sets the sort order direction to \a direction
* \sa direction()
+ \since 1.1
*/
void QOrganizerItemSortOrder::setDirection(Qt::SortOrder direction)
{
@@ -239,6 +252,7 @@ void QOrganizerItemSortOrder::setDirection(Qt::SortOrder direction)
* Note that if an organizer item has multiple details of the definition, the result of the sorting
* is undefined.
* \sa setDetailDefinitionName()
+ \since 1.1
*/
QString QOrganizerItemSortOrder::detailDefinitionName() const
{
@@ -248,6 +262,7 @@ QString QOrganizerItemSortOrder::detailDefinitionName() const
/*!
* Returns the name of the field in the definition which will be inspected to perform sorting
* \sa setDetailDefinitionName()
+ \since 1.1
*/
QString QOrganizerItemSortOrder::detailFieldName() const
{
@@ -257,6 +272,7 @@ QString QOrganizerItemSortOrder::detailFieldName() const
/*!
* Returns the blank policy of the sort order
* \sa setBlankPolicy()
+ \since 1.1
*/
QOrganizerItemSortOrder::BlankPolicy QOrganizerItemSortOrder::blankPolicy() const
{
@@ -266,6 +282,7 @@ QOrganizerItemSortOrder::BlankPolicy QOrganizerItemSortOrder::blankPolicy() cons
/*!
* Returns the direction of the sort order
* \sa setDirection()
+ \since 1.1
*/
Qt::SortOrder QOrganizerItemSortOrder::direction() const
{
@@ -275,6 +292,7 @@ Qt::SortOrder QOrganizerItemSortOrder::direction() const
/*!
* Returns the case sensitivity of the sort order
* \sa setCaseSensitivity()
+ \since 1.1
*/
Qt::CaseSensitivity QOrganizerItemSortOrder::caseSensitivity() const
{
@@ -284,6 +302,7 @@ Qt::CaseSensitivity QOrganizerItemSortOrder::caseSensitivity() const
/*!
* Sets the case sensitivity of the sort order to \a sensitivity
* \sa caseSensitivity()
+ \since 1.1
*/
void QOrganizerItemSortOrder::setCaseSensitivity(Qt::CaseSensitivity sensitivity)
{
diff --git a/src/organizer/qorganizermanager.cpp b/src/organizer/qorganizermanager.cpp
index 16bd223df4..2b57afcbba 100644
--- a/src/organizer/qorganizermanager.cpp
+++ b/src/organizer/qorganizermanager.cpp
@@ -56,6 +56,7 @@ QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerManager
\brief The QOrganizerManager class provides an interface which allows clients with access to organizer item information stored in a particular backend.
+ \since 1.1
\inmodule QtOrganizer
\ingroup organizer-main
@@ -77,30 +78,35 @@ QTM_BEGIN_NAMESPACE
This signal is emitted by the manager if its internal state changes, and it is unable to determine the changes
which occurred, or if the manager considers the changes to be radical enough to require clients to reload all data.
If this signal is emitted, no other signals will be emitted for the associated changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManager::itemsAdded(const QList<QOrganizerItemId>& itemIds)
This signal is emitted at some point once the items identified by \a itemIds have been added to a datastore managed by this manager.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManager::itemsChanged(const QList<QOrganizerItemId>& itemIds)
This signal is emitted at some point once the items identified by \a itemIds have been modified in a datastore managed by this manager.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManager::itemsRemoved(const QList<QOrganizerItemId>& itemIds)
This signal is emitted at some point once the items identified by \a itemIds have been removed from a datastore managed by this manager.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManager::collectionsAdded(const QList<QOrganizerCollectionId>& collectionIds)
This signal is emitted at some point once the collections identified by \a collectionIds have been added to a datastore managed by this manager.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
@@ -108,12 +114,14 @@ QTM_BEGIN_NAMESPACE
This signal is emitted at some point once the metadata for the collections identified by \a collectionIds have been modified in a datastore managed by this manager.
This signal is not emitted if one of the items in this collection has changed - itemsChanged() will be emitted instead.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManager::collectionsRemoved(const QList<QOrganizerCollectionId>& collectionIds)
This signal is emitted at some point once the collections identified by \a collectionIds have been removed from a datastore managed by this manager.
This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
@@ -125,6 +133,7 @@ QTM_BEGIN_NAMESPACE
Returns a list of available manager ids that can be used when constructing
a QOrganizerManager. If an empty id is specified to the constructor, the
first value in this list will be used instead.
+ \since 1.1
*/
QStringList QOrganizerManager::availableManagers()
{
@@ -145,6 +154,7 @@ QStringList QOrganizerManager::availableManagers()
/*!
Splits the given \a uri into the manager, store, and parameters that it describes, and places the information into the memory addressed by \a pManagerId and \a pParams respectively. Returns true if \a uri could be split successfully, otherwise returns false
+ \since 1.1
*/
bool QOrganizerManager::parseUri(const QString& uri, QString* pManagerId, QMap<QString, QString>* pParams)
{
@@ -201,7 +211,9 @@ bool QOrganizerManager::parseUri(const QString& uri, QString* pManagerId, QMap<Q
return true;
}
-/*! Returns a URI that completely describes a manager implementation, datastore, and the parameters with which to instantiate the manager, from the given \a managerName, \a params and an optional \a implementationVersion */
+/*! Returns a URI that completely describes a manager implementation, datastore, and the parameters with which to instantiate the manager, from the given \a managerName, \a params and an optional \a implementationVersion
+ \since 1.1
+*/
QString QOrganizerManager::buildUri(const QString& managerName, const QMap<QString, QString>& params, int implementationVersion)
{
QString ret(QLatin1String("qtorganizer:%1:%2"));
@@ -232,6 +244,7 @@ QString QOrganizerManager::buildUri(const QString& managerName, const QMap<QStri
/*!
Constructs a QOrganizerManager whose implementation, store and parameters are specified in the given \a storeUri,
and whose parent object is \a parent.
+ \since 1.1
*/
QOrganizerManager* QOrganizerManager::fromUri(const QString& storeUri, QObject* parent)
{
@@ -267,6 +280,7 @@ QOrganizerManager::QOrganizerManager(QObject* parent)
If an empty \a managerName is specified, the default implementation for the platform will
be used.
+ \since 1.1
*/
QOrganizerManager::QOrganizerManager(const QString& managerName, const QMap<QString, QString>& parameters, QObject* parent)
: QObject(parent),
@@ -301,6 +315,7 @@ void QOrganizerManager::createEngine(const QString& managerName, const QMap<QStr
If an empty \a managerName is specified, the default implementation for the platform will be instantiated.
If the specified implementation version is not available, the manager with the name \a managerName with the default implementation version is instantiated.
+ \since 1.1
*/
QOrganizerManager::QOrganizerManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters, QObject* parent)
: QObject(parent),
@@ -341,7 +356,9 @@ QOrganizerManager::~QOrganizerManager()
\value TimeoutError The most recent operation failed because it took longer than expected. It may be possible to try again.
*/
-/*! Return the error code of the most recent operation */
+/*! Return the error code of the most recent operation
+ \since 1.1
+*/
QOrganizerManager::Error QOrganizerManager::error() const
{
return d->m_lastError;
@@ -355,6 +372,7 @@ QOrganizerManager::Error QOrganizerManager::error() const
for which the error (whose error code is stored in the value for
that key in the map) occurred during the batch operation.
\sa error(), saveItems(), removeItems()
+ \since 1.1
*/
QMap<int, QOrganizerManager::Error> QOrganizerManager::errorMap() const
{
@@ -372,6 +390,7 @@ QMap<int, QOrganizerManager::Error> QOrganizerManager::errorMap() const
The \a fetchHint allows clients to specify which pieces of information they are interested or not interested in, to allow
backends to optimise data retrieval if possible. Note that it is simply a hint; backends can ignore the \a fetchHint,
but if they do so they must return the full item.
+ \since 1.1
*/
QList<QOrganizerItem> QOrganizerManager::itemOccurrences(const QOrganizerItem& parentItem, const QDateTime& periodStart, const QDateTime& periodEnd, int maxCount, const QOrganizerItemFetchHint& fetchHint) const
{
@@ -382,6 +401,7 @@ QList<QOrganizerItem> QOrganizerManager::itemOccurrences(const QOrganizerItem& p
/*!
Returns a list of organizer item ids that match the given \a filter, sorted according to the given list of \a sortOrders.
Depending on the backend, this filtering operation may involve retrieving all organizer items.
+ \since 1.1
*/
QList<QOrganizerItemId> QOrganizerManager::itemIds(const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders) const
{
@@ -396,6 +416,7 @@ QList<QOrganizerItemId> QOrganizerManager::itemIds(const QOrganizerItemFilter& f
and a default-constructed (invalid) \a endDate specifies an open end date (matches anything which occurs after the \a startDate).
If both the \a startDate and \a endDate are invalid, this function will return the ids of all items which match the \a filter criteria.
Depending on the backend, this filtering operation may involve retrieving all organizer items.
+ \since 1.1
*/
QList<QOrganizerItemId> QOrganizerManager::itemIds(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders) const
{
@@ -417,6 +438,7 @@ QList<QOrganizerItemId> QOrganizerManager::itemIds(const QDateTime& startDate, c
fetch hint, they should save it back using a partial save, masked by the same set of detail names
in order to avoid information loss.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManager::items(const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint) const
@@ -445,6 +467,7 @@ QList<QOrganizerItem> QOrganizerManager::items(const QOrganizerItemFilter& filte
fetch hint, they should save it back using a partial save, masked by the same set of detail names
in order to avoid information loss.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManager::items(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint) const
@@ -474,6 +497,7 @@ QList<QOrganizerItem> QOrganizerManager::items(const QDateTime& startDate, const
fetch hint, they should save it back using a partial save, masked by the same set of detail names
in order to avoid information loss.
+ \since 1.2
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManager::items(const QDateTime& startDate, const QDateTime& endDate, int maxCount, const QOrganizerItemFilter& filter, const QOrganizerItemFetchHint& fetchHint) const
@@ -500,6 +524,7 @@ QList<QOrganizerItem> QOrganizerManager::items(const QDateTime& startDate, const
fetch hint, they should save it back using a partial save, masked by the same set of detail names
in order to avoid information loss.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManager::itemsForExport(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint) const
@@ -520,6 +545,7 @@ QList<QOrganizerItem> QOrganizerManager::itemsForExport(const QDateTime& startDa
fetch hint, they should save it back using a partial save, masked by the same set of detail names
in order to avoid information loss.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QOrganizerItem QOrganizerManager::item(const QOrganizerItemId& itemId, const QOrganizerItemFetchHint& fetchHint) const
@@ -560,6 +586,7 @@ QOrganizerItem QOrganizerManager::item(const QOrganizerItemId& itemId, const QOr
and as such, clients should fetch an organizer item if they want the most up-to-date information
by calling \l QOrganizerManager::item().
+ \since 1.1
\sa managerUri()
*/
bool QOrganizerManager::saveItem(QOrganizerItem* item)
@@ -577,6 +604,7 @@ bool QOrganizerManager::saveItem(QOrganizerItem* item)
Remove the organizer item identified by \a itemId from the database.
Returns true if the organizer item was removed successfully, otherwise
returns false.
+ \since 1.1
*/
bool QOrganizerManager::removeItem(const QOrganizerItemId& itemId)
{
@@ -601,6 +629,7 @@ bool QOrganizerManager::removeItem(const QOrganizerItemId& itemId)
For each newly saved organizer item that was successful, the id of the organizer item
in the \a items list will be updated with the new value.
+ \since 1.1
\sa QOrganizerManager::saveItem()
*/
bool QOrganizerManager::saveItems(QList<QOrganizerItem>* items)
@@ -635,6 +664,7 @@ bool QOrganizerManager::saveItems(QList<QOrganizerItem>* items)
For each newly saved organizer item that was successful, the id of the organizer item
in the \a items list will be updated with the new value.
+ \since 1.2
\sa QOrganizerManager::saveItem()
*/
bool QOrganizerManager::saveItems(QList<QOrganizerItem>* items, const QStringList& definitionMask)
@@ -666,6 +696,7 @@ bool QOrganizerManager::saveItems(QList<QOrganizerItem>* items, const QStringLis
in the \a organizeritemIds list, return false, and set the overall operation error to
\c QOrganizerManager::DoesNotExistError.
+ \since 1.1
\sa QOrganizerManager::removeItem()
*/
bool QOrganizerManager::removeItems(const QList<QOrganizerItemId>& organizeritemIds)
@@ -681,6 +712,7 @@ bool QOrganizerManager::removeItems(const QList<QOrganizerItemId>& organizeritem
/*!
Returns the id of the default collection managed by this manager
+ \since 1.1
*/
QOrganizerCollection QOrganizerManager::defaultCollection() const
{
@@ -690,6 +722,7 @@ QOrganizerCollection QOrganizerManager::defaultCollection() const
/*!
Returns the collection identified by the given \a collectionId which is managed by this manager.
+ \since 1.1
*/
QOrganizerCollection QOrganizerManager::collection(const QOrganizerCollectionId& collectionId) const
{
@@ -699,6 +732,7 @@ QOrganizerCollection QOrganizerManager::collection(const QOrganizerCollectionId&
/*!
Returns a list of all of the collections managed by this manager.
+ \since 1.1
*/
QList<QOrganizerCollection> QOrganizerManager::collections() const
{
@@ -727,6 +761,7 @@ QList<QOrganizerCollection> QOrganizerManager::collections() const
correctly. Clients can call compatibleCollection() to retrieve a pruned
or updated version of the collection which is compatible with the manager.
+ \since 1.1
\sa compatibleCollection()
*/
bool QOrganizerManager::saveCollection(QOrganizerCollection* collection)
@@ -747,6 +782,7 @@ bool QOrganizerManager::saveCollection(QOrganizerCollection* collection)
Attempting to remove the default collection will fail and calling \l error() will return
QOrganizerManager::PermissionsError.
+ \since 1.1
*/
bool QOrganizerManager::removeCollection(const QOrganizerCollectionId& collectionId)
{
@@ -757,6 +793,7 @@ bool QOrganizerManager::removeCollection(const QOrganizerCollectionId& collectio
/*!
Returns a pruned or modified version of the \a original organizer item which is valid and can be saved in the manager.
The returned organizer item might have entire details removed or arbitrarily changed.
+ \since 1.1
*/
QOrganizerItem QOrganizerManager::compatibleItem(const QOrganizerItem& original) const
{
@@ -767,6 +804,7 @@ QOrganizerItem QOrganizerManager::compatibleItem(const QOrganizerItem& original)
/*!
Returns a pruned or modified version of the \a original organizer collection which is valid and can be saved in the manager.
The returned organizer collection might have meta data removed or arbitrarily changed.
+ \since 1.1
*/
QOrganizerCollection QOrganizerManager::compatibleCollection(const QOrganizerCollection& original) const
{
@@ -777,6 +815,7 @@ QOrganizerCollection QOrganizerManager::compatibleCollection(const QOrganizerCol
/*!
Returns a map of identifier to detail definition for the registered detail definitions for items whose type is the given \a organizeritemType
which are valid for the organizer items in this store
+ \since 1.1
*/
QMap<QString, QOrganizerItemDetailDefinition> QOrganizerManager::detailDefinitions(const QString& organizeritemType) const
{
@@ -789,7 +828,9 @@ QMap<QString, QOrganizerItemDetailDefinition> QOrganizerManager::detailDefinitio
return d->m_engine->detailDefinitions(organizeritemType, &h.error);
}
-/*! Returns the definition identified by the given \a definitionName that is valid for the organizer items whose type is the given \a organizeritemType in this store, or a default-constructed QOrganizerItemDetailDefinition if no such definition exists */
+/*! Returns the definition identified by the given \a definitionName that is valid for the organizer items whose type is the given \a organizeritemType in this store, or a default-constructed QOrganizerItemDetailDefinition if no such definition exists
+ \since 1.1
+*/
QOrganizerItemDetailDefinition QOrganizerManager::detailDefinition(const QString& definitionName, const QString& organizeritemType) const
{
QOrganizerManagerSyncOpErrorHolder h(this);
@@ -801,7 +842,9 @@ QOrganizerItemDetailDefinition QOrganizerManager::detailDefinition(const QString
return d->m_engine->detailDefinition(definitionName, organizeritemType, &h.error);
}
-/*! Persists the given definition \a def in the database, which is valid for organizer items whose type is the given \a organizeritemType. Returns true if the definition was saved successfully, otherwise returns false */
+/*! Persists the given definition \a def in the database, which is valid for organizer items whose type is the given \a organizeritemType. Returns true if the definition was saved successfully, otherwise returns false
+ \since 1.1
+*/
bool QOrganizerManager::saveDetailDefinition(const QOrganizerItemDetailDefinition& def, const QString& organizeritemType)
{
QOrganizerManagerSyncOpErrorHolder h(this);
@@ -813,7 +856,9 @@ bool QOrganizerManager::saveDetailDefinition(const QOrganizerItemDetailDefinitio
return d->m_engine->saveDetailDefinition(def, organizeritemType, &h.error);
}
-/*! Removes the detail definition identified by \a definitionName from the database, which is valid for organizer items whose type is the given \a organizeritemType. Returns true if the definition was removed successfully, otherwise returns false */
+/*! Removes the detail definition identified by \a definitionName from the database, which is valid for organizer items whose type is the given \a organizeritemType. Returns true if the definition was removed successfully, otherwise returns false
+ \since 1.1
+*/
bool QOrganizerManager::removeDetailDefinition(const QString& definitionName, const QString& organizeritemType)
{
QOrganizerManagerSyncOpErrorHolder h(this);
@@ -831,10 +876,12 @@ bool QOrganizerManager::removeDetailDefinition(const QString& definitionName, co
\value MutableDefinitions The manager supports saving, updating or removing detail definitions. Some built-in definitions may still be immutable
\value ChangeLogs The manager supports reporting of timestamps of changes, and filtering and sorting by those timestamps
\value Anonymous The manager is isolated from other managers
+ \since 1.1
*/
/*!
Returns true if the given feature \a feature is supported by the manager, for the specified type of organizer item \a organizeritemType
+ \since 1.1
*/
bool QOrganizerManager::hasFeature(QOrganizerManager::ManagerFeature feature, const QString& organizeritemType) const
{
@@ -849,6 +896,7 @@ bool QOrganizerManager::hasFeature(QOrganizerManager::ManagerFeature feature, co
cannot be emulated. For example, a filter that requests organizer items
that have changed since a given time depends on having that information
available. In these cases, the filter will fail.
+ \since 1.1
*/
bool QOrganizerManager::isFilterSupported(const QOrganizerItemFilter& filter) const
{
@@ -860,6 +908,7 @@ bool QOrganizerManager::isFilterSupported(const QOrganizerItemFilter& filter) co
This is a convenience function, equivalent to retrieving the allowable values
for the \c QOrganizerItemType::FieldType field of the QOrganizerItemType definition
which is valid in this manager.
+ \since 1.1
*/
QStringList QOrganizerManager::supportedItemTypes() const
{
@@ -868,19 +917,24 @@ QStringList QOrganizerManager::supportedItemTypes() const
/*!
Returns the engine backend implementation version number
+ \since 1.1
*/
int QOrganizerManager::managerVersion() const
{
return d->m_engine->managerVersion();
}
-/*! Returns the manager name for this QOrganizerManager */
+/*! Returns the manager name for this QOrganizerManager
+ \since 1.1
+*/
QString QOrganizerManager::managerName() const
{
return d->m_engine->managerName();
}
-/*! Return the parameters relevant to the creation of this QOrganizerManager */
+/*! Return the parameters relevant to the creation of this QOrganizerManager
+ \since 1.1
+*/
QMap<QString, QString> QOrganizerManager::managerParameters() const
{
QMap<QString, QString> params = d->m_engine->managerParameters();
@@ -892,13 +946,16 @@ QMap<QString, QString> QOrganizerManager::managerParameters() const
/*!
Return the uri describing this QOrganizerManager, consisting of the manager name and any parameters.
+ \since 1.1
*/
QString QOrganizerManager::managerUri() const
{
return d->m_engine->managerUri();
}
-/*! Return a list of QOrganizerItemId extracted from the \a items */
+/*! Return a list of QOrganizerItemId extracted from the \a items
+ \since 1.1
+*/
QList<QOrganizerItemId> QOrganizerManager::extractIds(const QList<QOrganizerItem>& items)
{
QList<QOrganizerItemId> ids;
diff --git a/src/organizer/qorganizermanagerengine.cpp b/src/organizer/qorganizermanagerengine.cpp
index 2711a1a1b7..2d1e8f3b7c 100644
--- a/src/organizer/qorganizermanagerengine.cpp
+++ b/src/organizer/qorganizermanagerengine.cpp
@@ -114,6 +114,7 @@ QTM_BEGIN_NAMESPACE
As it is possible that other processes (or other devices) may have caused the
changes, the timing can not be determined.
+ \since 1.1
\sa itemsAdded(), itemsChanged(), itemsRemoved()
*/
@@ -128,6 +129,7 @@ QTM_BEGIN_NAMESPACE
The list of ids of organizer items added is given by \a organizeritemIds. There may be one or more
ids in the list.
+ \since 1.1
\sa dataChanged()
*/
@@ -142,6 +144,7 @@ QTM_BEGIN_NAMESPACE
The list of ids of changed organizer items is given by \a organizeritemIds. There may be one or more
ids in the list.
+ \since 1.1
\sa dataChanged()
*/
@@ -156,6 +159,7 @@ QTM_BEGIN_NAMESPACE
The list of ids of removed organizer items is given by \a organizeritemIds. There may be one or more
ids in the list.
+ \since 1.1
\sa dataChanged()
*/
@@ -163,6 +167,7 @@ QTM_BEGIN_NAMESPACE
\fn QOrganizerManagerEngine::collectionsAdded(const QList<QOrganizerCollectionId>& collectionIds)
This signal should be emitted at some point once the collections identified by \a collectionIds have been added to a datastore managed by this engine.
This signal must not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
@@ -170,17 +175,21 @@ QTM_BEGIN_NAMESPACE
This signal should be emitted at some point once the metadata for the collections identified by \a collectionIds have been modified in a datastore managed by this engine.
This signal is not emitted if one of the items in this collection has changed - itemsChanged() will be emitted instead.
This signal must not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
/*!
\fn QOrganizerManagerEngine::collectionsRemoved(const QList<QOrganizerCollectionId>& collectionIds)
This signal should be emitted at some point once the collections identified by \a collectionIds have been removed from a datastore managed by this engine.
This signal must not be emitted if the dataChanged() signal was previously emitted for these changes.
+ \since 1.1
*/
-/*! Returns the manager name for this QOrganizerManagerEngine */
+/*! Returns the manager name for this QOrganizerManagerEngine
+ \since 1.1
+*/
QString QOrganizerManagerEngine::managerName() const
{
return QString(QLatin1String("base"));
@@ -190,6 +199,7 @@ QString QOrganizerManagerEngine::managerName() const
Returns the parameters with which this engine was constructed. Note that
the engine may have discarded unused or invalid parameters at the time of
construction, and these will not be returned.
+ \since 1.1
*/
QMap<QString, QString> QOrganizerManagerEngine::managerParameters() const
{
@@ -199,6 +209,7 @@ QMap<QString, QString> QOrganizerManagerEngine::managerParameters() const
/*!
Returns the unique URI of this manager, which is built from the manager name and the parameters
used to construct it.
+ \since 1.1
*/
QString QOrganizerManagerEngine::managerUri() const
{
@@ -232,6 +243,7 @@ QString QOrganizerManagerEngine::managerUri() const
in. It allows the manager to optimize retrieval of occurrences. The manager may ignore the
\a fetchHint, but if it does so each item occurrence it returns must include all of the details
associated with it in the database.
+ \since 1.1
*/
QList<QOrganizerItem> QOrganizerManagerEngine::itemOccurrences(const QOrganizerItem& parentItem, const QDateTime& periodStart, const QDateTime& periodEnd, int maxCount, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
{
@@ -256,6 +268,7 @@ QList<QOrganizerItem> QOrganizerManagerEngine::itemOccurrences(const QOrganizerI
Depending on the backend, this filtering operation may involve retrieving
all the organizer items. Any error which occurs will be saved in \a error.
+ \since 1.1
*/
QList<QOrganizerItemId> QOrganizerManagerEngine::itemIds(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, QOrganizerManager::Error* error) const
{
@@ -281,6 +294,7 @@ QList<QOrganizerItemId> QOrganizerManagerEngine::itemIds(const QDateTime& startD
fetchHint is the default constructed hint, all existing details in the matching organizer items
will be returned.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManagerEngine::items(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
@@ -314,6 +328,7 @@ QList<QOrganizerItem> QOrganizerManagerEngine::items(const QDateTime& startDate,
All items returned should have a non-zero ID.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManagerEngine::itemsForExport(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
@@ -339,6 +354,7 @@ QList<QOrganizerItem> QOrganizerManagerEngine::itemsForExport(const QDateTime& s
fetchHint is the default constructed hint, all existing details in the matching organizer items
will be returned.
+ \since 1.1
\sa QOrganizerItemFetchHint
*/
QOrganizerItem QOrganizerManagerEngine::item(const QOrganizerItemId& organizeritemId, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
@@ -351,6 +367,7 @@ QOrganizerItem QOrganizerManagerEngine::item(const QOrganizerItemId& organizerit
/*!
Returns true if the given \a feature is supported by this engine for organizer items of the given \a organizeritemType
+ \since 1.1
*/
bool QOrganizerManagerEngine::hasFeature(QOrganizerManager::ManagerFeature feature, const QString& organizeritemType) const
{
@@ -378,6 +395,7 @@ bool QOrganizerManagerEngine::hasFeature(QOrganizerManager::ManagerFeature featu
\o A QOrganizerItemDetailFilter or QOrganizerItemDetailRangeFilter with no definition name will be replaced with a QOrganizerItemInvalidFilter
\o A QOrganizerItemDetailRangeFilter with no range specified will be converted to a QOrganizerItemDetailFilter
\endlist
+ \since 1.1
*/
QOrganizerItemFilter QOrganizerManagerEngine::canonicalizedFilter(const QOrganizerItemFilter &filter)
{
@@ -485,6 +503,7 @@ QOrganizerItemFilter QOrganizerManagerEngine::canonicalizedFilter(const QOrganiz
Returns a whether the supplied \a filter can be implemented
natively by this engine. If not, the base class implementation
will emulate the functionality.
+ \since 1.1
*/
bool QOrganizerManagerEngine::isFilterSupported(const QOrganizerItemFilter& filter) const
{
@@ -498,6 +517,7 @@ bool QOrganizerManagerEngine::isFilterSupported(const QOrganizerItemFilter& filt
This is a convenience function, equivalent to retrieving the allowable values
for the \c QOrganizerItemType::FieldType field of the QOrganizerItemType definition
which is valid in this engine.
+ \since 1.1
*/
QStringList QOrganizerManagerEngine::supportedItemTypes() const
{
@@ -515,6 +535,7 @@ QStringList QOrganizerManagerEngine::supportedItemTypes() const
\fn int QOrganizerManagerEngine::managerVersion() const
Returns the engine backend implementation version number
+ \since 1.1
*/
/*!
@@ -1544,6 +1565,7 @@ QMap<QString, QMap<QString, QOrganizerItemDetailDefinition> > QOrganizerManagerE
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::validateItem(const QOrganizerItem& item, QOrganizerManager::Error* error) const
{
@@ -1616,6 +1638,7 @@ bool QOrganizerManagerEngine::validateItem(const QOrganizerItem& item, QOrganize
By default, modifiable collections are not supported, so this function returns false,
and \a error is set to QOrganizerManager::NotSupportedError.
Engines which do implement mutable collections should reimplement this function.
+ \since 1.1
*/
bool QOrganizerManagerEngine::validateCollection(const QOrganizerCollection& collection, QOrganizerManager::Error* error) const
{
@@ -1635,6 +1658,7 @@ bool QOrganizerManagerEngine::validateCollection(const QOrganizerCollection& col
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::validateDefinition(const QOrganizerItemDetailDefinition& definition, QOrganizerManager::Error* error) const
{
@@ -1674,6 +1698,7 @@ bool QOrganizerManagerEngine::validateDefinition(const QOrganizerItemDetailDefin
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
QMap<QString, QOrganizerItemDetailDefinition> QOrganizerManagerEngine::detailDefinitions(const QString& organizeritemType, QOrganizerManager::Error* error) const
{
@@ -1689,6 +1714,7 @@ QMap<QString, QOrganizerItemDetailDefinition> QOrganizerManagerEngine::detailDef
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
QOrganizerItemDetailDefinition QOrganizerManagerEngine::detailDefinition(const QString& definitionName, const QString& organizeritemType, QOrganizerManager::Error* error) const
{
@@ -1712,6 +1738,7 @@ QOrganizerItemDetailDefinition QOrganizerManagerEngine::detailDefinition(const Q
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::saveDetailDefinition(const QOrganizerItemDetailDefinition& def, const QString& organizeritemType, QOrganizerManager::Error* error)
{
@@ -1732,6 +1759,7 @@ bool QOrganizerManagerEngine::saveDetailDefinition(const QOrganizerItemDetailDef
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::removeDetailDefinition(const QString& definitionName, const QString& organizeritemType, QOrganizerManager::Error* error)
{
@@ -1751,6 +1779,7 @@ bool QOrganizerManagerEngine::removeDetailDefinition(const QString& definitionNa
Application code should not call this function, since validation of the
detail will happen in the engine in any case.
+ \since 1.1
*/
void QOrganizerManagerEngine::setDetailAccessConstraints(QOrganizerItemDetail *detail, QOrganizerItemDetail::AccessConstraints constraints)
{
@@ -1788,6 +1817,7 @@ void QOrganizerManagerEngine::setDetailAccessConstraints(QOrganizerItemDetail *d
The default implementation will convert this into a call to saveItems.
\sa managerUri()
+ \since 1.1
*/
bool QOrganizerManagerEngine::saveItem(QOrganizerItem* item, QOrganizerManager::Error* error)
{
@@ -1818,6 +1848,7 @@ bool QOrganizerManagerEngine::saveItem(QOrganizerItem* item, QOrganizerManager::
Any error which occurs will be saved in \a error.
The default implementation will convert this into a call to removeItems.
+ \since 1.1
*/
bool QOrganizerManagerEngine::removeItem(const QOrganizerItemId& organizeritemId, QOrganizerManager::Error* error)
{
@@ -1864,6 +1895,7 @@ bool QOrganizerManagerEngine::removeItem(const QOrganizerItemId& organizeritemId
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
\sa QOrganizerManager::saveItem()
*/
bool QOrganizerManagerEngine::saveItems(QList<QOrganizerItem>* items, QMap<int, QOrganizerManager::Error>* errorMap, QOrganizerManager::Error* error)
@@ -1896,6 +1928,7 @@ bool QOrganizerManagerEngine::saveItems(QList<QOrganizerItem>* items, QMap<int,
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
\sa QOrganizerManager::removeItem()
*/
bool QOrganizerManagerEngine::removeItems(const QList<QOrganizerItemId>& organizeritemIds, QMap<int, QOrganizerManager::Error>* errorMap, QOrganizerManager::Error* error)
@@ -1910,6 +1943,7 @@ bool QOrganizerManagerEngine::removeItems(const QList<QOrganizerItemId>& organiz
Returns the default collection of the manager.
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
QOrganizerCollection QOrganizerManagerEngine::defaultCollection(QOrganizerManager::Error* error) const
{
@@ -1922,6 +1956,7 @@ QOrganizerCollection QOrganizerManagerEngine::defaultCollection(QOrganizerManage
Any errors encountered during this operation should be stored to \a error.
If the given \a collectionId does not specify a valid collection, \a error will
be set to \c QOrganizerManager::DoesNotExistError.
+ \since 1.1
*/
QOrganizerCollection QOrganizerManagerEngine::collection(const QOrganizerCollectionId& collectionId, QOrganizerManager::Error* error) const
{
@@ -1934,6 +1969,7 @@ QOrganizerCollection QOrganizerManagerEngine::collection(const QOrganizerCollect
Returns the list of all of the collections managed by this manager.
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
QList<QOrganizerCollection> QOrganizerManagerEngine::collections(QOrganizerManager::Error* error) const
{
@@ -1945,6 +1981,7 @@ QList<QOrganizerCollection> QOrganizerManagerEngine::collections(QOrganizerManag
Returns true if the saving of the \a collection was successfull otherwise false.
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::saveCollection(QOrganizerCollection* collection, QOrganizerManager::Error* error)
{
@@ -1958,6 +1995,7 @@ bool QOrganizerManagerEngine::saveCollection(QOrganizerCollection* collection, Q
Returns true if the removing of the \a collectionId was successfull otherwise false.
Any errors encountered during this operation should be stored to
\a error.
+ \since 1.1
*/
bool QOrganizerManagerEngine::removeCollection(const QOrganizerCollectionId& collectionId, QOrganizerManager::Error* error)
{
@@ -1971,6 +2009,7 @@ bool QOrganizerManagerEngine::removeCollection(const QOrganizerCollectionId& col
Returns a pruned or modified version of the \a original item which is valid and can be saved in the manager.
The returned item might have details removed or arbitrarily changed.
Any error which occurs will be saved to \a error.
+ \since 1.1
*/
QOrganizerItem QOrganizerManagerEngine::compatibleItem(const QOrganizerItem& original, QOrganizerManager::Error* error) const
{
@@ -2054,6 +2093,7 @@ QOrganizerItem QOrganizerManagerEngine::compatibleItem(const QOrganizerItem& ori
The returned item might have meta data removed or arbitrarily changed. Any error which occurs will be saved to \a error.
By default, modifiable collections are not supported, and so this function always returns false.
Any engine which supports mutable collections should reimplement this function.
+ \since 1.1
*/
QOrganizerCollection QOrganizerManagerEngine::compatibleCollection(const QOrganizerCollection& original, QOrganizerManager::Error* error) const
{
@@ -2074,6 +2114,7 @@ QOrganizerCollection QOrganizerManagerEngine::compatibleCollection(const QOrgani
The results are undefined if the variants are different types, or
cannot be compared.
+ \since 1.1
*/
int QOrganizerManagerEngine::compareVariant(const QVariant& first, const QVariant& second, Qt::CaseSensitivity sensitivity)
{
@@ -2128,6 +2169,7 @@ int QOrganizerManagerEngine::compareVariant(const QVariant& first, const QVarian
Returns true if the supplied item \a item matches the supplied filter \a filter.
This function will test each condition in the filter, possibly recursing.
+ \since 1.1
*/
bool QOrganizerManagerEngine::testFilter(const QOrganizerItemFilter &filter, const QOrganizerItem &item)
{
@@ -2383,6 +2425,7 @@ bool QOrganizerManagerEngine::testFilter(const QOrganizerItemFilter &filter, con
infinitely small (i.e., will match anything up to the \a endPeriod) and a default-constructed
\a endPeriod signifies that the upper bound of the range is infinitely large
(i.e., will match anything which occurs after the \a startPeriod).
+ \since 1.1
*/
bool QOrganizerManagerEngine::isItemBetweenDates(const QOrganizerItem& item, const QDateTime& startPeriod, const QDateTime& endPeriod)
{
@@ -2437,6 +2480,7 @@ bool QOrganizerManagerEngine::isItemBetweenDates(const QOrganizerItem& item, con
/*!
* Returns the date associated with \a item that can be used for the purpose of date-sorting
* the item.
+ \since 1.1
*/
QDateTime getDateForSorting(const QOrganizerItem& item)
{
@@ -2480,6 +2524,7 @@ QDateTime getDateForSorting(const QOrganizerItem& item)
* temporally less than non-all day items on the same date. For events and todos, the
* start date is used, or if null, the end date is used. This function defines a total ordering
* suitable for use in a sort function.
+ \since 1.1
*/
bool QOrganizerManagerEngine::itemLessThan(const QOrganizerItem& a, const QOrganizerItem& b)
{
@@ -2499,6 +2544,7 @@ bool QOrganizerManagerEngine::itemLessThan(const QOrganizerItem& a, const QOrgan
Compares two organizer items (\a a and \a b) using the given list of \a sortOrders. Returns a negative number if \a a should appear
before \a b according to the sort order, a positive number if \a a should appear after \a b according to the sort order,
and zero if the two are unable to be sorted.
+ \since 1.1
*/
int QOrganizerManagerEngine::compareItem(const QOrganizerItem& a, const QOrganizerItem& b, const QList<QOrganizerItemSortOrder>& sortOrders)
{
@@ -2548,6 +2594,7 @@ int QOrganizerManagerEngine::compareItem(const QOrganizerItem& a, const QOrganiz
The first QOrganizerItemSortOrder in the list has the highest priority; if the item \a toAdd is deemed equal to another
in the \a sorted list, the second QOrganizerItemSortOrder in the list is used (and so on until either the item is inserted
or there are no more sort order objects in the list).
+ \since 1.1
*/
void QOrganizerManagerEngine::addSorted(QList<QOrganizerItem>* sorted, const QOrganizerItem& toAdd, const QList<QOrganizerItemSortOrder>& sortOrders)
{
@@ -2569,6 +2616,7 @@ void QOrganizerManagerEngine::addSorted(QList<QOrganizerItem>* sorted, const QOr
/*!
Returns the engine id from the given \a id.
The caller does not take ownership of the pointer, and should not delete returned id or undefined behavior may occur.
+ \since 1.1
*/
const QOrganizerItemEngineId* QOrganizerManagerEngine::engineItemId(const QOrganizerItemId& id)
{
@@ -2578,6 +2626,7 @@ const QOrganizerItemEngineId* QOrganizerManagerEngine::engineItemId(const QOrgan
/*!
Returns the engine id from the given \a id.
The caller does not take ownership of the pointer, and should not delete returned id or undefined behavior may occur.
+ \since 1.1
*/
const QOrganizerCollectionEngineId* QOrganizerManagerEngine::engineCollectionId(const QOrganizerCollectionId& id)
{
@@ -2603,6 +2652,7 @@ const QOrganizerCollectionEngineId* QOrganizerManagerEngine::engineCollectionId(
mutex, and make sure you take the mutex in the worker thread before calling any of the
QOrganizerAbstractRequest::updateXXXXXXRequest functions. And be careful of lock ordering
problems :D
+ \since 1.1
*/
void QOrganizerManagerEngine::requestDestroyed(QOrganizerAbstractRequest* req)
{
@@ -2629,6 +2679,7 @@ void QOrganizerManagerEngine::requestDestroyed(QOrganizerAbstractRequest* req)
notified not to touch that request any more.
\sa QOrganizerAbstractRequest::start()
+ \since 1.1
*/
bool QOrganizerManagerEngine::startRequest(QOrganizerAbstractRequest* req)
{
@@ -2643,6 +2694,7 @@ bool QOrganizerManagerEngine::startRequest(QOrganizerAbstractRequest* req)
otherwise returns false.
\sa startRequest(), QOrganizerAbstractRequest::cancel()
+ \since 1.1
*/
bool QOrganizerManagerEngine::cancelRequest(QOrganizerAbstractRequest* req)
{
@@ -2660,6 +2712,7 @@ bool QOrganizerManagerEngine::cancelRequest(QOrganizerAbstractRequest* req)
clients may call it in a loop.
\sa startRequest()
+ \since 1.1
*/
bool QOrganizerManagerEngine::waitForRequestFinished(QOrganizerAbstractRequest* req, int msecs)
{
@@ -2672,6 +2725,7 @@ bool QOrganizerManagerEngine::waitForRequestFinished(QOrganizerAbstractRequest*
Updates the given asynchronous request \a req by setting the new \a state
of the request. If the new state is different, the stateChanged() signal
will be emitted by the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateRequestState(QOrganizerAbstractRequest* req, QOrganizerAbstractRequest::State state)
{
@@ -2692,6 +2746,7 @@ void QOrganizerManagerEngine::updateRequestState(QOrganizerAbstractRequest* req,
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemOccurrenceFetchRequest(QOrganizerItemOccurrenceFetchRequest* req, const QList<QOrganizerItem>& result, QOrganizerManager::Error error, QOrganizerAbstractRequest::State newState)
{
@@ -2717,6 +2772,7 @@ void QOrganizerManagerEngine::updateItemOccurrenceFetchRequest(QOrganizerItemOcc
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemIdFetchRequest(QOrganizerItemIdFetchRequest* req, const QList<QOrganizerItemId>& result, QOrganizerManager::Error error, QOrganizerAbstractRequest::State newState)
{
@@ -2742,6 +2798,7 @@ void QOrganizerManagerEngine::updateItemIdFetchRequest(QOrganizerItemIdFetchRequ
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemFetchRequest(QOrganizerItemFetchRequest* req, const QList<QOrganizerItem>& result, QOrganizerManager::Error error, QOrganizerAbstractRequest::State newState)
{
@@ -2767,6 +2824,7 @@ void QOrganizerManagerEngine::updateItemFetchRequest(QOrganizerItemFetchRequest*
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemFetchForExportRequest(QOrganizerItemFetchForExportRequest* req, const QList<QOrganizerItem>& result, QOrganizerManager::Error error, QOrganizerAbstractRequest::State newState)
{
@@ -2792,6 +2850,7 @@ void QOrganizerManagerEngine::updateItemFetchForExportRequest(QOrganizerItemFetc
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemRemoveRequest(QOrganizerItemRemoveRequest* req, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2817,6 +2876,7 @@ void QOrganizerManagerEngine::updateItemRemoveRequest(QOrganizerItemRemoveReques
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateItemSaveRequest(QOrganizerItemSaveRequest* req, const QList<QOrganizerItem>& result, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2843,6 +2903,7 @@ void QOrganizerManagerEngine::updateItemSaveRequest(QOrganizerItemSaveRequest* r
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateDefinitionSaveRequest(QOrganizerItemDetailDefinitionSaveRequest* req, const QList<QOrganizerItemDetailDefinition>& result, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2869,6 +2930,7 @@ void QOrganizerManagerEngine::updateDefinitionSaveRequest(QOrganizerItemDetailDe
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateDefinitionRemoveRequest(QOrganizerItemDetailDefinitionRemoveRequest* req, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2894,6 +2956,7 @@ void QOrganizerManagerEngine::updateDefinitionRemoveRequest(QOrganizerItemDetail
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateDefinitionFetchRequest(QOrganizerItemDetailDefinitionFetchRequest* req, const QMap<QString, QOrganizerItemDetailDefinition>& result, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2919,6 +2982,7 @@ void QOrganizerManagerEngine::updateDefinitionFetchRequest(QOrganizerItemDetailD
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateCollectionFetchRequest(QOrganizerCollectionFetchRequest* req, const QList<QOrganizerCollection>& result, QOrganizerManager::Error error, QOrganizerAbstractRequest::State newState)
{
@@ -2943,6 +3007,7 @@ void QOrganizerManagerEngine::updateCollectionFetchRequest(QOrganizerCollectionF
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateCollectionRemoveRequest(QOrganizerCollectionRemoveRequest* req, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -2967,6 +3032,7 @@ void QOrganizerManagerEngine::updateCollectionRemoveRequest(QOrganizerCollection
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.1
*/
void QOrganizerManagerEngine::updateCollectionSaveRequest(QOrganizerCollectionSaveRequest* req, const QList<QOrganizerCollection>& result, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
@@ -3003,6 +3069,7 @@ void QOrganizerManagerEngine::updateCollectionSaveRequest(QOrganizerCollectionSa
fetchHint is the default constructed hint, all existing details in the matching
organizer items will be returned.
+ \since 1.2
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManagerEngineV2::items(const QDateTime& startDate, const QDateTime& endDate, const QOrganizerItemFilter& filter, const QList<QOrganizerItemSortOrder>& sortOrders, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
@@ -3026,6 +3093,7 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2::items(const QDateTime& startDat
fetchHint is the default constructed hint, all existing details in the matching
organizer items will be returned.
+ \since 1.2
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManagerEngineV2::items(const QDateTime& startDate, const QDateTime& endDate, int maxCount, const QOrganizerItemFilter& filter, const QOrganizerItemFetchHint& fetchHint, QOrganizerManager::Error* error) const
@@ -3035,7 +3103,9 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2::items(const QDateTime& startDat
return list.mid(0, maxCount);
}
-/*! \reimp */
+/*! \reimp
+ \since 1.2
+*/
bool QOrganizerManagerEngineV2::saveItems(QList<QOrganizerItem>* items, QMap<int, QOrganizerManager::Error>* errorMap, QOrganizerManager::Error* error)
{
return QOrganizerManagerEngine::saveItems(items, errorMap, error);
@@ -3062,6 +3132,7 @@ bool QOrganizerManagerEngineV2::saveItems(QList<QOrganizerItem>* items, QMap<int
will be updated with the new value.
Any errors encountered during this operation should be stored to \a error.
+ \since 1.2
*/
bool QOrganizerManagerEngineV2::saveItems(QList<QOrganizerItem> *items, const QStringList &definitionMask, QMap<int, QOrganizerManager::Error> *errorMap, QOrganizerManager::Error *error)
{
@@ -3204,6 +3275,7 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2::itemsForExport(const QDateTime&
definition mask should be used which corresponds to the detail definition hint. This is to ensure
that no data is lost by overwriting an existing item with a restricted version of it.
+ \since 1.2
\sa QOrganizerItemFetchHint
*/
QList<QOrganizerItem> QOrganizerManagerEngineV2::itemsForExport(const QList<QOrganizerItemId> &ids, const QOrganizerItemFetchHint &fetchHint, QMap<int, QOrganizerManager::Error> *errorMap, QOrganizerManager::Error *error) const
@@ -3246,6 +3318,7 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2::itemsForExport(const QList<QOrg
It then causes the request to emit its resultsAvailable() signal to notify clients of the request progress.
If the new request state is different from the previous state, the stateChanged() signal will also be emitted from the request.
+ \since 1.2
*/
void QOrganizerManagerEngineV2::updateItemFetchByIdRequest(QOrganizerItemFetchByIdRequest* req, const QList<QOrganizerItem>& result, QOrganizerManager::Error error, const QMap<int, QOrganizerManager::Error>& errorMap, QOrganizerAbstractRequest::State newState)
{
diff --git a/src/organizer/qorganizermanagerenginefactory.cpp b/src/organizer/qorganizermanagerenginefactory.cpp
index e0e0797fe2..32a58e0df8 100644
--- a/src/organizer/qorganizermanagerenginefactory.cpp
+++ b/src/organizer/qorganizermanagerenginefactory.cpp
@@ -48,6 +48,7 @@ QTM_BEGIN_NAMESPACE
\class QOrganizerManagerEngineFactory
\brief The QOrganizerManagerEngineFactory class provides the interface for
plugins that implement QOrganizerManagerEngine functionality.
+ \since 1.1
\inmodule QtOrganizer
\ingroup organizer-backends
@@ -82,6 +83,7 @@ QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
occurs, this function may return a null pointer, and the client developer will get an
invalid QOrganizerManager in return. Any error should be stored in the supplied \a error
reference.
+ \since 1.1
*/
/*!
@@ -97,6 +99,7 @@ QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
Engine implementers must implement this function, but should not need
to call it.
+ \since 1.1
*/
/*!
@@ -112,6 +115,7 @@ QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
Engine implementers must implement this function, but should not need
to call it.
+ \since 1.1
*/
/*!
@@ -122,12 +126,14 @@ QOrganizerManagerEngineFactory::~QOrganizerManagerEngineFactory()
Typically this would be of the form "com.nokia.qt.organizeritems.engines.memory", with
the appropriate domain and engine name substituted.
+ \since 1.1
*/
/*!
\fn QOrganizerManagerEngineFactory::supportedImplementationVersions() const
This function should return a list of versions of the engine which this factory can instantiate.
+ \since 1.1
*/
QList<int> QOrganizerManagerEngineFactory::supportedImplementationVersions() const
{
@@ -138,12 +144,14 @@ QList<int> QOrganizerManagerEngineFactory::supportedImplementationVersions() con
\fn QOrganizerItemEngineLocalId* QOrganizerItemManagerEngineFactory::createItemEngineLocalId() const
This abstract function create and return an QOrganizerItemEngineLocalId.
+ \since 1.1
*/
/*!
\fn QOrganizerCollectionEngineLocalId* QOrganizerItemManagerEngineFactory::createCollectionEngineLocalId()const
This abstract function create and return an QOrganizerCollectionEngineLocalId.
+ \since 1.1
*/
QTM_END_NAMESPACE
diff --git a/src/organizer/qorganizermanagerenginev2wrapper_p.cpp b/src/organizer/qorganizermanagerenginev2wrapper_p.cpp
index f5a9ffcb49..d159260293 100644
--- a/src/organizer/qorganizermanagerenginev2wrapper_p.cpp
+++ b/src/organizer/qorganizermanagerenginev2wrapper_p.cpp
@@ -74,6 +74,7 @@ QOrganizerManagerEngineV2Wrapper::~QOrganizerManagerEngineV2Wrapper()
/*! \reimp
* This function calls the wrapped engine's items function and ensures the results are sorted by
* date (if no sort order is given).
+ \since 1.2
*/
QList<QOrganizerItem> QOrganizerManagerEngineV2Wrapper::items(
const QDateTime& startDate,
@@ -93,6 +94,7 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2Wrapper::items(
/*! \reimp
* This function calls the wrapped engine's items function and ensures the results are sorted by
* date and truncates the list after maxCount items (if maxCount is not negative)
+ \since 1.2
*/
QList<QOrganizerItem> QOrganizerManagerEngineV2Wrapper::items(
const QDateTime& startDate,
@@ -109,7 +111,9 @@ QList<QOrganizerItem> QOrganizerManagerEngineV2Wrapper::items(
return list.mid(0, maxCount);
}
-/*! \reimp */
+/*! \reimp
+ \since 1.2
+*/
void QOrganizerManagerEngineV2Wrapper::requestDestroyed(QOrganizerAbstractRequest* req)
{
RequestController* controller = m_controllerForRequest.value(req);
@@ -123,7 +127,9 @@ void QOrganizerManagerEngineV2Wrapper::requestDestroyed(QOrganizerAbstractReques
}
}
-/*! \reimp */
+/*! \reimp
+ \since 1.2
+*/
bool QOrganizerManagerEngineV2Wrapper::startRequest(QOrganizerAbstractRequest* req)
{
if (req->type() == QOrganizerAbstractRequest::ItemFetchRequest
diff --git a/src/organizer/qorganizerrecurrencerule.cpp b/src/organizer/qorganizerrecurrencerule.cpp
index ce2ae5f0b8..c435b8240e 100644
--- a/src/organizer/qorganizerrecurrencerule.cpp
+++ b/src/organizer/qorganizerrecurrencerule.cpp
@@ -58,6 +58,7 @@ QTM_BEGIN_NAMESPACE
\class QOrganizerRecurrenceRule
\brief The QOrganizerRecurrenceRule class describes the a rule by which a QOrganizerItem repeats.
+ \since 1.1
\inmodule QtOrganizer
@@ -169,6 +170,7 @@ QOrganizerRecurrenceRule::~QOrganizerRecurrenceRule()
/*!
* Constructs a QOrganizerRecurrenceRule object as a copy of \a other.
+ \since 1.1
*/
QOrganizerRecurrenceRule::QOrganizerRecurrenceRule(const QOrganizerRecurrenceRule& other)
: d(other.d)
@@ -177,6 +179,7 @@ QOrganizerRecurrenceRule::QOrganizerRecurrenceRule(const QOrganizerRecurrenceRul
/*!
* Assigns this detail to be equal to \a other.
+ \since 1.1
*/
QOrganizerRecurrenceRule& QOrganizerRecurrenceRule::operator=(const QOrganizerRecurrenceRule& other)
{
@@ -185,6 +188,7 @@ QOrganizerRecurrenceRule& QOrganizerRecurrenceRule::operator=(const QOrganizerRe
}
/*!
Returns true if this recurrence rule is equal to the \a other; otherwise returns false.
+ \since 1.1
*/
bool QOrganizerRecurrenceRule::operator==(const QOrganizerRecurrenceRule& other) const
{
@@ -213,6 +217,7 @@ bool QOrganizerRecurrenceRule::operator==(const QOrganizerRecurrenceRule& other)
* Sets the frequency with which the item recurs to \a freq.
*
* This corresponds to the FREQ fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setFrequency(Frequency freq)
{
@@ -221,6 +226,7 @@ void QOrganizerRecurrenceRule::setFrequency(Frequency freq)
/*!
* Returns the frequency with which the item recurs. The default frequency is Invalid.
+ \since 1.1
*/
QOrganizerRecurrenceRule::Frequency QOrganizerRecurrenceRule::frequency() const
{
@@ -235,6 +241,7 @@ QOrganizerRecurrenceRule::Frequency QOrganizerRecurrenceRule::frequency() const
*
* This corresponds to the COUNT fragment in iCalendar's RRULE.
* \sa clearLimit()
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setLimit(int count)
{
@@ -255,6 +262,7 @@ void QOrganizerRecurrenceRule::setLimit(int count)
*
* This corresponds to the UNTIL fragment in iCalendar's RRULE.
* \sa clearLimit()
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setLimit(const QDate& date)
{
@@ -268,6 +276,7 @@ void QOrganizerRecurrenceRule::setLimit(const QDate& date)
}
/*! Clear any recurrence rule limitation conditions.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::clearLimit()
{
@@ -278,6 +287,7 @@ void QOrganizerRecurrenceRule::clearLimit()
/*! Returns the type of limitation specified by the recurrence rule. The default limit type is NoLimit (ie.
* unlimited)
+ \since 1.1
*/
QOrganizerRecurrenceRule::LimitType QOrganizerRecurrenceRule::limitType() const
{
@@ -286,6 +296,7 @@ QOrganizerRecurrenceRule::LimitType QOrganizerRecurrenceRule::limitType() const
/*! Returns the "count" condition specified by the recurrence rule. The default count is -1 (ie.
* unlimited)
+ \since 1.1
*/
int QOrganizerRecurrenceRule::limitCount() const
{
@@ -297,6 +308,7 @@ int QOrganizerRecurrenceRule::limitCount() const
/*! Returns the end-date condition specified by the recurrence rule. The default end date is the
* null date (ie. no end date).
+ \since 1.1
*/
QDate QOrganizerRecurrenceRule::limitDate() const
{
@@ -313,6 +325,7 @@ QDate QOrganizerRecurrenceRule::limitDate() const
* 2, the item should recur every second day.
*
* This corresponds to the INTERVAL fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setInterval(int interval)
{
@@ -322,6 +335,7 @@ void QOrganizerRecurrenceRule::setInterval(int interval)
/*!
* Returns the interval of recurrence. The default interval is 1.
+ \since 1.1
*/
int QOrganizerRecurrenceRule::interval() const
{
@@ -334,6 +348,7 @@ int QOrganizerRecurrenceRule::interval() const
* Sets the days of week on which the item should recur to \a days.
*
* This corresponds to the BYDAY fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setDaysOfWeek(const QSet<Qt::DayOfWeek>& days)
{
@@ -343,6 +358,7 @@ void QOrganizerRecurrenceRule::setDaysOfWeek(const QSet<Qt::DayOfWeek>& days)
/*!
* Returns a list of the days of week that the item should recur on. If not set, this is the empty
* list, which signifies that it should be implied, if necessary, by the day-of-week of the item.
+ \since 1.1
*/
QSet<Qt::DayOfWeek> QOrganizerRecurrenceRule::daysOfWeek() const
{
@@ -355,6 +371,7 @@ QSet<Qt::DayOfWeek> QOrganizerRecurrenceRule::daysOfWeek() const
* month and -1 represents the last day of the month.
*
* This corresponds to the BYMONTHDAY fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setDaysOfMonth(const QSet<int>& days)
{
@@ -365,6 +382,7 @@ void QOrganizerRecurrenceRule::setDaysOfMonth(const QSet<int>& days)
* Returns a list of the days of the month that the item should recur on. If not set, this is the
* empty list, which signifies that it should be implied, if necessary, by the day-of-month of the
* item.
+ \since 1.1
*/
QSet<int> QOrganizerRecurrenceRule::daysOfMonth() const
{
@@ -377,6 +395,7 @@ QSet<int> QOrganizerRecurrenceRule::daysOfMonth() const
* year and -1 represents the last day of the year.
*
* This corresponds to the BYYEARDAY fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setDaysOfYear(const QSet<int>& days)
{
@@ -387,6 +406,7 @@ void QOrganizerRecurrenceRule::setDaysOfYear(const QSet<int>& days)
* Returns a list of the days of the year that the item should recur on. If not set, this is the
* empty list, which signifies that it should be implied, if necessary, by the day-of-year of the
* item.
+ \since 1.1
*/
QSet<int> QOrganizerRecurrenceRule::daysOfYear() const
{
@@ -397,6 +417,7 @@ QSet<int> QOrganizerRecurrenceRule::daysOfYear() const
* Sets the months on which the item should recur to \a months.
*
* This corresponds to the BYMONTHDAY fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setMonthsOfYear(const QSet<Month>& months)
{
@@ -407,6 +428,7 @@ void QOrganizerRecurrenceRule::setMonthsOfYear(const QSet<Month>& months)
* Returns a list of the months that the item should recur on. If not set, this is the
* empty list, which signifies that it should be implied, if necessary, by the month of the
* item.
+ \since 1.1
*/
QSet<QOrganizerRecurrenceRule::Month> QOrganizerRecurrenceRule::monthsOfYear() const
{
@@ -419,6 +441,7 @@ QSet<QOrganizerRecurrenceRule::Month> QOrganizerRecurrenceRule::monthsOfYear() c
* year and -1 represents the last week of the year.
*
* This corresponds to the BYWEEK fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setWeeksOfYear(const QSet<int>& weeks)
{
@@ -429,6 +452,7 @@ void QOrganizerRecurrenceRule::setWeeksOfYear(const QSet<int>& weeks)
* Returns a list of the weeks of the year that the item should recur on. If not set, this is the
* empty list, which signifies that it should be implied, if necessary, by the week number of the
* item.
+ \since 1.1
*/
QSet<int> QOrganizerRecurrenceRule::weeksOfYear() const
{
@@ -447,6 +471,7 @@ QSet<int> QOrganizerRecurrenceRule::weeksOfYear() const
* weekday of each month.
*
* This corresponds to the BYSETPOS fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setPositions(const QSet<int>& pos)
{
@@ -456,6 +481,7 @@ void QOrganizerRecurrenceRule::setPositions(const QSet<int>& pos)
/*!
* Returns the position-list of the recurrence rule. If not set, this is the empty list, which
* signifies that the recurrence dates should not be restricted by position.
+ \since 1.1
*/
QSet<int> QOrganizerRecurrenceRule::positions() const
{
@@ -467,6 +493,7 @@ QSet<int> QOrganizerRecurrenceRule::positions() const
* weekOfYear is set. See the iCalendar spec for examples of its significance.
*
* This corresponds to the BYWKST fragment in iCalendar's RRULE.
+ \since 1.1
*/
void QOrganizerRecurrenceRule::setFirstDayOfWeek(Qt::DayOfWeek day)
{
@@ -475,6 +502,7 @@ void QOrganizerRecurrenceRule::setFirstDayOfWeek(Qt::DayOfWeek day)
/*!
* Returns the day that the week starts on. If not set, this is Monday.
+ \since 1.1
*/
Qt::DayOfWeek QOrganizerRecurrenceRule::firstDayOfWeek() const
{
@@ -532,6 +560,7 @@ uint qHash(const QOrganizerRecurrenceRule& r)
#ifndef QT_NO_DEBUG_STREAM
/*!
Outputs \a rule to the debug stream \a dbg
+ \since 1.2
*/
QDebug operator<<(QDebug dbg, const QOrganizerRecurrenceRule& rule)
{
diff --git a/src/publishsubscribe/qvaluespace.cpp b/src/publishsubscribe/qvaluespace.cpp
index 243340428d..410ade809a 100644
--- a/src/publishsubscribe/qvaluespace.cpp
+++ b/src/publishsubscribe/qvaluespace.cpp
@@ -127,6 +127,7 @@ QTM_BEGIN_NAMESPACE
\fn QString QAbstractValueSpaceLayer::name()
Returns the name of the Value Space layer. This name is only used for diagnostics purposes.
+ \since 1.0
*/
/*!
@@ -137,12 +138,14 @@ QTM_BEGIN_NAMESPACE
desired.
Returns true upon success; otherwise returns false.
+ \since 1.0
*/
/*!
\fn QUuid QAbstractValueSpaceLayer::id()
Returns a globally unique identifier for the layer. This id is used to break ordering ties.
+ \since 1.0
*/
/*!
@@ -151,6 +154,7 @@ QTM_BEGIN_NAMESPACE
Return the position in the Value Space layer stack that this layer should reside. Higher
numbers mean the layer has a higher precedence and its values will "shadow" those below it.
If two layers specify the same ordering, the id() value is used to break the tie.
+ \since 1.0
*/
/*!
@@ -161,18 +165,21 @@ QTM_BEGIN_NAMESPACE
The caller should call removeHandle() to free resources used by the handle when it is no longer
required.
+ \since 1.0
*/
/*!
\fn void QAbstractValueSpaceLayer::removeHandle(Handle handle)
Releases a \a handle previously returned from QAbstractValueSpaceLayer::item().
+ \since 1.0
*/
/*!
\fn void QAbstractValueSpaceLayer::setProperty(Handle handle, Properties property)
Apply the specified \a property mask to \a handle.
+ \since 1.0
*/
/*!
@@ -180,6 +187,7 @@ QTM_BEGIN_NAMESPACE
Returns the value for a particular \a handle. If a value is available, the layer will set
\a data and return true. If no value is available, false is returned.
+ \since 1.0
*/
/*!
@@ -187,6 +195,7 @@ QTM_BEGIN_NAMESPACE
Returns the value for a particular \a subPath of \a handle. If a value is available, the
layer will set \a data and return true. If no value is available, false is returned.
+ \since 1.0
*/
/*!
@@ -203,6 +212,7 @@ QTM_BEGIN_NAMESPACE
a request for children of "/Device/Configuration" will return
{ "Applications", "Buttons", "Name" }.
+ \since 1.0
*/
/*!
@@ -211,12 +221,14 @@ QTM_BEGIN_NAMESPACE
Returns the QValueSpace::LayerOptions describing this layer.
\sa QValueSpace::LayerOption
+ \since 1.0
*/
/*!
\fn bool QAbstractValueSpaceLayer::supportsInterestNotification() const
Returns true if the layer supports interest notifications; otherwise returns false.
+ \since 1.0
*/
/*!
@@ -229,6 +241,7 @@ QTM_BEGIN_NAMESPACE
matching call with \a interested set to false.
Returns true if the notification was successfully sent; otherwise returns false.
+ \since 1.0
*/
/*!
@@ -240,6 +253,7 @@ QTM_BEGIN_NAMESPACE
\a creator.
Returns true on success; otherwise returns false.
+ \since 1.0
*/
/*!
@@ -250,6 +264,7 @@ QTM_BEGIN_NAMESPACE
identified by \a handle and \a subPath and created by \a creator.
Returns true on success; otherwise returns false.
+ \since 1.0
*/
/*!
@@ -259,6 +274,7 @@ QTM_BEGIN_NAMESPACE
created by \a creator under \a handle.
Returns true on success; otherwise returns false.
+ \since 1.0
*/
/*!
@@ -267,6 +283,7 @@ QTM_BEGIN_NAMESPACE
Registers \a creator for change notifications to values under \a handle.
\sa removeWatches()
+ \since 1.0
*/
/*!
@@ -275,17 +292,20 @@ QTM_BEGIN_NAMESPACE
Removes all registered change notifications for \a creator under \a parent.
\sa addWatch()
+ \since 1.0
*/
/*!
\fn void QAbstractValueSpaceLayer::sync()
Flushes all pending changes made by calls to setValue(), removeValue() and removeSubTree().
+ \since 1.0
*/
/*!
Emits the QValueSpacePublisher::interestChanged() signal on \a publisher with \a path
and \a interested.
+ \since 1.0
*/
void QAbstractValueSpaceLayer::emitInterestChanged(QValueSpacePublisher *publisher,
const QString &path,
@@ -298,6 +318,7 @@ void QAbstractValueSpaceLayer::emitInterestChanged(QValueSpacePublisher *publish
\fn void QAbstractValueSpaceLayer::handleChanged(quintptr handle)
Emitted whenever the \a handle's value, or any sub value, changes.
+ \since 1.0
*/
@@ -362,6 +383,7 @@ void QAbstractValueSpaceLayer::emitInterestChanged(QValueSpacePublisher *publish
\internal
Support class used by the QVALUESPACE_AUTO_INSTALL_LAYER() macro.
+ \since 1.0
*/
/*!
@@ -369,12 +391,14 @@ void QAbstractValueSpaceLayer::emitInterestChanged(QValueSpacePublisher *publish
Installs the Value Space layer at static construction time by calling the layer creation
function \a func.
+ \since 1.0
*/
/*!
Initialize the Value Space manager as the server. This method only needs to be called by the
process acting as the server and should be called before any process in the system uses a value
space class.
+ \since 1.0
*/
void QValueSpace::initValueSpaceServer()
{
@@ -388,6 +412,7 @@ void QValueSpace::initValueSpaceServer()
should be a pointer to the layer to install.
\sa QVALUESPACE_AUTO_INSTALL_LAYER()
+ \since 1.0
*/
void QValueSpace::installLayer(QAbstractValueSpaceLayer *layer)
{
@@ -399,6 +424,7 @@ void QValueSpace::installLayer(QAbstractValueSpaceLayer *layer)
Called by the QVALUESPACE_AUTO_INSTALL_LAYER() macro to install the layer at static
initialization time.
+ \since 1.0
*/
void QValueSpace::installLayer(LayerCreateFunc func)
{
@@ -417,6 +443,7 @@ void QValueSpace::installLayer(LayerCreateFunc func)
You can test if the Shared Memory layer is available by checking if the list returned by
QValueSpace::availableLayers() contains this value.
+ \since 1.0
*/
/*!
@@ -432,6 +459,7 @@ void QValueSpace::installLayer(LayerCreateFunc func)
You can test if the Volatile Registry layer is available by checking if the list returned by
QValueSpace::availableLayers() contains this value. The Volatile Registry layer is only
available on Windows platforms.
+ \since 1.0
*/
/*!
@@ -447,6 +475,7 @@ void QValueSpace::installLayer(LayerCreateFunc func)
You can test if the Non-Volatile Registry layer is available by checking if the list returned
by QValueSpace::availableLayers() contains this value. The Non-Volatile Registry layer is only
available on Windows platforms.
+ \since 1.0
*/
/*!
@@ -461,6 +490,7 @@ void QValueSpace::installLayer(LayerCreateFunc func)
You can test if the ContextKit layer is available by checking if the list returned by
QValueSpace::availableLayers() contains this value.
+ \since 1.0
*/
/*!
@@ -475,10 +505,12 @@ void QValueSpace::installLayer(LayerCreateFunc func)
You can test if the Symbian Settings layer is available by checking if the list returned by
QValueSpace::availableLayers() contains this value.
+ \since 1.0
*/
/*!
Returns a list of QUuids of all of the available layers.
+ \since 1.0
*/
QList<QUuid> QValueSpace::availableLayers()
{
@@ -497,6 +529,7 @@ QList<QUuid> QValueSpace::availableLayers()
\ingroup publishsubscribe
Returns \a path with all duplicate '/' characters removed.
+ \since 1.0
*/
QString qCanonicalPath(const QString &path)
{
diff --git a/src/publishsubscribe/qvaluespacepublisher.cpp b/src/publishsubscribe/qvaluespacepublisher.cpp
index 648759bfd4..c6fcaebeea 100644
--- a/src/publishsubscribe/qvaluespacepublisher.cpp
+++ b/src/publishsubscribe/qvaluespacepublisher.cpp
@@ -114,6 +114,7 @@ QTM_BEGIN_NAMESPACE
Signal that is emitted when interest in \a attribute changes. If \a interested is true at
least on QValueSpaceSubscriber is interested in the value of \a attribute.
+ \since 1.0
*/
class QValueSpacePublisherPrivate
@@ -192,6 +193,7 @@ QValueSpacePublisherPrivate::QValueSpacePublisherPrivate(const QString &_path, c
/*!
Constructs a QValueSpacePublisher with the specified \a parent that publishes values under
\a path.
+ \since 1.0
*/
QValueSpacePublisher::QValueSpacePublisher(const QString &path, QObject *parent)
: QObject(parent), d(new QValueSpacePublisherPrivate(path))
@@ -210,6 +212,7 @@ QValueSpacePublisher::QValueSpacePublisher(const QString &path, QObject *parent)
If no suitable layer is found, the constructed QValueSpacePublisher will be unconnected.
\sa isConnected()
+ \since 1.0
*/
QValueSpacePublisher::QValueSpacePublisher(QValueSpace::LayerOptions filter,
const QString &path,
@@ -230,6 +233,7 @@ QValueSpacePublisher::QValueSpacePublisher(QValueSpace::LayerOptions filter,
unconnected.
\sa isConnected()
+ \since 1.0
*/
QValueSpacePublisher::QValueSpacePublisher(const QUuid &uuid, const QString &path, QObject *parent)
@@ -241,6 +245,7 @@ QValueSpacePublisher::QValueSpacePublisher(const QUuid &uuid, const QString &pat
/*!
Destroys the QValueSpacePublisher. This will remove all values published by this publisher in
\l {QValueSpace::TransientLayer}{non-permanent} layers.
+ \since 1.0
*/
QValueSpacePublisher::~QValueSpacePublisher()
{
@@ -258,6 +263,7 @@ QValueSpacePublisher::~QValueSpacePublisher()
/*!
Returns the path that this QValueSpacePublisher refers to.
+ \since 1.0
*/
QString QValueSpacePublisher::path() const
{
@@ -271,6 +277,7 @@ QString QValueSpacePublisher::path() const
/*!
Returns true if this QValueSpacePublisher is connected to an available layer; otherwise returns
false.
+ \since 1.0
*/
bool QValueSpacePublisher::isConnected() const
{
@@ -286,6 +293,7 @@ bool QValueSpacePublisher::isConnected() const
processes in the system will be able to see the attribute changes.
Generally, calling this function is unnecessary.
+ \since 1.0
*/
void QValueSpacePublisher::sync()
{
@@ -308,6 +316,7 @@ void QValueSpacePublisher::sync()
// QValueSpaceSubscriber("/Device/State").value() == QVariant("Starting")
\endcode
+ \since 1.0
*/
void QValueSpacePublisher::setValue(const QString &name, const QVariant &data)
{
@@ -337,6 +346,7 @@ void QValueSpacePublisher::setValue(const QString &name, const QVariant &data)
// QValueSpaceSubscriber("/Device/State").value() == QVariant();
// QValueSpaceSubscriber("/Device/State/Memory").value() == QVariant();
\endcode
+ \since 1.0
*/
void QValueSpacePublisher::resetValue(const QString &name)
{
@@ -361,6 +371,7 @@ void QValueSpacePublisher::resetValue(const QString &name)
your implementation.
\sa interestChanged()
+ \since 1.0
*/
void QValueSpacePublisher::connectNotify(const char *member)
{
diff --git a/src/publishsubscribe/qvaluespacesubscriber.cpp b/src/publishsubscribe/qvaluespacesubscriber.cpp
index 95add53391..e3e9312627 100644
--- a/src/publishsubscribe/qvaluespacesubscriber.cpp
+++ b/src/publishsubscribe/qvaluespacesubscriber.cpp
@@ -91,6 +91,7 @@ QTM_BEGIN_NAMESPACE
will invoke the \c {buttonInfoChanged()} slot whenever any value under \c {/Device/Buttons}
changes. This includes the value of \c {/Device/Buttons} itself, a change of a subpath such as
\c {/Device/Buttons/2/Name} or the creation or removal of a subpath.
+ \since 1.0
*/
/*!
@@ -100,6 +101,7 @@ QTM_BEGIN_NAMESPACE
\bold {Note:} that if a value changes multiple times in quick succession, only the most recent
value may be accessible via the value() function.
+ \since 1.0
*/
/*!
@@ -109,12 +111,14 @@ QTM_BEGIN_NAMESPACE
Settings this property causes the QValueSpaceSubscriber to disconnect and reconnect to the
Value Space with the new path. As a result all signal/slot connections are disconnected.
+ \since 1.0
*/
/*!
\property QValueSpaceSubscriber::value
This property holds the value of the path that this QValueSpaceSubscriber refers to.
+ \since 1.0
*/
class QValueSpaceSubscriberPrivateProxy : public QObject
@@ -314,6 +318,7 @@ bool QValueSpaceSubscriberPrivate::disconnect(QValueSpaceSubscriber * space)
Constructs a QValueSpaceSubscriber with the specified \a parent that refers to the root path.
The constructed Value Space subscriber will access all available layers.
+ \since 1.0
*/
QValueSpaceSubscriber::QValueSpaceSubscriber(QObject *parent)
: QObject(parent)
@@ -325,6 +330,7 @@ QValueSpaceSubscriber::QValueSpaceSubscriber(QObject *parent)
Constructs a QValueSpaceSubscriber with the specified \a parent that refers to \a path.
The constructed Value Space subscriber will access all available layers.
+ \since 1.0
*/
QValueSpaceSubscriber::QValueSpaceSubscriber(const QString &path, QObject *parent)
: QObject(parent)
@@ -340,6 +346,7 @@ QValueSpaceSubscriber::QValueSpaceSubscriber(const QString &path, QObject *paren
unconnected.
\sa isConnected()
+ \since 1.0
*/
QValueSpaceSubscriber::QValueSpaceSubscriber(QValueSpace::LayerOptions filter,
const QString &path,
@@ -360,6 +367,7 @@ QValueSpaceSubscriber::QValueSpaceSubscriber(QValueSpace::LayerOptions filter,
unconnected.
\sa QValueSpace, isConnected()
+ \since 1.0
*/
QValueSpaceSubscriber::QValueSpaceSubscriber(const QUuid &uuid,
const QString &path,
@@ -371,6 +379,7 @@ QValueSpaceSubscriber::QValueSpaceSubscriber(const QUuid &uuid,
/*!
Destroys the QValueSpaceSubscriber.
+ \since 1.0
*/
QValueSpaceSubscriber::~QValueSpaceSubscriber()
{
@@ -384,6 +393,7 @@ QValueSpaceSubscriber::~QValueSpaceSubscriber()
space with the new \a path.
Calling this function disconnects all signal/slot connections.
+ \since 1.0
*/
void QValueSpaceSubscriber::setPath(const QString &path)
{
@@ -404,6 +414,7 @@ void QValueSpaceSubscriber::setPath(const QString &path)
space with the specified \a path.
Calling this function disconnects all signal/slot connections.
+ \since 1.0
*/
void QValueSpaceSubscriber::setPath(QValueSpaceSubscriber *subscriber)
{
@@ -426,6 +437,7 @@ QString QValueSpaceSubscriber::path() const
/*!
Changes the path to the absolute path if \a path starts with a '/'; otherwise changes to the
sub path of the current path.
+ \since 1.0
*/
void QValueSpaceSubscriber::cd(const QString &path)
{
@@ -437,6 +449,7 @@ void QValueSpaceSubscriber::cd(const QString &path)
/*!
Sets the path to parent of the current path.
+ \since 1.0
*/
void QValueSpaceSubscriber::cdUp()
{
@@ -456,6 +469,7 @@ void QValueSpaceSubscriber::cdUp()
Returns true if this QValueSpaceSubscriber is connected to at least one available layer;
otherwise returns false. An unconnected QValueSpaceSubscriber is constructed if the filtering
parameters passed to the constructor eliminate all available layers.
+ \since 1.0
*/
bool QValueSpaceSubscriber::isConnected() const
{
@@ -475,6 +489,7 @@ bool QValueSpaceSubscriber::isConnected() const
// Is true
equiv.value() == base.value("Nokia/General/Mappings");
\endcode
+ \since 1.0
*/
QVariant QValueSpaceSubscriber::value(const QString & subPath, const QVariant &def) const
{
@@ -511,6 +526,7 @@ QVariant QValueSpaceSubscriber::valuex(const QVariant &def) const
Registers for change notifications in response to connection to the contentsChanged()
\a signal.
+ \since 1.0
*/
void QValueSpaceSubscriber::connectNotify(const char *signal)
{
@@ -525,6 +541,7 @@ void QValueSpaceSubscriber::connectNotify(const char *signal)
Unregisters for change notifications in response to disconnection from the contentsChanged()
\a signal.
+ \since 1.0
*/
void QValueSpaceSubscriber::disconnectNotify(const char *signal)
{
@@ -547,6 +564,7 @@ void QValueSpaceSubscriber::disconnectNotify(const char *signal)
\c { QValueSpaceSubscriber("/Settings").subPaths() } will return a list containing
\c { { Nokia, Qt } } in no particular order.
+ \since 1.0
*/
QStringList QValueSpaceSubscriber::subPaths() const
{
diff --git a/src/publishsubscribe/sharedmemorylayer.cpp b/src/publishsubscribe/sharedmemorylayer.cpp
index c2287328ca..27da013611 100644
--- a/src/publishsubscribe/sharedmemorylayer.cpp
+++ b/src/publishsubscribe/sharedmemorylayer.cpp
@@ -460,6 +460,7 @@ unsigned short FixedMemoryTree::findClosest(unsigned int from,
/*!
Returns the default datum for \a node, or NULL if one doesn't exist.
+ \since 1.0
*/
NodeDatum * FixedMemoryTree::data(unsigned short node)
{
@@ -477,6 +478,7 @@ NodeDatum * FixedMemoryTree::data(unsigned short node)
/*!
Inserts a watch for \a owner at the specified \a path
+ \since 1.0
*/
bool FixedMemoryTree::addWatch(const char * path, NodeWatch owner)
{
@@ -494,6 +496,7 @@ bool FixedMemoryTree::addWatch(const char * path, NodeWatch owner)
/*!
Removes an existing watch for \a owner from the specified \a path
+ \since 1.0
*/
bool FixedMemoryTree::remWatch(const char * path, NodeWatch owner)
{
@@ -512,6 +515,7 @@ bool FixedMemoryTree::remWatch(const char * path, NodeWatch owner)
/*!
Inserts \a data of length \a dataLen at \a path with the set \a owner.
Returns true if the tree has visibly changed.
+ \since 1.0
*/
bool FixedMemoryTree::insert(const char * path, NodeDatum::Type type,
const char * data, unsigned int dataLen,
@@ -536,6 +540,7 @@ bool FixedMemoryTree::insert(const char * path, NodeDatum::Type type,
/*!
Returns the linear offset of \a subNode within \a node. Asserts if not
found.
+ \since 1.0
*/
unsigned short FixedMemoryTree::offsetOfSubNode(unsigned short node,
unsigned short subNode)
@@ -578,6 +583,7 @@ bool FixedMemoryTree::remove(const char * path, NodeOwner owner)
\i Up to 64 entries, double the size each allocation.
\i From 64 onwards, grow in chunks of 64
\endlist
+ \since 1.0
*/
unsigned int FixedMemoryTree::growListSize(unsigned int currentSize)
{
@@ -598,6 +604,7 @@ unsigned int FixedMemoryTree::growListSize(unsigned int currentSize)
\i For currentSize < 64, reduce by half if possible
\i Otherwise, remain the same
\endlist
+ \since 1.0
*/
unsigned int FixedMemoryTree::shrunkListSize(unsigned int currentSize,
unsigned int contentSize)
@@ -617,13 +624,14 @@ unsigned int FixedMemoryTree::shrunkListSize(unsigned int currentSize,
sets \a *match to false and returns the offset where the node would be
found, should it exist. Moving all nodes up one notch and inserting the
new node at the returned offset maintains order.
+ \since 1.0
*/
unsigned int FixedMemoryTree::locateInNode(Node * node, const char * name,
unsigned int len, bool * match)
{
Q_ASSERT(node && name && match);
- // This is a linear search. It would be possible to replace this with a
+ // This is a linear search. It would be possible to replace this with a
// binary search, which may or may not improve performance depending on the
// number of sub nodes.
unsigned short counter = 0;
@@ -651,6 +659,7 @@ unsigned int FixedMemoryTree::locateInNode(Node * node, const char * name,
/*!
\internal
Recursive implementation of FixedMemoryTree::findClosest
+ \since 1.0
*/
unsigned short FixedMemoryTree::findRecur(unsigned short node,
const char * path,
@@ -688,6 +697,7 @@ unsigned short FixedMemoryTree::findRecur(unsigned short node,
it was removed, or INVALID_HANDLE if no nodes were removed. This can
be used by the parent to determine whether to increment the version
number and whether to remove the sub node.
+ \since 1.0
*/
unsigned short FixedMemoryTree::removeRecur(unsigned short node,
NodeOwner owner)
@@ -891,6 +901,7 @@ unsigned short FixedMemoryTree::removeRecur(unsigned short node,
/*!
Removes sub node number \a subNodeNumber from \a from's sub node list. Does
bump \a from's version number. Does not touch removed sub node.
+ \since 1.0
*/
void FixedMemoryTree::removeFrom(unsigned short from,
unsigned short subNodeNumber)
@@ -1039,6 +1050,7 @@ bool FixedMemoryTree::removeRecur(unsigned short node, const char * path,
/*!
Removes \a owner as a watch on \a node. Returns true if owner was removed,
false if owner was not a watch.
+ \since 1.0
*/
bool FixedMemoryTree::remWatch(unsigned short node, NodeWatch owner)
{
@@ -1099,6 +1111,7 @@ bool FixedMemoryTree::remWatch(unsigned short node, NodeWatch owner)
/*!
Inserts \a owner as a watch on \a node.
+ \since 1.0
*/
bool FixedMemoryTree::setWatch(unsigned short node, NodeWatch owner)
{
@@ -1157,6 +1170,7 @@ bool FixedMemoryTree::setWatch(unsigned short node, NodeWatch owner)
/*!
Inserts \a data of length \a dataLen into \a node. Returns true if the
version number of \a node has increased to handle this set.
+ \since 1.0
*/
bool FixedMemoryTree::setData(unsigned short node,
NodeOwner owner,
@@ -1401,6 +1415,7 @@ bool FixedMemoryTree::addWatchRecur(unsigned short node, const char * path,
/*!
Returns true if the insert should force a version bump.
+ \since 1.0
*/
bool FixedMemoryTree::insertRecur(unsigned short node,
const char * path,
@@ -1514,7 +1529,9 @@ unsigned int FixedMemoryTree::ptr(void * mem)
return (unsigned int)((char *)mem - poolMem);
}
-/*! Increment \a node's version number */
+/*! Increment \a node's version number
+ \since 1.0
+*/
void FixedMemoryTree::bump(unsigned short node)
{
++(versionTable()->entries[node].version);
@@ -1531,6 +1548,7 @@ Node * FixedMemoryTree::node(unsigned int entry)
/*! Returns the node identified by \a entry, or null if there is no node in that
slot. This is different to FixedMemoryTree::node() in that it checks the
return value (and is thus slower).
+ \since 1.0
*/
Node * FixedMemoryTree::getNode(unsigned int entry)
{
@@ -1562,6 +1580,7 @@ unsigned int FixedMemoryTree::version(unsigned int entry)
/*!
Creates a new node of \a name (name length \a len) and sets a single \a watch on it. Returns
ROOT_VERSION_ENTRY if the new node could not be created.
+ \since 1.0
*/
unsigned short FixedMemoryTree::newNode(const char * name, unsigned int len,
NodeWatch owner)
@@ -1606,6 +1625,7 @@ unsigned short FixedMemoryTree::newNode(const char * name, unsigned int len,
Creates a new node of \a name (name length \a len) and pre-fills it with \a data of length
\a dataLen owned by \a owner. If \a owner is an invalid owner, the node is a virtual node and
not prefilled with data. Returns ROOT_VERSION_ENTRY if the new node could not be created.
+ \since 1.0
*/
unsigned short FixedMemoryTree::newNode(const char * name, unsigned int len,
NodeOwner owner, NodeDatum::Type type,
@@ -2445,7 +2465,7 @@ bool SharedMemoryLayer::value(Handle handle, const QString &subPath,
bool rv = false;
if(0xFFFFFFFF == rhandle->currentPath) {
QByteArray abs_path = rhandle->path + subPath.toUtf8();
- if (rhandle->path.length() == 1)
+ if (rhandle->path.length() == 1)
abs_path = subPath.toUtf8();
ReadHandle vhandle(abs_path);
clearHandle(&vhandle);
@@ -2553,6 +2573,7 @@ SharedMemoryLayer::Handle SharedMemoryLayer::item(Handle parent, const QString &
That is, returns true if a handleChanged() signal is needed :)
The layer MUST be locked for reading.
+ \since 1.0
*/
bool SharedMemoryLayer::refreshHandle(ReadHandle * handle)
diff --git a/src/sensors/qaccelerometer.cpp b/src/sensors/qaccelerometer.cpp
index a9ea15b728..e07d99468b 100644
--- a/src/sensors/qaccelerometer.cpp
+++ b/src/sensors/qaccelerometer.cpp
@@ -73,6 +73,7 @@ IMPLEMENT_READING(QAccelerometerReading)
The scale of the values is meters per second squared.
\sa {QAccelerometerReading Units}
+ \since 1.0
*/
qreal QAccelerometerReading::x() const
@@ -82,6 +83,7 @@ qreal QAccelerometerReading::x() const
/*!
Sets the acceleration on the X axis to \a x.
+ \since 1.0
*/
void QAccelerometerReading::setX(qreal x)
{
@@ -94,6 +96,7 @@ void QAccelerometerReading::setX(qreal x)
The scale of the values is meters per second squared.
\sa {QAccelerometerReading Units}
+ \since 1.0
*/
qreal QAccelerometerReading::y() const
@@ -103,6 +106,7 @@ qreal QAccelerometerReading::y() const
/*!
Sets the acceleration on the Y axis to \a y.
+ \since 1.0
*/
void QAccelerometerReading::setY(qreal y)
{
@@ -115,6 +119,7 @@ void QAccelerometerReading::setY(qreal y)
The scale of the values is meters per second squared.
\sa {QAccelerometerReading Units}
+ \since 1.0
*/
qreal QAccelerometerReading::z() const
@@ -124,6 +129,7 @@ qreal QAccelerometerReading::z() const
/*!
Sets the acceleration on the Z axis to \a z.
+ \since 1.0
*/
void QAccelerometerReading::setZ(qreal z)
{
@@ -141,6 +147,7 @@ void QAccelerometerReading::setZ(qreal z)
The only difference is that the filter() method features a pointer to QAccelerometerReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -149,6 +156,7 @@ void QAccelerometerReading::setZ(qreal z)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QAccelerometer::type("QAccelerometer");
@@ -167,18 +175,21 @@ char const * const QAccelerometer::type("QAccelerometer");
For details about how the sensor works, see \l QAccelerometerReading.
\sa QAccelerometerReading
+ \since 1.0
*/
/*!
\fn QAccelerometer::QAccelerometer(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QAccelerometer::~QAccelerometer()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -187,6 +198,7 @@ char const * const QAccelerometer::type("QAccelerometer");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
#include "moc_qaccelerometer.cpp"
diff --git a/src/sensors/qambientlightsensor.cpp b/src/sensors/qambientlightsensor.cpp
index d5358fd73c..d2648eafbe 100644
--- a/src/sensors/qambientlightsensor.cpp
+++ b/src/sensors/qambientlightsensor.cpp
@@ -80,6 +80,7 @@ IMPLEMENT_READING(QAmbientLightReading)
The value represents the ambient light and comes from QAmbientLightReading::LightLevel.
\sa {QAmbientLightReading Units}
+ \since 1.0
*/
QAmbientLightReading::LightLevel QAmbientLightReading::lightLevel() const
@@ -89,6 +90,7 @@ QAmbientLightReading::LightLevel QAmbientLightReading::lightLevel() const
/*!
Sets the ambient light level to \a lightLevel.
+ \since 1.0
*/
void QAmbientLightReading::setLightLevel(QAmbientLightReading::LightLevel lightLevel)
{
@@ -117,6 +119,7 @@ void QAmbientLightReading::setLightLevel(QAmbientLightReading::LightLevel lightL
The only difference is that the filter() method features a pointer to QAmbientLightReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -125,6 +128,7 @@ void QAmbientLightReading::setLightLevel(QAmbientLightReading::LightLevel lightL
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QAmbientLightSensor::type("QAmbientLightSensor");
@@ -143,18 +147,21 @@ char const * const QAmbientLightSensor::type("QAmbientLightSensor");
For details about how the sensor works, see \l QAmbientLightReading.
\sa QAmbientLightReading
+ \since 1.0
*/
/*!
\fn QAmbientLightSensor::QAmbientLightSensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QAmbientLightSensor::~QAmbientLightSensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -163,6 +170,7 @@ char const * const QAmbientLightSensor::type("QAmbientLightSensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
#include "moc_qambientlightsensor.cpp"
diff --git a/src/sensors/qcompass.cpp b/src/sensors/qcompass.cpp
index 9da353e7ec..27fe266f4b 100644
--- a/src/sensors/qcompass.cpp
+++ b/src/sensors/qcompass.cpp
@@ -78,6 +78,7 @@ IMPLEMENT_READING(QCompassReading)
Measured in degrees from magnetic north in a clockwise direction based
the top of the UI.
\sa {QCompassReading Units}
+ \since 1.0
*/
qreal QCompassReading::azimuth() const
@@ -89,6 +90,7 @@ qreal QCompassReading::azimuth() const
Sets the \a azimuth of the device.
\sa {QCompassReading Units}
+ \since 1.0
*/
void QCompassReading::setAzimuth(qreal azimuth)
{
@@ -101,6 +103,7 @@ void QCompassReading::setAzimuth(qreal azimuth)
Measured as a value from 0 to 1 with higher values being better.
\sa {QCompassReading Units}, {http://wiki.forum.nokia.com/index.php/CS001671_-_Calibrating_the_magnetometer_sensor}{CS001671 - Calibrating the magnetometer sensor}
+ \since 1.0
*/
qreal QCompassReading::calibrationLevel() const
@@ -110,6 +113,7 @@ qreal QCompassReading::calibrationLevel() const
/*!
Sets the calibration level of the reading to \a calibrationLevel.
+ \since 1.0
*/
void QCompassReading::setCalibrationLevel(qreal calibrationLevel)
{
@@ -127,6 +131,7 @@ void QCompassReading::setCalibrationLevel(qreal calibrationLevel)
The only difference is that the filter() method features a pointer to QCompassReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -135,6 +140,7 @@ void QCompassReading::setCalibrationLevel(qreal calibrationLevel)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QCompass::type("QCompass");
@@ -153,18 +159,21 @@ char const * const QCompass::type("QCompass");
For details about how the sensor works, see \l QCompassReading.
\sa QCompassReading
+ \since 1.0
*/
/*!
\fn QCompass::QCompass(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QCompass::~QCompass()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -173,6 +182,7 @@ char const * const QCompass::type("QCompass");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
#include "moc_qcompass.cpp"
diff --git a/src/sensors/qgyroscope.cpp b/src/sensors/qgyroscope.cpp
index 1ea2a6f0a7..e22480c33d 100644
--- a/src/sensors/qgyroscope.cpp
+++ b/src/sensors/qgyroscope.cpp
@@ -71,6 +71,7 @@ IMPLEMENT_READING(QGyroscopeReading)
Measured as degrees per second.
\sa {QGyroscopeReading Units}
+ \since 1.2
*/
qreal QGyroscopeReading::x() const
@@ -80,6 +81,7 @@ qreal QGyroscopeReading::x() const
/*!
Sets the angular velocity around the x axis to \a x.
+ \since 1.2
*/
void QGyroscopeReading::setX(qreal x)
{
@@ -92,6 +94,7 @@ void QGyroscopeReading::setX(qreal x)
Measured as degrees per second.
\sa {QGyroscopeReading Units}
+ \since 1.2
*/
qreal QGyroscopeReading::y() const
@@ -101,6 +104,7 @@ qreal QGyroscopeReading::y() const
/*!
Sets the angular velocity around the y axis to \a y.
+ \since 1.2
*/
void QGyroscopeReading::setY(qreal y)
{
@@ -113,6 +117,7 @@ void QGyroscopeReading::setY(qreal y)
Measured as degrees per second.
\sa {QGyroscopeReading Units}
+ \since 1.2
*/
qreal QGyroscopeReading::z() const
@@ -122,6 +127,7 @@ qreal QGyroscopeReading::z() const
/*!
Sets the angular velocity around the z axis to \a z.
+ \since 1.2
*/
void QGyroscopeReading::setZ(qreal z)
{
@@ -139,6 +145,7 @@ void QGyroscopeReading::setZ(qreal z)
The only difference is that the filter() method features a pointer to QGyroscopeReading
instead of QSensorReading.
+ \since 1.2
*/
/*!
@@ -147,6 +154,7 @@ void QGyroscopeReading::setZ(qreal z)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.2
*/
char const * const QGyroscope::type("QGyroscope");
@@ -165,18 +173,21 @@ char const * const QGyroscope::type("QGyroscope");
For details about how the sensor works, see \l QGyroscopeReading.
\sa QGyroscopeReading
+ \since 1.2
*/
/*!
\fn QGyroscope::QGyroscope(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.2
*/
/*!
\fn QGyroscope::~QGyroscope()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.2
*/
/*!
@@ -185,6 +196,7 @@ char const * const QGyroscope::type("QGyroscope");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.2
*/
#include "moc_qgyroscope.cpp"
diff --git a/src/sensors/qlightsensor.cpp b/src/sensors/qlightsensor.cpp
index e63ec0dfe8..1725026c02 100644
--- a/src/sensors/qlightsensor.cpp
+++ b/src/sensors/qlightsensor.cpp
@@ -49,7 +49,7 @@ IMPLEMENT_READING(QLightReading)
/*!
\class QLightReading
\ingroup sensors_reading
-
+
\since 1.2
\preliminary
@@ -66,6 +66,7 @@ IMPLEMENT_READING(QLightReading)
Measured as lux.
\sa {QLightReading Units}
+ \since 1.2
*/
qreal QLightReading::lux() const
@@ -75,6 +76,7 @@ qreal QLightReading::lux() const
/*!
Sets the light level to \a lux.
+ \since 1.2
*/
void QLightReading::setLux(qreal lux)
{
@@ -92,6 +94,7 @@ void QLightReading::setLux(qreal lux)
The only difference is that the filter() method features a pointer to QLightReading
instead of QSensorReading.
+ \since 1.2
*/
/*!
@@ -100,6 +103,7 @@ void QLightReading::setLux(qreal lux)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.2
*/
char const * const QLightSensor::type("QLightSensor");
@@ -118,18 +122,21 @@ char const * const QLightSensor::type("QLightSensor");
For details about how the sensor works, see \l QLightReading.
\sa QLightReading
+ \since 1.2
*/
/*!
\fn QLightSensor::QLightSensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.2
*/
/*!
\fn QLightSensor::~QLightSensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.2
*/
/*!
@@ -138,6 +145,7 @@ char const * const QLightSensor::type("QLightSensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.2
*/
/*!
@@ -145,6 +153,7 @@ char const * const QLightSensor::type("QLightSensor");
\brief a value indicating the field of view.
This is an angle that represents the field of view of the sensor.
+ \since 1.2
*/
#include "moc_qlightsensor.cpp"
diff --git a/src/sensors/qmagnetometer.cpp b/src/sensors/qmagnetometer.cpp
index 55a80e1ed9..701893388b 100644
--- a/src/sensors/qmagnetometer.cpp
+++ b/src/sensors/qmagnetometer.cpp
@@ -87,6 +87,7 @@ IMPLEMENT_READING(QMagnetometerReading)
Measured as telsas.
\sa {QMagnetometerReading Units}
+ \since 1.0
*/
qreal QMagnetometerReading::x() const
@@ -96,6 +97,7 @@ qreal QMagnetometerReading::x() const
/*!
Sets the raw magnetic flux density on the X axis to \a x.
+ \since 1.0
*/
void QMagnetometerReading::setX(qreal x)
{
@@ -108,6 +110,7 @@ void QMagnetometerReading::setX(qreal x)
Measured as telsas.
\sa {QMagnetometerReading Units}
+ \since 1.0
*/
qreal QMagnetometerReading::y() const
@@ -117,6 +120,7 @@ qreal QMagnetometerReading::y() const
/*!
Sets the raw magnetic flux density on the Y axis to \a y.
+ \since 1.0
*/
void QMagnetometerReading::setY(qreal y)
{
@@ -129,6 +133,7 @@ void QMagnetometerReading::setY(qreal y)
Measured as telsas.
\sa {QMagnetometerReading Units}
+ \since 1.0
*/
qreal QMagnetometerReading::z() const
@@ -138,6 +143,7 @@ qreal QMagnetometerReading::z() const
/*!
Sets the raw magnetic flux density on the Z axis to \a z.
+ \since 1.0
*/
void QMagnetometerReading::setZ(qreal z)
{
@@ -153,6 +159,7 @@ void QMagnetometerReading::setZ(qreal z)
Note that this only changes when measuring geomagnetic flux density.
Raw magnetic flux readings will always have a value of 1.
\sa {QMagnetometerReading Units}, {http://wiki.forum.nokia.com/index.php/CS001671_-_Calibrating_the_magnetometer_sensor}{CS001671 - Calibrating the magnetometer sensor}
+ \since 1.0
*/
qreal QMagnetometerReading::calibrationLevel() const
@@ -162,6 +169,7 @@ qreal QMagnetometerReading::calibrationLevel() const
/*!
Sets the accuracy of the reading to \a calibrationLevel.
+ \since 1.0
*/
void QMagnetometerReading::setCalibrationLevel(qreal calibrationLevel)
{
@@ -179,6 +187,7 @@ void QMagnetometerReading::setCalibrationLevel(qreal calibrationLevel)
The only difference is that the filter() method features a pointer to QMagnetometerReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -187,6 +196,7 @@ void QMagnetometerReading::setCalibrationLevel(qreal calibrationLevel)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QMagnetometer::type("QMagnetometer");
@@ -205,18 +215,21 @@ char const * const QMagnetometer::type("QMagnetometer");
For details about how the sensor works, see \l QMagnetometerReading.
\sa QMagnetometerReading
+ \since 1.0
*/
/*!
\fn QMagnetometer::QMagnetometer(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QMagnetometer::~QMagnetometer()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -225,6 +238,7 @@ char const * const QMagnetometer::type("QMagnetometer");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
/*!
@@ -236,6 +250,7 @@ char const * const QMagnetometer::type("QMagnetometer");
Note that you must access this property via QObject::property() and QObject::setProperty().
The property must be set before calling start().
+ \since 1.0
*/
#include "moc_qmagnetometer.cpp"
diff --git a/src/sensors/qorientationsensor.cpp b/src/sensors/qorientationsensor.cpp
index f98ab6d764..b5f24ec6c2 100644
--- a/src/sensors/qorientationsensor.cpp
+++ b/src/sensors/qorientationsensor.cpp
@@ -102,6 +102,7 @@ IMPLEMENT_READING(QOrientationReading)
The unit is an enumeration describing the orientation of the device.
\sa {QOrientationReading Units}
+ \since 1.0
*/
QOrientationReading::Orientation QOrientationReading::orientation() const
@@ -111,6 +112,7 @@ QOrientationReading::Orientation QOrientationReading::orientation() const
/*!
Sets the \a orientation for the reading.
+ \since 1.0
*/
void QOrientationReading::setOrientation(QOrientationReading::Orientation orientation)
{
@@ -140,6 +142,7 @@ void QOrientationReading::setOrientation(QOrientationReading::Orientation orient
The only difference is that the filter() method features a pointer to QOrientationReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -148,6 +151,7 @@ void QOrientationReading::setOrientation(QOrientationReading::Orientation orient
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QOrientationSensor::type("QOrientationSensor");
@@ -166,18 +170,21 @@ char const * const QOrientationSensor::type("QOrientationSensor");
For details about how the sensor works, see \l QOrientationReading.
\sa QOrientationReading
+ \since 1.0
*/
/*!
\fn QOrientationSensor::QOrientationSensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QOrientationSensor::~QOrientationSensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -186,6 +193,7 @@ char const * const QOrientationSensor::type("QOrientationSensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
#include "moc_qorientationsensor.cpp"
diff --git a/src/sensors/qproximitysensor.cpp b/src/sensors/qproximitysensor.cpp
index b4a8e7ab74..db97299c03 100644
--- a/src/sensors/qproximitysensor.cpp
+++ b/src/sensors/qproximitysensor.cpp
@@ -70,6 +70,7 @@ IMPLEMENT_READING(QProximityReading)
Set to false is nothing is close.
\sa QProximityReading_Units
+ \since 1.0
*/
bool QProximityReading::close() const
@@ -79,6 +80,7 @@ bool QProximityReading::close() const
/*!
Sets the close value to \a close.
+ \since 1.0
*/
void QProximityReading::setClose(bool close)
{
@@ -96,6 +98,7 @@ void QProximityReading::setClose(bool close)
The only difference is that the filter() method features a pointer to QProximityReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -104,6 +107,7 @@ void QProximityReading::setClose(bool close)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QProximitySensor::type("QProximitySensor");
@@ -122,18 +126,21 @@ char const * const QProximitySensor::type("QProximitySensor");
For details about how the sensor works, see \l QProximityReading.
\sa QProximityReading
+ \since 1.0
*/
/*!
\fn QProximitySensor::QProximitySensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QProximitySensor::~QProximitySensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -142,6 +149,7 @@ char const * const QProximitySensor::type("QProximitySensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
#include "moc_qproximitysensor.cpp"
diff --git a/src/sensors/qrotationsensor.cpp b/src/sensors/qrotationsensor.cpp
index 4d5e8742ca..06950dc5b7 100644
--- a/src/sensors/qrotationsensor.cpp
+++ b/src/sensors/qrotationsensor.cpp
@@ -109,6 +109,7 @@ IMPLEMENT_READING(QRotationReading)
Measured as degrees.
\sa {QRotationReading Units}
+ \since 1.0
*/
qreal QRotationReading::x() const
@@ -118,6 +119,7 @@ qreal QRotationReading::x() const
/*!
Sets the rotation around the x axis to \a x.
+ \since 1.0
*/
void QRotationReading::setX(qreal x)
{
@@ -130,6 +132,7 @@ void QRotationReading::setX(qreal x)
Measured as degrees.
\sa {QRotationReading Units}
+ \since 1.0
*/
qreal QRotationReading::y() const
@@ -139,6 +142,7 @@ qreal QRotationReading::y() const
/*!
Sets the rotation around the y axis to \a y.
+ \since 1.0
*/
void QRotationReading::setY(qreal y)
{
@@ -151,6 +155,7 @@ void QRotationReading::setY(qreal y)
Measured as degrees.
\sa {QRotationReading Units}
+ \since 1.0
*/
qreal QRotationReading::z() const
@@ -160,6 +165,7 @@ qreal QRotationReading::z() const
/*!
Sets the rotation around the z axis to \a z.
+ \since 1.0
*/
void QRotationReading::setZ(qreal z)
{
@@ -177,6 +183,7 @@ void QRotationReading::setZ(qreal z)
The only difference is that the filter() method features a pointer to QRotationReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -185,6 +192,7 @@ void QRotationReading::setZ(qreal z)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QRotationSensor::type("QRotationSensor");
@@ -203,18 +211,21 @@ char const * const QRotationSensor::type("QRotationSensor");
For details about how the sensor works, see \l QRotationReading.
\sa QRotationReading
+ \since 1.0
*/
/*!
\fn QRotationSensor::QRotationSensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QRotationSensor::~QRotationSensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -223,6 +234,7 @@ char const * const QRotationSensor::type("QRotationSensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
/*!
@@ -231,6 +243,7 @@ char const * const QRotationSensor::type("QRotationSensor");
Returns true if z is available.
Returns false if z is not available.
+ \since 1.0
*/
#include "moc_qrotationsensor.cpp"
diff --git a/src/sensors/qsensor.cpp b/src/sensors/qsensor.cpp
index 3058b355af..c6219fe591 100644
--- a/src/sensors/qsensor.cpp
+++ b/src/sensors/qsensor.cpp
@@ -124,6 +124,7 @@ QTM_BEGIN_NAMESPACE
-2G to +2G (with an accuracy value of 0.015G) or -8G to +8G (with an accuracy value of 0.06G).
\sa qoutputrangelist, QSensor::outputRanges
+ \since 1.0
*/
/*!
@@ -188,10 +189,12 @@ static int qoutputrangelist_id = qRegisterMetaType<QtMobility::qoutputrangelist>
The sensor data is delivered via QSensorData and its sub-classes.
\sa QSensorReading
+ \since 1.0
*/
/*!
Construct the \a type sensor as a child of \a parent.
+ \since 1.0
*/
QSensor::QSensor(const QByteArray &type, QObject *parent)
: QObject(parent)
@@ -203,6 +206,7 @@ QSensor::QSensor(const QByteArray &type, QObject *parent)
/*!
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
QSensor::~QSensor()
{
@@ -227,6 +231,7 @@ QSensor::~QSensor()
immediately. This is automatically called if you call start() so you only need
to do this if you need access to sensor properties (ie. to poll the sensor's
meta-data before you use it).
+ \since 1.0
*/
bool QSensor::isConnectedToBackend() const
@@ -242,6 +247,7 @@ bool QSensor::isConnectedToBackend() const
when the sensor is connected to a backend. If you want
to connect a specific backend, you should call
setIdentifier() before connectToBackend().
+ \since 1.0
*/
QByteArray QSensor::identifier() const
@@ -261,6 +267,7 @@ void QSensor::setIdentifier(const QByteArray &identifier)
/*!
\property QSensor::type
\brief the type of the sensor.
+ \since 1.0
*/
QByteArray QSensor::type() const
@@ -276,6 +283,7 @@ QByteArray QSensor::type() const
The type must be set before calling this method if you are using QSensor directly.
\sa isConnectedToBackend()
+ \since 1.0
*/
bool QSensor::connectToBackend()
{
@@ -313,6 +321,7 @@ bool QSensor::connectToBackend()
the sensor.
\sa busyChanged()
+ \since 1.0
*/
bool QSensor::isBusy() const
@@ -332,6 +341,7 @@ bool QSensor::isBusy() const
// need to wait for busyChanged signal and try again
}
\endcode
+ \since 1.0
*/
/*!
@@ -342,6 +352,7 @@ bool QSensor::isBusy() const
Note that setting this value to true will not have an immediate effect. Instead,
the sensor will be started once the event loop has been reached.
+ \since 1.1
*/
void QSensor::setActive(bool active)
{
@@ -377,6 +388,7 @@ bool QSensor::isActive() const
they run. In such cases, the list will be empty.
\sa QSensor::dataRate, qrangelist
+ \since 1.0
*/
qrangelist QSensor::availableDataRates() const
@@ -408,6 +420,7 @@ qrangelist QSensor::availableDataRates() const
platform.
\sa QSensor::availableDataRates
+ \since 1.0
*/
int QSensor::dataRate() const
@@ -464,6 +477,7 @@ void QSensor::setDataRate(int rate)
\endcode
\sa QSensor::busy
+ \since 1.0
*/
bool QSensor::start()
{
@@ -486,6 +500,7 @@ bool QSensor::start()
This releases the sensor so that other processes can use it.
\sa QSensor::busy
+ \since 1.0
*/
void QSensor::stop()
{
@@ -511,6 +526,7 @@ void QSensor::stop()
Applications must wait for the readingChanged() signal to be emitted.
\sa isConnectedToBackend(), start()
+ \since 1.0
*/
QSensorReading *QSensor::reading() const
@@ -525,6 +541,7 @@ QSensorReading *QSensor::reading() const
QSensorFilter will inform the sensor if it is destroyed.
\sa QSensorFilter
+ \since 1.0
*/
void QSensor::addFilter(QSensorFilter *filter)
{
@@ -540,6 +557,7 @@ void QSensor::addFilter(QSensorFilter *filter)
Remove \a filter from the sensor.
\sa QSensorFilter
+ \since 1.0
*/
void QSensor::removeFilter(QSensorFilter *filter)
{
@@ -555,6 +573,7 @@ void QSensor::removeFilter(QSensorFilter *filter)
Returns the filters currently attached to the sensor.
\sa QSensorFilter
+ \since 1.2
*/
QList<QSensorFilter*> QSensor::filters() const
{
@@ -564,6 +583,7 @@ QList<QSensorFilter*> QSensor::filters() const
/*!
\fn QSensor::d_func() const
\internal
+ \since 1.0
*/
/*!
@@ -580,6 +600,7 @@ QList<QSensorFilter*> QSensor::filters() const
have uninitialized data.
\sa start()
+ \since 1.0
*/
/*!
@@ -588,6 +609,7 @@ QList<QSensorFilter*> QSensor::filters() const
This signal is emitted when the QSensor::active property has changed.
\sa QSensor::active
+ \since 1.1
*/
/*!
@@ -602,6 +624,7 @@ QList<QSensorFilter*> QSensor::filters() const
accelerometers).
\sa QSensor::outputRange, qoutputrangelist
+ \since 1.0
*/
qoutputrangelist QSensor::outputRanges() const
@@ -625,6 +648,7 @@ qoutputrangelist QSensor::outputRanges() const
platform.
\sa QSensor::outputRanges
+ \since 1.0
*/
int QSensor::outputRange() const
@@ -651,6 +675,7 @@ void QSensor::setOutputRange(int index)
/*!
\property QSensor::description
\brief a descriptive string for the sensor.
+ \since 1.0
*/
QString QSensor::description() const
@@ -663,6 +688,7 @@ QString QSensor::description() const
\brief the last error code set on the sensor.
Note that error codes are sensor-specific.
+ \since 1.0
*/
int QSensor::error() const
@@ -676,6 +702,7 @@ int QSensor::error() const
This signal is emitted when an \a error code is set on the sensor.
Note that some errors will cause the sensor to stop working.
You should call isActive() to determine if the sensor is still running.
+ \since 1.0
*/
/*!
@@ -689,6 +716,7 @@ int QSensor::error() const
unavailable when it was off.
\sa QSensor::sensorTypes(), QSensor::sensorsForType()
+ \since 1.2
*/
// =====================================================================
@@ -715,10 +743,12 @@ int QSensor::error() const
not be updated until after the filters have been run.
\sa filter()
+ \since 1.0
*/
/*!
\internal
+ \since 1.0
*/
QSensorFilter::QSensorFilter()
: m_sensor(0)
@@ -727,6 +757,7 @@ QSensorFilter::QSensorFilter()
/*!
Notifies the attached sensor (if any) that the filter is being destroyed.
+ \since 1.0
*/
QSensorFilter::~QSensorFilter()
{
@@ -746,10 +777,12 @@ QSensorFilter::~QSensorFilter()
to be emitted and the value is stored in the sensor.
Returns false to drop the reading.
+ \since 1.0
*/
/*!
\internal
+ \since 1.0
*/
void QSensorFilter::setSensor(QSensor *sensor)
{
@@ -767,10 +800,12 @@ void QSensorFilter::setSensor(QSensor *sensor)
Note that QSensorReading is not particularly useful by itself. The interesting
data for each sensor is defined in a sub-class of QSensorReading.
+ \since 1.0
*/
/*!
\internal
+ \since 1.0
*/
QSensorReading::QSensorReading(QObject *parent, QSensorReadingPrivate *_d)
: QObject(parent)
@@ -780,6 +815,7 @@ QSensorReading::QSensorReading(QObject *parent, QSensorReadingPrivate *_d)
/*!
\internal
+ \since 1.0
*/
QSensorReading::~QSensorReading()
{
@@ -790,10 +826,12 @@ QSensorReading::~QSensorReading()
\brief the timestamp of the reading.
\sa qtimestamp
+ \since 1.0
*/
/*!
Returns the timestamp of the reading.
+ \since 1.0
*/
qtimestamp QSensorReading::timestamp() const
{
@@ -802,6 +840,7 @@ qtimestamp QSensorReading::timestamp() const
/*!
Sets the \a timestamp of the reading.
+ \since 1.0
*/
void QSensorReading::setTimestamp(qtimestamp timestamp)
{
@@ -815,6 +854,7 @@ void QSensorReading::setTimestamp(qtimestamp timestamp)
As an example, this returns 3 for QAccelerometerReading because
there are 3 properties defined in that class.
+ \since 1.0
*/
int QSensorReading::valueCount() const
{
@@ -853,6 +893,7 @@ int QSensorReading::valueCount() const
of QSensorReading.
\sa valueCount(), QObject::property()
+ \since 1.0
*/
QVariant QSensorReading::value(int index) const
{
@@ -877,6 +918,7 @@ QVariant QSensorReading::value(int index) const
using the DECLARE_READING() and IMPLEMENT_READING() macros.
Note that this method should only be called by QSensorBackend.
+ \since 1.0
*/
void QSensorReading::copyValuesFrom(QSensorReading *other)
{
@@ -890,6 +932,7 @@ void QSensorReading::copyValuesFrom(QSensorReading *other)
\fn QSensorReading::d_ptr()
\internal
No longer used. Exists to keep the winscw build happy.
+ \since 1.0
*/
/*!
diff --git a/src/sensors/qsensorbackend.cpp b/src/sensors/qsensorbackend.cpp
index e59acd69bb..88b23d6314 100644
--- a/src/sensors/qsensorbackend.cpp
+++ b/src/sensors/qsensorbackend.cpp
@@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE
/*!
\internal
+ \since 1.0
*/
QSensorBackend::QSensorBackend(QSensor *sensor)
: m_sensor(sensor)
@@ -67,6 +68,7 @@ QSensorBackend::QSensorBackend(QSensor *sensor)
/*!
\internal
+ \since 1.0
*/
QSensorBackend::~QSensorBackend()
{
@@ -74,6 +76,7 @@ QSensorBackend::~QSensorBackend()
/*!
Notify the QSensor class that a new reading is available.
+ \since 1.0
*/
void QSensorBackend::newReadingAvailable()
{
@@ -98,12 +101,14 @@ void QSensorBackend::newReadingAvailable()
\fn QSensorBackend::start()
Start reporting values.
+ \since 1.0
*/
/*!
\fn QSensorBackend::stop()
Stop reporting values.
+ \since 1.0
*/
/*!
@@ -114,6 +119,7 @@ void QSensorBackend::newReadingAvailable()
type.
\sa setReading()
+ \since 1.0
*/
QSensorReading *QSensorBackend::reading() const
{
@@ -125,6 +131,7 @@ QSensorReading *QSensorBackend::reading() const
\fn QSensorBackend::sensor() const
Returns the sensor front end associated with this backend.
+ \since 1.0
*/
/*!
@@ -189,10 +196,12 @@ QSensorReading *QSensorBackend::reading() const
\endcode
\sa reading()
+ \since 1.0
*/
/*!
\internal
+ \since 1.0
*/
void QSensorBackend::setReadings(QSensorReading *device, QSensorReading *filter, QSensorReading *cache)
{
@@ -209,6 +218,7 @@ void QSensorBackend::setReadings(QSensorReading *device, QSensorReading *filter,
is available immediately.
\sa QSensor::availableDataRates
+ \since 1.0
*/
void QSensorBackend::addDataRate(qreal min, qreal max)
{
@@ -229,6 +239,7 @@ void QSensorBackend::addDataRate(qreal min, qreal max)
is available immediately.
\sa QSensor::availableDataRates, addDataRate()
+ \since 1.0
*/
void QSensorBackend::setDataRates(const QSensor *otherSensor)
{
@@ -252,6 +263,7 @@ void QSensorBackend::setDataRates(const QSensor *otherSensor)
is available immediately.
\sa QSensor::outputRange, QSensor::outputRanges
+ \since 1.0
*/
void QSensorBackend::addOutputRange(qreal min, qreal max, qreal accuracy)
{
@@ -267,6 +279,7 @@ void QSensorBackend::addOutputRange(qreal min, qreal max, qreal accuracy)
Note that this function should be called from the constructor so that the information
is available immediately.
+ \since 1.0
*/
void QSensorBackend::setDescription(const QString &description)
{
@@ -283,6 +296,7 @@ void QSensorBackend::setDescription(const QString &description)
the sensor has stopped. If the sensor has stopped due to an error
the sensorError() function should be called to notify the class
of the error condition.
+ \since 1.0
*/
void QSensorBackend::sensorStopped()
{
@@ -299,6 +313,7 @@ void QSensorBackend::sensorStopped()
the sensor is busy. If the sensor has stopped due to an error
the sensorError() function should be called to notify the class
of the error condition.
+ \since 1.0
*/
void QSensorBackend::sensorBusy()
{
@@ -313,6 +328,7 @@ void QSensorBackend::sensorBusy()
not stop the sensor.
\sa sensorStopped()
+ \since 1.0
*/
void QSensorBackend::sensorError(int error)
{
diff --git a/src/sensors/qsensormanager.cpp b/src/sensors/qsensormanager.cpp
index 9c6c1190e4..49ab382684 100644
--- a/src/sensors/qsensormanager.cpp
+++ b/src/sensors/qsensormanager.cpp
@@ -219,6 +219,7 @@ void QSensorManagerPrivate::loadPlugins()
Register a sensor for \a type. The \a identifier must be unique.
The \a factory will be asked to create instances of the backend.
+ \since 1.0
*/
void QSensorManager::registerBackend(const QByteArray &type, const QByteArray &identifier, QSensorBackendFactory *factory)
{
@@ -252,6 +253,7 @@ void QSensorManager::registerBackend(const QByteArray &type, const QByteArray &i
Note that this only prevents new instance of the backend from being created. It does not
invalidate the existing instances of the backend. The backend code should handle the
disappearance of the underlying hardware itself.
+ \since 1.2
*/
void QSensorManager::unregisterBackend(const QByteArray &type, const QByteArray &identifier)
{
@@ -294,6 +296,7 @@ void QSensorManager::unregisterBackend(const QByteArray &type, const QByteArray
/*!
\internal
+ \since 1.0
*/
void QSensorManager::registerStaticPlugin(CreatePluginFunc func)
{
@@ -303,6 +306,7 @@ void QSensorManager::registerStaticPlugin(CreatePluginFunc func)
/*!
Create a backend for \a sensor. Returns null if no suitable backend exists.
+ \since 1.0
*/
QSensorBackend *QSensorManager::createBackend(QSensor *sensor)
{
@@ -365,6 +369,7 @@ QSensorBackend *QSensorManager::createBackend(QSensor *sensor)
Returns true if the backend identified by \a type and \a identifier is registered.
This is a convenience method that helps out plugins doing dynamic registration.
+ \since 1.2
*/
bool QSensorManager::isBackendRegistered(const QByteArray &type, const QByteArray &identifier)
{
@@ -385,6 +390,7 @@ bool QSensorManager::isBackendRegistered(const QByteArray &type, const QByteArra
/*!
Returns a list of all sensor types.
+ \since 1.0
*/
QList<QByteArray> QSensor::sensorTypes()
{
@@ -397,6 +403,7 @@ QList<QByteArray> QSensor::sensorTypes()
/*!
Returns a list of ids for each of the sensors for \a type.
If there are no sensors of that type available the list will be empty.
+ \since 1.0
*/
QList<QByteArray> QSensor::sensorsForType(const QByteArray &type)
{
@@ -422,6 +429,7 @@ QList<QByteArray> QSensor::sensorsForType(const QByteArray &type)
registered for that type or if it is specified in \c{Sensors.conf}.
\sa {Determining the default sensor for a type}
+ \since 1.0
*/
QByteArray QSensor::defaultSensorForType(const QByteArray &type)
{
@@ -464,11 +472,13 @@ void QSensor::registerInstance()
This interface must be implemented in order to register a sensor backend.
\sa {Creating a sensor plugin}
+ \since 1.0
*/
/*!
\fn QSensorBackendFactory::~QSensorBackendFactory()
\internal
+ \since 1.0
*/
/*!
@@ -478,6 +488,7 @@ void QSensor::registerInstance()
it should check with the \a sensor to see which one is requested.
If the factory cannot create a backend it should return 0.
+ \since 1.0
*/
/*!
diff --git a/src/sensors/qsensorplugin.cpp b/src/sensors/qsensorplugin.cpp
index f6e78c5c30..26ff701db6 100644
--- a/src/sensors/qsensorplugin.cpp
+++ b/src/sensors/qsensorplugin.cpp
@@ -52,11 +52,13 @@
backends with QSensorManager.
\sa {Creating a sensor plugin}
+ \since 1.0
*/
/*!
\fn QSensorPluginInterface::~QSensorPluginInterface()
\internal
+ \since 1.0
*/
/*!
@@ -68,6 +70,7 @@
QSensorPluginInterface::sensorsChanged() method instead.
\sa {Creating a sensor plugin}
+ \since 1.0
*/
/*!
@@ -80,11 +83,13 @@
that registered sensor backends have changed.
\sa {Creating a sensor plugin}
+ \since 1.2
*/
/*!
\fn QSensorChangesInterface::~QSensorChangesInterface()
\internal
+ \since 1.2
*/
/*!
\fn QSensorChangesInterface::sensorsChanged()
@@ -94,5 +99,6 @@
registered or unregistered in here.
\sa {Creating a sensor plugin}
+ \since 1.2
*/
diff --git a/src/sensors/qtapsensor.cpp b/src/sensors/qtapsensor.cpp
index 8c37728579..02f7892a4d 100644
--- a/src/sensors/qtapsensor.cpp
+++ b/src/sensors/qtapsensor.cpp
@@ -115,6 +115,7 @@ IMPLEMENT_READING(QTapReading)
\brief the direction of the tap.
\sa {QTapReading Units}
+ \since 1.0
*/
QTapReading::TapDirection QTapReading::tapDirection() const
@@ -124,6 +125,7 @@ QTapReading::TapDirection QTapReading::tapDirection() const
/*!
Sets the tap direction to \a tapDirection.
+ \since 1.0
*/
void QTapReading::setTapDirection(QTapReading::TapDirection tapDirection)
{
@@ -154,6 +156,7 @@ void QTapReading::setTapDirection(QTapReading::TapDirection tapDirection)
\o false - single tap
\endlist
\sa {QTapReading Units}
+ \since 1.0
*/
bool QTapReading::isDoubleTap() const
@@ -163,6 +166,7 @@ bool QTapReading::isDoubleTap() const
/*!
Sets the double tap status of the reading to \a doubleTap.
+ \since 1.0
*/
void QTapReading::setDoubleTap(bool doubleTap)
{
@@ -180,6 +184,7 @@ void QTapReading::setDoubleTap(bool doubleTap)
The only difference is that the filter() method features a pointer to QTapReading
instead of QSensorReading.
+ \since 1.0
*/
/*!
@@ -188,6 +193,7 @@ void QTapReading::setDoubleTap(bool doubleTap)
Called when \a reading changes. Returns false to prevent the reading from propagating.
\sa QSensorFilter::filter()
+ \since 1.0
*/
char const * const QTapSensor::type("QTapSensor");
@@ -206,18 +212,21 @@ char const * const QTapSensor::type("QTapSensor");
For details about how the sensor works, see \l QTapReading.
\sa QTapReading
+ \since 1.0
*/
/*!
\fn QTapSensor::QTapSensor(QObject *parent)
Construct the sensor as a child of \a parent.
+ \since 1.0
*/
/*!
\fn QTapSensor::~QTapSensor()
Destroy the sensor. Stops the sensor if it has not already been stopped.
+ \since 1.0
*/
/*!
@@ -226,6 +235,7 @@ char const * const QTapSensor::type("QTapSensor");
Returns the reading class for this sensor.
\sa QSensor::reading()
+ \since 1.0
*/
/*!
@@ -240,6 +250,7 @@ char const * const QTapSensor::type("QTapSensor");
Note that you must access this property via QObject::property() and QObject::setProperty().
The property must be set before calling start().
+ \since 1.0
*/
#include "moc_qtapsensor.cpp"
diff --git a/src/serviceframework/qabstractsecuritysession.cpp b/src/serviceframework/qabstractsecuritysession.cpp
index e655ec44cb..8934b3cd84 100644
--- a/src/serviceframework/qabstractsecuritysession.cpp
+++ b/src/serviceframework/qabstractsecuritysession.cpp
@@ -99,6 +99,7 @@ QAbstractSecuritySession::~QAbstractSecuritySession()
Returns true if the security session has sufficient rights to access the required
service \a capabilities.
+ \since 1.0
*/
#include "moc_qabstractsecuritysession.cpp"
diff --git a/src/serviceframework/qremoteserviceregister.cpp b/src/serviceframework/qremoteserviceregister.cpp
index 19bdfad59e..985e211e0c 100644
--- a/src/serviceframework/qremoteserviceregister.cpp
+++ b/src/serviceframework/qremoteserviceregister.cpp
@@ -53,8 +53,8 @@ QTM_BEGIN_NAMESPACE
\brief The Entry class represents a remote service entry to be published on QRemoteServiceRegister.
This class is created using QRemoteServiceRegister::createEntry to supply remote service
- details matching a valid QServiceInterfaceDescriptor.
-
+ details matching a valid QServiceInterfaceDescriptor.
+
A registration entry can then be published for discovery by remote clients.
\since 1.1
@@ -62,6 +62,7 @@ QTM_BEGIN_NAMESPACE
/*!
Constructs a null registration entry.
+ \since 1.1
*/
QRemoteServiceRegister::Entry::Entry()
{
@@ -70,6 +71,7 @@ QRemoteServiceRegister::Entry::Entry()
/*!
Constructs the registration entry that is a copy of \a other.
+ \since 1.1
*/
QRemoteServiceRegister::Entry::Entry(const Entry& other)
: d(other.d)
@@ -78,6 +80,7 @@ QRemoteServiceRegister::Entry::Entry(const Entry& other)
/*!
Destroys the registration entry.
+ \since 1.1
*/
QRemoteServiceRegister::Entry::~Entry()
{
@@ -87,7 +90,8 @@ QRemoteServiceRegister::Entry::~Entry()
Checks if the registration entry is currently a valid remote service entry
Returns true if the serviceName(), interfaceName() and version() point to
- a valid QServiceInterfaceDescriptor, otherwise false.
+ a valid QServiceInterfaceDescriptor, otherwise false.
+ \since 1.1
*/
bool QRemoteServiceRegister::Entry::isValid() const
{
@@ -99,6 +103,7 @@ bool QRemoteServiceRegister::Entry::isValid() const
/*!
Returns true if this font is equal to \a other; otherwise false.
+ \since 1.1
*/
bool QRemoteServiceRegister::Entry::operator==(const Entry& other) const
{
@@ -109,6 +114,7 @@ bool QRemoteServiceRegister::Entry::operator==(const Entry& other) const
/*!
Returns true if this font is different from \a other; otherwise false.
+ \since 1.1
*/
bool QRemoteServiceRegister::Entry::operator!=(const Entry& other) const
{
@@ -117,6 +123,7 @@ bool QRemoteServiceRegister::Entry::operator!=(const Entry& other) const
/*!
Assigns \a other to this registration entry and returns a reference to it.
+ \since 1.1
*/
QRemoteServiceRegister::Entry &QRemoteServiceRegister::Entry::operator=(const Entry& other)
{
@@ -124,36 +131,39 @@ QRemoteServiceRegister::Entry &QRemoteServiceRegister::Entry::operator=(const En
return *this;
}
-/*!
+/*!
Returns the interface name of the registration entry.
This should correspond to the interface name from the service XML description.
\sa serviceName(), version()
+ \since 1.1
*/
QString QRemoteServiceRegister::Entry::interfaceName() const
{
return d->iface;
}
-/*!
+/*!
Returns the service name of the registration entry.
This should correspond to the service name from the service XML description.
\sa interfaceName(), version()
+ \since 1.1
*/
QString QRemoteServiceRegister::Entry::serviceName() const
{
return d->service;
}
-/*!
+/*!
Returns the version of the registration entry in format x.y.
This should correspond to the interface version from the service XML description.
\sa interfaceName(), serviceName()
+ \since 1.1
*/
QString QRemoteServiceRegister::Entry::version() const
{
@@ -168,16 +178,18 @@ const QMetaObject * QRemoteServiceRegister::Entry::metaObject() const
/*!
Sets the QRemoteServiceRegister::InstanceType of the registration entry.
- If this is not explicitly called, the default instance \a type for the registration entry
+ If this is not explicitly called, the default instance \a type for the registration entry
is QRemoteServiceRegister::PrivateInstance.
+ \since 1.1
*/
void QRemoteServiceRegister::Entry::setInstantiationType(QRemoteServiceRegister::InstanceType type)
{
d->instanceType = type;
}
-/*!
+/*!
Returns the QRemoteServiceRegister::InstanceType of the registration entry.
+ \since 1.1
*/
QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiationType() const
{
@@ -189,6 +201,7 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
\inmodule QtServiceFramework
\ingroup servicefw
\brief The QRemoteServiceRegister class manages instances of remote service objects.
+ \since 1.1
This class registers and publishes IPC based service objects. It owns the service's
objects and uess the platform specific IPC mechanism to publish the service.
@@ -197,8 +210,8 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
QRemoteServiceRegister::Entry must be registered with the same information in
the XML description, otherwise no corresponding QServiceInterfaceDescriptor can be
found.
-
- The following XML descriptor is used for subsequent examples.
+
+ The following XML descriptor is used for subsequent examples.
\code
<SFW version="1.1">
@@ -216,8 +229,8 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
</SFW>
\endcode
- The snippet belows demonstrates how an application can register the class \a MyClass
- as a remote service, which is published and accessible to clients who wish to load
+ The snippet belows demonstrates how an application can register the class \a MyClass
+ as a remote service, which is published and accessible to clients who wish to load
service object instances.
\code
@@ -230,7 +243,7 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
QRemoteServiceRegister::Entry myService;
myService = serviceRegister->createEntry<MyClass>(
"MyService", "com.nokia.qt.example.myservice", "1.0");
-
+
serviceRegister->publishEntries("my_service");
return app.exec();
@@ -238,7 +251,7 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
}
\endcode
- By default all entries are created as \l QRemoteServiceRegister::GlobalInstance
+ By default all entries are created as \l QRemoteServiceRegister::GlobalInstance
types. This can be changed by calling QRemoteServiceRegister::Entry::setInstantiationType()
on the entry. Once the service register has been published the associated service entries
can no longer be changed.
@@ -258,11 +271,12 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
This signal is emitted whenever a created instance has been closed. This indicates
that a connected client has either shutdown or released the loaded service object.
-
- \a entry is supplied to identify which registered service
+
+ \a entry is supplied to identify which registered service
entry the closed instance belonged to.
\sa allInstancesClosed()
+ \since 1.1
*/
/*!
@@ -270,17 +284,18 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
This signal is emitted whenever all service instances have been closed. This indicates
that the last connected client has either shutdown or released the loaded service object.
-
+
\sa instanceClosed()
+ \since 1.1
*/
-/*!
+/*!
\typedef QRemoteServiceRegister::CreateServiceFunc
\internal
Denotes a function pointer returning a service instance
*/
-/*!
+/*!
\typedef QRemoteServiceRegister::SecurityFilter
\internal
Denotes a function pointer used for the security filter feature
@@ -288,6 +303,7 @@ QRemoteServiceRegister::InstanceType QRemoteServiceRegister::Entry::instantiatio
/*!
Creates a service register instance with the given \a parent.
+ \since 1.1
*/
QRemoteServiceRegister::QRemoteServiceRegister(QObject* parent)
: QObject(parent)
@@ -308,15 +324,16 @@ QRemoteServiceRegister::~QRemoteServiceRegister()
}
/*!
- Publishes every service QRemoteServiceRegister::Entry that has been created using
- \l createEntry(). The \a ident is the service specific IPC address under which
- the service can be reached.
-
- This address must match the address provided in the services XML descriptor, otherwise
- the service will not be discoverable. In some cases this may also cause the IPC
+ Publishes every service QRemoteServiceRegister::Entry that has been created using
+ \l createEntry(). The \a ident is the service specific IPC address under which
+ the service can be reached.
+
+ This address must match the address provided in the services XML descriptor, otherwise
+ the service will not be discoverable. In some cases this may also cause the IPC
rendezvous feature to fail.
\sa createEntry()
+ \since 1.1
*/
void QRemoteServiceRegister::publishEntries(const QString& ident)
{
@@ -327,6 +344,7 @@ void QRemoteServiceRegister::publishEntries(const QString& ident)
\property QRemoteServiceRegister::quitOnLastInstanceClosed
\brief Terminate the service when all clients have closed all objects. Default value is true.
+ \since 1.1
*/
bool QRemoteServiceRegister::quitOnLastInstanceClosed() const
{
@@ -338,20 +356,20 @@ void QRemoteServiceRegister::setQuitOnLastInstanceClosed(bool quit)
d->setQuitOnLastInstanceClosed(quit);
}
-/*!
- Allows a security filter to be set which can access
+/*!
+ Allows a security filter to be set which can access
QRemoteServiceRegister::QRemoteServiceRegisterCredentials.
-
+
The \a filter is a function pointer where the function code implements possible
permission checks and returns true or false. If a connecting client fails the security
- filter it will be denied access and unable to obtain a valid service instance.
-
+ filter it will be denied access and unable to obtain a valid service instance.
+
The following snippet is an example of how to use the security filter feature.
-
+
\code
bool myFunction(const void *p)
{
- const QRemoteServiceRegisterCredentials *cred =
+ const QRemoteServiceRegisterCredentials *cred =
(const struct QRemoteServiceRegisterCredentials *)p;
// allow the superuser
@@ -360,7 +378,7 @@ void QRemoteServiceRegister::setQuitOnLastInstanceClosed(bool quit)
return false;
}
-
+
int main(int argc, char** argv)
{
...
@@ -372,6 +390,7 @@ void QRemoteServiceRegister::setQuitOnLastInstanceClosed(bool quit)
}
\endcode
+ \since 1.1
*/
QRemoteServiceRegister::SecurityFilter QRemoteServiceRegister::setSecurityFilter(QRemoteServiceRegister::SecurityFilter filter)
{
@@ -381,11 +400,12 @@ QRemoteServiceRegister::SecurityFilter QRemoteServiceRegister::setSecurityFilter
/*!
\fn QRemoteServiceRegister::createEntry(const QString& serviceName, const QString& interfaceName, const QString& version)
- Creates an entry on our remote instance manager. The \a serviceName, \a interfaceName and
- \a version must match the service XML descriptor in order for the remote service to be
+ Creates an entry on our remote instance manager. The \a serviceName, \a interfaceName and
+ \a version must match the service XML descriptor in order for the remote service to be
discoverable.
\sa publishEntries()
+ \since 1.1
*/
QRemoteServiceRegister::Entry QRemoteServiceRegister::createEntry(const QString& serviceName, const QString& interfaceName, const QString& version, QRemoteServiceRegister::CreateServiceFunc cptr, const QMetaObject* meta)
{
diff --git a/src/serviceframework/qservicecontext.cpp b/src/serviceframework/qservicecontext.cpp
index dc941c0aa2..dba656aa7e 100644
--- a/src/serviceframework/qservicecontext.cpp
+++ b/src/serviceframework/qservicecontext.cpp
@@ -90,11 +90,12 @@ public:
Services may call this function to notify the service client about service related
context information of the given \a type. The contextual information is stored in \a data.
+ \since 1.0
*/
/*!
- Constrcuts a service context with the given \a parent.
+ Constructs a service context with the given \a parent.
*/
QServiceContext::QServiceContext(QObject* parent)
: QObject(parent)
@@ -122,6 +123,7 @@ QServiceContext::~QServiceContext()
By default, this value is empty but you can change this by calling
setClientId().
+ \since 1.0
*/
QString QServiceContext::clientId() const
{
@@ -130,6 +132,7 @@ QString QServiceContext::clientId() const
/*!
Sets the \a id of the client using the service.
+ \since 1.0
*/
void QServiceContext::setClientId(const QString& id)
{
@@ -142,6 +145,7 @@ void QServiceContext::setClientId(const QString& id)
By default, this value is empty but you can change this by calling
setClientName(). This string is translated and can be shown to the user.
+ \since 1.0
*/
QString QServiceContext::clientName() const
{
@@ -157,6 +161,7 @@ void QServiceContext::setClientName(const QString& name)
Returns the client data associated to \a key.
\sa setClientData(), resetClientData()
+ \since 1.1
*/
QVariant QServiceContext::clientData(const QString& key) const
{
@@ -174,6 +179,7 @@ QVariant QServiceContext::clientData(const QString& key) const
can be retrieved via \a key.
\sa clientData(), resetClientData()
+ \since 1.1
*/
void QServiceContext::setClientData(const QString& key, const QVariant& value)
{
@@ -188,6 +194,7 @@ void QServiceContext::setClientData(const QString& key, const QVariant& value)
Deletes all client data associated to the service context.
\sa clientData(), setClientData()
+ \since 1.1
*/
void QServiceContext::resetClientData()
{
diff --git a/src/serviceframework/qservicefilter.cpp b/src/serviceframework/qservicefilter.cpp
index 770b76dcee..2e7f44d206 100644
--- a/src/serviceframework/qservicefilter.cpp
+++ b/src/serviceframework/qservicefilter.cpp
@@ -164,6 +164,7 @@ QServiceFilter::QServiceFilter(const QServiceFilter& other)
Creates a new filter object that matches all service
implementations implementing \a interfaceName that match the specified
\a version using the given \a rule.
+ \since 1.0
*/
QServiceFilter::QServiceFilter(const QString& interfaceName, const QString& version, QServiceFilter::VersionMatchRule rule)
{
@@ -188,6 +189,7 @@ QServiceFilter::~QServiceFilter()
Copies the content of the QServiceFilter object contained in
\a other into this one.
+ \since 1.0
*/
QServiceFilter& QServiceFilter::operator=(const QServiceFilter& other)
{
@@ -210,6 +212,7 @@ QServiceFilter& QServiceFilter::operator=(const QServiceFilter& other)
specified by \a serviceName.
If the \a serviceName is empty the filter matches any service.
+ \since 1.0
*/
void QServiceFilter::setServiceName(const QString& serviceName)
{
@@ -229,6 +232,7 @@ void QServiceFilter::setServiceName(const QString& serviceName)
A valid version string has the format x.y whereby x and y are positive integer
numbers.
+ \since 1.0
*/
void QServiceFilter::setInterface(const QString &interfaceName, const QString& version, QServiceFilter::VersionMatchRule rule)
{
@@ -287,6 +291,7 @@ void QServiceFilter::setInterface(const QString &interfaceName, const QString& v
Returns the service name for this filter.
\sa setServiceName()
+ \since 1.0
*/
QString QServiceFilter::serviceName() const
{
@@ -299,6 +304,7 @@ QString QServiceFilter::serviceName() const
Returns the interface name for this filter.
\sa setInterface()
+ \since 1.0
*/
QString QServiceFilter::interfaceName() const
{
@@ -311,6 +317,7 @@ QString QServiceFilter::interfaceName() const
Returns the major interface version for this filter.
\sa setInterface()
+ \since 1.0
*/
int QServiceFilter::majorVersion() const
{
@@ -323,6 +330,7 @@ int QServiceFilter::majorVersion() const
Returns the minor interface version for this filter.
\sa setInterface()
+ \since 1.0
*/
int QServiceFilter::minorVersion() const
{
@@ -337,6 +345,7 @@ int QServiceFilter::minorVersion() const
\i{<customproperty>} tag within the service xml.
\sa customAttribute(), clearCustomAttribute()
+ \since 1.0
*/
void QServiceFilter::setCustomAttribute(const QString& key, const QString& value)
{
@@ -350,6 +359,7 @@ void QServiceFilter::setCustomAttribute(const QString& key, const QString& value
returns a null string.
\sa setCustomAttribute(), clearCustomAttribute()
+ \since 1.0
*/
QString QServiceFilter::customAttribute(const QString& key) const
{
@@ -363,6 +373,7 @@ QString QServiceFilter::customAttribute(const QString& key) const
If \a key is empty all custom attributes are cleared.
\sa setCustomAttribute()
+ \since 1.0
*/
void QServiceFilter::clearCustomAttribute(const QString &key)
{
@@ -378,6 +389,7 @@ void QServiceFilter::clearCustomAttribute(const QString &key)
Returns the version match rule for this filter.
\sa setInterface()
+ \since 1.0
*/
QServiceFilter::VersionMatchRule QServiceFilter::versionMatchRule() const
{
@@ -388,6 +400,7 @@ QServiceFilter::VersionMatchRule QServiceFilter::versionMatchRule() const
\fn QList<QString> QServiceFilter::customAttributes() const
Returns the list of custom keys which have been added to the filter.
+ \since 1.0
*/
QStringList QServiceFilter::customAttributes() const
{
@@ -402,6 +415,7 @@ QStringList QServiceFilter::customAttributes() const
to the given \a rule.
\sa capabilities(), QAbstractSecuritySession
+ \since 1.0
*/
void QServiceFilter::setCapabilities(QServiceFilter::CapabilityMatchRule rule, const QStringList& capabilities )
{
@@ -419,6 +433,7 @@ void QServiceFilter::setCapabilities(QServiceFilter::CapabilityMatchRule rule, c
for which they have the required capabilties.
\sa setCapabilities(), capabilityMatchRule(), QAbstractSecuritySession
+ \since 1.0
*/
QStringList QServiceFilter::capabilities() const
{
@@ -429,6 +444,7 @@ QStringList QServiceFilter::capabilities() const
Returns the capability matching rule for this filter.
\sa setCapabilities(), capabilities()
+ \since 1.0
*/
QServiceFilter::CapabilityMatchRule QServiceFilter::capabilityMatchRule() const
{
@@ -442,6 +458,7 @@ QServiceFilter::CapabilityMatchRule QServiceFilter::capabilityMatchRule() const
Writes service filter \a sf to the stream \a out and returns a reference
to the stream.
+ \since 1.0
*/
QDataStream &operator<<(QDataStream &out, const QServiceFilter &sf)
@@ -474,6 +491,7 @@ QDataStream &operator<<(QDataStream &out, const QServiceFilter &sf)
Reads a service filter into \a sf from the stream \a in and returns a
reference to the stream.
+ \since 1.0
*/
QDataStream &operator>>(QDataStream &in, QServiceFilter &sf)
{
diff --git a/src/serviceframework/qserviceinterfacedescriptor.cpp b/src/serviceframework/qserviceinterfacedescriptor.cpp
index 617b70486d..538d7e540d 100644
--- a/src/serviceframework/qserviceinterfacedescriptor.cpp
+++ b/src/serviceframework/qserviceinterfacedescriptor.cpp
@@ -129,6 +129,7 @@ QServiceInterfaceDescriptor::~QServiceInterfaceDescriptor()
/*!
Creates a copy of QServiceInterfaceDescriptor contained in \a other.
+ \since 1.0
*/
QServiceInterfaceDescriptor::QServiceInterfaceDescriptor(const QServiceInterfaceDescriptor& other)
: d(0)
@@ -141,6 +142,7 @@ QServiceInterfaceDescriptor::QServiceInterfaceDescriptor(const QServiceInterface
Copies the content of the QServiceInterfaceDescriptor object contained
in \a other into this one.
+ \since 1.0
*/
QServiceInterfaceDescriptor& QServiceInterfaceDescriptor::operator=(const QServiceInterfaceDescriptor& other)
{
@@ -163,6 +165,7 @@ QServiceInterfaceDescriptor& QServiceInterfaceDescriptor::operator=(const QServi
Compares a QServiceInterfaceDescriptor to \a other. Returns true if they
are equal and false otherwise.
+ \since 1.0
*/
bool QServiceInterfaceDescriptor::operator==(const QServiceInterfaceDescriptor& other) const
{
@@ -182,12 +185,14 @@ bool QServiceInterfaceDescriptor::operator==(const QServiceInterfaceDescriptor&
Compares a QServiceInterfaceDescriptor to \a other. Returns true
if they are not equal and false otherwise.
+ \since 1.0
*/
/*!
\fn bool QServiceInterfaceDescriptor::isValid() const
Returns true if this descriptor is valid; otherwise returns false.
+ \since 1.0
*/
bool QServiceInterfaceDescriptor::isValid() const
{
@@ -200,6 +205,7 @@ bool QServiceInterfaceDescriptor::isValid() const
Returns true if this implementation is provided for all users on the system.
\sa QService::Scope
+ \since 1.0
*/
QService::Scope QServiceInterfaceDescriptor::scope() const
{
@@ -210,6 +216,7 @@ QService::Scope QServiceInterfaceDescriptor::scope() const
\fn QString QServiceInterfaceDescriptor::serviceName() const
Returns the name of service that provides this implementation.
+ \since 1.0
*/
QString QServiceInterfaceDescriptor::serviceName() const
{
@@ -220,6 +227,7 @@ QString QServiceInterfaceDescriptor::serviceName() const
\fn QString QServiceInterfaceDescriptor::interfaceName() const
Returns the name of the interface that is implemented.
+ \since 1.0
*/
QString QServiceInterfaceDescriptor::interfaceName() const
{
@@ -234,6 +242,7 @@ QString QServiceInterfaceDescriptor::interfaceName() const
Subsequent versions of an interface are binary compatible
to previous versions of the same interface. If an interface
is broken it must use a new interface name.
+ \since 1.0
*/
int QServiceInterfaceDescriptor::majorVersion() const
{
@@ -244,6 +253,7 @@ int QServiceInterfaceDescriptor::majorVersion() const
\fn int QServiceInterfaceDescriptor::minorVersion() const
Returns the version of the implementation.
+ \since 1.0
*/
int QServiceInterfaceDescriptor::minorVersion() const
{
@@ -255,6 +265,7 @@ int QServiceInterfaceDescriptor::minorVersion() const
Returns the value for the attribute \a which; otherwise returns
an invalid QVariant.
+ \since 1.0
*/
QVariant QServiceInterfaceDescriptor::attribute(QServiceInterfaceDescriptor::Attribute which) const
{
@@ -268,6 +279,7 @@ QVariant QServiceInterfaceDescriptor::attribute(QServiceInterfaceDescriptor::Att
Returns the value for the custom attribute \a which; otherwise
returns a null string.
+ \since 1.0
*/
QString QServiceInterfaceDescriptor::customAttribute(const QString& which) const
{
@@ -278,6 +290,7 @@ QString QServiceInterfaceDescriptor::customAttribute(const QString& which) const
/*!
Returns a list of custom attributes attached to the service.
+ \since 1.0
*/
QStringList QServiceInterfaceDescriptor::customAttributes() const
{
@@ -325,6 +338,7 @@ QDataStream &operator>>(QDataStream &in, QServiceInterfaceDescriptor::Attribute
Writes service interface descriptor \a dc to the stream \a out and returns a reference
to the stream.
+ \since 1.0
*/
QDataStream &operator<<(QDataStream &out, const QServiceInterfaceDescriptor &dc)
@@ -353,6 +367,7 @@ QDataStream &operator<<(QDataStream &out, const QServiceInterfaceDescriptor &dc)
Reads a service interface descriptor into \a dc from the stream \a in and returns a
reference to the stream.
+ \since 1.0
*/
QDataStream &operator>>(QDataStream &in, QServiceInterfaceDescriptor &dc)
{
diff --git a/src/serviceframework/qservicemanager.cpp b/src/serviceframework/qservicemanager.cpp
index 584e488cf8..af994a46ba 100644
--- a/src/serviceframework/qservicemanager.cpp
+++ b/src/serviceframework/qservicemanager.cpp
@@ -252,6 +252,7 @@ private slots:
notifications about services added in the user scope.
\sa addService()
+ \since 1.0
*/
/*!
@@ -265,6 +266,7 @@ private slots:
notifications about services removed in the user scope.
\sa removeService()
+ \since 1.0
*/
/*!
@@ -282,6 +284,7 @@ QServiceManager::QServiceManager(QObject *parent)
/*!
Creates a service manager with the given \a scope and \a parent.
+ \since 1.0
*/
QServiceManager::QServiceManager(QService::Scope scope, QObject *parent)
: QObject(parent),
@@ -300,6 +303,7 @@ QServiceManager::~QServiceManager()
/*!
Returns the scope used for registering and searching of services.
+ \since 1.0
*/
QService::Scope QServiceManager::scope() const
{
@@ -310,6 +314,7 @@ QService::Scope QServiceManager::scope() const
Returns a list of the services that provide the interface specified by
\a interfaceName. If \a interfaceName is empty, this function returns
a list of all available services in this manager's scope.
+ \since 1.0
*/
QStringList QServiceManager::findServices(const QString& interfaceName) const
{
@@ -323,6 +328,7 @@ QStringList QServiceManager::findServices(const QString& interfaceName) const
/*!
Returns a list of the interfaces that match the specified \a filter.
+ \since 1.0
*/
QList<QServiceInterfaceDescriptor> QServiceManager::findInterfaces(const QServiceFilter& filter) const
{
@@ -340,6 +346,7 @@ QList<QServiceInterfaceDescriptor> QServiceManager::findInterfaces(const QServic
Returns a list of the interfaces provided by the service named
\a serviceName. If \a serviceName is empty, this function returns
a list of all available interfaces in this manager's scope.
+ \since 1.0
*/
QList<QServiceInterfaceDescriptor> QServiceManager::findInterfaces(const QString& serviceName) const
{
@@ -365,6 +372,7 @@ QList<QServiceInterfaceDescriptor> QServiceManager::findInterfaces(const QString
are enforced during service loading.
\sa setInterfaceDefault(), interfaceDefault()
+ \since 1.0
*/
QObject* QServiceManager::loadInterface(const QString& interfaceName, QServiceContext* context, QAbstractSecuritySession* session)
{
@@ -384,6 +392,7 @@ QObject* QServiceManager::loadInterface(const QString& interfaceName, QServiceCo
the service manager will not perform any checks. Therefore it is assumed that
the service manager client is trusted as it controls whether service capabilities
are enforced during service loading.
+ \since 1.0
*/
QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descriptor, QServiceContext* context, QAbstractSecuritySession* session)
{
@@ -495,6 +504,7 @@ QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descr
are enforced during service loading.
\sa setInterfaceDefault(), interfaceDefault()
+ \since 1.0
*/
@@ -518,6 +528,7 @@ QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descr
the service manager will not perform any checks. Therefore it is assumed that
the service manager client is trusted as it controls whether service capabilities
are enforced during service loading.
+ \since 1.0
*/
/*!
@@ -533,6 +544,7 @@ QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descr
versions that the new plugin implements.
\sa removeService(), setInterfaceDefault()
+ \since 1.0
*/
bool QServiceManager::addService(const QString& xmlFilePath)
{
@@ -564,6 +576,7 @@ bool QServiceManager::addService(const QString& xmlFilePath)
service manager instance.
\sa removeService(), setInterfaceDefault()
+ \since 1.0
*/
bool QServiceManager::addService(QIODevice *device)
{
@@ -621,6 +634,7 @@ bool QServiceManager::addService(QIODevice *device)
service manager instance.
\sa addService()
+ \since 1.0
*/
bool QServiceManager::removeService(const QString& serviceName)
{
@@ -675,6 +689,7 @@ bool QServiceManager::removeService(const QString& serviceName)
\bold {Note:} When in system scope, the \a service must be a system-wide
service rather than a user-specific service; otherwise, this will fail.
+ \since 1.0
*/
bool QServiceManager::setInterfaceDefault(const QString &service, const QString &interfaceName)
{
@@ -704,6 +719,7 @@ bool QServiceManager::setInterfaceDefault(const QString &service, const QString
\bold {Note:} When in system scope, the \a descriptor must refer to a
system-wide service rather than a user-specific service; otherwise, this
will fail.
+ \since 1.0
*/
bool QServiceManager::setInterfaceDefault(const QServiceInterfaceDescriptor& descriptor)
{
@@ -719,6 +735,7 @@ bool QServiceManager::setInterfaceDefault(const QServiceInterfaceDescriptor& des
/*!
Returns the default interface implementation for the given \a interfaceName.
+ \since 1.0
*/
QServiceInterfaceDescriptor QServiceManager::interfaceDefault(const QString& interfaceName) const
{
@@ -735,6 +752,7 @@ QServiceInterfaceDescriptor QServiceManager::interfaceDefault(const QString& int
/*!
Returns the type of error that last occurred.
+ \since 1.0
*/
QServiceManager::Error QServiceManager::error() const
{
@@ -743,6 +761,7 @@ QServiceManager::Error QServiceManager::error() const
/*!
\internal
+ \since 1.0
*/
void QServiceManager::connectNotify(const char *signal)
{
@@ -756,6 +775,7 @@ void QServiceManager::connectNotify(const char *signal)
/*!
\internal
+ \since 1.0
*/
void QServiceManager::disconnectNotify(const char *signal)
{
diff --git a/src/serviceframework/qserviceplugininterface.cpp b/src/serviceframework/qserviceplugininterface.cpp
index b5a3826db2..7673f6e447 100644
--- a/src/serviceframework/qserviceplugininterface.cpp
+++ b/src/serviceframework/qserviceplugininterface.cpp
@@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE
/*!
\internal
+ \since 1.0
*/
QServicePluginInterface::QServicePluginInterface()
{
@@ -60,6 +61,7 @@ QServicePluginInterface::QServicePluginInterface()
/*!
\internal
+ \since 1.0
*/
QServicePluginInterface::~QServicePluginInterface()
{
@@ -75,6 +77,7 @@ QServicePluginInterface::~QServicePluginInterface()
This function returns a null pointer if the plug-in doesn't
support the given \a descriptor.
+ \since 1.0
*/
/*!
@@ -87,6 +90,7 @@ QServicePluginInterface::~QServicePluginInterface()
The default implementation for this function does nothing.
\sa QServiceManager::addService()
+ \since 1.0
*/
void QServicePluginInterface::installService()
{
@@ -102,6 +106,7 @@ void QServicePluginInterface::installService()
The default implementation for this function does nothing.
\sa QServiceManager::removeService()
+ \since 1.0
*/
void QServicePluginInterface::uninstallService()