diff options
| author | Peter Yard <peter.yard@nokia.com> | 2011-04-15 16:22:50 +1000 |
|---|---|---|
| committer | Peter Yard <peter.yard@nokia.com> | 2011-04-15 16:22:50 +1000 |
| commit | 5107308dc3224db69770e554c1b470c35cc92cdf (patch) | |
| tree | 1f1b6d77cf82b28d7f535b560792caf081640ae3 | |
| parent | 906c2d9a2f38058693d7a39b234a044724b1d1fc (diff) | |
Docs: QTMOBILITY-790 added since tag for 1.1 Classes.
107 files changed, 704 insertions, 595 deletions
diff --git a/src/feedback/qfeedbackactuator.cpp b/src/feedback/qfeedbackactuator.cpp index ed8eda59f9..edbfd9477f 100644 --- a/src/feedback/qfeedbackactuator.cpp +++ b/src/feedback/qfeedbackactuator.cpp @@ -50,6 +50,7 @@ QTM_BEGIN_NAMESPACE \class QFeedbackActuator \brief The QFeedbackActuator class describes actuators for tactile feedback. \inmodule QtFeedback + \since 1.1 An actuator knows how to play a \l{QFeedbackEffect}{tactile effect}. The class gives access to a specified actuator. diff --git a/src/feedback/qfeedbackeffect.cpp b/src/feedback/qfeedbackeffect.cpp index add90fb9da..f5e4213823 100644 --- a/src/feedback/qfeedbackeffect.cpp +++ b/src/feedback/qfeedbackeffect.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE \brief The QFeedbackEffect class is the abstract base class for feedback effects. \ingroup feedback \inmodule QtFeedback + \since 1.1 It represents an effect to provide feedback to a person (i.e., an effect that affect human senses). The technology available today usually only diff --git a/src/feedback/qfeedbackplugin.cpp b/src/feedback/qfeedbackplugin.cpp index 74c11a885c..e87ea88830 100644 --- a/src/feedback/qfeedbackplugin.cpp +++ b/src/feedback/qfeedbackplugin.cpp @@ -57,6 +57,7 @@ QTM_BEGIN_NAMESPACE \class QFeedbackInterface \ingroup feedback \inmodule QtFeedback + \since 1.1 \brief The QFeedbackInterface class is the base class for plugins providing feedback. @@ -76,14 +77,14 @@ QTM_BEGIN_NAMESPACE This enum describes the priority that the plugin should have in case more than one of the same type (Haptics or Theme) is found. If more than one plugin has the same priority, the first one that has been loaded will be used. However, multiple file effect plugins can be loaded at the same time. - + \value PluginLowPriority The plugin will have a low priority. This is usually the case for platform specific-APIs. - \value PluginNormalPriority The plugin will have a normal priority. + \value PluginNormalPriority The plugin will have a normal priority. This is usually the case for advanced technologies. - \value PluginHighPriority The plugin will have higher priority. Use this priority if you + \value PluginHighPriority The plugin will have higher priority. Use this priority if you want your own plugin to be used. */ @@ -162,7 +163,7 @@ public: //start loading tryBackendLoad(effect); } else { - //unload + //unload if (QFeedbackFileInterface *subBackend = getBackend(effect)) subBackend->setLoaded(effect, load); QFeedbackFileEffectPrivate::get(effect)->loadFinished(false); // make sure it's marked unloaded [XXX this isn't allowed to fail!] @@ -220,7 +221,7 @@ public: } private: - QList<QFeedbackFileInterface*> subBackends; + QList<QFeedbackFileInterface*> subBackends; QFeedbackFileInterface *getBackend(const QFeedbackFileEffect *effect) { diff --git a/src/gallery/qabstractgallery.cpp b/src/gallery/qabstractgallery.cpp index 1e5dd6c0c4..2113cfe1fa 100644 --- a/src/gallery/qabstractgallery.cpp +++ b/src/gallery/qabstractgallery.cpp @@ -49,6 +49,7 @@ QTM_BEGIN_NAMESPACE \ingroup gallery \ingroup gallery-galleries + \since 1.1 \inmodule QtGallery diff --git a/src/gallery/qdocumentgallery.cpp b/src/gallery/qdocumentgallery.cpp index 7ee956ea37..cb426a102e 100644 --- a/src/gallery/qdocumentgallery.cpp +++ b/src/gallery/qdocumentgallery.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \ingroup gallery \ingroup gallery-galleries + \since 1.1 \inmodule QtGallery diff --git a/src/gallery/qgalleryabstractrequest.cpp b/src/gallery/qgalleryabstractrequest.cpp index 56388720b7..9aa15a6cbc 100644 --- a/src/gallery/qgalleryabstractrequest.cpp +++ b/src/gallery/qgalleryabstractrequest.cpp @@ -122,6 +122,7 @@ void QGalleryAbstractRequestPrivate::_q_progressChanged(int current, int maximum \ingroup gallery \ingroup gallery-requests + \since 1.1 \inmodule QtGallery diff --git a/src/gallery/qgalleryabstractresponse.cpp b/src/gallery/qgalleryabstractresponse.cpp index 66af6180a2..af75aef871 100644 --- a/src/gallery/qgalleryabstractresponse.cpp +++ b/src/gallery/qgalleryabstractresponse.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \ingroup gallery \inmodule QtGallery + \since 1.1 \brief The QGalleryAbstractResponse class provides a base class for responses to gallery requests. diff --git a/src/gallery/qgalleryfilter.cpp b/src/gallery/qgalleryfilter.cpp index 1bfd238dff..cc5d1fcb64 100644 --- a/src/gallery/qgalleryfilter.cpp +++ b/src/gallery/qgalleryfilter.cpp @@ -219,6 +219,7 @@ public: \ingroup gallery \ingroup gallery-filters + \since 1.1 \inmodule QtGallery @@ -510,6 +511,7 @@ QGalleryIntersectionFilter operator &&( \ingroup gallery \ingroup gallery-filters + \since 1.1 \inmodule QtGallery @@ -795,6 +797,7 @@ QGalleryUnionFilter operator ||( \ingroup gallery-filters \inmodule QtGallery + \since 1.1 \brief The QGalleryMetaDataFilter class provides a filter which accepts items with meta-data properties matching a specific value. diff --git a/src/gallery/qgalleryitemrequest.cpp b/src/gallery/qgalleryitemrequest.cpp index 1dad0135c3..9dc48212b1 100644 --- a/src/gallery/qgalleryitemrequest.cpp +++ b/src/gallery/qgalleryitemrequest.cpp @@ -108,6 +108,7 @@ public: \ingroup gallery-requests \inmodule QtGallery + \since 1.1 \brief The QGalleryItemRequest class provides a request for the properties of a single item from a gallery. diff --git a/src/gallery/qgalleryquerymodel.cpp b/src/gallery/qgalleryquerymodel.cpp index 93a4d2d244..5dd0788428 100644 --- a/src/gallery/qgalleryquerymodel.cpp +++ b/src/gallery/qgalleryquerymodel.cpp @@ -281,6 +281,7 @@ void QGalleryQueryModelPrivate::_q_metaDataChanged(int index, int count, const Q \ingroup gallery \inmodule QtGallery + \since 1.1 \brief The QGalleryQueryModel class provides a model for the results of a gallery query. diff --git a/src/gallery/qgalleryqueryrequest.cpp b/src/gallery/qgalleryqueryrequest.cpp index 9e0535332f..c4701a3376 100644 --- a/src/gallery/qgalleryqueryrequest.cpp +++ b/src/gallery/qgalleryqueryrequest.cpp @@ -83,6 +83,7 @@ public: \ingroup gallery-requests \inmodule QtGallery + \since 1.1 \brief The QGalleryQueryRequest class provides a request for a set of items from a gallery. diff --git a/src/gallery/qgalleryresource.cpp b/src/gallery/qgalleryresource.cpp index 642a027c4a..a0874553d9 100644 --- a/src/gallery/qgalleryresource.cpp +++ b/src/gallery/qgalleryresource.cpp @@ -47,6 +47,7 @@ QTM_BEGIN_NAMESPACE \class QGalleryResource \ingroup gallery + \since 1.1 \inmodule QtGallery diff --git a/src/gallery/qgalleryresultset.cpp b/src/gallery/qgalleryresultset.cpp index 2e9e9550d5..7fe5fd01ce 100644 --- a/src/gallery/qgalleryresultset.cpp +++ b/src/gallery/qgalleryresultset.cpp @@ -49,6 +49,7 @@ QTM_BEGIN_NAMESPACE \class QGalleryResultSet \ingroup gallery + \since 1.1 \inmodule QtGallery diff --git a/src/gallery/qgallerytyperequest.cpp b/src/gallery/qgallerytyperequest.cpp index 2138620f5d..3f869628cf 100644 --- a/src/gallery/qgallerytyperequest.cpp +++ b/src/gallery/qgallerytyperequest.cpp @@ -108,6 +108,7 @@ public: \ingroup gallery-requests \inmodule QtGallery + \since 1.1 \brief The QGalleryTypeRequest class provides an interface for requesting the properties of a type from a gallery. diff --git a/src/location/landmarks/qlandmark.cpp b/src/location/landmarks/qlandmark.cpp index a16a6198fa..ff503ea144 100644 --- a/src/location/landmarks/qlandmark.cpp +++ b/src/location/landmarks/qlandmark.cpp @@ -155,6 +155,7 @@ bool QLandmarkPrivate::operator== (const QLandmarkPrivate &other) const \inmodule QtLocation \ingroup landmarks-main + \since 1.1 \brief The QLandmark class represents a point of interest. diff --git a/src/location/landmarks/qlandmarkabstractrequest.cpp b/src/location/landmarks/qlandmarkabstractrequest.cpp index 7d3185a1b2..afc97f43b4 100644 --- a/src/location/landmarks/qlandmarkabstractrequest.cpp +++ b/src/location/landmarks/qlandmarkabstractrequest.cpp @@ -63,6 +63,7 @@ QLandmarkAbstractRequestPrivate::QLandmarkAbstractRequestPrivate(QLandmarkManage \inmodule QtLocation + \since 1.1 \ingroup landmarks-request diff --git a/src/location/landmarks/qlandmarkattributefilter.cpp b/src/location/landmarks/qlandmarkattributefilter.cpp index fb4d8cd9e6..5023bb14a3 100644 --- a/src/location/landmarks/qlandmarkattributefilter.cpp +++ b/src/location/landmarks/qlandmarkattributefilter.cpp @@ -98,6 +98,7 @@ QLandmarkAttributeFilterPrivate::~QLandmarkAttributeFilterPrivate() \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 You can provide various keys which describe the attribute(s) to search. Precisely which keys may be used depends on the manager diff --git a/src/location/landmarks/qlandmarkboxfilter.cpp b/src/location/landmarks/qlandmarkboxfilter.cpp index 7e1613c51c..d135ab1151 100644 --- a/src/location/landmarks/qlandmarkboxfilter.cpp +++ b/src/location/landmarks/qlandmarkboxfilter.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 In order to be a valid filter, the region covered by the box filter must not cover one of the poles. */ diff --git a/src/location/landmarks/qlandmarkcategory.cpp b/src/location/landmarks/qlandmarkcategory.cpp index 182a7564d0..d8d6907509 100644 --- a/src/location/landmarks/qlandmarkcategory.cpp +++ b/src/location/landmarks/qlandmarkcategory.cpp @@ -104,6 +104,7 @@ bool QLandmarkCategoryPrivate::operator == (const QLandmarkCategoryPrivate &othe \inmodule QtLocation \ingroup landmarks-main + \since 1.1 Landmarks of similar type may be grouped together into categories, e.g. restaurants, accommodation etc, a QLandmarkCategory object diff --git a/src/location/landmarks/qlandmarkcategoryfetchrequest.cpp b/src/location/landmarks/qlandmarkcategoryfetchrequest.cpp index d0d5ca728c..9406594bc3 100644 --- a/src/location/landmarks/qlandmarkcategoryfetchrequest.cpp +++ b/src/location/landmarks/qlandmarkcategoryfetchrequest.cpp @@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE the usage of request classes and ownership semantics. \inmodule QtLocation + \since 1.1 \ingroup landmarks-request */ diff --git a/src/location/landmarks/qlandmarkcategoryfilter.cpp b/src/location/landmarks/qlandmarkcategoryfilter.cpp index fc6fefac4b..0bfeae5f37 100644 --- a/src/location/landmarks/qlandmarkcategoryfilter.cpp +++ b/src/location/landmarks/qlandmarkcategoryfilter.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE belong to a certain category. \inmodule QtLocation + \since 1.1 \ingroup landmarks-filter */ diff --git a/src/location/landmarks/qlandmarkcategoryid.cpp b/src/location/landmarks/qlandmarkcategoryid.cpp index c0e70a022e..ba08fba6d9 100644 --- a/src/location/landmarks/qlandmarkcategoryid.cpp +++ b/src/location/landmarks/qlandmarkcategoryid.cpp @@ -49,8 +49,9 @@ QTM_USE_NAMESPACE \class QLandmarkCategoryId \inmodule QtLocation - + \ingroup landmarks-main + \since 1.1 \brief The QLandmarkCategoryId class provides a unique identifier for a category. diff --git a/src/location/landmarks/qlandmarkcategoryidfetchrequest.cpp b/src/location/landmarks/qlandmarkcategoryidfetchrequest.cpp index 3c9131d410..ddff967a58 100644 --- a/src/location/landmarks/qlandmarkcategoryidfetchrequest.cpp +++ b/src/location/landmarks/qlandmarkcategoryidfetchrequest.cpp @@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE the usage of request classes and ownership semantics. \inmodule QtLocation + \since 1.1 \ingroup landmarks-request */ diff --git a/src/location/landmarks/qlandmarkcategoryremoverequest.cpp b/src/location/landmarks/qlandmarkcategoryremoverequest.cpp index 0228d09eb6..a310b10988 100644 --- a/src/location/landmarks/qlandmarkcategoryremoverequest.cpp +++ b/src/location/landmarks/qlandmarkcategoryremoverequest.cpp @@ -63,6 +63,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarkcategorysaverequest.cpp b/src/location/landmarks/qlandmarkcategorysaverequest.cpp index 6d70b611d2..3e27fb64eb 100644 --- a/src/location/landmarks/qlandmarkcategorysaverequest.cpp +++ b/src/location/landmarks/qlandmarkcategorysaverequest.cpp @@ -61,6 +61,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarkexportrequest.cpp b/src/location/landmarks/qlandmarkexportrequest.cpp index 717a3b257f..025f0a22e5 100644 --- a/src/location/landmarks/qlandmarkexportrequest.cpp +++ b/src/location/landmarks/qlandmarkexportrequest.cpp @@ -65,6 +65,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarkfetchbyidrequest.cpp b/src/location/landmarks/qlandmarkfetchbyidrequest.cpp index fd00c58062..5a6c88dc41 100644 --- a/src/location/landmarks/qlandmarkfetchbyidrequest.cpp +++ b/src/location/landmarks/qlandmarkfetchbyidrequest.cpp @@ -62,6 +62,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarkfetchrequest.cpp b/src/location/landmarks/qlandmarkfetchrequest.cpp index 8977d9a372..3e8c7d5a24 100644 --- a/src/location/landmarks/qlandmarkfetchrequest.cpp +++ b/src/location/landmarks/qlandmarkfetchrequest.cpp @@ -63,6 +63,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarkfilter.cpp b/src/location/landmarks/qlandmarkfilter.cpp index 465db82a88..9e5566a0af 100644 --- a/src/location/landmarks/qlandmarkfilter.cpp +++ b/src/location/landmarks/qlandmarkfilter.cpp @@ -82,6 +82,7 @@ QLandmarkFilterPrivate::~QLandmarkFilterPrivate() \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 This class is used as a parameter to search for landmarks, it allows selection of landmarks which meet certain criteria. It is used with QLandmarkManager diff --git a/src/location/landmarks/qlandmarkid.cpp b/src/location/landmarks/qlandmarkid.cpp index b4052982c0..f857a3b442 100644 --- a/src/location/landmarks/qlandmarkid.cpp +++ b/src/location/landmarks/qlandmarkid.cpp @@ -49,8 +49,9 @@ QTM_USE_NAMESPACE \class QLandmarkId \inmodule QtLocation - + \ingroup landmarks-main + \since 1.1 \brief The QLandmarkId class provides a unique identifier for a landmark. diff --git a/src/location/landmarks/qlandmarkidfetchrequest.cpp b/src/location/landmarks/qlandmarkidfetchrequest.cpp index 122ee2dcf6..5353d40346 100644 --- a/src/location/landmarks/qlandmarkidfetchrequest.cpp +++ b/src/location/landmarks/qlandmarkidfetchrequest.cpp @@ -60,6 +60,7 @@ QTM_BEGIN_NAMESPACE the usage of request classes and ownership semantics. \inmodule QtLocation + \since 1.1 \ingroup landmarks-request */ @@ -169,7 +170,7 @@ void QLandmarkIdFetchRequest::setLimit(int limit) Returns the index offset for the request. By default the offset is set to 0. The offset determines the first index which is retrieved, it is generally used in conjunction with limit() to facilitate paging. - + For example, if there are 10 landmarks in the landmark store, setting the offset to 2 and limit to 5 will retrieve the 3rd and 7th landmark ids inclusively. (The order of the landmark ids is sepecified by the sorting field). diff --git a/src/location/landmarks/qlandmarkidfilter.cpp b/src/location/landmarks/qlandmarkidfilter.cpp index 6a1c0ffc12..35f9d203aa 100644 --- a/src/location/landmarks/qlandmarkidfilter.cpp +++ b/src/location/landmarks/qlandmarkidfilter.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 */ Q_IMPLEMENT_LANDMARKFILTER_PRIVATE(QLandmarkIdFilter) diff --git a/src/location/landmarks/qlandmarkimportrequest.cpp b/src/location/landmarks/qlandmarkimportrequest.cpp index a477ff7037..39d7efe324 100644 --- a/src/location/landmarks/qlandmarkimportrequest.cpp +++ b/src/location/landmarks/qlandmarkimportrequest.cpp @@ -62,6 +62,7 @@ QTM_BEGIN_NAMESPACE supported for import requests and will always return false. \inmodule QtLocation + \since 1.1 \ingroup landmarks-request */ diff --git a/src/location/landmarks/qlandmarkintersectionfilter.cpp b/src/location/landmarks/qlandmarkintersectionfilter.cpp index b18c22fe75..faeffb7294 100644 --- a/src/location/landmarks/qlandmarkintersectionfilter.cpp +++ b/src/location/landmarks/qlandmarkintersectionfilter.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 Conceptually it performs an AND operation and thus may be used to select landmarks which match all of it's constituent filters. diff --git a/src/location/landmarks/qlandmarkmanagerengine.cpp b/src/location/landmarks/qlandmarkmanagerengine.cpp index 6b91c66b44..41bb7dbe51 100644 --- a/src/location/landmarks/qlandmarkmanagerengine.cpp +++ b/src/location/landmarks/qlandmarkmanagerengine.cpp @@ -147,6 +147,7 @@ QStringList commonLandmarkKeys = QStringList() << "name" of the landmark manager backend functionality. \inmodule QtLocation + \since 1.1 \ingroup landmarks-backend diff --git a/src/location/landmarks/qlandmarknamefilter.cpp b/src/location/landmarks/qlandmarknamefilter.cpp index b072fa5e76..4c16a716d4 100644 --- a/src/location/landmarks/qlandmarknamefilter.cpp +++ b/src/location/landmarks/qlandmarknamefilter.cpp @@ -49,6 +49,7 @@ QTM_BEGIN_NAMESPACE \brief The QLandmarkNameFilter class is used to search for landmarks by name. \inmodule QtLocation + \since 1.1 \ingroup landmarks-filter diff --git a/src/location/landmarks/qlandmarknamesort.cpp b/src/location/landmarks/qlandmarknamesort.cpp index 324f8c919f..29ef320930 100644 --- a/src/location/landmarks/qlandmarknamesort.cpp +++ b/src/location/landmarks/qlandmarknamesort.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-sort + \since 1.1 Note that some manager's may not support case sensitive sorting. */ diff --git a/src/location/landmarks/qlandmarkproximityfilter.cpp b/src/location/landmarks/qlandmarkproximityfilter.cpp index 7012f532c0..cfe32e296c 100644 --- a/src/location/landmarks/qlandmarkproximityfilter.cpp +++ b/src/location/landmarks/qlandmarkproximityfilter.cpp @@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-filter + \since 1.1 In order to be a valid filter, the region covered by the proximity filter must not cover one of the poles. The landmarks are returned in ascending order of distance. A proximity filter may diff --git a/src/location/landmarks/qlandmarkremoverequest.cpp b/src/location/landmarks/qlandmarkremoverequest.cpp index f7164f8c0f..6ef90ecf53 100644 --- a/src/location/landmarks/qlandmarkremoverequest.cpp +++ b/src/location/landmarks/qlandmarkremoverequest.cpp @@ -61,6 +61,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 */ /*! diff --git a/src/location/landmarks/qlandmarksaverequest.cpp b/src/location/landmarks/qlandmarksaverequest.cpp index 953a3d0dbe..8c5214954b 100644 --- a/src/location/landmarks/qlandmarksaverequest.cpp +++ b/src/location/landmarks/qlandmarksaverequest.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation \ingroup landmarks-request + \since 1.1 For a QLandmarkSaveRequest, the resultsAvailable() signal will be emitted when either an individual items error out (individaul errors may be retrieved diff --git a/src/location/landmarks/qlandmarksortorder.cpp b/src/location/landmarks/qlandmarksortorder.cpp index 7abb42be6b..74901d571e 100644 --- a/src/location/landmarks/qlandmarksortorder.cpp +++ b/src/location/landmarks/qlandmarksortorder.cpp @@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE no sorting. \inmodule QtLocation + \since 1.1 \ingroup landmarks-sort diff --git a/src/location/landmarks/qlandmarkunionfilter.cpp b/src/location/landmarks/qlandmarkunionfilter.cpp index 3be3e2dd65..8d792e4a76 100644 --- a/src/location/landmarks/qlandmarkunionfilter.cpp +++ b/src/location/landmarks/qlandmarkunionfilter.cpp @@ -50,8 +50,9 @@ QTM_BEGIN_NAMESPACE of its constituent filters. \inmodule QtLocation - + \ingroup landmarks-filter + \since 1.1 Conceptually it performs an OR operation and may thus be used to select landmarks which match any one of it's constituent filters. diff --git a/src/location/maps/qgeomaneuver.cpp b/src/location/maps/qgeomaneuver.cpp index 94b676487b..92a2ac2625 100644 --- a/src/location/maps/qgeomaneuver.cpp +++ b/src/location/maps/qgeomaneuver.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE point at which two QGeoRouteSegments meet. \inmodule QtLocation + \since 1.1 \ingroup maps-routing @@ -114,8 +115,8 @@ The instruction indicates that the direction of travel should bear to the left. /*! Constructs a invalid maneuver object. - The maneuver will remain invalid until one of - setPosition(), setInstructionText(), setDirection(), + The maneuver will remain invalid until one of + setPosition(), setInstructionText(), setDirection(), setTimeToNextInstruction(), setDistanceToNextInstruction() or setWaypoint() is called. */ @@ -162,7 +163,7 @@ bool QGeoManeuver::operator!= (const QGeoManeuver &other) const /*! Returns whether this maneuver is valid or not. - Invalid maneuvers are used when there is no information + Invalid maneuvers are used when there is no information that needs to be attached to the endpoint of a QGeoRouteSegment instance. */ bool QGeoManeuver::isValid() const diff --git a/src/location/maps/qgeomapcircleobject.cpp b/src/location/maps/qgeomapcircleobject.cpp index f5e98f8e9a..35ff7747cc 100644 --- a/src/location/maps/qgeomapcircleobject.cpp +++ b/src/location/maps/qgeomapcircleobject.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE within a given distance of a coordinate. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -287,7 +288,7 @@ qreal QGeoMapCircleObject::radius() const /*! \fn void QGeoMapCircleObject::centerChanged(const QGeoCoordinate ¢er) - This signal is emitted when the center of the circle object has + This signal is emitted when the center of the circle object has changed. The new value is \a center. @@ -296,7 +297,7 @@ qreal QGeoMapCircleObject::radius() const /*! \fn void QGeoMapCircleObject::radiusChanged(qreal radius) - This signal is emitted when the radius of the circle object has + This signal is emitted when the radius of the circle object has changed. The new value is \a radius. @@ -305,7 +306,7 @@ qreal QGeoMapCircleObject::radius() const /*! \fn void QGeoMapCircleObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw the edge of + This signal is emitted when the pen used to draw the edge of the circle object has changed. The new value is \a pen. @@ -314,7 +315,7 @@ qreal QGeoMapCircleObject::radius() const /*! \fn void QGeoMapCircleObject::brushChanged(const QBrush &brush) - This signal is emitted when the brush used to fill the inside of + This signal is emitted when the brush used to fill the inside of the circle object has changed. The new value is \a brush. diff --git a/src/location/maps/qgeomapdata.cpp b/src/location/maps/qgeomapdata.cpp index 2da4e6dc94..d6716d02fe 100644 --- a/src/location/maps/qgeomapdata.cpp +++ b/src/location/maps/qgeomapdata.cpp @@ -73,6 +73,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-impl @@ -121,7 +122,7 @@ QGeoMapData::~QGeoMapData() } /*! - This function is run after the QGeoMapData instance has been + This function is run after the QGeoMapData instance has been constructed. Any subclasses which override this function should make sure that @@ -710,7 +711,7 @@ void QGeoMapData::setBlockPropertyChangeSignals(bool block) /*! \fn void QGeoMapData::windowSizeChanged(const QSizeF &windowSize) - This signal is emitted when the size of the window which contains + This signal is emitted when the size of the window which contains the map has changed. The new value is \a windowSize. @@ -759,7 +760,7 @@ void QGeoMapData::setBlockPropertyChangeSignals(bool block) /*! \fn void QGeoMapData::connectivityModeChanged(QGraphicsGeoMap::ConnectivityMode connectivityMode) - This signal is emitted when the connectivity mode used to fetch the + This signal is emitted when the connectivity mode used to fetch the map data has changed. The new value is \a connectivityMode. @@ -768,7 +769,7 @@ void QGeoMapData::setBlockPropertyChangeSignals(bool block) /*! \fn void QGeoMapData::updateMapDisplay(const QRectF &target) - This signal is emitted when the region \a target of the window which + This signal is emitted when the region \a target of the window which contains the map needs to be updated. diff --git a/src/location/maps/qgeomapgroupobject.cpp b/src/location/maps/qgeomapgroupobject.cpp index 939af440b8..dcd953a22f 100644 --- a/src/location/maps/qgeomapgroupobject.cpp +++ b/src/location/maps/qgeomapgroupobject.cpp @@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE manager a group of other map objects. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects diff --git a/src/location/maps/qgeomapobject.cpp b/src/location/maps/qgeomapobject.cpp index cd3c6836a9..3c42fc4522 100644 --- a/src/location/maps/qgeomapobject.cpp +++ b/src/location/maps/qgeomapobject.cpp @@ -57,6 +57,7 @@ QTM_BEGIN_NAMESPACE \class QGeoMapObject \brief The QGeoMapObject class is a graphical item to be displayed on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -458,7 +459,7 @@ void QGeoMapObject::setUnits(const CoordinateUnit &unit) /*! \fn void QGeoMapObject::zValueChanged(int zValue) - This signal is emitted when the z value of the map object + This signal is emitted when the z value of the map object has changed. The new value is \a zValue. @@ -467,7 +468,7 @@ void QGeoMapObject::setUnits(const CoordinateUnit &unit) /*! \fn void QGeoMapObject::visibleChanged(bool visible) - This signal is emitted when the visible state of the map object + This signal is emitted when the visible state of the map object has changed. The new value is \a visible. diff --git a/src/location/maps/qgeomapobjectinfo.cpp b/src/location/maps/qgeomapobjectinfo.cpp index 1900820372..e399d47286 100644 --- a/src/location/maps/qgeomapobjectinfo.cpp +++ b/src/location/maps/qgeomapobjectinfo.cpp @@ -57,6 +57,7 @@ QTM_BEGIN_NAMESPACE particular QGeoMapData subclass. \inmodule QtLocation + \since 1.1 \ingroup maps-impl @@ -101,7 +102,7 @@ QGeoMapObjectInfo::~QGeoMapObjectInfo() void QGeoMapObjectInfo::init() {} /*! - This function is called when the window size of the map changes to + This function is called when the window size of the map changes to \a windowSize. The default implementation does nothing. @@ -112,7 +113,7 @@ void QGeoMapObjectInfo::windowSizeChanged(const QSizeF &windowSize) } /*! - This function is called when the zoom level of the map changes to + This function is called when the zoom level of the map changes to \a zoomLevel. The default implementation does nothing. @@ -123,7 +124,7 @@ void QGeoMapObjectInfo::zoomLevelChanged(qreal zoomLevel) } /*! - This function is called when the center of the map changes to + This function is called when the center of the map changes to \a coordinate. The default implementation does nothing. @@ -144,7 +145,7 @@ void QGeoMapObjectInfo::zValueChanged(int zValue) } /*! - This function is run when the visible state of the object changes to + This function is run when the visible state of the object changes to \a visible. The default implementation does nothing. @@ -155,7 +156,7 @@ void QGeoMapObjectInfo::visibleChanged(bool visible) } /*! - This function is run when the selected state of the object changes to + This function is run when the selected state of the object changes to \a selected. The default implementation does nothing. diff --git a/src/location/maps/qgeomapoverlay.cpp b/src/location/maps/qgeomapoverlay.cpp index a888e3713b..5d5fa582d5 100644 --- a/src/location/maps/qgeomapoverlay.cpp +++ b/src/location/maps/qgeomapoverlay.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \brief The QGeoMapOverlay class is used to draw overlays on the map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping diff --git a/src/location/maps/qgeomappingmanager.cpp b/src/location/maps/qgeomappingmanager.cpp index 36692311ec..3bac9036dc 100644 --- a/src/location/maps/qgeomappingmanager.cpp +++ b/src/location/maps/qgeomappingmanager.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE and interacting with maps. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping diff --git a/src/location/maps/qgeomappingmanagerengine.cpp b/src/location/maps/qgeomappingmanagerengine.cpp index b9cb547ced..72d3002b8d 100644 --- a/src/location/maps/qgeomappingmanagerengine.cpp +++ b/src/location/maps/qgeomappingmanagerengine.cpp @@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE and interacting with maps. \inmodule QtLocation + \since 1.1 \ingroup maps-impl diff --git a/src/location/maps/qgeomappixmapobject.cpp b/src/location/maps/qgeomappixmapobject.cpp index 51bde21ea6..0109cea4ed 100644 --- a/src/location/maps/qgeomappixmapobject.cpp +++ b/src/location/maps/qgeomappixmapobject.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE a pixmap on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -184,7 +185,7 @@ void QGeoMapPixmapObject::setOffset(const QPoint &offset) /*! \fn void QGeoMapPixmapObject::coordinateChanged(const QGeoCoordinate &coordinate) - This signal is emitted when the coordinate at which the pixmap + This signal is emitted when the coordinate at which the pixmap should be drawn has changed. The new value will be \a coordinate. @@ -192,8 +193,8 @@ void QGeoMapPixmapObject::setOffset(const QPoint &offset) /*! \fn void QGeoMapPixmapObject::pixmapChanged(const QPixmap &pixmap) - - This signal is emitted when the pixmap associated with this + + This signal is emitted when the pixmap associated with this pixmap object has changed. The new value will be \a pixmap. @@ -201,8 +202,8 @@ void QGeoMapPixmapObject::setOffset(const QPoint &offset) /*! \fn void QGeoMapPixmapObject::offsetChanged(const QPoint &offset) - - This signal is emitted when the on-screen offset from the coordinate + + This signal is emitted when the on-screen offset from the coordinate at which this pixmap object should be drawn has changed. The new value will be \a offset. diff --git a/src/location/maps/qgeomappolygonobject.cpp b/src/location/maps/qgeomappolygonobject.cpp index da34decb7d..d7c5d6b79b 100644 --- a/src/location/maps/qgeomappolygonobject.cpp +++ b/src/location/maps/qgeomappolygonobject.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE a polygon on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -168,7 +169,7 @@ QBrush QGeoMapPolygonObject::brush() const /*! \fn void QGeoMapPolygonObject::pathChanged(const QList<QGeoCoordinate> &path) - This signal is emitted when the ordered list of coordinates that define + This signal is emitted when the ordered list of coordinates that define the polygon to be drawn by this polygon object has changed. The new value is \a path. @@ -177,7 +178,7 @@ QBrush QGeoMapPolygonObject::brush() const /*! \fn void QGeoMapPolygonObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw the edge of this + This signal is emitted when the pen used to draw the edge of this polygon object has changed. The new value is \a pen. @@ -186,9 +187,9 @@ QBrush QGeoMapPolygonObject::brush() const /*! \fn void QGeoMapPolygonObject::brushChanged(const QBrush &brush) - This signal is emitted when the brush used to fill in the interior of + This signal is emitted when the brush used to fill in the interior of this polygon object has changed. - + The new value is \a brush. */ diff --git a/src/location/maps/qgeomappolylineobject.cpp b/src/location/maps/qgeomappolylineobject.cpp index 4ddb4ee713..96f77bc7d2 100644 --- a/src/location/maps/qgeomappolylineobject.cpp +++ b/src/location/maps/qgeomappolylineobject.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE a segmented line on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -143,7 +144,7 @@ QPen QGeoMapPolylineObject::pen() const /*! \fn void QGeoMapPolylineObject::pathChanged(const QList<QGeoCoordinate> &path) - This signal is emitted when the ordered list of coordinates that define + This signal is emitted when the ordered list of coordinates that define the polyline to be drawn by this polyline object has changed. The new value is \a path. @@ -152,7 +153,7 @@ QPen QGeoMapPolylineObject::pen() const /*! \fn void QGeoMapPolylineObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw the edge of this + This signal is emitted when the pen used to draw the edge of this polyline object has changed. The new value is \a pen. diff --git a/src/location/maps/qgeomaprectangleobject.cpp b/src/location/maps/qgeomaprectangleobject.cpp index 6ba2a0e722..ade4e56473 100644 --- a/src/location/maps/qgeomaprectangleobject.cpp +++ b/src/location/maps/qgeomaprectangleobject.cpp @@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE a rectangular region on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -249,7 +250,7 @@ void QGeoMapRectangleObject::setBrush(const QBrush &brush) /*! \fn void QGeoMapRectangleObject::topLeftChanged(const QGeoCoordinate &topLeft) - This signal is emitted when the top left coordinate of this rectangle + This signal is emitted when the top left coordinate of this rectangle object has changed. The new value is \a topLeft. @@ -258,7 +259,7 @@ void QGeoMapRectangleObject::setBrush(const QBrush &brush) /*! \fn void QGeoMapRectangleObject::bottomRightChanged(const QGeoCoordinate &bottomRight) - This signal is emitted when the bottom right coordinate of this rectangle + This signal is emitted when the bottom right coordinate of this rectangle object has changed. The new value is \a bottomRight. @@ -267,7 +268,7 @@ void QGeoMapRectangleObject::setBrush(const QBrush &brush) /*! \fn void QGeoMapRectangleObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw the perimeter of this + This signal is emitted when the pen used to draw the perimeter of this rectangle object has changed. The new value is \a pen. @@ -276,7 +277,7 @@ void QGeoMapRectangleObject::setBrush(const QBrush &brush) /*! \fn void QGeoMapRectangleObject::brushChanged(const QBrush &brush) - This signal is emitted when the brush used to fill in the interior of + This signal is emitted when the brush used to fill in the interior of this rectangle object has changed. The new value is \a brush. diff --git a/src/location/maps/qgeomaprouteobject.cpp b/src/location/maps/qgeomaprouteobject.cpp index 1c81f14dfe..3822b87448 100644 --- a/src/location/maps/qgeomaprouteobject.cpp +++ b/src/location/maps/qgeomaprouteobject.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE a route on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -182,7 +183,7 @@ void QGeoMapRouteObject::setDetailLevel(quint32 detailLevel) /*! \fn void QGeoMapRouteObject::routeChanged(const QGeoRoute &route) - This signal is emitted when the route drawn by this route object + This signal is emitted when the route drawn by this route object has changed. The new value is \a route. @@ -191,7 +192,7 @@ void QGeoMapRouteObject::setDetailLevel(quint32 detailLevel) /*! \fn void QGeoMapRouteObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw this route object has + This signal is emitted when the pen used to draw this route object has changed. The new value is \a pen. @@ -200,7 +201,7 @@ void QGeoMapRouteObject::setDetailLevel(quint32 detailLevel) /*! \fn void QGeoMapRouteObject::detailLevelChanged(quint32 detailLevel) - This signal is emitted when the level of detail used to draw this + This signal is emitted when the level of detail used to draw this route object has changed. The new value is \a detailLevel. diff --git a/src/location/maps/qgeomaptextobject.cpp b/src/location/maps/qgeomaptextobject.cpp index 0c451f451a..8cc8d1ab08 100644 --- a/src/location/maps/qgeomaptextobject.cpp +++ b/src/location/maps/qgeomaptextobject.cpp @@ -50,6 +50,7 @@ QTM_BEGIN_NAMESPACE text on a map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping-objects @@ -72,7 +73,7 @@ QGeoMapTextObject::QGeoMapTextObject() Constructs a new text object which will display the text \a text with font \a font at the coordinate \a coordinate on the map. - The text will be displayed at an on-screen offset from the coordinate of \a + The text will be displayed at an on-screen offset from the coordinate of \a offset pixels, and will be aligned according to \a alignment. */ QGeoMapTextObject::QGeoMapTextObject(const QGeoCoordinate &coordinate, @@ -297,7 +298,7 @@ void QGeoMapTextObject::setAlignment(Qt::Alignment alignment) /*! \fn void QGeoMapTextObject::coordinateChanged(const QGeoCoordinate &coordinate) - This signal is emitted when the coordinate at which this text + This signal is emitted when the coordinate at which this text object will be drawn has changed. The new value is \a coordinate. @@ -306,7 +307,7 @@ void QGeoMapTextObject::setAlignment(Qt::Alignment alignment) /*! \fn void QGeoMapTextObject::textChanged(const QString &text) - This signal is emitted when the text to be drawn by this text object + This signal is emitted when the text to be drawn by this text object has changed. The new value is \a text. @@ -315,7 +316,7 @@ void QGeoMapTextObject::setAlignment(Qt::Alignment alignment) /*! \fn void QGeoMapTextObject::fontChanged(const QFont &font) - This signal is emitted when the font use to draw this text object + This signal is emitted when the font use to draw this text object has changed. The new value is \a font. @@ -324,7 +325,7 @@ void QGeoMapTextObject::setAlignment(Qt::Alignment alignment) /*! \fn void QGeoMapTextObject::penChanged(const QPen &pen) - This signal is emitted when the pen used to draw the outline of the + This signal is emitted when the pen used to draw the outline of the letters for this text object has changed. The new value is \a pen. @@ -342,7 +343,7 @@ void QGeoMapTextObject::setAlignment(Qt::Alignment alignment) /*! \fn void QGeoMapTextObject::offsetChanged(const QPoint &offset) - This signal is emitted when the on screen offset from the coordinate at + This signal is emitted when the on screen offset from the coordinate at which this text object will be drawn has changed. The new value is \a offset. diff --git a/src/location/maps/qgeoroute.cpp b/src/location/maps/qgeoroute.cpp index ecb3dcbaa9..564bef3fe3 100644 --- a/src/location/maps/qgeoroute.cpp +++ b/src/location/maps/qgeoroute.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE \brief The QGeoRoute class represents a route between two points. \inmodule QtLocation + \since 1.1 \ingroup maps-routing diff --git a/src/location/maps/qgeoroutereply.cpp b/src/location/maps/qgeoroutereply.cpp index 35b3dc49c6..22966b9022 100644 --- a/src/location/maps/qgeoroutereply.cpp +++ b/src/location/maps/qgeoroutereply.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE of QGeoRoutingManager. \inmodule QtLocation + \since 1.1 \ingroup maps-routing diff --git a/src/location/maps/qgeorouterequest.cpp b/src/location/maps/qgeorouterequest.cpp index 47897f6968..d4a41ac013 100644 --- a/src/location/maps/qgeorouterequest.cpp +++ b/src/location/maps/qgeorouterequest.cpp @@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE which define a request for routing information. \inmodule QtLocation + \since 1.1 \ingroup maps-routing @@ -124,8 +125,8 @@ QTM_BEGIN_NAMESPACE not be part of the route. \value NoFeature - Used by QGeoRoutingManager::supportedFeatureTypes() to indicate that - no features will be taken into account when planning the route. + Used by QGeoRoutingManager::supportedFeatureTypes() to indicate that + no features will be taken into account when planning the route. \value TollFeature Consdier tollways when planning the route. \value HighwayFeature diff --git a/src/location/maps/qgeoroutesegment.cpp b/src/location/maps/qgeoroutesegment.cpp index 1ee2406fdd..d86e8dfe52 100644 --- a/src/location/maps/qgeoroutesegment.cpp +++ b/src/location/maps/qgeoroutesegment.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \brief The QGeoRouteSegment class represents a segment of a route. \inmodule QtLocation + \since 1.1 \ingroup maps-routing @@ -230,7 +231,7 @@ void QGeoRouteSegment::setManeuver(const QGeoManeuver &maneuver) /*! Returns the manevuer for this route segment. - Will return an invalid QGeoManeuver if no information has been attached + Will return an invalid QGeoManeuver if no information has been attached to the endpoint of this route segment. */ QGeoManeuver QGeoRouteSegment::maneuver() const diff --git a/src/location/maps/qgeoroutingmanager.cpp b/src/location/maps/qgeoroutingmanager.cpp index 313aa95627..539369d76e 100644 --- a/src/location/maps/qgeoroutingmanager.cpp +++ b/src/location/maps/qgeoroutingmanager.cpp @@ -55,6 +55,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-routing diff --git a/src/location/maps/qgeoroutingmanagerengine.cpp b/src/location/maps/qgeoroutingmanagerengine.cpp index abf3583614..cdcb0defdc 100644 --- a/src/location/maps/qgeoroutingmanagerengine.cpp +++ b/src/location/maps/qgeoroutingmanagerengine.cpp @@ -53,6 +53,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-impl diff --git a/src/location/maps/qgeosearchmanager.cpp b/src/location/maps/qgeosearchmanager.cpp index 59d3d13f19..57ebf891dc 100644 --- a/src/location/maps/qgeosearchmanager.cpp +++ b/src/location/maps/qgeosearchmanager.cpp @@ -66,6 +66,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-places diff --git a/src/location/maps/qgeosearchmanagerengine.cpp b/src/location/maps/qgeosearchmanagerengine.cpp index 355358e924..1c4510ed18 100644 --- a/src/location/maps/qgeosearchmanagerengine.cpp +++ b/src/location/maps/qgeosearchmanagerengine.cpp @@ -56,6 +56,7 @@ QTM_BEGIN_NAMESPACE to provide support for searching operations related to geographic data. \inmodule QtLocation + \since 1.1 \ingroup maps-impl diff --git a/src/location/maps/qgeosearchreply.cpp b/src/location/maps/qgeosearchreply.cpp index ce190287a1..6e4c3cc82a 100644 --- a/src/location/maps/qgeosearchreply.cpp +++ b/src/location/maps/qgeosearchreply.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-places @@ -260,7 +261,7 @@ int QGeoSearchReply::limit() const } /*! - Returns the offset into the entire result set at which to start + Returns the offset into the entire result set at which to start fetching results. */ int QGeoSearchReply::offset() const @@ -279,7 +280,7 @@ void QGeoSearchReply::setLimit(int limit) } /*! - Sets the offset in the entire result set at which to start + Sets the offset in the entire result set at which to start fetching result to \a offset. */ void QGeoSearchReply::setOffset(int offset) diff --git a/src/location/maps/qgeoserviceprovider.cpp b/src/location/maps/qgeoserviceprovider.cpp index 964c343d45..093540c7dd 100644 --- a/src/location/maps/qgeoserviceprovider.cpp +++ b/src/location/maps/qgeoserviceprovider.cpp @@ -72,6 +72,7 @@ QTM_BEGIN_NAMESPACE geographical information. \inmodule QtLocation + \since 1.1 \ingroup maps diff --git a/src/location/maps/qgeoserviceproviderfactory.cpp b/src/location/maps/qgeoserviceproviderfactory.cpp index 643faf80d0..600c4469b5 100644 --- a/src/location/maps/qgeoserviceproviderfactory.cpp +++ b/src/location/maps/qgeoserviceproviderfactory.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtLocation + \since 1.1 \ingroup maps-impl diff --git a/src/location/maps/qgraphicsgeomap.cpp b/src/location/maps/qgraphicsgeomap.cpp index 39487216c4..f7fb49eed8 100644 --- a/src/location/maps/qgraphicsgeomap.cpp +++ b/src/location/maps/qgraphicsgeomap.cpp @@ -66,6 +66,7 @@ QTM_BEGIN_NAMESPACE interactions between the user and the map. \inmodule QtLocation + \since 1.1 \ingroup maps-mapping @@ -783,7 +784,7 @@ QGeoCoordinate QGraphicsGeoMap::screenPositionToCoordinate(QPointF screenPositio /*! \fn void QGraphicsGeoMap::connectivityModeChanged(QGraphicsGeoMap::ConnectivityMode connectivityMode) - This signal is emitted when the connectivity mode used to fetch the + This signal is emitted when the connectivity mode used to fetch the map data changes. The new value is \a connectivityMode. diff --git a/src/location/qgeoaddress.cpp b/src/location/qgeoaddress.cpp index 7c6e85bcee..e01402d62b 100644 --- a/src/location/qgeoaddress.cpp +++ b/src/location/qgeoaddress.cpp @@ -76,6 +76,7 @@ QGeoAddressPrivate::~QGeoAddressPrivate() \brief The QGeoAddress class represents an address \inmodule QtLocation + \since 1.1 \ingroup location diff --git a/src/location/qgeoboundingarea.cpp b/src/location/qgeoboundingarea.cpp index ed4736847b..1f256be676 100644 --- a/src/location/qgeoboundingarea.cpp +++ b/src/location/qgeoboundingarea.cpp @@ -48,14 +48,15 @@ QTM_BEGIN_NAMESPACE \brief The QGeoBoundingArea class defines a geographic area. \inmodule QtLocation + \since 1.1 \ingroup maps - This class is the base class for classes which specify a geographic - area. - + This class is the base class for classes which specify a geographic + area. + For the sake of consistency, subclasses should describe the specific - details of the associated areas in terms of QGeoCoordinate instances + details of the associated areas in terms of QGeoCoordinate instances and distances in metres. */ @@ -85,8 +86,8 @@ Returns the type of this area. Returns whether this bounding area is valid. -An area is considered to be invalid if some of the data that is required to -unambiguously describe the area has not been set or has been set to an +An area is considered to be invalid if some of the data that is required to +unambiguously describe the area has not been set or has been set to an unsuitable value. */ @@ -101,7 +102,7 @@ An empty area is a region which has a geometrical area of 0. /*! \fn bool QGeoBoundingArea::contains(const QGeoCoordinate &coordinate) const -Returns whether the coordinate \a coordinate is contained within this +Returns whether the coordinate \a coordinate is contained within this area. */ diff --git a/src/location/qgeoboundingbox.cpp b/src/location/qgeoboundingbox.cpp index 32dc7889b5..7d170ca22b 100644 --- a/src/location/qgeoboundingbox.cpp +++ b/src/location/qgeoboundingbox.cpp @@ -54,7 +54,8 @@ QTM_BEGIN_NAMESPACE \brief The QGeoBoundingBox class defines a rectangular geographic area. \inmodule QtLocation - + \since 1.1 + \ingroup maps The rectangle is defined in terms of a QGeoCoordinate which specifies the diff --git a/src/location/qgeoboundingcircle.cpp b/src/location/qgeoboundingcircle.cpp index 5be6fc764c..943e87e119 100644 --- a/src/location/qgeoboundingcircle.cpp +++ b/src/location/qgeoboundingcircle.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE \brief The QGeoBoundingCircle class defines a circular geographic area. \inmodule QtLocation + \since 1.1 \ingroup maps diff --git a/src/location/qgeoplace.cpp b/src/location/qgeoplace.cpp index 58b5921ac2..0fa7675711 100644 --- a/src/location/qgeoplace.cpp +++ b/src/location/qgeoplace.cpp @@ -61,6 +61,7 @@ QTM_BEGIN_NAMESPACE \brief The QGeoPlace class represents basic information about a place. \inmodule QtLocation + \since 1.1 \ingroup location diff --git a/src/messaging/win32wce/qmailaddress.cpp b/src/messaging/win32wce/qmailaddress.cpp index b4ae930f9a..709f6be1ac 100644 --- a/src/messaging/win32wce/qmailaddress.cpp +++ b/src/messaging/win32wce/qmailaddress.cpp @@ -176,10 +176,10 @@ void AddressSeparator::process(QChar character, bool quoted, bool escaped, int c } // RFC 2822 requires comma as the separator, but we'll allow the semi-colon as well. - if ( ( character == ',' || character == ';' || character.isSpace()) && + if ( ( character == ',' || character == ';' || character.isSpace()) && !_inGroup && !quoted && !escaped && commentDepth == 0 ) { if (character.isSpace()) { - // We'll also attempt to separate on whitespace, but we need to append it to + // We'll also attempt to separate on whitespace, but we need to append it to // the token to preserve the input data accept(character); _tokenCompleted = true; @@ -281,7 +281,7 @@ void AddressListGenerator::complete(TokenType type, bool hardSeparator) QRegExp suffixPattern("\\s*/TYPE=.*"); if (suffixPattern.exactMatch(_partial)) { type = Suffix; - } + } else { // See if the token is a bare email address; otherwise it must be a name element QRegExp emailPattern(QMailAddress::emailAddressPattern()); @@ -350,7 +350,7 @@ void AddressListGenerator::processPending() if ((_pending.value(i - 1).first == Name) && ((type == Name) || (type == Group))) { _pending.replace(i - 1, qMakePair(type, _pending.value(i - 1).second + _pending.value(i).second)); _pending.removeAt(i); - } + } else { ++i; } @@ -514,7 +514,7 @@ void parseMailbox(QString& input, QString& name, QString& address, QString& suff { name = address = input.trimmed(); } - else + else { if (delimiters.first == -1) { @@ -531,9 +531,9 @@ void parseMailbox(QString& input, QString& name, QString& address, QString& suff address = input.mid(delimiters.first + 1, (delimiters.second - delimiters.first - 1)).trimmed(); } - if ( name.isEmpty() ) + if ( name.isEmpty() ) name = address; - } + } } } @@ -587,7 +587,7 @@ QMailAddressPrivate::QMailAddressPrivate() { } -QMailAddressPrivate::QMailAddressPrivate(const QString& addressText) +QMailAddressPrivate::QMailAddressPrivate(const QString& addressText) : _group(false), _searchCompleted(false) { @@ -614,7 +614,7 @@ QMailAddressPrivate::QMailAddressPrivate(const QString& addressText) } } -QMailAddressPrivate::QMailAddressPrivate(const QString& name, const QString& address) +QMailAddressPrivate::QMailAddressPrivate(const QString& name, const QString& address) : _group(false), _searchCompleted(false) { @@ -648,7 +648,7 @@ void QMailAddressPrivate::setComponents(const QString& nameText, const QString& _address.remove( charIndex, 1 ); } -QMailAddressPrivate::QMailAddressPrivate(const QMailAddressPrivate& other) +QMailAddressPrivate::QMailAddressPrivate(const QMailAddressPrivate& other) : QSharedData(other), _searchCompleted(false) { @@ -783,13 +783,13 @@ QString QMailAddressPrivate::toString(bool forceDelimited) const return result; } -template <typename Stream> +template <typename Stream> void QMailAddressPrivate::serialize(Stream &stream) const { stream << _name << _address << _suffix << _group; } -template <typename Stream> +template <typename Stream> void QMailAddressPrivate::deserialize(Stream &stream) { _searchCompleted = false; @@ -802,15 +802,16 @@ void QMailAddressPrivate::deserialize(Stream &stream) \brief The QMailAddress class provides an interface for manipulating message address strings. \ingroup messaginglibrary + \since 1.1 QMailAddress provides functions for splitting the address strings of messages into name and address components, and for combining the individual components into correctly formatted - address strings. QMailAddress can be used to manipulate the address elements exposed by the + address strings. QMailAddress can be used to manipulate the address elements exposed by the QMailMessage class. - Address strings are expected to use the format "name_part '<'address_part'>'", where - \i name_part describes a message sender or recipient and \i address_part defines the address - at which they can be contacted. The address component is not validated, so it can contain an + Address strings are expected to use the format "name_part '<'address_part'>'", where + \i name_part describes a message sender or recipient and \i address_part defines the address + at which they can be contacted. The address component is not validated, so it can contain an email address, phone number, or any other type of textual address representation. \sa QMailMessage @@ -827,7 +828,7 @@ QMailAddress::QMailAddress() /*! Constructs a QMailAddress object, extracting the name and address components from \a addressText. - If \a addressText cannot be separated into name and address components, both name() and address() + If \a addressText cannot be separated into name and address components, both name() and address() will return the entirety of \a addressText. \sa name(), address() @@ -910,7 +911,7 @@ bool QMailAddress::isGroup() const } /*! - Returns a list containing the individual addresses that comprise the address group. + Returns a list containing the individual addresses that comprise the address group. If the address is not a group address, an empty list is returned. \sa isGroup() @@ -972,7 +973,7 @@ QStringList QMailAddress::toStringList(const QList<QMailAddress>& list, bool for } /*! - Returns a list containing a QMailAddress object constructed from each + Returns a list containing a QMailAddress object constructed from each comma-separated address in \a list. */ QList<QMailAddress> QMailAddress::fromStringList(const QString& list) @@ -981,7 +982,7 @@ QList<QMailAddress> QMailAddress::fromStringList(const QString& list) } /*! - Returns a list containing a QMailAddress object constructed from each + Returns a list containing a QMailAddress object constructed from each address string in \a list. */ QList<QMailAddress> QMailAddress::fromStringList(const QStringList& list) @@ -1018,7 +1019,7 @@ QString QMailAddress::phoneNumberPattern() static const QString pattern("\"?" // zero-or-one:'"' "(" // start capture "(?:\\+ ?)?" // zero-or-one:('+', zero-or-one:space) - "(?:\\(\\d+\\)[ -]?)?" // zero-or-one:'(', one-or-more:digits, ')', zero-or-one:separator + "(?:\\(\\d+\\)[ -]?)?" // zero-or-one:'(', one-or-more:digits, ')', zero-or-one:separator "(?:\\d{1,14})" // one:(one-to-fourteen):digits "(?:[ -]?[\\d#\\*]{1,10}){0,4}" // zero-to-four:(zero-or-one:separator), one-to-ten:(digits | '#' | '*') "(?:" // zero-or-one: @@ -1036,12 +1037,12 @@ QString QMailAddress::phoneNumberPattern() /*! \internal */ QString QMailAddress::emailAddressPattern() { - // Taken from: http://www.regular-expressions.info/email.html, but + // Taken from: http://www.regular-expressions.info/email.html, but // modified to accept uppercase characters as well as lower-case // Also - RFC 1034 seems to prohibit domain name elements beginning // with digits, but they exist in practise... static const QString pattern("[A-Za-z\\d!#$%&'*+/=?^_`{|}~-]+" // one-or-more: legal chars (some punctuation permissible) - "(?:" // zero-or-more: + "(?:" // zero-or-more: "\\." // '.', "[A-Za-z\\d!#$%&'*+/=?^_`{|}~-]+" // one-or-more: legal chars ")*" // end of optional group @@ -1049,8 +1050,8 @@ QString QMailAddress::emailAddressPattern() "(?:" // either: "localhost" // 'localhost' "|" // or: - "(?:" // one-or-more: - "[A-Za-z\\d]" // one: legal char, + "(?:" // one-or-more: + "[A-Za-z\\d]" // one: legal char, "(?:" // zero-or-one: "[A-Za-z\\d-]*[A-Za-z\\d]" // (zero-or-more: (legal char or '-'), one: legal char) ")?" // end of optional group @@ -1065,21 +1066,21 @@ QString QMailAddress::emailAddressPattern() return pattern; } -/*! +/*! \fn QMailAddress::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailAddress::serialize(Stream &stream) const { d->serialize(stream); } -/*! +/*! \fn QMailAddress::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailAddress::deserialize(Stream &stream) { d->deserialize(stream); diff --git a/src/messaging/win32wce/qmailcodec.cpp b/src/messaging/win32wce/qmailcodec.cpp index 4d1df48d61..adb39b491d 100644 --- a/src/messaging/win32wce/qmailcodec.cpp +++ b/src/messaging/win32wce/qmailcodec.cpp @@ -59,6 +59,7 @@ int QTOPIAMAIL_EXPORT QuotedPrintableMaxLineLength = 74; \brief The QMailCodec class provides mechanisms for encoding and decoding between 7-bit ASCII strings and arbitrary octet sequences. + \since 1.1 \ingroup messaginglibrary @@ -71,15 +72,15 @@ int QTOPIAMAIL_EXPORT QuotedPrintableMaxLineLength = 74; must be used that provides a policy for mapping 8-bit data to and from 7-bit ASCII characters. This policy is implemented by overriding the encodeChunk() and decodeChunk() virtual functions. - Using the QMailCodec interface, data can be encoded or decoded from an input QDataStream to an + Using the QMailCodec interface, data can be encoded or decoded from an input QDataStream to an output QDataStream, or for convenience, from an input QByteArray to an output QByteArray. If the data to be encoded is in unicode form, then the QMailCodec interface can be used to convert the data to ASCII via an intermediate QTextCodec, which converts the incoming text to a sequence of octets. The QTextCodec used is specified by the name of the encoding - produced, or that decoded when decoding an ASCII input sequence. QMailCodec provides functions + produced, or that decoded when decoding an ASCII input sequence. QMailCodec provides functions to encode from a QTextStream to a QDataStream, and to decode from a QDataStream to a QTextStream. - For convenience, it is also possible to encode a QString to a QByteArray, and to decode a + For convenience, it is also possible to encode a QString to a QByteArray, and to decode a QByteArray to a QString. \sa QDataStream, QTextStream, QTextCodec @@ -89,7 +90,7 @@ int QTOPIAMAIL_EXPORT QuotedPrintableMaxLineLength = 74; \fn void QMailCodec::encodeChunk(QDataStream& out, const unsigned char* input, int length, bool finalChunk) Overridden by derived classes to perform an encoding operation. The implementation function - must encode \a length 8-bit octets at the location \a input, writing the resulting ASCII characters + must encode \a length 8-bit octets at the location \a input, writing the resulting ASCII characters to the stream \a out. If \a finalChunk is false, further calls will be made to encodeChunk() with continued input data. Otherwise, the encoding operation is complete. */ @@ -138,7 +139,7 @@ static QTextCodec* codecForName(const QByteArray& charset, bool translateAscii = { int index; - if (translateAscii && encoding.contains("ascii")) + if (translateAscii && encoding.contains("ascii")) { // We'll assume the text is plain ASCII, to be extracted to Latin-1 encoding = "ISO-8859-1"; @@ -163,8 +164,8 @@ static QTextCodec* codecForName(const QByteArray& charset, bool translateAscii = } /*! - Writes the data read from the stream \a in to the stream \a out, as a sequence - of 7-bit ASCII characters. The unicode characters read from \a in are first + Writes the data read from the stream \a in to the stream \a out, as a sequence + of 7-bit ASCII characters. The unicode characters read from \a in are first encoded to the text encoding \a charset. \sa QTextCodec::codecForName() @@ -178,8 +179,8 @@ void QMailCodec::encode(QDataStream& out, QTextStream& in, const QString& charse QString chunk = in.read(MaxCharacters); QByteArray charsetEncoded = codec->fromUnicode(chunk); - encodeChunk(out, - reinterpret_cast<const unsigned char*>(charsetEncoded.constData()), + encodeChunk(out, + reinterpret_cast<const unsigned char*>(charsetEncoded.constData()), charsetEncoded.length(), in.atEnd()); } @@ -187,8 +188,8 @@ void QMailCodec::encode(QDataStream& out, QTextStream& in, const QString& charse } /*! - Writes the data read from the stream \a in to the stream \a out, converting from - a sequence of 7-bit ASCII characters. The characters read from \a in are + Writes the data read from the stream \a in to the stream \a out, converting from + a sequence of 7-bit ASCII characters. The characters read from \a in are decoded from the text encoding \a charset to unicode. \sa QTextCodec::codecForName() @@ -200,7 +201,7 @@ void QMailCodec::decode(QTextStream& out, QDataStream& in, const QString& charse QByteArray decoded; { QDataStream decodedStream(&decoded, QIODevice::WriteOnly); - + char* buffer = new char[MaxCharacters]; while (!in.atEnd()) { @@ -223,7 +224,7 @@ void QMailCodec::decode(QTextStream& out, QDataStream& in, const QString& charse } /*! - Writes the data read from the stream \a in to the stream \a out, as a sequence + Writes the data read from the stream \a in to the stream \a out, as a sequence of 7-bit ASCII characters. */ void QMailCodec::encode(QDataStream& out, QDataStream& in) @@ -239,7 +240,7 @@ void QMailCodec::encode(QDataStream& out, QDataStream& in) } /*! - Writes the data read from the stream \a in to the stream \a out, converting from + Writes the data read from the stream \a in to the stream \a out, converting from a sequence of 7-bit ASCII characters. */ void QMailCodec::decode(QDataStream& out, QDataStream& in) @@ -281,7 +282,7 @@ void QMailCodec::copy(QTextStream& out, QTextStream& in) } /*! - Returns a QByteArray containing the string \a input, encoded to the text encoding \a charset + Returns a QByteArray containing the string \a input, encoded to the text encoding \a charset and then to a sequence of 7-bit ASCII characters. \sa QTextCodec::codecForName() @@ -303,8 +304,8 @@ QByteArray QMailCodec::encode(const QString& input, const QString& charset) } /*! - Returns a QString containing characters decoded from the text encoding \a charset, which - are decoded from the sequence of 7-bit ASCII characters read from \a input. + Returns a QString containing characters decoded from the text encoding \a charset, which + are decoded from the sequence of 7-bit ASCII characters read from \a input. \sa QTextCodec::codecForName() */ @@ -321,7 +322,7 @@ QString QMailCodec::decode(const QByteArray& input, const QString& charset) } /*! - Returns a QByteArray containing the octets from \a input, encoded to a sequence of + Returns a QByteArray containing the octets from \a input, encoded to a sequence of 7-bit ASCII characters. */ QByteArray QMailCodec::encode(const QByteArray& input) @@ -402,15 +403,15 @@ static inline unsigned char base64Index(const char ascii) \ingroup messaginglibrary - The Base64 character mapping scheme maps arbitrary 8-bit values into a range of 64 printable - characters from the 7-bit ASCII set. The mapping scheme used is defined in - \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Multipurpose Internet Mail Extensions Part One). + The Base64 character mapping scheme maps arbitrary 8-bit values into a range of 64 printable + characters from the 7-bit ASCII set. The mapping scheme used is defined in + \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Multipurpose Internet Mail Extensions Part One). This encoding is also defined as the '"B" encoding' for 'encoded words' in - \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} (Multipurpose Internet Mail Extensions Part Three). + \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} (Multipurpose Internet Mail Extensions Part Three). - The Base64 scheme encodes every incoming octet regardless of its original value, and thus + The Base64 scheme encodes every incoming octet regardless of its original value, and thus produces the same ratio of output length to input length for any input data sequence. Since - Base64 encodes four output characters for every three input octets, it produces a 33% + Base64 encodes four output characters for every three input octets, it produces a 33% increase in stream size when encoding. An instance of QMailBase64Codec contains state information about the encoding or decoding @@ -430,7 +431,7 @@ static inline unsigned char base64Index(const char ascii) /*! \enum QMailBase64Codec::ContentType - This enumerated type is used to specify whether content is textual data or binary data. + This enumerated type is used to specify whether content is textual data or binary data. \value Text The data is textual data; newline sequences within the data will be converted during coding. \value Binary The data is not textual, and does not contain newline sequences. @@ -443,7 +444,7 @@ static inline unsigned char base64Index(const char ascii) between the local representation (for example, 0x0A on Unix) and the transmission standard representation (0x0D 0x0A). Otherwise, the data will be coded without modification. - The maximum number of encoded characters per output line can be specified as \a maximumLineLength. + The maximum number of encoded characters per output line can be specified as \a maximumLineLength. If not specified, or specified to a non-positive value, a default value will be used. */ QMailBase64Codec::QMailBase64Codec(ContentType content, int maximumLineLength) @@ -493,7 +494,7 @@ void QMailBase64Codec::encodeChunk(QDataStream& out, const unsigned char* it, in // We can accept one more input character than accounted for lineEnd += 1; } - else + else { // We must replace this character with ASCII CRLF *_encodeBufferOut++ = CarriageReturn; @@ -501,11 +502,11 @@ void QMailBase64Codec::encodeChunk(QDataStream& out, const unsigned char* it, in { *_encodeBufferOut++ = LineFeed; } - else + else { trailingLF = true; } - + // We can accept one fewer input character than expected, now lineEnd -= 1; } @@ -641,7 +642,7 @@ static const unsigned char* QuotedPrintableValues = reinterpret_cast<const unsig static bool requiresEscape(unsigned char input, QMailQuotedPrintableCodec::ConformanceType conformance, int charsRemaining) { // For both, we need to escape '=' and anything unprintable - bool escape = ((input > MaxPrintableRange) || + bool escape = ((input > MaxPrintableRange) || ((input < MinPrintableRange) && (input != HorizontalTab) && (input != FormFeed)) || (input == Equals)); @@ -651,7 +652,7 @@ static bool requiresEscape(unsigned char input, QMailQuotedPrintableCodec::Confo if (!escape && (conformance == QMailQuotedPrintableCodec::Rfc2047)) { // We can also ignore space, since it will become an underscore - if ((input != ExclamationMark) && (input != Asterisk) && (input != Plus) && + if ((input != ExclamationMark) && (input != Asterisk) && (input != Plus) && (input != Minus) && (input != Slash) && (input != Underscore) && (input != Space)) { escape = !isalnum(input); @@ -701,23 +702,23 @@ static inline unsigned char decodeCharacter(unsigned char value) /*! \class QMailQuotedPrintableCodec - \brief The QMailQuotedPrintableCodec class encodes or decodes between 8-bit data and 7-bit ASCII, + \brief The QMailQuotedPrintableCodec class encodes or decodes between 8-bit data and 7-bit ASCII, using the 'quoted printable' character mapping scheme. \ingroup messaginglibrary The 'quoted printable' character mapping scheme maps arbitrary 8-bit values into 7-bit ASCII characters, by replacing values that cannot be directly represented with an escape sequence. - The mapping scheme used is defined in - \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Multipurpose Internet Mail Extensions Part One). + The mapping scheme used is defined in + \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Multipurpose Internet Mail Extensions Part One). A minor variation on the scheme is defined as the '"Q" encoding' for 'encoded words' in - \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} (Multipurpose Internet Mail Extensions Part Three). + \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} (Multipurpose Internet Mail Extensions Part Three). The 'quoted printable' scheme encodes only those incoming octet values that cannot be directly - represented in ASCII, by replacing the input octet with a three-character sequence that encodes - the numeric value of the original octet. Therefore, the ratio of input length to output length - for any input data sequence depends on the percentage of the input that corresponds to ASCII - values, with ASCII-like encodings producing only small increases. With an input data encoding + represented in ASCII, by replacing the input octet with a three-character sequence that encodes + the numeric value of the original octet. Therefore, the ratio of input length to output length + for any input data sequence depends on the percentage of the input that corresponds to ASCII + values, with ASCII-like encodings producing only small increases. With an input data encoding such as Latin-1 (ISO-8859-1), the output maintains a reasonable degree of human-readability. An instance of QMailQuotedPrintableCodec contains state information about the encoding or decoding @@ -726,7 +727,7 @@ static inline unsigned char decodeCharacter(unsigned char value) \code QByteArray asciiData = acquireInput(); - // We know the data is text in Latin-1 encoding, so decode the data from + // We know the data is text in Latin-1 encoding, so decode the data from // quoted printable ASCII encoding, and then decode from Latin-1 to unicode QMailQuotedPrintableCodec decoder(QMailQuotedPrintableCodec::Text, QMailQuotedPrintableCodec::Rfc2045); QString textData = decoder.decode(asciiData, "ISO-8859-1"); @@ -738,7 +739,7 @@ static inline unsigned char decodeCharacter(unsigned char value) /*! \enum QMailQuotedPrintableCodec::ContentType - This enumerated type is used to specify whether content is textual data or binary data. + This enumerated type is used to specify whether content is textual data or binary data. \value Text The data is textual data; newline sequences within the data will be converted during coding. \value Binary The data is not textual, and does not contain newline sequences. @@ -762,11 +763,11 @@ static inline unsigned char decodeCharacter(unsigned char value) representation (0x0D 0x0A). Otherwise, the data will be coded without modification. If \a conformance is QMailQuotedPrintableCodec::Rfc2047, then coding will use the mapping - scheme of the - \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} '"Q" encoding'; otherwise the scheme defined in + scheme of the + \l{http://www.ietf.org/rfc/rfc2047.txt} {RFC 2047} '"Q" encoding'; otherwise the scheme defined in \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} will be used. - The maximum number of encoded output characters per line can be specified as \a maximumLineLength. + The maximum number of encoded output characters per line can be specified as \a maximumLineLength. If not specified, or specified to a non-positive value, a default value will be used. */ QMailQuotedPrintableCodec::QMailQuotedPrintableCodec(ContentType content, ConformanceType conformance, int maximumLineLength) @@ -774,7 +775,7 @@ QMailQuotedPrintableCodec::QMailQuotedPrintableCodec(ContentType content, Confor _conformance(conformance), _maximumLineLength(maximumLineLength) { - // We're allowed up to 76 chars per output line, but the RFC isn't really clear on + // We're allowed up to 76 chars per output line, but the RFC isn't really clear on // whether this includes the '=' and '\n' of a soft line break, so we'll assume they're counted if (_maximumLineLength <= 0) _maximumLineLength = QuotedPrintableMaxLineLength; @@ -808,7 +809,7 @@ void QMailQuotedPrintableCodec::encodeChunk(QDataStream& out, const unsigned cha { // We have already encoded this character-sequence } - else + else { // We must replace this character with ascii CRLF out << CarriageReturn << LineFeed; @@ -825,7 +826,7 @@ void QMailQuotedPrintableCodec::encodeChunk(QDataStream& out, const unsigned cha // If we can't fit this character on the line, insert a line break if (charsRequired > _encodeLineCharsRemaining) { - lineBreak(out, &_encodeLineCharsRemaining, _maximumLineLength); + lineBreak(out, &_encodeLineCharsRemaining, _maximumLineLength); // We may no longer need the encoding after the line break if (input == Space || (input == HorizontalTab && _conformance != Rfc2047)) @@ -845,7 +846,7 @@ void QMailQuotedPrintableCodec::encodeChunk(QDataStream& out, const unsigned cha _encodeLineCharsRemaining -= charsRequired; if ((_encodeLineCharsRemaining == 0) && !(finalChunk && (it == end))) - lineBreak(out, &_encodeLineCharsRemaining, _maximumLineLength); + lineBreak(out, &_encodeLineCharsRemaining, _maximumLineLength); _encodeLastChar = input; } @@ -924,7 +925,7 @@ void QMailQuotedPrintableCodec::decodeChunk(QDataStream& out, const char* it, in } } } - else + else { if ((input == CarriageReturn || input == LineFeed) && (_content == Text)) { @@ -981,7 +982,7 @@ static void writeStream(QDataStream& out, const char* it, int length) The pass-through codec is primarily useful when communicating with SMTP servers supporting the \l{http://www.ietf.org/rfc/rfc1652.txt} {RFC 1652} (8BITMIME) extension, which permits the exchange - of data without coding via 7-bit ASCII. + of data without coding via 7-bit ASCII. A QMailPassThroughCodec can be instantiated directly, but is more likely to be used polymorphically: @@ -989,7 +990,7 @@ static void writeStream(QDataStream& out, const char* it, int length) // Get an object to perform the encoding required for the current server QMailCodec* encoder = getCodecForServer(currentServer()); - // If the codec returned is a QMailPassThroughCodec, the input data will + // If the codec returned is a QMailPassThroughCodec, the input data will // be written to the output stream without encoding to 7-bit ASCII encoder->encode(outputStream, inputStream); \endcode @@ -1028,8 +1029,8 @@ void QMailPassThroughCodec::decodeChunk(QDataStream& out, const char* it, int le \ingroup messaginglibrary The QMailLineEndingCodec allows client code to use the QMailCodec interface to encode textual data - from the local line-ending convention to the CR/LF convention required for SMTP transmission. The - codec will convert from single carriage return or single line feed line-endings to CR/LF pairs, or + from the local line-ending convention to the CR/LF convention required for SMTP transmission. The + codec will convert from single carriage return or single line feed line-endings to CR/LF pairs, or will preserve data already using the correct encoding. Decoded data will have CR/LF pairs converted to \c \n. @@ -1071,7 +1072,7 @@ void QMailLineEndingCodec::encodeChunk(QDataStream& out, const unsigned char* it // We have already encoded this character-sequence; skip the input begin = (it + 1); } - else + else { // Write the preceding characters if (it > begin) diff --git a/src/messaging/win32wce/qmailid.cpp b/src/messaging/win32wce/qmailid.cpp index 48d1cff280..4068f013d8 100644 --- a/src/messaging/win32wce/qmailid.cpp +++ b/src/messaging/win32wce/qmailid.cpp @@ -60,7 +60,7 @@ MailId::MailId() MailId::MailId(quint64 value) { d = new MailIdPrivate(); - d->id = value; + d->id = value; } MailId::MailId(const MailId& other) @@ -72,7 +72,7 @@ MailId::~MailId() { } -MailId& MailId::operator=(const MailId& other) +MailId& MailId::operator=(const MailId& other) { d = other.d; return *this; @@ -127,6 +127,7 @@ QTextStream& operator<< (QTextStream& s, const MailId &id) /*! \class QMailAccountId \ingroup messaginglibrary + \since 1.1 \brief The QMailAccountId class is used to identify accounts stored by QMailStore. @@ -134,9 +135,9 @@ QTextStream& operator<< (QTextStream& s, const MailId &id) by their unique numeric internal indentifer. A QMailAccountId instance can be tested for validity, and compared to other instances - for equality. The numeric value of the identifier is not intrinsically meaningful + for equality. The numeric value of the identifier is not intrinsically meaningful and cannot be modified. - + \sa QMailAccount, QMailStore::account() */ @@ -147,7 +148,7 @@ QTextStream& operator<< (QTextStream& s, const MailId &id) Q_IMPLEMENT_USER_METATYPE(QMailAccountId); -/*! +/*! Construct an uninitialized QMailAccountId, for which isValid() returns false. */ QMailAccountId::QMailAccountId() @@ -155,7 +156,7 @@ QMailAccountId::QMailAccountId() { } -/*! +/*! Construct a QMailAccountId with the supplied numeric identifier \a value. */ QMailAccountId::QMailAccountId(quint64 value) @@ -175,7 +176,7 @@ QMailAccountId::~QMailAccountId() } /*! \internal */ -QMailAccountId& QMailAccountId::operator=(const QMailAccountId& other) +QMailAccountId& QMailAccountId::operator=(const QMailAccountId& other) { MailId::operator=(other); return *this; @@ -228,18 +229,18 @@ bool QMailAccountId::operator< (const QMailAccountId& other) const return MailId::operator<(other); } -/*! +/*! \fn QMailAccountId::serialize(Stream&) const - \internal + \internal */ template <typename Stream> void QMailAccountId::serialize(Stream &stream) const { MailId::serialize(stream); } -/*! +/*! \fn QMailAccountId::deserialize(Stream&) - \internal + \internal */ template <typename Stream> void QMailAccountId::deserialize(Stream &stream) { @@ -271,9 +272,9 @@ Q_IMPLEMENT_USER_METATYPE_TYPEDEF(QMailAccountIdList, QMailAccountIdList) by their unique numeric internal indentifer. A QMailFolderId instance can be tested for validity, and compared to other instances - for equality. The numeric value of the identifier is not intrinsically meaningful + for equality. The numeric value of the identifier is not intrinsically meaningful and cannot be modified. - + \sa QMailFolder, QMailStore::folder() */ @@ -284,7 +285,7 @@ Q_IMPLEMENT_USER_METATYPE_TYPEDEF(QMailAccountIdList, QMailAccountIdList) Q_IMPLEMENT_USER_METATYPE(QMailFolderId); -/*! +/*! Construct an uninitialized QMailFolderId, for which isValid() returns false. */ QMailFolderId::QMailFolderId() @@ -292,7 +293,7 @@ QMailFolderId::QMailFolderId() { } -/*! +/*! Construct a QMailFolderId corresponding to the predefined folder identifier \a id. */ QMailFolderId::QMailFolderId(QMailFolderFwd::PredefinedFolderId id) @@ -300,7 +301,7 @@ QMailFolderId::QMailFolderId(QMailFolderFwd::PredefinedFolderId id) { } -/*! +/*! Construct a QMailFolderId with the supplied numeric identifier \a value. */ QMailFolderId::QMailFolderId(quint64 value) @@ -320,7 +321,7 @@ QMailFolderId::~QMailFolderId() } /*! \internal */ -QMailFolderId& QMailFolderId::operator=(const QMailFolderId& other) +QMailFolderId& QMailFolderId::operator=(const QMailFolderId& other) { MailId::operator=(other); return *this; @@ -373,18 +374,18 @@ bool QMailFolderId::operator< (const QMailFolderId& other) const return MailId::operator<(other); } -/*! +/*! \fn QMailFolderId::serialize(Stream&) const - \internal + \internal */ template <typename Stream> void QMailFolderId::serialize(Stream &stream) const { MailId::serialize(stream); } -/*! +/*! \fn QMailFolderId::deserialize(Stream&) - \internal + \internal */ template <typename Stream> void QMailFolderId::deserialize(Stream &stream) { @@ -416,9 +417,9 @@ Q_IMPLEMENT_USER_METATYPE_TYPEDEF(QMailFolderIdList, QMailFolderIdList) by their unique numeric internal indentifer. A QMailMessageId instance can be tested for validity, and compared to other instances - for equality. The numeric value of the identifier is not intrinsically meaningful + for equality. The numeric value of the identifier is not intrinsically meaningful and cannot be modified. - + \sa QMailMessage, QMailStore::message() */ @@ -429,7 +430,7 @@ Q_IMPLEMENT_USER_METATYPE_TYPEDEF(QMailFolderIdList, QMailFolderIdList) Q_IMPLEMENT_USER_METATYPE(QMailMessageId); -/*! +/*! Construct an uninitialized QMailMessageId, for which isValid() returns false. */ QMailMessageId::QMailMessageId() @@ -437,7 +438,7 @@ QMailMessageId::QMailMessageId() { } -/*! +/*! Construct a QMailMessageId with the supplied numeric identifier \a value. */ QMailMessageId::QMailMessageId(quint64 value) @@ -457,7 +458,7 @@ QMailMessageId::~QMailMessageId() } /*! \internal */ -QMailMessageId& QMailMessageId::operator=(const QMailMessageId& other) +QMailMessageId& QMailMessageId::operator=(const QMailMessageId& other) { MailId::operator=(other); return *this; @@ -510,18 +511,18 @@ bool QMailMessageId::operator< (const QMailMessageId& other) const return MailId::operator<(other); } -/*! +/*! \fn QMailMessageId::serialize(Stream&) const - \internal + \internal */ template <typename Stream> void QMailMessageId::serialize(Stream &stream) const { MailId::serialize(stream); } -/*! +/*! \fn QMailMessageId::deserialize(Stream&) - \internal + \internal */ template <typename Stream> void QMailMessageId::deserialize(Stream &stream) { diff --git a/src/messaging/win32wce/qmailmessage.cpp b/src/messaging/win32wce/qmailmessage.cpp index 5cce53bacd..452a7f02b3 100644 --- a/src/messaging/win32wce/qmailmessage.cpp +++ b/src/messaging/win32wce/qmailmessage.cpp @@ -138,7 +138,7 @@ static int insensitiveIndexOf(const QByteArray& content, const QByteArray& conta const char* searchIt = it; const char* matchIt = matchBegin + 1; - do + do { if (matchIt == matchEnd) return ((it - 1) - begin); @@ -200,7 +200,7 @@ static QTextCodec* codecForName(const QByteArray& charset, bool translateAscii = { int index; - if (translateAscii && encoding.contains("ascii")) + if (translateAscii && encoding.contains("ascii")) { // We'll assume the text is plain ASCII, to be extracted to Latin-1 encoding = "ISO-8859-1"; @@ -265,7 +265,7 @@ static QMailMessageBody::TransferEncoding encodingForName(const QByteArray& name static const char* nameForEncoding(QMailMessageBody::TransferEncoding te) { - switch( te ) + switch( te ) { case QMailMessageBody::SevenBit: return "7bit"; @@ -286,7 +286,7 @@ static const char* nameForEncoding(QMailMessageBody::TransferEncoding te) static QMailCodec* codecForEncoding(QMailMessageBody::TransferEncoding te, bool textualData) { - switch( te ) + switch( te ) { case QMailMessageBody::NoEncoding: case QMailMessageBody::Binary: @@ -499,14 +499,14 @@ static QList<Token> tokenSequence(const QString& input) const QChar* it = input.constData(); const QChar* const end = it + input.length(); - if (it != end) + if (it != end) { const QChar* token = it; - EncodingTokenType state = ((*it) == '"' ? Quote : ((*it).isSpace() ? Whitespace : Word)); + EncodingTokenType state = ((*it) == '"' ? Quote : ((*it).isSpace() ? Whitespace : Word)); - for (++it; it != end; ++it) + for (++it; it != end; ++it) { - if (!escaped && (*it == '\\')) + if (!escaped && (*it == '\\')) { escaped = true; continue; @@ -517,7 +517,7 @@ static QList<Token> tokenSequence(const QString& input) // This quotation mark is a token by itself result.append(makeToken(state, token, it, escaped)); - state = ((*it) == '"' && !escaped ? Quote : ((*it).isSpace() ? Whitespace : Word)); + state = ((*it) == '"' && !escaped ? Quote : ((*it).isSpace() ? Whitespace : Word)); token = it; } else if (state == Whitespace) @@ -676,8 +676,8 @@ static QString decodeParameter(const QByteArray& encodedParameter) return decodeParameterText(parameterFormat.cap(2).toLatin1(), parameterFormat.cap(1).toLatin1()); // Treat the whole thing as input, and deafult the charset to ascii - // This is not required by the RFC, since the input is illegal. But, it - // seems ok since the parameter name has already indicated that the text + // This is not required by the RFC, since the input is illegal. But, it + // seems ok since the parameter name has already indicated that the text // should be encoded... return decodeParameterText(encodedParameter, "us-ascii"); } @@ -710,7 +710,7 @@ static QByteArray generateEncodedParameter(const QByteArray& charset, const QByt result.append('\''); result.append(lang); result.append('\''); - + // Have a guess at how long the result will be result.reserve(result.length() + (2 * text.length())); @@ -981,7 +981,7 @@ bool QMailMessageHeaderFieldPrivate::operator== (const QMailMessageHeaderFieldPr { if (!insensitiveEqual(_id, other._id)) return false; - + if (_content != other._content) return false; @@ -1062,7 +1062,7 @@ void QMailMessageHeaderFieldPrivate::setParameter(const QByteArray& name, const _parameters.erase(matches.takeFirst()); if (matches.count() == 1) it = matches.takeFirst(); - + // If the value is too long to fit on one line, break it into manageable pieces const int maxInputLength = 78 - 9 - param.length(); @@ -1090,7 +1090,7 @@ void QMailMessageHeaderFieldPrivate::setParameter(const QByteArray& name, const } } else { - // Overwrite the remaining instance of the parameter, and place any + // Overwrite the remaining instance of the parameter, and place any // following pieces immediately after int n = pieces.count() - 1; int initial = n; @@ -1212,7 +1212,7 @@ QByteArray QMailMessageHeaderFieldPrivate::toString(bool includeName, bool prese if (includeName) { result = _id + ":"; } - + if (!_content.isEmpty()) { if (includeName) result += ' '; @@ -1244,7 +1244,7 @@ static void outputHeaderPart(QDataStream& out, const QByteArray& text, int* line int wsIndex = -1; int lastIndex = -1; int preferredIndex = -1; - do + do { lastIndex = wsIndex; if ((lastIndex > 0) && (text[lastIndex - 1] == ';')) { @@ -1344,7 +1344,7 @@ QString QMailMessageHeaderFieldPrivate::decodedContent() const return result; } -template <typename Stream> +template <typename Stream> void QMailMessageHeaderFieldPrivate::serialize(Stream &stream) const { stream << _id; @@ -1353,7 +1353,7 @@ void QMailMessageHeaderFieldPrivate::serialize(Stream &stream) const stream << _parameters; } -template <typename Stream> +template <typename Stream> void QMailMessageHeaderFieldPrivate::deserialize(Stream &stream) { stream >> _id; @@ -1367,27 +1367,28 @@ void QMailMessageHeaderFieldPrivate::deserialize(Stream &stream) \class QMailMessageHeaderField \brief The QMailMessageHeaderField class encapsulates the parsing of message header fields. - + \since 1.1 + \ingroup messaginglibrary - - QMailMessageHeaderField provides simplified access to the various components of the + + QMailMessageHeaderField provides simplified access to the various components of the header field, and allows the field content to be extracted in a standardized form. - The content of a header field may be formed of unstructured text, or it may have an - internal structure. If a structured field is specified, QMailMessageHeaderField assumes - that the contained header field is structured in a format equivalent to that used for the - RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. If the field + The content of a header field may be formed of unstructured text, or it may have an + internal structure. If a structured field is specified, QMailMessageHeaderField assumes + that the contained header field is structured in a format equivalent to that used for the + RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. If the field is unstructured, or conforms to a different structure, then the parameter() and parameters() functions will return empty results, and the setParameter() function will have no effect. QMailMessageHeaderField contains static functions to assist in creating correct - header field content, and presenting header field content. The encodeWord() and + header field content, and presenting header field content. The encodeWord() and decodeWord() functions translate between plain text and the encoded-word specification defined in RFC 2045. The encodeParameter() and decodeParameter() functions translate between plain text and the encoded-parameter format defined in RFC 2231. The removeWhitespace() function can be used to remove irrelevant whitespace characters - from a string, and the removeComments() function can remove any comment sequences + from a string, and the removeComments() function can remove any comment sequences present, encododed according to the RFC 2822 specification. */ @@ -1410,9 +1411,9 @@ QMailMessageHeaderField::QMailMessageHeaderField() } /*! - Creates a message header field object from the data in \a text. If \a fieldType is - QMailMessageHeaderField::StructuredField, then \a text will be parsed assuming a - format equivalent to that used for the RFC 2045 'Content-Type' and + Creates a message header field object from the data in \a text. If \a fieldType is + QMailMessageHeaderField::StructuredField, then \a text will be parsed assuming a + format equivalent to that used for the RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. */ QMailMessageHeaderField::QMailMessageHeaderField(const QByteArray& text, FieldType fieldType) @@ -1421,9 +1422,9 @@ QMailMessageHeaderField::QMailMessageHeaderField(const QByteArray& text, FieldTy } /*! - Creates a message header field object with the field id \a id and the content - data in \a text. If \a fieldType is QMailMessageHeaderField::StructuredField, - then \a text will be parsed assuming a format equivalent to that used for the + Creates a message header field object with the field id \a id and the content + data in \a text. If \a fieldType is QMailMessageHeaderField::StructuredField, + then \a text will be parsed assuming a format equivalent to that used for the RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. */ QMailMessageHeaderField::QMailMessageHeaderField(const QByteArray& id, const QByteArray& text, FieldType fieldType) @@ -1478,7 +1479,7 @@ void QMailMessageHeaderField::setContent(const QByteArray& text) } /*! - Returns the value of the parameter with the name \a name. + Returns the value of the parameter with the name \a name. Name comparisons are case-insensitive. */ QByteArray QMailMessageHeaderField::parameter(const QByteArray& name) const @@ -1487,7 +1488,7 @@ QByteArray QMailMessageHeaderField::parameter(const QByteArray& name) const } /*! - Sets the parameter with the name \a name to have the value \a value, if present; + Sets the parameter with the name \a name to have the value \a value, if present; otherwise a new parameter is appended with the supplied properties. If \a name ends with a single asterisk, the parameter will be flagged as encoded. @@ -1499,8 +1500,8 @@ void QMailMessageHeaderField::setParameter(const QByteArray& name, const QByteAr } /*! - Returns true if the parameter with name \a name exists and is marked as encoded - according to RFC 2231; otherwise returns false. + Returns true if the parameter with name \a name exists and is marked as encoded + according to RFC 2231; otherwise returns false. Name comparisons are case-insensitive. */ bool QMailMessageHeaderField::isParameterEncoded(const QByteArray& name) const @@ -1528,9 +1529,9 @@ QList<QMailMessageHeaderField::ParameterType> QMailMessageHeaderField::parameter /*! Returns the entire header field text as a formatted string, with the name of the field - included if \a includeName is true. If \a presentable is true, artifacts of RFC 2822 - transmission format such as parameter folding will be removed. For example: - + included if \a includeName is true. If \a presentable is true, artifacts of RFC 2822 + transmission format such as parameter folding will be removed. For example: + \code QMailMessageHeaderField hdr; hdr.setId("Content-Type"); @@ -1562,7 +1563,7 @@ void QMailMessageHeaderField::parse(const QByteArray& text, FieldType fieldType) /*! Returns the content of the string \a input encoded into a series of RFC 2045 'encoded-word' - format tokens, each no longer than 75 characters. The encoding used can be specified in + format tokens, each no longer than 75 characters. The encoding used can be specified in \a charset, or can be deduced from the content of \a input if \a charset is empty. */ QByteArray QMailMessageHeaderField::encodeWord(const QString& input, const QByteArray& charset) @@ -1581,9 +1582,9 @@ QString QMailMessageHeaderField::decodeWord(const QByteArray& input) /*! Returns the content of the string \a input encoded into RFC 2231 'extended-parameter' - format. The encoding used can be specified in \a charset, or can be deduced from the - content of \a input if \a charset is empty. If \a language is non-empty, it will be - included in the encoded output; otherwise the language component will be extracted from + format. The encoding used can be specified in \a charset, or can be deduced from the + content of \a input if \a charset is empty. If \a language is non-empty, it will be + included in the encoded output; otherwise the language component will be extracted from \a charset, if it contains a trailing language specifier as defined in RFC 2231. */ QByteArray QMailMessageHeaderField::encodeParameter(const QString& input, const QByteArray& charset, const QByteArray& language) @@ -1627,7 +1628,7 @@ QByteArray QMailMessageHeaderField::removeComments(const QByteArray& input) } /*! - Returns the content of \a input with any whitespace characters removed. + Returns the content of \a input with any whitespace characters removed. Whitespace inside double quotes is preserved. */ QByteArray QMailMessageHeaderField::removeWhitespace(const QByteArray& input) @@ -1646,7 +1647,7 @@ QByteArray QMailMessageHeaderField::removeWhitespace(const QByteArray& input) if (quoted || !isspace(*it)) result.append(*it); } - + return result; } @@ -1656,21 +1657,21 @@ void QMailMessageHeaderField::output(QDataStream& out) const impl(this)->output(out); } -/*! +/*! \fn QMailMessageHeaderField::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageHeaderField::serialize(Stream &stream) const { impl(this)->serialize(stream); } -/*! +/*! \fn QMailMessageHeaderField::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageHeaderField::deserialize(Stream &stream) { impl(this)->deserialize(stream); @@ -1682,10 +1683,10 @@ void QMailMessageHeaderField::deserialize(Stream &stream) \brief The QMailMessageContentType class encapsulates the parsing of the RFC 2822 'Content-Type' header field. - + \ingroup messaginglibrary - - QMailMessageContentType provides simplified access to the various components of the + + QMailMessageContentType provides simplified access to the various components of the 'Content-Type' header field. Components of the header field not exposed by member functions can be accessed using the functions inherited from QMailMessageHeaderField. @@ -1751,7 +1752,7 @@ QByteArray QMailMessageContentType::type() const } /*! - Sets the primary type information of the 'Content-Type' header field to \a type. If \a type + Sets the primary type information of the 'Content-Type' header field to \a type. If \a type is empty, then any pre-existing sub-type information will be cleared. \sa setSubType() @@ -1874,10 +1875,10 @@ void QMailMessageContentType::setCharset(const QByteArray& charset) \brief The QMailMessageContentDisposition class encapsulates the parsing of the RFC 2822 'Content-Disposition' header field. - + \ingroup messaginglibrary - - QMailMessageContentDisposition provides simplified access to the various components of the + + QMailMessageContentDisposition provides simplified access to the various components of the 'Content-Disposition' header field. Components of the header field not exposed by member functions can be accessed using the functions inherited from QMailMessageHeaderField. @@ -2230,13 +2231,13 @@ void QMailMessageHeaderPrivate::output(QDataStream& out, const QList<QByteArray> } } -template <typename Stream> +template <typename Stream> void QMailMessageHeaderPrivate::serialize(Stream &stream) const { stream << _headerFields; } -template <typename Stream> +template <typename Stream> void QMailMessageHeaderPrivate::deserialize(Stream &stream) { stream >> _headerFields; @@ -2303,21 +2304,21 @@ void QMailMessageHeader::output(QDataStream& out, const QList<QByteArray>& exclu impl(this)->output(out, exclusions, excludeInternalFields); } -/*! +/*! \fn QMailMessageHeader::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageHeader::serialize(Stream &stream) const { impl(this)->serialize(stream); } -/*! +/*! \fn QMailMessageHeader::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageHeader::deserialize(Stream &stream) { impl(this)->deserialize(stream); @@ -2358,7 +2359,7 @@ void QMailMessageBodyPrivate::fromStream(QDataStream& in, const QMailMessageCont _encoded = true; _filename = QString(); _bodyData = LongString(); - + // If the data is already encoded, we don't need to do it again if (status == QMailMessageBody::AlreadyEncoded) te = QMailMessageBody::SevenBit; @@ -2575,7 +2576,7 @@ bool QMailMessageBodyPrivate::toStream(QTextStream& out) const bool result = false; if (!_encoded && !_filename.isEmpty() && unicodeConvertingCharset(charset)) - { + { // The data is already in unicode format QTextStream* in = _bodyData.textStream(); in->setCodec(charset); @@ -2630,7 +2631,7 @@ void QMailMessageBodyPrivate::output(QDataStream& out, bool includeAttachments) toStream( out, QMailMessageBody::Encoded ); } -template <typename Stream> +template <typename Stream> void QMailMessageBodyPrivate::serialize(Stream &stream) const { stream << _encoding; @@ -2640,7 +2641,7 @@ void QMailMessageBodyPrivate::serialize(Stream &stream) const stream << _type; } -template <typename Stream> +template <typename Stream> void QMailMessageBodyPrivate::deserialize(Stream &stream) { stream >> _encoding; @@ -2655,9 +2656,9 @@ void QMailMessageBodyPrivate::deserialize(Stream &stream) \class QMailMessageBody \brief The QMailMessageBody class contains the body element of a message or message part. - + \ingroup messaginglibrary - + The body of a message or message part is treated as an atomic unit by the Qt Extended messaging library. It can only be inserted into a message part container or extracted from one. It can be inserted or extracted using either a QByteArray, a QDataStream or to/from a file. In the case of unicode text data, the insertion and extraction can @@ -2666,30 +2667,30 @@ void QMailMessageBodyPrivate::deserialize(Stream &stream) The body data must be associated with a QMailMessageContentType describing that data. When extracting body data from a message or part to unicode text, the content type description must include a parameter named 'charset'; this parameter is used to locate - a QTextCodec to be used to extract unicode data from the body data octet stream. - - If the Content-Type of the data is a subtype of "text", then line-ending translation - will be used to ensure that the text is transmitted with CR/LF line endings. The text - data supplied to QMailMessageBody must conform to the RFC 2822 restrictions on maximum - line lengths: "Each line of characters MUST be no more than 998 characters, and SHOULD - be no more than 78 characters, excluding the CRLF." Textual message body data decoded - from a QMailMessageBody object will have transmitted CR/LF line endings converted to + a QTextCodec to be used to extract unicode data from the body data octet stream. + + If the Content-Type of the data is a subtype of "text", then line-ending translation + will be used to ensure that the text is transmitted with CR/LF line endings. The text + data supplied to QMailMessageBody must conform to the RFC 2822 restrictions on maximum + line lengths: "Each line of characters MUST be no more than 998 characters, and SHOULD + be no more than 78 characters, excluding the CRLF." Textual message body data decoded + from a QMailMessageBody object will have transmitted CR/LF line endings converted to \c \n on extraction. The body data can also be encoded from 8-bit octets to 7-bit ASCII characters for - safe transmission through obsolete email systems. When creating an instance of the - QMailMessageBody class, the encoding to be used must be specified using the + safe transmission through obsolete email systems. When creating an instance of the + QMailMessageBody class, the encoding to be used must be specified using the QMailMessageBody::TransferEncoding enum. \sa QMailMessagePart, QMailMessage, QTextCodec -*/ +*/ /*! \typedef QMailMessageBody::ImplementationType \internal */ -/*! +/*! Creates an instance of QMailMessageBody. */ QMailMessageBody::QMailMessageBody() @@ -2698,13 +2699,13 @@ QMailMessageBody::QMailMessageBody() } /*! - Creates a message body from the data contained in the file \a filename, having the content type - \a type. If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be + Creates a message body from the data contained in the file \a filename, having the content type + \a type. If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be encoded to \a encoding for transmission; otherwise it must already be in that encoding, which will be reported to recipients of the data. If \a type is a subtype of "text", the data will be treated as text, and line-ending - translation will be employed. Otherwise, the file will be treated as containing binary + translation will be employed. Otherwise, the file will be treated as containing binary data. If the file contains unicode text data, it will be converted to an octet stream using a QTextCodec object identified by the 'charset' parameter of \a type. @@ -2723,13 +2724,13 @@ QMailMessageBody QMailMessageBody::fromFile(const QString& filename, const QMail } /*! - Creates a message body from the data read from \a in, having the content type \a type. - If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be - encoded to \a encoding for transmission; otherwise it must already be in that encoding, + Creates a message body from the data read from \a in, having the content type \a type. + If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be + encoded to \a encoding for transmission; otherwise it must already be in that encoding, which will be reported to recipients of the data. If \a type is a subtype of "text", the data will be treated as text, and line-ending - translation will be employed. Otherwise, the file will be treated as containing binary + translation will be employed. Otherwise, the file will be treated as containing binary data. If \a encoding is QMailMessageBody::QuotedPrintable, encoding will be performed assuming @@ -2745,13 +2746,13 @@ QMailMessageBody QMailMessageBody::fromStream(QDataStream& in, const QMailMessag } /*! - Creates a message body from the data contained in \a input, having the content type - \a type. If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be - encoded to \a encoding for transmission; otherwise it must already be in that encoding, + Creates a message body from the data contained in \a input, having the content type + \a type. If \a status is QMailMessageBody::RequiresEncoding, the data from the file will be + encoded to \a encoding for transmission; otherwise it must already be in that encoding, which will be reported to recipients of the data. If \a type is a subtype of "text", the data will be treated as text, and line-ending - translation will be employed. Otherwise, the file will be treated as containing binary + translation will be employed. Otherwise, the file will be treated as containing binary data. If \a encoding is QMailMessageBody::QuotedPrintable, encoding will be performed assuming @@ -2770,9 +2771,9 @@ QMailMessageBody QMailMessageBody::fromData(const QByteArray& input, const QMail } /*! - Creates a message body from the data read from \a in, having the content type \a type. + Creates a message body from the data read from \a in, having the content type \a type. The data read from \a in will be encoded to \a encoding for transmission, and line-ending - translation will be employed. The unicode text data will be converted to an octet stream + translation will be employed. The unicode text data will be converted to an octet stream using a QTextCodec object identified by the 'charset' parameter of \a type. If \a encoding is QMailMessageBody::QuotedPrintable, encoding will be performed assuming @@ -2788,9 +2789,9 @@ QMailMessageBody QMailMessageBody::fromStream(QTextStream& in, const QMailMessag } /*! - Creates a message body from the data contained in \a input, having the content type - \a type. The data from \a input will be encoded to \a encoding for transmission, and - line-ending translation will be employed. The unicode text data will be converted to + Creates a message body from the data contained in \a input, having the content type + \a type. The data from \a input will be encoded to \a encoding for transmission, and + line-ending translation will be employed. The unicode text data will be converted to an octet stream using a QTextCodec object identified by the 'charset' parameter of \a type. If \a encoding is QMailMessageBody::QuotedPrintable, encoding will be performed assuming @@ -2822,8 +2823,8 @@ QMailMessageBody QMailMessageBody::fromLongString(LongString& ls, const QMailMes QMailMessageBody::Encoded, then the data is written in the transfer encoding it was created with; otherwise, it is written in unencoded form. - If the body has a content type with a QMailMessageContentType::type() of "text", and the - content type parameter 'charset' is not empty, then the unencoded data will be written + If the body has a content type with a QMailMessageContentType::type() of "text", and the + content type parameter 'charset' is not empty, then the unencoded data will be written as unicode text data, using the charset parameter to locate the appropriate QTextCodec. Returns false if the operation causes an error; otherwise returns true. @@ -2870,7 +2871,7 @@ bool QMailMessageBody::toStream(QDataStream& out, EncodingFormat format) const Returns the data of the message body as a QString, in unencoded form. Line-endings transmitted as CR/LF pairs are converted to \c \n on extraction. - The 'charset' parameter of the body's content type is used to locate the appropriate + The 'charset' parameter of the body's content type is used to locate the appropriate QTextCodec to convert the data from an octet stream to unicode, if necessary. \sa QMailCodec, QMailMessageContentType, QTextCodec @@ -2886,11 +2887,11 @@ QString QMailMessageBody::data() const } /*! - Writes the data of the message body to the stream \a out, in unencoded form. + Writes the data of the message body to the stream \a out, in unencoded form. Line-endings transmitted as CR/LF pairs are converted to \c \n on extraction. Returns false if the operation causes an error; otherwise returns true. - The 'charset' parameter of the body's content type is used to locate the appropriate + The 'charset' parameter of the body's content type is used to locate the appropriate QTextCodec to convert the data from an octet stream to unicode, if necessary. \sa QMailCodec, QMailMessageContentType, QTextCodec @@ -2944,21 +2945,21 @@ void QMailMessageBody::output(QDataStream& out, bool includeAttachments) const impl(this)->output(out, includeAttachments); } -/*! +/*! \fn QMailMessageBody::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageBody::serialize(Stream &stream) const { impl(this)->serialize(stream); } -/*! +/*! \fn QMailMessageBody::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageBody::deserialize(Stream &stream) { impl(this)->deserialize(stream); @@ -3006,8 +3007,8 @@ int QMailMessagePartContainerPrivate::partNumber() const bool QMailMessagePartContainerPrivate::contains(const QMailMessagePart::Location& location) const { - const QMailMessagePart* part = 0; - const QList<QMailMessagePart>* partList = &_messageParts; + const QMailMessagePart* part = 0; + const QList<QMailMessagePart>* partList = &_messageParts; foreach (uint index, location.d->_indices) { if (partList->count() < index) { @@ -3023,8 +3024,8 @@ bool QMailMessagePartContainerPrivate::contains(const QMailMessagePart::Location const QMailMessagePart& QMailMessagePartContainerPrivate::partAt(const QMailMessagePart::Location& location) const { - const QMailMessagePart* part = 0; - const QList<QMailMessagePart>* partList = &_messageParts; + const QMailMessagePart* part = 0; + const QList<QMailMessagePart>* partList = &_messageParts; foreach (uint index, location.d->_indices) { part = &(partList->at(index - 1)); @@ -3037,8 +3038,8 @@ const QMailMessagePart& QMailMessagePartContainerPrivate::partAt(const QMailMess QMailMessagePart& QMailMessagePartContainerPrivate::partAt(const QMailMessagePart::Location& location) { - QMailMessagePart* part = 0; - QList<QMailMessagePart>* partList = &_messageParts; + QMailMessagePart* part = 0; + QList<QMailMessagePart>* partList = &_messageParts; foreach (uint index, location.d->_indices) { part = &((*partList)[index - 1]); @@ -3593,7 +3594,7 @@ void QMailMessagePartContainerPrivate::setDirty(bool value, bool recursive) } } -template <typename Stream> +template <typename Stream> void QMailMessagePartContainerPrivate::serialize(Stream &stream) const { stream << _multipartType; @@ -3608,7 +3609,7 @@ void QMailMessagePartContainerPrivate::serialize(Stream &stream) const stream << _dirty; } -template <typename Stream> +template <typename Stream> void QMailMessagePartContainerPrivate::deserialize(Stream &stream) { stream >> _multipartType; @@ -3628,27 +3629,27 @@ void QMailMessagePartContainerPrivate::deserialize(Stream &stream) \class QMailMessagePartContainer \brief The QMailMessagePartContainer class provides access to a collection of message parts. - + \ingroup messaginglibrary - - Message formats such as email messages conforming to - \l{http://www.ietf.org/rfc/rfc2822.txt} {RFC 2822} (Internet Message Format) can consist of - multiple independent parts, whose relationship to each other is defined by the message that - contains those parts. The QMailMessagePartContainer class provides storage for these related + + Message formats such as email messages conforming to + \l{http://www.ietf.org/rfc/rfc2822.txt} {RFC 2822} (Internet Message Format) can consist of + multiple independent parts, whose relationship to each other is defined by the message that + contains those parts. The QMailMessagePartContainer class provides storage for these related message parts, and the interface through which they are accessed. - The multipartType() function returns a member of the MultipartType enumeration, which + The multipartType() function returns a member of the MultipartType enumeration, which describes the relationship of the parts in the container to each other. The part container can instead contain a message body element. In this case, it cannot contain - sub-parts, and the multipartType() function will return MultipartType::MultipartNone for the part. + sub-parts, and the multipartType() function will return MultipartType::MultipartNone for the part. The body element can be accessed via the body() function. The QMailMessagePart class is itself derived from QMailMessagePartContainer, which allows messages to support the nesting of part collections within other part collections. \sa QMailMessagePart, QMailMessage, QMailMessageBody -*/ +*/ /*! \typedef QMailMessagePartContainer::ImplementationType @@ -3658,7 +3659,7 @@ void QMailMessagePartContainerPrivate::deserialize(Stream &stream) /*! \fn QMailMessagePartContainer::QMailMessagePartContainer(Subclass*) - Constructs an empty part container object, in the space allocated + Constructs an empty part container object, in the space allocated within the subclass instance at \a p. */ template<typename Subclass> @@ -3675,7 +3676,7 @@ void QMailMessagePartContainer::setHeader(const QMailMessageHeader& partHeader, /*! Returns the number of attachments the message has. -*/ +*/ uint QMailMessagePartContainer::partCount() const { return impl(this)->_messageParts.count(); @@ -3708,7 +3709,7 @@ void QMailMessagePartContainer::removePartAt(uint pos) } /*! - Returns a const reference to the item at position \a pos in the list of + Returns a const reference to the item at position \a pos in the list of attachments for the message. \a pos must be a valid index position in the list (i.e., 0 <= i < partCount()). @@ -3719,7 +3720,7 @@ const QMailMessagePart& QMailMessagePartContainer::partAt(uint pos) const } /*! - Returns a non-const reference to the item at position \a pos in the list of + Returns a non-const reference to the item at position \a pos in the list of attachments for the message. \a pos must be a valid index position in the list (i.e., 0 <= i < partCount()). @@ -3740,7 +3741,7 @@ void QMailMessagePartContainer::clearParts() /*! Returns the type of multipart relationship shared by the parts contained within this container, or \l {QMailMessagePartContainerFwd::MultipartNone}{MultipartNone} if the content is not a multipart message. -*/ +*/ QMailMessagePartContainer::MultipartType QMailMessagePartContainer::multipartType() const { return impl(this)->_multipartType; @@ -3796,7 +3797,7 @@ bool QMailMessagePartContainer::hasBody() const /*! Returns the content type of this part. Where hasBody() is true, the type of the - contained body element is returned; otherwise a content type matching the + contained body element is returned; otherwise a content type matching the multipartType() for this part is returned. \sa hasBody(), QMailMessageBody::contentType(), multipartType() @@ -3809,7 +3810,7 @@ QMailMessageContentType QMailMessagePartContainer::contentType() const /*! Returns the transfer encoding type of this part. Where hasBody() is true, the transfer encoding type of the contained body element is returned; otherwise, the - transfer encoding type specified by the 'Content-Transfer-Encoding' field of the + transfer encoding type specified by the 'Content-Transfer-Encoding' field of the header for this part is returned. \sa hasBody(), QMailMessageBody::transferEncoding() @@ -3829,8 +3830,8 @@ QString QMailMessagePartContainer::headerFieldText( const QString &id ) const /*! Returns an object containing the value of the first header field with the given \a id. - If \a fieldType is QMailMessageHeaderField::StructuredField, then the field content - will be parsed assuming a format equivalent to that used for the RFC 2045 'Content-Type' + If \a fieldType is QMailMessageHeaderField::StructuredField, then the field content + will be parsed assuming a format equivalent to that used for the RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. */ QMailMessageHeaderField QMailMessagePartContainer::headerField( const QString &id, QMailMessageHeaderField::FieldType fieldType ) const @@ -3858,8 +3859,8 @@ QStringList QMailMessagePartContainer::headerFieldsText( const QString &id ) con /*! Returns a list of objects containing the value of each header field with the given \a id. - If \a fieldType is QMailMessageHeaderField::StructuredField, then the field content will - be parsed assuming a format equivalent to that used for the RFC 2045 'Content-Type' and + If \a fieldType is QMailMessageHeaderField::StructuredField, then the field content will + be parsed assuming a format equivalent to that used for the RFC 2045 'Content-Type' and RFC 2183 'Content-Disposition' header fields. */ QList<QMailMessageHeaderField> QMailMessagePartContainer::headerFields( const QString &id, QMailMessageHeaderField::FieldType fieldType ) const @@ -3888,14 +3889,14 @@ QList<QMailMessageHeaderField> QMailMessagePartContainer::headerFields() const } /*! - Sets the value of the first header field with identity \a id to \a value if it already - exists; otherwise adds the header with the supplied id and value. If \a value is of + Sets the value of the first header field with identity \a id to \a value if it already + exists; otherwise adds the header with the supplied id and value. If \a value is of the form "<id>:<content>", then only the part after the semi-colon is processed. - RFC 2822 encoding requires header fields to be transmitted in ASCII characters. - If \a value contains non-ASCII characters, it will be encoded to ASCII via the - QMailMessageHeaderField::encodeContent() function; depending on the specific header - field this may result in illegal content. Where possible, clients should encode + RFC 2822 encoding requires header fields to be transmitted in ASCII characters. + If \a value contains non-ASCII characters, it will be encoded to ASCII via the + QMailMessageHeaderField::encodeContent() function; depending on the specific header + field this may result in illegal content. Where possible, clients should encode non-ASCII data prior to calling setHeaderField. \sa QMailMessageHeaderField @@ -3929,13 +3930,13 @@ void QMailMessagePartContainer::setHeaderField( const QMailMessageHeaderField& f /*! Appends a new header field with id \a id and value \a value to the existing list of header fields. Any existing header fields with the same id are not modified. - If \a value is of the form "<id>:<content>", then only the part after the + If \a value is of the form "<id>:<content>", then only the part after the semi-colon is processed. - RFC 2822 encoding requires header fields to be transmitted in ASCII characters. - If \a value contains non-ASCII characters, it will be encoded to ASCII via the - QMailMessageHeaderField::encodeContent() function; depending on the specific header - field this may result in illegal content. Where possible, clients should encode + RFC 2822 encoding requires header fields to be transmitted in ASCII characters. + If \a value contains non-ASCII characters, it will be encoded to ASCII via the + QMailMessageHeaderField::encodeContent() function; depending on the specific header + field this may result in illegal content. Where possible, clients should encode non-ASCII data prior to calling appendHeaderField. \sa QMailMessageHeaderField @@ -3958,7 +3959,7 @@ void QMailMessagePartContainer::appendHeaderField( const QString& id, const QStr } /*! - Appends a new header field with the properties of \a field. Any existing header + Appends a new header field with the properties of \a field. Any existing header fields with the same id are not modified. */ void QMailMessagePartContainer::appendHeaderField( const QMailMessageHeaderField& field ) @@ -4016,7 +4017,7 @@ QMailMessagePartContainer::MultipartType QMailMessagePartContainer::multipartTyp */ QByteArray QMailMessagePartContainer::nameForMultipartType(QMailMessagePartContainer::MultipartType type) { - switch (type) + switch (type) { case QMailMessagePartContainer::MultipartSigned: { @@ -4109,7 +4110,7 @@ QMailMessagePart::ReferenceType QMailMessagePartPrivate::referenceType() const { if (_referenceId.isValid()) return QMailMessagePart::MessageReference; - + if (_referenceLocation.isValid()) return QMailMessagePart::PartReference; @@ -4189,7 +4190,7 @@ void QMailMessagePartPrivate::output(QDataStream **out, bool addMimePreamble, bo } } -template <typename Stream> +template <typename Stream> void QMailMessagePartPrivate::serialize(Stream &stream) const { QMailMessagePartContainerPrivate::serialize(stream); @@ -4199,7 +4200,7 @@ void QMailMessagePartPrivate::serialize(Stream &stream) const stream << _resolution; } -template <typename Stream> +template <typename Stream> void QMailMessagePartPrivate::deserialize(Stream &stream) { QMailMessagePartContainerPrivate::deserialize(stream); @@ -4209,16 +4210,16 @@ void QMailMessagePartPrivate::deserialize(Stream &stream) stream >> _resolution; } -void QMailMessagePartPrivate::setReference(const QMailMessageId &id, - const QMailMessageContentType& type, +void QMailMessagePartPrivate::setReference(const QMailMessageId &id, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { _referenceId = id; setBodyProperties(type, encoding); } -void QMailMessagePartPrivate::setReference(const QMailMessagePart::Location &location, - const QMailMessageContentType& type, +void QMailMessagePartPrivate::setReference(const QMailMessagePart::Location &location, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { _referenceLocation = location; @@ -4244,7 +4245,7 @@ QMailMessagePartContainerPrivate* QMailMessagePartContainerPrivate::privatePoint /*! \fn bool QMailMessagePartContainer::foreachPart(F func) - + Applies the function or functor \a func to each part contained within the container. \a func must implement the signature 'bool operator()(QMailMessagePart &)', and must return true to indicate success, or false to end the traversal operation. @@ -4255,7 +4256,7 @@ QMailMessagePartContainerPrivate* QMailMessagePartContainerPrivate::privatePoint /*! \fn bool QMailMessagePartContainer::foreachPart(F func) const - + Applies the function or functor \a func to each part contained within the container. \a func must implement the signature 'bool operator()(const QMailMessagePart &)', and must return true to indicate success, or false to end the traversal operation. @@ -4271,21 +4272,21 @@ QMailMessagePartContainerPrivate* QMailMessagePartContainerPrivate::privatePoint /*! \class QMailMessagePart - \brief The QMailMessagePart class provides a convenient interface for working + \brief The QMailMessagePart class provides a convenient interface for working with message attachments. \ingroup messaginglibrary - - A message part inherits the properties of QMailMessagePartContainer, and can - therefore contain a message body or a collection of sub-parts. - - A message part differs from a message proper in that a part will often have - properties specified by the MIME multipart specification, not relevant to - messages. These include the 'name' and 'filename' parameters of the Content-Type + + A message part inherits the properties of QMailMessagePartContainer, and can + therefore contain a message body or a collection of sub-parts. + + A message part differs from a message proper in that a part will often have + properties specified by the MIME multipart specification, not relevant to + messages. These include the 'name' and 'filename' parameters of the Content-Type and Content-Disposition fields, and the Content-Id and Content-Location fields. A message part may consist entirely of a reference to an external message, or - a part within an external message. Parts that consists of references may be + a part within an external message. Parts that consists of references may be used with some protocols that permit data to be transmitted by reference, such as IMAP with the URLAUTH extension. Not all messaging protocols support the use of content references. The partReference() and messageReference() functions @@ -4307,9 +4308,9 @@ QMailMessagePartContainerPrivate* QMailMessagePartContainerPrivate::privatePoint with the message that contains it. \ingroup messaginglibrary - + A Location object is used to refer to a single part within a multi-part message. The - location can be used to reference a part within a QMailMessage object, via the + location can be used to reference a part within a QMailMessage object, via the \l{QMailMessage::partAt()}{partAt} function. */ @@ -4384,7 +4385,7 @@ const QMailMessagePart::Location &QMailMessagePart::Location::operator=(const QM return *this; } -/*! +/*! Returns true if the location object contains the location of a valid message part. If \a extended is true, the location must also contain a valid message identifier. */ @@ -4393,7 +4394,7 @@ bool QMailMessagePart::Location::isValid(bool extended) const return ((!extended || d->_messageId.isValid()) && !d->_indices.isEmpty()); } -/*! +/*! Returns the identifier of the message that contains the part with this location. */ QMailMessageId QMailMessagePart::Location::containingMessageId() const @@ -4401,7 +4402,7 @@ QMailMessageId QMailMessagePart::Location::containingMessageId() const return d->_messageId; } -/*! +/*! Sets the identifier of the message that contains the part with this location to \a id. */ void QMailMessagePart::Location::setContainingMessageId(const QMailMessageId &id) @@ -4426,11 +4427,11 @@ QString QMailMessagePart::Location::toString(bool extended) const return result.append(numbers.join(".")); } -/*! +/*! \fn QMailMessagePart::Location::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessagePart::Location::serialize(Stream &stream) const { stream << d->_messageId; @@ -4439,11 +4440,11 @@ void QMailMessagePart::Location::serialize(Stream &stream) const template void QMailMessagePart::Location::serialize(QDataStream &) const; -/*! +/*! \fn QMailMessagePart::Location::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessagePart::Location::deserialize(Stream &stream) { stream >> d->_messageId; @@ -4461,16 +4462,16 @@ QMailMessagePart::QMailMessagePart() } /*! - Creates a QMailMessagePart containing an attachment of type \a disposition, from the + Creates a QMailMessagePart containing an attachment of type \a disposition, from the data contained in \a filename, of content type \a type and using the transfer encoding \a encoding. The current status of the data is specified as \a status. \sa QMailMessageBody::fromFile() */ QMailMessagePart QMailMessagePart::fromFile(const QString& filename, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, - QMailMessageBody::TransferEncoding encoding, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, + QMailMessageBody::TransferEncoding encoding, QMailMessageBody::EncodingStatus status) { QMailMessagePart part; @@ -4481,16 +4482,16 @@ QMailMessagePart QMailMessagePart::fromFile(const QString& filename, } /*! - Creates a QMailMessagePart containing an attachment of type \a disposition, from the + Creates a QMailMessagePart containing an attachment of type \a disposition, from the data read from \a in, of content type \a type and using the transfer encoding \a encoding. The current status of the data is specified as \a status. \sa QMailMessageBody::fromStream() */ QMailMessagePart QMailMessagePart::fromStream(QDataStream& in, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, - QMailMessageBody::TransferEncoding encoding, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, + QMailMessageBody::TransferEncoding encoding, QMailMessageBody::EncodingStatus status) { QMailMessagePart part; @@ -4501,16 +4502,16 @@ QMailMessagePart QMailMessagePart::fromStream(QDataStream& in, } /*! - Creates a QMailMessagePart containing an attachment of type \a disposition, from the + Creates a QMailMessagePart containing an attachment of type \a disposition, from the data contained in \a input, of content type \a type and using the transfer encoding \a encoding. The current status of the data is specified as \a status. \sa QMailMessageBody::fromData() */ QMailMessagePart QMailMessagePart::fromData(const QByteArray& input, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, - QMailMessageBody::TransferEncoding encoding, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, + QMailMessageBody::TransferEncoding encoding, QMailMessageBody::EncodingStatus status) { QMailMessagePart part; @@ -4521,15 +4522,15 @@ QMailMessagePart QMailMessagePart::fromData(const QByteArray& input, } /*! - Creates a QMailMessagePart containing an attachment of type \a disposition, from the + Creates a QMailMessagePart containing an attachment of type \a disposition, from the data read from \a in, of content type \a type and using the transfer encoding \a encoding. \sa QMailMessageBody::fromStream() */ QMailMessagePart QMailMessagePart::fromStream(QTextStream& in, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { QMailMessagePart part; @@ -4540,15 +4541,15 @@ QMailMessagePart QMailMessagePart::fromStream(QTextStream& in, } /*! - Creates a QMailMessagePart containing an attachment of type \a disposition, from the + Creates a QMailMessagePart containing an attachment of type \a disposition, from the data contained in \a input, of content type \a type and using the transfer encoding \a encoding. \sa QMailMessageBody::fromData() */ QMailMessagePart QMailMessagePart::fromData(const QString& input, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { QMailMessagePart part; @@ -4560,16 +4561,16 @@ QMailMessagePart QMailMessagePart::fromData(const QString& input, /*! Creates a QMailMessagePart containing an attachment of type \a disposition, whose - content is a reference to the message identified by \a messageId. The resulting + content is a reference to the message identified by \a messageId. The resulting part has content type \a type and uses the transfer encoding \a encoding. - - The message reference can only be resolved by transmitting the message to an external - server, where both the originating server of the referenced message and the receiving + + The message reference can only be resolved by transmitting the message to an external + server, where both the originating server of the referenced message and the receiving server of the new message support resolution of the content reference. */ QMailMessagePart QMailMessagePart::fromMessageReference(const QMailMessageId &messageId, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { QMailMessagePart part; @@ -4581,16 +4582,16 @@ QMailMessagePart QMailMessagePart::fromMessageReference(const QMailMessageId &me /*! Creates a QMailMessagePart containing an attachment of type \a disposition, whose - content is a reference to the message part identified by \a partLocation. The + content is a reference to the message part identified by \a partLocation. The resulting part has content type \a type and uses the transfer encoding \a encoding. - - The part reference can only be resolved by transmitting the message to an external - server, where both the originating server of the referenced part's message and the + + The part reference can only be resolved by transmitting the message to an external + server, where both the originating server of the referenced part's message and the receiving server of the new message support resolution of the content reference. */ QMailMessagePart QMailMessagePart::fromPartReference(const QMailMessagePart::Location &partLocation, - const QMailMessageContentDisposition& disposition, - const QMailMessageContentType& type, + const QMailMessageContentDisposition& disposition, + const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding) { QMailMessagePart part; @@ -4603,9 +4604,9 @@ QMailMessagePart QMailMessagePart::fromPartReference(const QMailMessagePart::Loc /*! Sets the part content to contain a reference to the message identified by \a id, having content type \a type and using the transfer encoding \a encoding. - - The message reference can only be resolved by transmitting the message to an external - server, where both the originating server of the referenced message and the receiving + + The message reference can only be resolved by transmitting the message to an external + server, where both the originating server of the referenced message and the receiving server of the new message support resolution of the content reference. \sa referenceType(), setReferenceResolution() @@ -4618,9 +4619,9 @@ void QMailMessagePart::setReference(const QMailMessageId &id, const QMailMessage /*! Sets the part content to contain a reference to the message part identified by \a location, having content type \a type and using the transfer encoding \a encoding. - - The part reference can only be resolved by transmitting the message to an external - server, where both the originating server of the referenced part's message and the + + The part reference can only be resolved by transmitting the message to an external + server, where both the originating server of the referenced part's message and the receiving server of the new message support resolution of the content reference. \sa referenceType(), setReferenceResolution() @@ -4666,7 +4667,7 @@ void QMailMessagePart::setContentID(const QString &id) } /*! - Returns the Content-Location header field for the part, if present; + Returns the Content-Location header field for the part, if present; otherwise returns an empty string. */ QString QMailMessagePart::contentLocation() const @@ -4683,7 +4684,7 @@ void QMailMessagePart::setContentLocation(const QString &location) } /*! - Returns the Content-Description header field for the part, if present; + Returns the Content-Description header field for the part, if present; otherwise returns an empty string. */ QString QMailMessagePart::contentDescription() const @@ -4716,7 +4717,7 @@ void QMailMessagePart::setContentDisposition(const QMailMessageContentDispositio } /*! - Returns the Content-Language header field for the part, if present; + Returns the Content-Language header field for the part, if present; otherwise returns an empty string. */ QString QMailMessagePart::contentLanguage() const @@ -4749,11 +4750,11 @@ QMailMessagePart::Location QMailMessagePart::location() const } /*! - Returns a non-empty string to identify the part, appropriate for display. If the part - 'Content-Type' header field contains a 'name' parameter, that value is used. Otherwise, - if the part has a 'Content-Disposition' header field containing a 'filename' parameter, - that value is used. Otherwise, if the part has a 'Content-ID' header field, that value - is used. Finally, a usable name will be created by combining the content type of the + Returns a non-empty string to identify the part, appropriate for display. If the part + 'Content-Type' header field contains a 'name' parameter, that value is used. Otherwise, + if the part has a 'Content-Disposition' header field containing a 'filename' parameter, + that value is used. Otherwise, if the part has a 'Content-ID' header field, that value + is used. Finally, a usable name will be created by combining the content type of the part with the part's number. \sa identifier() @@ -4780,10 +4781,10 @@ QString QMailMessagePart::displayName() const } /*! - Returns a non-empty string to identify the part, appropriate for storage. If the part - has a 'Content-ID' header field, that value is used. Otherwise, if the part has a + Returns a non-empty string to identify the part, appropriate for storage. If the part + has a 'Content-ID' header field, that value is used. Otherwise, if the part has a 'Content-Disposition' header field containing a 'filename' parameter, that value is used. - Otherwise, if the part 'Content-Type' header field contains a 'name' parameter, that value + Otherwise, if the part 'Content-Type' header field contains a 'name' parameter, that value is used. Finally, the part's number will be returned. */ QString QMailMessagePart::identifier() const @@ -4866,7 +4867,7 @@ void QMailMessagePart::setReferenceResolution(const QString &uri) static QString randomString(int length) { - if (length <= 0) + if (length <= 0) return QString(); QString str; @@ -4916,7 +4917,7 @@ static QString partFileName(const QMailMessagePart &part) /*! Writes the decoded body of the part to a file under the directory specified by \a path. - The name of the resulting file is taken from the part. If that file name already exists + The name of the resulting file is taken from the part. If that file name already exists in the path a new unique name of the format <random chars>.<filename> is saved. Returns the path of the file written on success, or an empty string otherwise. @@ -4951,14 +4952,14 @@ QString QMailMessagePart::writeBodyTo(const QString &path) const qWarning() << "Could not write part data to file " << filepath; return QString(); } - + return filepath; } /*! Returns an indication of the size of the part. This measure should be used only in comparing the relative size of parts with respect to transmission. -*/ +*/ uint QMailMessagePart::indicativeSize() const { return impl(this)->indicativeSize(); @@ -4987,11 +4988,11 @@ void QMailMessagePart::output(QDataStream& out, bool includeAttachments, bool ex return impl(this)->output<DummyChunkProcessor>(&ds, false, includeAttachments, excludeInternalFields, 0); } -/*! +/*! \fn QMailMessagePart::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessagePart::serialize(Stream &stream) const { impl(this)->serialize(stream); @@ -4999,11 +5000,11 @@ void QMailMessagePart::serialize(Stream &stream) const template void QMailMessagePart::serialize(QDataStream &) const; -/*! +/*! \fn QMailMessagePart::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessagePart::deserialize(Stream &stream) { impl(this)->deserialize(stream); @@ -5164,7 +5165,7 @@ void QMailMessageMetaDataPrivate::setReceivedDate(const QMailTimeStamp& timeStam void QMailMessageMetaDataPrivate::setFrom(const QString& s) { updateMember(_from, s); -} +} void QMailMessageMetaDataPrivate::setTo(const QString& s) { @@ -5260,7 +5261,7 @@ void QMailMessageMetaDataPrivate::setCustomFields(const QMap<QString, QString> & _customFieldsModified = true; } -template <typename Stream> +template <typename Stream> void QMailMessageMetaDataPrivate::serialize(Stream &stream) const { stream << _messageType; @@ -5290,7 +5291,7 @@ void QMailMessageMetaDataPrivate::serialize(Stream &stream) const stream << _dirty; } -template <typename Stream> +template <typename Stream> void QMailMessageMetaDataPrivate::deserialize(Stream &stream) { QString timeStamp; @@ -5329,25 +5330,25 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) \class QMailMessageMetaData \brief The QMailMessageMetaData class provides information about a message stored by Qtopia. - + \ingroup messaginglibrary - + The QMailMessageMetaData class provides information about messages stored in the Qt Extended system as QMailMessage objects. The meta data is more compact and more easily accessed and - manipulated than the content of the message itself. Many messaging-related tasks can - be accomplished by manipulating the message meta data, such as listing, filtering, and + manipulated than the content of the message itself. Many messaging-related tasks can + be accomplished by manipulating the message meta data, such as listing, filtering, and searching through sets of messages. QMailMessageMetaData objects can be created as needed, specifying the identifier of - the message whose meta data is required. The meta data of a message can be located by - specifying the QMailMessageId identifier directly, or by specifying the account and server UID + the message whose meta data is required. The meta data of a message can be located by + specifying the QMailMessageId identifier directly, or by specifying the account and server UID pair needed to locate the message. - The content of the message described by the meta data object can be accessed by creating + The content of the message described by the meta data object can be accessed by creating a QMailMessage object specifying the identifier returned by QMailMessageMetaData::id(). \sa QMailStore, QMailMessageId -*/ - +*/ + /*! \typedef QMailMessageMetaData::ImplementationType \internal @@ -5356,7 +5357,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Incoming - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Incoming" against the result of QMailMessage::status(). This flag indicates that the message has been sent from an external source to an @@ -5366,17 +5367,17 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Outgoing - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Outgoing" against the result of QMailMessage::status(). - This flag indicates that the message originates within Qt Extended, for transmission + This flag indicates that the message originates within Qt Extended, for transmission to an external message sink. */ /*! \variable QMailMessageMetaData::Sent - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Sent" against the result of QMailMessage::status(). This flag indicates that the message has been delivered to an external message sink. @@ -5385,27 +5386,27 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Replied - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Replied" against the result of QMailMessage::status(). - This flag indicates that a message replying to the source of this message has been + This flag indicates that a message replying to the source of this message has been created, in response to this message. */ /*! \variable QMailMessageMetaData::RepliedAll - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "RepliedAll" against the result of QMailMessage::status(). - This flag indicates that a message replying to the source of this message and all + This flag indicates that a message replying to the source of this message and all its recipients, has been created in response to this message. */ /*! \variable QMailMessageMetaData::Forwarded - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Forwarded" against the result of QMailMessage::status(). This flag indicates that a message forwarding the content of this message has been created. @@ -5414,7 +5415,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Read - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Read" against the result of QMailMessage::status(). This flag indicates that the content of this message has been displayed to the user. @@ -5423,7 +5424,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Removed - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Removed" against the result of QMailMessage::status(). This flag indicates that the message has been deleted from or moved on the originating server. @@ -5432,7 +5433,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::ReadElsewhere - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "ReadElsewhere" against the result of QMailMessage::status(). This flag indicates that the content of this message has been reported as having @@ -5442,7 +5443,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::UnloadedData - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "UnloadedData" against the result of QMailMessage::status(). This flag indicates that the meta data of the message is not loaded in entirety. @@ -5451,7 +5452,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::New - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "New" against the result of QMailMessage::status(). This flag indicates that the meta data of the message has not yet been displayed to the user. @@ -5460,7 +5461,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::ReadReplyRequested - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "ReadReplyRequested" against the result of QMailMessage::status(). This flag indicates that the message has requested that a read confirmation reply be returned to the sender. @@ -5469,7 +5470,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Trash - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Trash" against the result of QMailMessage::status(). This flag indicates that the message has been marked as trash, and should be considered logically deleted. @@ -5478,7 +5479,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::ContentAvailable - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "ContentAvailable" against the result of QMailMessage::status(). This flag indicates that the entire content of the message has been retrieved from the originating server, @@ -5490,7 +5491,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::PartialContentAvailable - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "PartialContentAvailable" against the result of QMailMessage::status(). This flag indicates that some portion of the content of the message has been retrieved from the originating server. @@ -5501,7 +5502,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::HasAttachments - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "HasAttachments" against the result of QMailMessage::status(). This flag indicates that the message contains at least one sub-part with 'Attachment' disposition. @@ -5512,7 +5513,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::HasReferences - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "HasReferences" against the result of QMailMessage::status(). This flag indicates that the message contains at least one sub-part which is a reference to an external message element. @@ -5523,7 +5524,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::HasUnresolvedReferences - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "HasUnresolvedReferences" against the result of QMailMessage::status(). This flag indicates that the message contains at least one sub-part which is a reference, that has no corresponding resolution value. @@ -5534,7 +5535,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Draft - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Draft" against the result of QMailMessage::status(). This flag indicates that the message has been marked as a draft, and should be considered subject to further composition. @@ -5543,7 +5544,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Outbox - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Outbox" against the result of QMailMessage::status(). This flag indicates that the message has been marked as ready for transmission. @@ -5552,7 +5553,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::Junk - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "Junk" against the result of QMailMessage::status(). This flag indicates that the message has been marked as junk, and should be considered unsuitable for standard listings. @@ -5561,7 +5562,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::TransmitFromExternal - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "TransmitFromExternal" against the result of QMailMessage::status(). This flag indicates that the message should be transmitted by reference to its external server location. @@ -5570,7 +5571,7 @@ void QMailMessageMetaDataPrivate::deserialize(Stream &stream) /*! \variable QMailMessageMetaData::LocalOnly - The status mask needed for testing the value of the registered status flag named + The status mask needed for testing the value of the registered status flag named \c "LocalOnly" against the result of QMailMessage::status(). This flag indicates that the message exists only on the local device, and has no representation on any external server. @@ -5619,7 +5620,7 @@ QMailMessageMetaData::QMailMessageMetaData(const QMailMessageId& id) } /*! - Constructs a message meta data object from data stored in the message store with the unique + Constructs a message meta data object from data stored in the message store with the unique identifier \a uid from the account with id \a accountId. */ QMailMessageMetaData::QMailMessageMetaData(const QString& uid, const QMailAccountId& accountId) @@ -5730,7 +5731,7 @@ void QMailMessageMetaData::setSubject(const QString &subject) /*! - Returns the timestamp contained in the origination date header field of the message, if present; + Returns the timestamp contained in the origination date header field of the message, if present; otherwise returns an empty timestamp. */ QMailTimeStamp QMailMessageMetaData::date() const @@ -5763,7 +5764,7 @@ void QMailMessageMetaData::setReceivedDate(const QMailTimeStamp &timeStamp) impl(this)->setReceivedDate(timeStamp); } -/*! +/*! Returns the list of primary recipients for the message. \sa QMailAddress @@ -5773,7 +5774,7 @@ QList<QMailAddress> QMailMessageMetaData::to() const return QMailAddress::fromStringList(impl(this)->_to); } -/*! +/*! Sets the list of primary recipients for the message to \a toList. */ void QMailMessageMetaData::setTo(const QList<QMailAddress>& toList) @@ -5781,7 +5782,7 @@ void QMailMessageMetaData::setTo(const QList<QMailAddress>& toList) impl(this)->setTo(QMailAddress::toStringList(toList).join(",")); } -/*! +/*! Sets the list of primary recipients for the message to contain \a address. */ void QMailMessageMetaData::setTo(const QMailAddress& address) @@ -5793,7 +5794,7 @@ void QMailMessageMetaData::setTo(const QMailAddress& address) Returns the status value for the message. \sa setStatus(), statusMask() -*/ +*/ quint64 QMailMessageMetaData::status() const { return impl(this)->_status; @@ -5828,7 +5829,7 @@ void QMailMessageMetaData::setStatus(quint64 mask, bool set) #ifndef QTOPIAMAIL_PARSING_ONLY /*! Returns the id of the originating account for the message. -*/ +*/ QMailAccountId QMailMessageMetaData::parentAccountId() const { return impl(this)->_parentAccountId; @@ -5836,7 +5837,7 @@ QMailAccountId QMailMessageMetaData::parentAccountId() const /*! Sets the id of the originating account for the message to \a id. -*/ +*/ void QMailMessageMetaData::setParentAccountId(const QMailAccountId& id) { impl(this)->setParentAccountId(id); @@ -5845,7 +5846,7 @@ void QMailMessageMetaData::setParentAccountId(const QMailAccountId& id) /*! Returns the identifier for the message on the originating server. -*/ +*/ QString QMailMessageMetaData::serverUid() const { return impl(this)->_serverUid; @@ -5854,7 +5855,7 @@ QString QMailMessageMetaData::serverUid() const /*! Sets the originating server identifier for the message to \a server. The identifier specified should be unique. -*/ +*/ void QMailMessageMetaData::setServerUid(const QString &server) { impl(this)->setServerUid(server); @@ -5862,7 +5863,7 @@ void QMailMessageMetaData::setServerUid(const QString &server) /*! Returns the complete size of the message as indicated on the originating server. -*/ +*/ uint QMailMessageMetaData::size() const { return impl(this)->_size; @@ -5870,7 +5871,7 @@ uint QMailMessageMetaData::size() const /*! Sets the complete size of the message as found on the server to \a size. -*/ +*/ void QMailMessageMetaData::setSize(uint size) { impl(this)->setSize(size); @@ -5879,7 +5880,7 @@ void QMailMessageMetaData::setSize(uint size) /*! Returns an indication of the size of the message. This measure should be used only in comparing the relative size of messages with respect to transmission. -*/ +*/ uint QMailMessageMetaData::indicativeSize() const { return impl(this)->indicativeSize(); @@ -5887,7 +5888,7 @@ uint QMailMessageMetaData::indicativeSize() const /*! Returns the type of content contained within the message. -*/ +*/ QMailMessage::ContentType QMailMessageMetaData::content() const { return impl(this)->_contentType; @@ -5896,9 +5897,9 @@ QMailMessage::ContentType QMailMessageMetaData::content() const /*! \fn QMailMessageMetaData::setContent(QMailMessageMetaData::ContentType) - Sets the type of content contained within the message to \a type. + Sets the type of content contained within the message to \a type. It is the caller's responsibility to ensure that this value matches the actual content. -*/ +*/ void QMailMessageMetaData::setContent(QMailMessage::ContentType type) { impl(this)->setContent(type); @@ -5906,7 +5907,7 @@ void QMailMessageMetaData::setContent(QMailMessage::ContentType type) #ifndef QTOPIAMAIL_PARSING_ONLY /*! - Return the QMailFolderId of the folder that contained the message before it was + Return the QMailFolderId of the folder that contained the message before it was moved into the current parent folder. */ QMailFolderId QMailMessageMetaData::previousParentFolderId() const @@ -5915,7 +5916,7 @@ QMailFolderId QMailMessageMetaData::previousParentFolderId() const } /*! - Sets the QMailFolderId of the folder that contained the message before it was + Sets the QMailFolderId of the folder that contained the message before it was moved into the current parent folder to \a id. */ void QMailMessageMetaData::setPreviousParentFolderId(const QMailFolderId &id) @@ -5926,7 +5927,7 @@ void QMailMessageMetaData::setPreviousParentFolderId(const QMailFolderId &id) /*! Returns the scheme used to store the content of this message. -*/ +*/ QString QMailMessageMetaData::contentScheme() const { return impl(this)->_contentScheme; @@ -5935,7 +5936,7 @@ QString QMailMessageMetaData::contentScheme() const /*! Sets the scheme used to store the content of this message to \a scheme, and returns true if successful. Once set, the scheme cannot be modified. -*/ +*/ bool QMailMessageMetaData::setContentScheme(const QString &scheme) { if (!impl(this)->_contentScheme.isEmpty() && (impl(this)->_contentScheme != scheme)) { @@ -5948,7 +5949,7 @@ bool QMailMessageMetaData::setContentScheme(const QString &scheme) /*! Returns the identifer used to locate the content of this message. -*/ +*/ QString QMailMessageMetaData::contentIdentifier() const { return impl(this)->_contentIdentifier; @@ -5959,7 +5960,7 @@ QString QMailMessageMetaData::contentIdentifier() const true if successful. Once set, the identifier cannot be modified. The identifier specified should be unique within the scheme returned by contentScheme(). -*/ +*/ bool QMailMessageMetaData::setContentIdentifier(const QString &identifier) { impl(this)->setContentIdentifier(identifier); @@ -5968,7 +5969,7 @@ bool QMailMessageMetaData::setContentIdentifier(const QString &identifier) /*! Returns the identifier of the message that this message was created in response to. -*/ +*/ QMailMessageId QMailMessageMetaData::inResponseTo() const { return impl(this)->_responseId; @@ -5986,7 +5987,7 @@ void QMailMessageMetaData::setInResponseTo(const QMailMessageId &id) Returns the type of response that this message was created as. \sa inResponseTo() -*/ +*/ QMailMessageMetaData::ResponseType QMailMessageMetaData::responseType() const { return impl(this)->_responseType; @@ -6032,7 +6033,7 @@ void QMailMessageMetaData::setUnmodified() #ifndef QTOPIAMAIL_PARSING_ONLY /*! - Returns the status bitmask needed to test the result of QMailMessageMetaData::status() + Returns the status bitmask needed to test the result of QMailMessageMetaData::status() against the QMailMessageMetaData status flag registered with the identifier \a flagName. \sa status(), QMailStore::messageStatusMask() @@ -6043,7 +6044,7 @@ quint64 QMailMessageMetaData::statusMask(const QString &flagName) } #endif -/*! +/*! Returns the value recorded in the custom field named \a name. \sa setCustomField(), customFields() @@ -6053,7 +6054,7 @@ QString QMailMessageMetaData::customField(const QString &name) const return d->customField(name); } -/*! +/*! Sets the value of the custom field named \a name to \a value. \sa customField(), customFields() @@ -6063,7 +6064,7 @@ void QMailMessageMetaData::setCustomField(const QString &name, const QString &va d->setCustomField(name, value); } -/*! +/*! Removes the custom field named \a name. \sa customField(), customFields() @@ -6073,7 +6074,7 @@ void QMailMessageMetaData::removeCustomField(const QString &name) d->removeCustomField(name); } -/*! +/*! Returns the map of custom fields stored in the message. \sa customField(), setCustomField() @@ -6109,11 +6110,11 @@ void QMailMessageMetaData::initStore() } #endif -/*! +/*! \fn QMailMessageMetaData::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageMetaData::serialize(Stream &stream) const { impl(this)->serialize(stream); @@ -6121,11 +6122,11 @@ void QMailMessageMetaData::serialize(Stream &stream) const template void QMailMessageMetaData::serialize(QDataStream &) const; -/*! +/*! \fn QMailMessageMetaData::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessageMetaData::deserialize(Stream &stream) { impl(this)->deserialize(stream); @@ -6194,7 +6195,7 @@ void QMailMessagePrivate::setDate(const QMailTimeStamp& timeStamp) void QMailMessagePrivate::setFrom(const QString& s) { updateHeaderField( "From:", s ); -} +} void QMailMessagePrivate::setReplyTo(const QString& s) { @@ -6235,7 +6236,7 @@ bool QMailMessagePrivate::hasRecipients() const uint QMailMessagePrivate::indicativeSize() const { - uint size = QMailMessagePartContainerPrivate::indicativeSize(); + uint size = QMailMessagePartContainerPrivate::indicativeSize(); // Count the message header as one size unit return (size + 1); @@ -6285,7 +6286,7 @@ void QMailMessagePrivate::toRfc2822(QDataStream **out, QMailMessage::EncodingFor bool isOutgoing = (messageStatus & (QMailMessage::Outgoing | QMailMessage::Sent)); bool addTimeStamp = (format != QMailMessage::IdentityFormat); - bool addContentHeaders = ((format != QMailMessage::IdentityFormat) && + bool addContentHeaders = ((format != QMailMessage::IdentityFormat) && ((format != QMailMessage::StorageFormat) || isOutgoing || !hasBody())); bool includeBcc = (format != QMailMessage::TransmissionFormat); bool excludeInternalFields = (format == QMailMessage::TransmissionFormat); @@ -6350,13 +6351,13 @@ void QMailMessagePrivate::setUnmodified() setDirty(false, true); } -template <typename Stream> +template <typename Stream> void QMailMessagePrivate::serialize(Stream &stream) const { QMailMessagePartContainerPrivate::serialize(stream); } -template <typename Stream> +template <typename Stream> void QMailMessagePrivate::deserialize(Stream &stream) { QMailMessagePartContainerPrivate::deserialize(stream); @@ -6369,34 +6370,34 @@ void QMailMessagePrivate::deserialize(Stream &stream) \class QMailMessage \brief The QMailMessage class provides a convenient interface for working with messages. - + \ingroup messaginglibrary - - QMailMessage supports a number of types. These include telephony types - such as SMS and MMS, and internet email messages as defined in - \l{http://www.ietf.org/rfc/rfc2822.txt} {RFC 2822} (Internet Message Format), and - \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Format of Internet Message Bodies) through + + QMailMessage supports a number of types. These include telephony types + such as SMS and MMS, and internet email messages as defined in + \l{http://www.ietf.org/rfc/rfc2822.txt} {RFC 2822} (Internet Message Format), and + \l{http://www.ietf.org/rfc/rfc2045.txt} {RFC 2045} (Format of Internet Message Bodies) through \l{http://www.ietf.org/rfc/rfc2049.txt} {RFC 2049} (Conformance Criteria and Examples). - + The most common way to use QMailMessage is to initialize it from raw data using QMailMessage::fromRfc2822(). - - A QMailMessage can also be constructed piece by piece using functions such as - setMessageType(), setFrom(), setTo(), setSubject(), and setBody() or appendPart(). + + A QMailMessage can also be constructed piece by piece using functions such as + setMessageType(), setFrom(), setTo(), setSubject(), and setBody() or appendPart(). Convenience functions such as from()/setFrom() and date()/setDate() accept and return wrapper types, to simplify the exchange of correctly-formatted data. - In some cases, however, it may be simpler for clients to get and set the content + In some cases, however, it may be simpler for clients to get and set the content of header fields directly, using the headerField() and setHeaderField() functions inherited from QMailMessagePartContainer. - - Messages can be added to the QMailStore, or retrieved from the store via their QMailMessageId + + Messages can be added to the QMailStore, or retrieved from the store via their QMailMessageId identifier. The QMailMessage object also provides access to any relevant meta data describing the message, using the functions inherited from QMailMessageMetaData. A message may be serialized to a QDataStream, or returned as a QByteArray using toRfc2822(). - + \sa QMailMessageMetaData, QMailMessagePart, QMailMessageBody, QMailStore, QMailMessageId -*/ +*/ const char QMailMessage::CarriageReturn = '\015'; @@ -6424,7 +6425,7 @@ QMailMessage::QMailMessage(const QMailMessageId& id) } /*! - Constructs a message object from data stored in the message store with the unique + Constructs a message object from data stored in the message store with the unique identifier \a uid from the account with id \a accountId. */ QMailMessage::QMailMessage(const QString& uid, const QMailAccountId& accountId) @@ -6537,7 +6538,7 @@ QByteArray QMailMessage::toRfc2822(EncodingFormat format) const } /*! - Writes the message to the output stream \a out, in RFC 2822 format. + Writes the message to the output stream \a out, in RFC 2822 format. The encoded content will vary depending on the value of \a format. */ void QMailMessage::toRfc2822(QDataStream& out, EncodingFormat format) const @@ -6562,7 +6563,7 @@ struct ChunkStore close(); } - void close() + void close() { if (ds) { delete ds; @@ -6646,7 +6647,7 @@ void QMailMessage::setTo(const QMailAddress& address) Returns a list of all the cc (carbon copy) recipients specified for the message. \sa to(), bcc(), QMailAddress -*/ +*/ QList<QMailAddress> QMailMessage::cc() const { return QMailAddress::fromStringList(headerFieldText("Cc")); @@ -6656,7 +6657,7 @@ QList<QMailAddress> QMailMessage::cc() const Set the list of cc (carbon copy) recipients for the message to \a ccList. \sa setTo(), setBcc() -*/ +*/ void QMailMessage::setCc(const QList<QMailAddress>& ccList) { partContainerImpl()->setCc(QMailAddress::toStringList(ccList).join(",")); @@ -6666,7 +6667,7 @@ void QMailMessage::setCc(const QList<QMailAddress>& ccList) Returns a list of all the bcc (blind carbon copy) recipients specified for the message. \sa to(), cc(), QMailAddress -*/ +*/ QList<QMailAddress> QMailMessage::bcc() const { return QMailAddress::fromStringList(headerFieldText("Bcc")); @@ -6676,7 +6677,7 @@ QList<QMailAddress> QMailMessage::bcc() const Set the list of bcc (blind carbon copy) recipients for the message to \a bccList. \sa setTo(), setCc() -*/ +*/ void QMailMessage::setBcc(const QList<QMailAddress>& bccList) { partContainerImpl()->setBcc(QMailAddress::toStringList(bccList).join(",")); @@ -6684,7 +6685,7 @@ void QMailMessage::setBcc(const QList<QMailAddress>& bccList) /*! Returns the address specified by the RFC 2822 'Reply-To' field for the message, if present. -*/ +*/ QMailAddress QMailMessage::replyTo() const { return QMailAddress(headerFieldText("Reply-To")); @@ -6692,7 +6693,7 @@ QMailAddress QMailMessage::replyTo() const /*! Sets the RFC 2822 'Reply-To' address of the message to \a address. -*/ +*/ void QMailMessage::setReplyTo(const QMailAddress &address) { partContainerImpl()->setReplyTo(address.toString()); @@ -6700,7 +6701,7 @@ void QMailMessage::setReplyTo(const QMailAddress &address) /*! Returns the message ID specified by the RFC 2822 'In-Reply-To' field for the message, if present. -*/ +*/ QString QMailMessage::inReplyTo() const { return headerFieldText("In-Reply-To"); @@ -6718,7 +6719,7 @@ void QMailMessage::setInReplyTo(const QString &messageId) Returns a list of all the recipients specified for the message, either as To, CC, or BCC addresses. \sa to(), cc(), bcc(), hasRecipients() -*/ +*/ QList<QMailAddress> QMailMessage::recipients() const { QList<QMailAddress> addresses; @@ -6739,15 +6740,15 @@ QList<QMailAddress> QMailMessage::recipients() const } /*! - Returns true if there are any recipients (either To, CC or BCC addresses) + Returns true if there are any recipients (either To, CC or BCC addresses) defined for this message; otherwise returns false. -*/ +*/ bool QMailMessage::hasRecipients() const { return partContainerImpl()->hasRecipients(); } -/*! \reimp */ +/*! \reimp */ uint QMailMessage::indicativeSize() const { // Count the message header as one size unit @@ -6756,7 +6757,7 @@ uint QMailMessage::indicativeSize() const /*! Returns the size of the message content excluding any meta data, in bytes. -*/ +*/ uint QMailMessage::contentSize() const { return customField("qtopiamail-content-size").toUInt(); @@ -6772,7 +6773,7 @@ void QMailMessage::setContentSize(uint size) /*! Returns a value by which the external location of the message can be referenced, if available. -*/ +*/ QString QMailMessage::externalLocationReference() const { return customField("qtopiamail-external-location-reference"); @@ -6800,30 +6801,30 @@ bool QMailMessage::partialContentAvailable() const // The QMMMetaData half of this object is implemented in a QMailMessageMetaDataPrivate object /*! \internal */ -QMailMessageMetaDataPrivate* QMailMessage::metaDataImpl() -{ - return QMailMessageMetaData::impl<QMailMessageMetaDataPrivate>(); +QMailMessageMetaDataPrivate* QMailMessage::metaDataImpl() +{ + return QMailMessageMetaData::impl<QMailMessageMetaDataPrivate>(); } /*! \internal */ -const QMailMessageMetaDataPrivate* QMailMessage::metaDataImpl() const -{ - return QMailMessageMetaData::impl<const QMailMessageMetaDataPrivate>(); +const QMailMessageMetaDataPrivate* QMailMessage::metaDataImpl() const +{ + return QMailMessageMetaData::impl<const QMailMessageMetaDataPrivate>(); } // The QMMPartContainer half of this object is implemented in a QMailMessagePrivate object /*! \internal */ -QMailMessagePrivate* QMailMessage::partContainerImpl() -{ - return QMailMessagePartContainer::impl<QMailMessagePrivate>(); +QMailMessagePrivate* QMailMessage::partContainerImpl() +{ + return QMailMessagePartContainer::impl<QMailMessagePrivate>(); } /*! \internal */ -const QMailMessagePrivate* QMailMessage::partContainerImpl() const -{ - return QMailMessagePartContainer::impl<const QMailMessagePrivate>(); +const QMailMessagePrivate* QMailMessage::partContainerImpl() const +{ + return QMailMessagePartContainer::impl<const QMailMessagePrivate>(); } - + /*! \internal */ bool QMailMessage::contentModified() const { @@ -6899,11 +6900,11 @@ QMailMessage QMailMessage::fromRfc2822(LongString& ls) return mail; } -/*! +/*! \fn QMailMessage::serialize(Stream&) const - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessage::serialize(Stream &stream) const { metaDataImpl()->serialize(stream); @@ -6912,11 +6913,11 @@ void QMailMessage::serialize(Stream &stream) const template void QMailMessage::serialize(QDataStream &) const; -/*! +/*! \fn QMailMessage::deserialize(Stream&) - \internal + \internal */ -template <typename Stream> +template <typename Stream> void QMailMessage::deserialize(Stream &stream) { metaDataImpl()->deserialize(stream); diff --git a/src/messaging/win32wce/qmailmessagefwd.cpp b/src/messaging/win32wce/qmailmessagefwd.cpp index a77111c4c9..3fc53a0bc4 100644 --- a/src/messaging/win32wce/qmailmessagefwd.cpp +++ b/src/messaging/win32wce/qmailmessagefwd.cpp @@ -42,14 +42,15 @@ /*! \class QMailMessageHeaderFieldFwd \brief The QMailMessageHeaderFieldFwd class declares enumerations used by QMailMessageHeaderField - - QMailMessageHeaderFieldFwd allows QMailMessageHeaderField::FieldType + \since 1.1 + + QMailMessageHeaderFieldFwd allows QMailMessageHeaderField::FieldType to be used without including all of \c qmailmessage.h. */ /*! \enum QMailMessageHeaderFieldFwd::FieldType - + This enum type is used to describe the formatting of field content. \value StructuredField The field content should be parsed assuming it is structured according to the specification for RFC 2045 'Content-Type' fields. @@ -59,14 +60,14 @@ /*! \class QMailMessageContentDispositionFwd \brief The QMailMessageContentDispositionFwd class declares enumerations used by QMailMessageContentDisposition - - QMailMessageContentDispositionFwd allows QMailMessageContentDisposition::DispositionType + + QMailMessageContentDispositionFwd allows QMailMessageContentDisposition::DispositionType to be used without including all of \c qmailmessage.h. */ /*! \enum QMailMessageContentDispositionFwd::DispositionType - + This enum type is used to describe the disposition of a message part. \value Attachment The part data should be presented as an attachment. @@ -77,16 +78,16 @@ /*! \class QMailMessageBodyFwd \brief The QMailMessageBodyFwd class declares enumerations used by QMailMessageBody - + QMailMessageBodyFwd allows QMailMessageBody::TransferEncoding and QMailMessageBody::EncodingStatus to be used without including all of \c qmailmessage.h. */ /*! \enum QMailMessageBodyFwd::TransferEncoding - + This enum type is used to describe a type of binary to text encoding. - Encoding types used here are documented in + Encoding types used here are documented in \l {http://www.ietf.org/rfc/rfc2045.txt}{RFC 2045} "Format of Internet Message Bodies" \value NoEncoding The encoding is not specified. @@ -101,7 +102,7 @@ /*! \enum QMailMessageBodyFwd::EncodingStatus - + This enum type is used to describe the encoding status of body data. \value AlreadyEncoded The body data is already encoded to the necessary encoding. @@ -110,17 +111,17 @@ /*! \enum QMailMessageBodyFwd::EncodingFormat - + This enum type is used to describe the format in which body data should be presented. - \value Encoded The body data should be presented in encoded form. - \value Decoded The body data should be presented in unencoded form. + \value Encoded The body data should be presented in encoded form. + \value Decoded The body data should be presented in unencoded form. */ /*! \class QMailMessagePartContainerFwd \brief The QMailMessagePartContainerFwd class declares enumerations used by QMailMessagePartContainer - + QMailMessagePartContainerFwd allows QMailMessagePartContainerFwd::MultipartType to be used without including all of \c qmailmessage.h. */ @@ -143,9 +144,9 @@ */ /*! - \class QMailMessagePartFwd + \class QMailMessagePartFwd \brief The QMailMessagePartFwd class declares enumerations used by QMailMessagePart - + QMailMessagePartFwd allows QMailMessagePartFwd::ReferenceType to be used without including all of \c qmailmessage.h. */ @@ -163,7 +164,7 @@ /*! \class QMailMessageMetaDataFwd \brief The QMailMessageMetaDataFwd class declares enumerations used by QMailMessageMetaData - + QMailMessageMetaDataFwd allows QMailMessageMetaData::MessageType, QMailMessageMetaData::ContentType and QMailMessageMetaData::ResponseType to be used without including all of \c qmailmessage.h. */ @@ -222,7 +223,7 @@ /*! \class QMailMessageFwd \brief The QMailMessageFwd class declares enumerations used by QMailMessage - + QMailMessageFwd allows QMailMessage::AttachmentsAction and QMailMessage::EncodingFormat to be used without including all of \c qmailmessage.h. */ @@ -230,14 +231,14 @@ /*! \enum QMailMessageFwd::AttachmentsAction - This enum type is used to describe the action that should be performed on + This enum type is used to describe the action that should be performed on each message attachment. - \value LinkToAttachments Add a part to the message containing a link to the - supplied attachment. If the document is removed, the + \value LinkToAttachments Add a part to the message containing a link to the + supplied attachment. If the document is removed, the message will no longer have access to the data. \value CopyAttachments Add a part to the message containing a copy of the - data in the supplied attachment. If the document is + data in the supplied attachment. If the document is removed, the message will still contain the data. \value CopyAndDeleteAttachments Add a part to the message containing a copy of the data in the supplied attachment, then delete the @@ -246,7 +247,7 @@ /*! \enum QMailMessageFwd::EncodingFormat - + This enum type is used to describe the format in which a message should be serialized. \value HeaderOnlyFormat Only the header portion of the message is serialized, to RFC 2822 form. @@ -257,7 +258,7 @@ /*! \enum QMailMessageFwd::ChunkType - + This enum type is used to denote the content of a single chunk in a partitioned output sequence. \value Text The chunk contains verbatim output text. diff --git a/src/messaging/win32wce/qmailtimestamp.cpp b/src/messaging/win32wce/qmailtimestamp.cpp index d4fa5da66b..298e11591a 100644 --- a/src/messaging/win32wce/qmailtimestamp.cpp +++ b/src/messaging/win32wce/qmailtimestamp.cpp @@ -153,7 +153,7 @@ QMailTimeStampPrivate::QMailTimeStampPrivate(const QString& timeText) year = value; if ( year < 100 ) { year += ( year <= 49 ? 2000 : 1900 ); - } + } else if ( year < 1000 ) { year += 1900; } @@ -172,10 +172,10 @@ QMailTimeStampPrivate::QMailTimeStampPrivate(const QString& timeText) QTime timeComponent; QTime parsedTime; - if ( timeStr.length() == 8 ) { + if ( timeStr.length() == 8 ) { parsedTime = QTime::fromString( timeStr, "hh:mm:ss" ); } - else if ( timeStr.length() == 5 ) { + else if ( timeStr.length() == 5 ) { // Is this legal? Either way, it seems desirable for robustness... parsedTime = QTime::fromString( timeStr, "hh:mm" ); } @@ -228,7 +228,7 @@ QMailTimeStampPrivate::QMailTimeStampPrivate(const QDateTime& dateTime) } QMailTimeStampPrivate::QMailTimeStampPrivate(const QMailTimeStampPrivate& other) - : QSharedData(other) + : QSharedData(other) { this->operator=(other); } @@ -339,10 +339,11 @@ bool QMailTimeStampPrivate::operator>= (const QMailTimeStampPrivate& other) cons \brief The QMailTimeStamp class manages message time stamps. \ingroup messaginglibrary + \since 1.1 QMailTimeStamp provides functions for creating and manipulating the time stamps of messages. - QMailTimeStamp can be created from time stamp strings, or from QDateTime objects. The - time stamp information can be extracted in UTC time, local time, or as a formatted + QMailTimeStamp can be created from time stamp strings, or from QDateTime objects. The + time stamp information can be extracted in UTC time, local time, or as a formatted string. QMailTimeStamp maintains the timezone information of a time stamp, so it can be used to @@ -353,7 +354,7 @@ bool QMailTimeStampPrivate::operator>= (const QMailTimeStampPrivate& other) cons /*! \enum QMailTimeStamp::OutputFormat - + This enum type is used to select a format for timestamp output. \value Rfc2822 The format used in SMTP message format; example: "Wed, 17 May 2006 20:45:00 +0100". diff --git a/src/multimedia/qcamera.cpp b/src/multimedia/qcamera.cpp index f942b88f6a..61eb558187 100644 --- a/src/multimedia/qcamera.cpp +++ b/src/multimedia/qcamera.cpp @@ -84,6 +84,7 @@ public: \inmodule QtMultimediaKit \ingroup camera + \since 1.1 QCamera can be used with QVideoWidget for viewfinder display, QMediaRecorder for video recording and QCameraImageCapture for image taking. diff --git a/src/multimedia/qcameracontrol.cpp b/src/multimedia/qcameracontrol.cpp index 5a8856b5f7..431a4fe68b 100644 --- a/src/multimedia/qcameracontrol.cpp +++ b/src/multimedia/qcameracontrol.cpp @@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 This service is provided by a QMediaService object via QMediaService::control(). It is used by QCamera. diff --git a/src/multimedia/qcameraexposure.cpp b/src/multimedia/qcameraexposure.cpp index c31fa46f8d..34e02395f3 100644 --- a/src/multimedia/qcameraexposure.cpp +++ b/src/multimedia/qcameraexposure.cpp @@ -59,6 +59,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 */ diff --git a/src/multimedia/qcameraexposurecontrol.cpp b/src/multimedia/qcameraexposurecontrol.cpp index bb89d4ea7b..2ce98dc895 100644 --- a/src/multimedia/qcameraexposurecontrol.cpp +++ b/src/multimedia/qcameraexposurecontrol.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 The interface name of QCameraExposureControl is \c com.nokia.Qt.QCameraExposureControl/1.0 as defined in QCameraExposureControl_iid. diff --git a/src/multimedia/qcameraflashcontrol.cpp b/src/multimedia/qcameraflashcontrol.cpp index a35d0d16e5..0b548b1a9e 100644 --- a/src/multimedia/qcameraflashcontrol.cpp +++ b/src/multimedia/qcameraflashcontrol.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE \ingroup camera \inmodule QtMultimediaKit + \since 1.1 The interface name of QCameraFlashControl is \c com.nokia.Qt.QCameraFlashControl/1.0 as defined in QCameraFlashControl_iid. diff --git a/src/multimedia/qcamerafocus.cpp b/src/multimedia/qcamerafocus.cpp index 65a48db624..a67b372333 100644 --- a/src/multimedia/qcamerafocus.cpp +++ b/src/multimedia/qcamerafocus.cpp @@ -172,6 +172,7 @@ void QCameraFocusZone::setStatus(QCameraFocusZone::FocusZoneStatus status) \inmodule QtMultimediaKit \ingroup camera + \since 1.1 */ diff --git a/src/multimedia/qcamerafocuscontrol.cpp b/src/multimedia/qcamerafocuscontrol.cpp index dc3f900b4a..9ee1720297 100644 --- a/src/multimedia/qcamerafocuscontrol.cpp +++ b/src/multimedia/qcamerafocuscontrol.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 The interface name of QCameraFocusControl is \c com.nokia.Qt.QCameraFocusControl/1.0 as defined in QCameraFocusControl_iid. diff --git a/src/multimedia/qcameraimagecapture.cpp b/src/multimedia/qcameraimagecapture.cpp index fe9bc8d348..0f43adaaf2 100644 --- a/src/multimedia/qcameraimagecapture.cpp +++ b/src/multimedia/qcameraimagecapture.cpp @@ -60,8 +60,9 @@ QT_BEGIN_NAMESPACE \class QCameraImageCapture \inmodule QtMultimediaKit \ingroup multimedia + \since 1.1 + - \brief The QCameraImageCapture class is used for the recording of media content. The QCameraImageCapture class is a high level images recording class. diff --git a/src/multimedia/qcameraimagecapturecontrol.cpp b/src/multimedia/qcameraimagecapturecontrol.cpp index cf673a41ec..7d40bb1238 100644 --- a/src/multimedia/qcameraimagecapturecontrol.cpp +++ b/src/multimedia/qcameraimagecapturecontrol.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 diff --git a/src/multimedia/qcameraimageprocessing.cpp b/src/multimedia/qcameraimageprocessing.cpp index df1b17c39c..212425fb44 100644 --- a/src/multimedia/qcameraimageprocessing.cpp +++ b/src/multimedia/qcameraimageprocessing.cpp @@ -63,6 +63,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 */ diff --git a/src/multimedia/qcameraimageprocessingcontrol.cpp b/src/multimedia/qcameraimageprocessingcontrol.cpp index d79fa374e8..18b3581807 100644 --- a/src/multimedia/qcameraimageprocessingcontrol.cpp +++ b/src/multimedia/qcameraimageprocessingcontrol.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE \class QCameraImageProcessingControl \inmodule QtMultimediaKit \ingroup multimedia-serv + \since 1.1 \brief The QCameraImageProcessingControl class provides an abstract class diff --git a/src/multimedia/qcameralockscontrol.cpp b/src/multimedia/qcameralockscontrol.cpp index fd2683fe14..bf00d07cdd 100644 --- a/src/multimedia/qcameralockscontrol.cpp +++ b/src/multimedia/qcameralockscontrol.cpp @@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 This service is provided by a QMediaService object via QMediaService::control(). It is used by QCamera. diff --git a/src/multimedia/qcameraviewfinder.cpp b/src/multimedia/qcameraviewfinder.cpp index 5707e1a0c4..121f05b9cc 100644 --- a/src/multimedia/qcameraviewfinder.cpp +++ b/src/multimedia/qcameraviewfinder.cpp @@ -58,6 +58,7 @@ QT_USE_NAMESPACE \inmodule QtMultimediaKit \ingroup camera + \since 1.1 \snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera diff --git a/src/organizer/qorganizerabstractrequest.cpp b/src/organizer/qorganizerabstractrequest.cpp index 553652a91c..5253dcbb3e 100644 --- a/src/organizer/qorganizerabstractrequest.cpp +++ b/src/organizer/qorganizerabstractrequest.cpp @@ -58,6 +58,7 @@ QTM_BEGIN_NAMESPACE asynchronous requests to be made of a manager if it supports them. \inmodule QtOrganizer + \since 1.1 \ingroup organizer-main diff --git a/src/organizer/qorganizeritem.cpp b/src/organizer/qorganizeritem.cpp index f28a056f4b..46c298d7aa 100644 --- a/src/organizer/qorganizeritem.cpp +++ b/src/organizer/qorganizeritem.cpp @@ -74,6 +74,7 @@ QTM_BEGIN_NAMESPACE \brief The QOrganizerItem class represents an event, todo, note, or journal entry \inmodule QtOrganizer + \since 1.1 \ingroup organizer-main diff --git a/src/organizer/qorganizeritemdetail.cpp b/src/organizer/qorganizeritemdetail.cpp index 93e41d947c..33034f9c0a 100644 --- a/src/organizer/qorganizeritemdetail.cpp +++ b/src/organizer/qorganizeritemdetail.cpp @@ -75,6 +75,7 @@ Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash) \brief The QOrganizerItemDetail class represents a single, complete detail about an organizer item. \inmodule QtOrganizer \ingroup organizer-main + \since 1.1 All of the information for an organizer item is stored in one or more QOrganizerItemDetail objects. diff --git a/src/organizer/qorganizermanagerengine.cpp b/src/organizer/qorganizermanagerengine.cpp index 3036e8134c..2711a1a1b7 100644 --- a/src/organizer/qorganizermanagerengine.cpp +++ b/src/organizer/qorganizermanagerengine.cpp @@ -67,6 +67,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtOrganizer \ingroup organizer-backends + \since 1.1 Instances of this class are usually provided by a \l QOrganizerManagerEngineFactory, which is loaded from a plugin. @@ -2593,7 +2594,7 @@ const QOrganizerCollectionEngineId* QOrganizerManagerEngine::engineCollectionId( \o it can't reliably access any properties of the request pointer any more. The pointer will be invalid once this function returns. \endlist - + This means that if there is a worker thread, the engine needs to let that thread know that the request object is not valid and block until that thread acknowledges it. One way to do this is to have a QSet<QOrganizerAbstractRequest*> (or QMap<QOrganizerAbstractRequest, @@ -2614,13 +2615,13 @@ void QOrganizerManagerEngine::requestDestroyed(QOrganizerAbstractRequest* req) Generally, the engine queues the request and processes it at some later time (probably in another thread). - + Once a request is started, the engine should call the updateRequestState and/or the specific updateXXXXXRequest functions to mark it in the active state. - + If the engine is particularly fast, or the operation involves only in memory data, the request can be processed and completed without queueing it. - + Note that when the client is threaded, and the request might live on a different thread, the engine needs to be careful with locking. In particular, the request might be deleted while the engine is still working on it. In this case, the requestDestroyed function will be called while diff --git a/src/organizer/requests/qorganizeritemsaverequest.cpp b/src/organizer/requests/qorganizeritemsaverequest.cpp index 32461b076a..f2c80e19be 100644 --- a/src/organizer/requests/qorganizeritemsaverequest.cpp +++ b/src/organizer/requests/qorganizeritemsaverequest.cpp @@ -56,6 +56,7 @@ QTM_BEGIN_NAMESPACE the overall operation error (which may be retrieved by calling error()) is updated. \ingroup organizer-requests + \since 1.1 */ /*! Constructs a new organizer item save request whose parent is the specified \a parent */ diff --git a/src/serviceframework/ipc/qmetaobjectbuilder.cpp b/src/serviceframework/ipc/qmetaobjectbuilder.cpp index 63eeeabb97..b19eb1a34c 100644 --- a/src/serviceframework/ipc/qmetaobjectbuilder.cpp +++ b/src/serviceframework/ipc/qmetaobjectbuilder.cpp @@ -52,6 +52,7 @@ QTM_BEGIN_NAMESPACE \class QMetaObjectBuilder \internal \brief The QMetaObjectBuilder class supports building QMetaObject objects at runtime. + \since 1.1 */ @@ -889,7 +890,7 @@ const QMetaObject *QMetaObjectBuilder::relatedMetaObject(int index) const QByteArray QMetaObjectBuilder::classInfoName(int index) const { if (index >= 0 && index < d->classInfoNames.size()) - return d->classInfoNames[index]; + return d->classInfoNames[index]; else return QByteArray(); } @@ -904,7 +905,7 @@ QByteArray QMetaObjectBuilder::classInfoName(int index) const QByteArray QMetaObjectBuilder::classInfoValue(int index) const { if (index >= 0 && index < d->classInfoValues.size()) - return d->classInfoValues[index]; + return d->classInfoValues[index]; else return QByteArray(); } @@ -1178,9 +1179,9 @@ static QByteArray buildParameterNames // Build a QMetaObject in "buf" based on the information in "d". // If "buf" is null, then return the number of bytes needed to -// build the QMetaObject. Returns -1 if the metaobject if +// build the QMetaObject. Returns -1 if the metaobject if // relocatable is set, but the metaobject contains extradata. -static int buildMetaObject(QMetaObjectBuilderPrivate *d, char *buf, +static int buildMetaObject(QMetaObjectBuilderPrivate *d, char *buf, bool relocatable) { int size = 0; @@ -1189,7 +1190,7 @@ static int buildMetaObject(QMetaObjectBuilderPrivate *d, char *buf, int index; bool hasNotifySignals = false; - if (relocatable && + if (relocatable && (d->relatedMetaObjects.size() > 0 || d->staticMetacallFunction)) return -1; @@ -1466,7 +1467,7 @@ QMetaObject *QMetaObjectBuilder::toMetaObject() const The data is specific to the architecture on which it was created, but is not specific to the process that created it. Not all meta object builder's can be converted to data in this way. If \a ok is provided, it will be set to - true if the conversion succeeds, and false otherwise. If a + true if the conversion succeeds, and false otherwise. If a staticMetacallFunction() or any relatedMetaObject()'s are specified the conversion to relocatable data will fail. */ @@ -1489,12 +1490,12 @@ QByteArray QMetaObjectBuilder::toRelocatableData(bool *ok) const /* \internal - Sets the \a data returned from toRelocatableData() onto a concrete + Sets the \a data returned from toRelocatableData() onto a concrete QMetaObject instance, \a output. As the meta object's super class is not saved in the relocatable data, it must be passed as \a superClass. */ -void QMetaObjectBuilder::fromRelocatableData(QMetaObject *output, - const QMetaObject *superclass, +void QMetaObjectBuilder::fromRelocatableData(QMetaObject *output, + const QMetaObject *superclass, const QByteArray &data) { if (!output) diff --git a/src/serviceframework/ipc/qsignalintercepter.cpp b/src/serviceframework/ipc/qsignalintercepter.cpp index 9b97fea611..049e1072c3 100644 --- a/src/serviceframework/ipc/qsignalintercepter.cpp +++ b/src/serviceframework/ipc/qsignalintercepter.cpp @@ -50,6 +50,7 @@ \internal \brief The QSignalIntercepter class provides an interface for intercepting signals as meta-calls + \since 1.1 IPC mechanisms need to intercept signals and convert them into protocol messages, but it is generally impractical to create a slot for every diff --git a/src/serviceframework/ipc/qslotinvoker.cpp b/src/serviceframework/ipc/qslotinvoker.cpp index 76b369e3ab..56427b0094 100644 --- a/src/serviceframework/ipc/qslotinvoker.cpp +++ b/src/serviceframework/ipc/qslotinvoker.cpp @@ -50,6 +50,7 @@ \internal \brief The QSlotInvoker class provides an interface for invoking slots with explicit arguments + \since 1.1 IPC mechanisms need to intercept protocol messages and convert them into slot invocations, but it is generally impractical to create explicit code diff --git a/src/systeminfo/qsystemdisplayinfo.cpp b/src/systeminfo/qsystemdisplayinfo.cpp index cdfbeb0789..ce894199fe 100644 --- a/src/systeminfo/qsystemdisplayinfo.cpp +++ b/src/systeminfo/qsystemdisplayinfo.cpp @@ -76,6 +76,7 @@ QSystemDisplayInfoPrivate *getSystemDisplayInfoPrivate() { return displayInfoPri \class QSystemDisplayInfo \ingroup systeminfo \inmodule QtSystemInfo + \since 1.1 \brief The QSystemDisplayInfo class provides access to display information from the system. */ diff --git a/src/systeminfo/qsystemnetworkinfo.cpp b/src/systeminfo/qsystemnetworkinfo.cpp index 55088c0b46..4cee14135b 100644 --- a/src/systeminfo/qsystemnetworkinfo.cpp +++ b/src/systeminfo/qsystemnetworkinfo.cpp @@ -56,6 +56,7 @@ QSystemNetworkInfoPrivate *getSystemNetworkInfoPrivate() { return netInfoPrivate \ingroup systeminfo \inmodule QtSystemInfo \brief The QSystemNetworkInfo class provides access to various networking status and signals. + \since 1.1 */ /*! diff --git a/src/systeminfo/qsystemscreensaver.cpp b/src/systeminfo/qsystemscreensaver.cpp index 4d31a75bb4..3bfe151459 100644 --- a/src/systeminfo/qsystemscreensaver.cpp +++ b/src/systeminfo/qsystemscreensaver.cpp @@ -49,6 +49,7 @@ QTM_BEGIN_NAMESPACE \ingroup systeminfo \inmodule QtSystemInfo \brief The QSystemScreenSaver class provides access to screen saver and blanking. + \since 1.1 On platforms where there is no one default screensaver mechanism, such as Linux, this class may not be available. diff --git a/src/systeminfo/qsystemstorageinfo.cpp b/src/systeminfo/qsystemstorageinfo.cpp index 3d87f1d6b1..7beb91d391 100644 --- a/src/systeminfo/qsystemstorageinfo.cpp +++ b/src/systeminfo/qsystemstorageinfo.cpp @@ -56,6 +56,7 @@ QSystemStorageInfoPrivate *getSystemStorageInfoPrivate() { return storageInfoPri \ingroup systeminfo \inmodule QtSystemInfo \brief The QSystemStorageInfo class provides access to disk storage information from the system. + \since 1.1 */ /*! diff --git a/src/versit/qversitcontactexporter.cpp b/src/versit/qversitcontactexporter.cpp index 2dfaad47d2..1b840ec8e9 100644 --- a/src/versit/qversitcontactexporter.cpp +++ b/src/versit/qversitcontactexporter.cpp @@ -54,6 +54,7 @@ QTM_USE_NAMESPACE \class QVersitContactExporterDetailHandler \brief The QVersitContactExporterDetailHandler class is the legacy interface for clients wishing to implement custom export behaviour for certain contact details. + \since 1.1 This interface is replaced by QVersitContactExporterDetailHandlerV2. For general information on extending Qt Versit, see the document on \l{Versit Plugins}. @@ -114,7 +115,7 @@ QTM_USE_NAMESPACE \fn void QVersitContactExporterDetailHandlerV2::detailProcessed(const QContact& contact, const QContactDetail& detail, const QVersitDocument& document, QSet<QString>* processedFields, QList<QVersitProperty>* toBeRemoved, QList<QVersitProperty>* toBeAdded) Process \a detail and provide a list of updated \l{QVersitProperty}{QVersitProperties} by - modifying the \a toBeRemoved and \a toBeAdded lists. + modifying the \a toBeRemoved and \a toBeAdded lists. This function is called on every QContactDetail encountered during an export, after the detail has been processed by the QVersitContactExporter. An implementation of this function can be made to @@ -124,7 +125,7 @@ QTM_USE_NAMESPACE fields in the \a detail that were considered by the QVersitContactExporter or another handler in processing the detail. \a document holds the state of the document before the detail was processed by the exporter. - + \a toBeRemoved and \a toBeAdded are initially filled with a list of properties that the exporter will remove from and add to the document. These lists can be modified (by removing, modifying or adding properties) by the handler to control the changes that will actually be made to the diff --git a/src/versit/qversitcontactimporter.cpp b/src/versit/qversitcontactimporter.cpp index a75d39a345..f0b6ec6416 100644 --- a/src/versit/qversitcontactimporter.cpp +++ b/src/versit/qversitcontactimporter.cpp @@ -53,6 +53,7 @@ QTM_USE_NAMESPACE \class QVersitContactImporterPropertyHandler \brief The QVersitContactImporterPropertyHandler class is the legacy interface for specifying custom import behaviour for vCard properties. + \since 1.1 This interface is replaced by QVersitContactImporterPropertyHandlerV2. For general information on extending Qt Versit, see the document on \l{Versit Plugins}. |