diff options
| author | Peter Yard <peter.yard@nokia.com> | 2011-04-15 14:24:20 +1000 |
|---|---|---|
| committer | Peter Yard <peter.yard@nokia.com> | 2011-04-15 14:24:20 +1000 |
| commit | 906c2d9a2f38058693d7a39b234a044724b1d1fc (patch) | |
| tree | 19d6df5e612aadcaa77a91a1715a3f75d2017d8c | |
| parent | 2b15ddb74099ff3a9179de0b37f8726add54b133 (diff) | |
Docs: added since version to 1.0 classes. QTMOBILITY-790
125 files changed, 1164 insertions, 1014 deletions
diff --git a/src/bearer/qnetworkconfigmanager.cpp b/src/bearer/qnetworkconfigmanager.cpp index 1fb9d364b7..28e3c84ad5 100644 --- a/src/bearer/qnetworkconfigmanager.cpp +++ b/src/bearer/qnetworkconfigmanager.cpp @@ -106,6 +106,7 @@ Q_GLOBAL_STATIC_QAPP_DESTRUCTION(QNetworkConfigurationManagerPrivate, connManage \inmodule QtNetwork \ingroup bearer + \since 1.0 QNetworkConfigurationManager provides access to the network configurations known to the system and enables applications to detect the system capabilities (with regards to network sessions) at runtime. @@ -133,7 +134,7 @@ Q_GLOBAL_STATIC_QAPP_DESTRUCTION(QNetworkConfigurationManagerPrivate, connManage \sa QNetworkConfiguration */ -/*! +/*! \fn void QNetworkConfigurationManager::configurationAdded(const QNetworkConfiguration& config) This signal is emitted whenever a new network configuration is added to the system. The new @@ -224,7 +225,7 @@ QNetworkConfigurationManager::QNetworkConfigurationManager( QObject* parent ) this, SIGNAL(configurationRemoved(QNetworkConfiguration))); connect(priv, SIGNAL(configurationUpdateComplete()), this, SIGNAL(updateCompleted())); - connect(priv, SIGNAL(onlineStateChanged(bool)), + connect(priv, SIGNAL(onlineStateChanged(bool)), this, SIGNAL(onlineStateChanged(bool))); connect(priv, SIGNAL(configurationChanged(QNetworkConfiguration)), this, SIGNAL(configurationChanged(QNetworkConfiguration))); @@ -284,7 +285,7 @@ QList<QNetworkConfiguration> QNetworkConfigurationManager::allConfigurations(QNe //find all InternetAccessPoints foreach (const QString &ii, conPriv->accessPointConfigurations.keys()) { - QExplicitlySharedDataPointer<QNetworkConfigurationPrivate> p = + QExplicitlySharedDataPointer<QNetworkConfigurationPrivate> p = conPriv->accessPointConfigurations.value(ii); if ( (p->state & filter) == filter ) { QNetworkConfiguration pt; @@ -295,7 +296,7 @@ QList<QNetworkConfiguration> QNetworkConfigurationManager::allConfigurations(QNe //find all service networks foreach (const QString &ii, conPriv->snapConfigurations.keys()) { - QExplicitlySharedDataPointer<QNetworkConfigurationPrivate> p = + QExplicitlySharedDataPointer<QNetworkConfigurationPrivate> p = conPriv->snapConfigurations.value(ii); if ( (p->state & filter) == filter ) { QNetworkConfiguration pt; diff --git a/src/bearer/qnetworkconfiguration.cpp b/src/bearer/qnetworkconfiguration.cpp index 933b8b5684..e446a3c96f 100644 --- a/src/bearer/qnetworkconfiguration.cpp +++ b/src/bearer/qnetworkconfiguration.cpp @@ -58,6 +58,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtNetwork \ingroup bearer + \since 1.0 QNetworkConfiguration encapsulates a single access point or service network. In most cases a single access point configuration can be mapped to one network @@ -352,7 +353,7 @@ QList<QNetworkConfiguration> QNetworkConfiguration::children() const bearer types: \table - \header + \header \o Value \o Description \row @@ -367,7 +368,7 @@ QList<QNetworkConfiguration> QNetworkConfiguration::children() const \row \o 2G \o The session uses CSD, GPRS, HSCSD, EDGE or cdmaOne. - \row + \row \o CDMA2000 \o The session uses CDMA. \row diff --git a/src/bearer/qnetworksession.cpp b/src/bearer/qnetworksession.cpp index fa79c47c76..b7b9bc6220 100644 --- a/src/bearer/qnetworksession.cpp +++ b/src/bearer/qnetworksession.cpp @@ -62,39 +62,40 @@ QTM_BEGIN_NAMESPACE \inmodule QtNetwork \ingroup bearer + \since 1.0 A QNetworkSession enables control over the system's network interfaces. The session's configuration - parameter are determined via the QNetworkConfiguration object to which it is bound. Depending on the + parameter are determined via the QNetworkConfiguration object to which it is bound. Depending on the type of the session (single access point or service network) a session may be linked to one or more - network interfaces. By means of \l{open()}{opening} and \l{close()}{closing} of network sessions - a developer can start and stop the systems network interfaces. If the configuration represents + network interfaces. By means of \l{open()}{opening} and \l{close()}{closing} of network sessions + a developer can start and stop the systems network interfaces. If the configuration represents multiple access points (see \l QNetworkConfiguration::ServiceNetwork) more advanced features such as roaming may be supported. - QNetworkSession supports session management within the same process and depending on the platform's - capabilities may support out-of-process sessions. If the same + QNetworkSession supports session management within the same process and depending on the platform's + capabilities may support out-of-process sessions. If the same network configuration is used by multiple open sessions the underlying network interface is only terminated once the last session has been closed. \section1 Roaming - Applications may connect to the preferredConfigurationChanged() signal in order to - receive notifications when a more suitable access point becomes available. + Applications may connect to the preferredConfigurationChanged() signal in order to + receive notifications when a more suitable access point becomes available. In response to this signal the application must either initiate the roaming via migrate() - or ignore() the new access point. Once the session has roamed the - newConfigurationActivated() signal is emitted. The application may now test the + or ignore() the new access point. Once the session has roamed the + newConfigurationActivated() signal is emitted. The application may now test the carrier and must either accept() or reject() it. The session will return to the previous access point if the roaming was rejected. The subsequent state diagram depicts the required state transitions. - + \image roaming-states.png - Some platforms may distinguish forced roaming and application level roaming (ALR). - ALR implies that the application controls (via migrate(), ignore(), accept() and reject()) + Some platforms may distinguish forced roaming and application level roaming (ALR). + ALR implies that the application controls (via migrate(), ignore(), accept() and reject()) whether a network session can roam from one access point to the next. Such control is useful if the application maintains stateful socket connections and wants to control the transition from - one interface to the next. Forced roaming implies that the system automatically roams to the next network without + one interface to the next. Forced roaming implies that the system automatically roams to the next network without consulting the application. This has the advantage that the application can make use of roaming features - without actually being aware of it. It is expected that the application detects that the underlying + without actually being aware of it. It is expected that the application detects that the underlying socket is broken and automatically reconnects via the new network link. If the platform supports both modes of roaming, an application indicates its preference @@ -103,7 +104,7 @@ QTM_BEGIN_NAMESPACE level roaming. If the client does not connect to the preferredConfigurationChanged(), forced roaming is used. If forced roaming is not supported the network session will not roam by default. - Some applications may want to suppress any form of roaming altogether. Possible use cases may be + Some applications may want to suppress any form of roaming altogether. Possible use cases may be high priority downloads or remote services which cannot handle a roaming enabled client. Clients can suppress roaming by connecting to the preferredConfigurationChanged() signal and answer each signal emission with ignore(). @@ -118,19 +119,19 @@ QTM_BEGIN_NAMESPACE single access point configuration the state of the session is the same as the state of the associated network interface. - \value Invalid The session is invalid due to an invalid configuration. This may - happen due to a removed access point or a configuration that was + \value Invalid The session is invalid due to an invalid configuration. This may + happen due to a removed access point or a configuration that was invalid to begin with. \value NotAvailable The session is based on a defined but not yet discovered QNetworkConfiguration (see \l QNetworkConfiguration::StateFlag). \value Connecting The network session is being established. \value Connected The network session is connected. If the current process wishes to use this session - it has to register its interest by calling open(). A network session + it has to register its interest by calling open(). A network session is considered to be ready for socket operations if it isOpen() and connected. \value Closing The network session is in the process of being shut down. \value Disconnected The network session is not connected. The associated QNetworkConfiguration has the state QNetworkConfiguration::Discovered. - \value Roaming The network session is roaming from one access point to another + \value Roaming The network session is roaming from one access point to another access point. */ @@ -180,16 +181,16 @@ QTM_BEGIN_NAMESPACE If the roaming process is non-seamless the IP address will change which means that a socket becomes invalid. However seamless mobility can ensure that the local IP address does not change. This is achieved by using a virtual IP address which is bound to the actual - link address. During the roaming process the virtual address is attached to the new link + link address. During the roaming process the virtual address is attached to the new link address. - Some platforms may support the concept of Forced Roaming and Application Level Roaming (ALR). - Forced roaming implies that the platform may simply roam to a new configuration without + Some platforms may support the concept of Forced Roaming and Application Level Roaming (ALR). + Forced roaming implies that the platform may simply roam to a new configuration without consulting applications. It is up to the application to detect the link layer loss and reestablish - its sockets. In contrast ALR provides the opportunity to prevent the system from roaming. + its sockets. In contrast ALR provides the opportunity to prevent the system from roaming. If this session is based on a configuration that supports roaming the application can choose - whether it wants to be consulted (ALR use case) by connecting to this signal. For as long as this signal - connection remains the session remains registered as a roaming stakeholder; otherwise roaming will + whether it wants to be consulted (ALR use case) by connecting to this signal. For as long as this signal + connection remains the session remains registered as a roaming stakeholder; otherwise roaming will be enforced by the platform. \sa migrate(), ignore(), QNetworkConfiguration::isRoamingAvailable() @@ -200,7 +201,7 @@ QTM_BEGIN_NAMESPACE This signal is emitted once the session has roamed to the new access point. The application may reopen its socket and test the suitability of the new network link. - Subsequently it must either accept() or reject() the new access point. + Subsequently it must either accept() or reject() the new access point. \sa accept(), reject() */ @@ -208,8 +209,8 @@ QTM_BEGIN_NAMESPACE /*! \fn void QNetworkSession::opened() - This signal is emitted when the network session has been opened. - + This signal is emitted when the network session has been opened. + The underlying network interface will not be shut down as long as the session remains open. Note that this feature is dependent on \l{QNetworkConfigurationManager::SystemSessionSupport}{system wide session support}. */ @@ -232,7 +233,7 @@ QNetworkSession::QNetworkSession(const QNetworkConfiguration& connectionConfig, d->q = this; d->publicConfig = connectionConfig; d->syncStateWithInterface(); - QObject::connect(d, SIGNAL(quitPendingWaitsForOpened()), + QObject::connect(d, SIGNAL(quitPendingWaitsForOpened()), this, SIGNAL(opened())); } @@ -249,12 +250,12 @@ QNetworkSession::~QNetworkSession() The system will not terminate a network interface until the session reference counter reaches zero. Therefore an open session allows an application to register its use of the interface. - As a result of calling open() the interface will be started if it is not connected/up yet. + As a result of calling open() the interface will be started if it is not connected/up yet. Some platforms may not provide support for out-of-process sessions. On such platforms the session - counter ignores any sessions held by another process. The platform capabilities can be + counter ignores any sessions held by another process. The platform capabilities can be detected via QNetworkConfigurationManager::capabilities(). - Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired + Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired by connecting to the stateChanged(), opened() or error() signals. It is not a requirement to open a session in order to monitor the underlying network interface. @@ -314,10 +315,10 @@ bool QNetworkSession::waitForOpened(int msecs) \l Disconnected if the current session was the last open session. If the platform does not support out-of-process sessions calling this function does not stop the - interface. In this case \l{stop()} has to be used to force a shut down. + interface. In this case \l{stop()} has to be used to force a shut down. The platform capabilities can be detected via QNetworkConfigurationManager::capabilities(). - Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired + Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired by connecting to the stateChanged(), opened() or error() signals. \sa open(), stop(), isOpen() @@ -328,10 +329,10 @@ void QNetworkSession::close() } /*! - Invalidates all open sessions against the network interface and therefore stops the + Invalidates all open sessions against the network interface and therefore stops the underlying network interface. This function always changes the session's state() flag to - \l Disconnected. - + \l Disconnected. + On Symbian platform, a 'NetworkControl' capability is required for full interface-level stop (without the capability, only the current session is stopped). @@ -358,7 +359,7 @@ QNetworkConfiguration QNetworkSession::configuration() const bearer types: \table - \header + \header \o Value \o Description \row @@ -373,7 +374,7 @@ QNetworkConfiguration QNetworkSession::configuration() const \row \o 2G \o The session uses CSD, GPRS, HSCSD, EDGE or cdmaOne. - \row + \row \o CDMA2000 \o The session uses CDMA. \row @@ -390,9 +391,9 @@ QNetworkConfiguration QNetworkSession::configuration() const \o The session uses WiMAX. \endtable - If the session is based on a network configuration of type - \l QNetworkConfiguration::ServiceNetwork the type of the preferred or currently - active configuration is returned. Therefore the bearer type may change + If the session is based on a network configuration of type + \l QNetworkConfiguration::ServiceNetwork the type of the preferred or currently + active configuration is returned. Therefore the bearer type may change over time. This function returns an empty string if this session is based on an invalid configuration, or @@ -410,8 +411,8 @@ QNetworkConfiguration QNetworkSession::configuration() const This function only returns a valid QNetworkInterface when this session is \l Connected. The returned interface may change as a result of a roaming process. - - Note: this function does not work in Symbian emulator due to the way the + + Note: this function does not work in Symbian emulator due to the way the connectivity is emulated on Windows. \sa state() @@ -433,15 +434,15 @@ bool QNetworkSession::isOpen() const } /*! - Returns the state of the session. - - If the session is based on a single access point configuration the state of the + Returns the state of the session. + + If the session is based on a single access point configuration the state of the session is the same as the state of the associated network interface. Therefore - a network session object can be used to monitor network interfaces. + a network session object can be used to monitor network interfaces. A \l QNetworkConfiguration::ServiceNetwork based session summarizes the state of all its children - and therefore returns the \l Connected state if at least one of the service network's - \l {QNetworkConfiguration::children()}{children()} configurations is active. + and therefore returns the \l Connected state if at least one of the service network's + \l {QNetworkConfiguration::children()}{children()} configurations is active. Note that it is not required to hold an open session in order to obtain the network interface state. A connected but closed session may be used to monitor network interfaces whereas an open and connected @@ -465,7 +466,7 @@ QNetworkSession::SessionError QNetworkSession::error() const } /*! - Returns a human-readable description of the last device error that + Returns a human-readable description of the last device error that occurred. \sa error() @@ -492,7 +493,7 @@ QString QNetworkSession::errorString() const QNetworkConfiguration that is used by this session; otherwise an empty string. The main purpose of this key is to determine which Internet access point is used - if the session is based on a \l{QNetworkConfiguration::ServiceNetwork}{ServiceNetwork}. + if the session is based on a \l{QNetworkConfiguration::ServiceNetwork}{ServiceNetwork}. The following code snippet highlights the difference: \code QNetworkConfigurationManager mgr; @@ -519,7 +520,7 @@ QString QNetworkSession::errorString() const this key may return an identifier for either a \l {QNetworkConfiguration::ServiceNetwork}{service network} or a \l {QNetworkConfiguration::InternetAccessPoint}{Internet access points} configurations - whereas \i ActiveConfiguration always returns identifiers to + whereas \i ActiveConfiguration always returns identifiers to \l {QNetworkConfiguration::InternetAccessPoint}{Internet access points} configurations. \row \o ConnectInBackground @@ -555,7 +556,7 @@ QVariant QNetworkSession::sessionProperty(const QString& key) const /*! Sets the property \a value on the session. The property is identified using - \a key. Removing an already set property can be achieved by passing an + \a key. Removing an already set property can be achieved by passing an invalid QVariant. Note that the \i UserChoiceConfiguration and \i ActiveConfiguration @@ -563,15 +564,15 @@ QVariant QNetworkSession::sessionProperty(const QString& key) const */ void QNetworkSession::setSessionProperty(const QString& key, const QVariant& value) { - if (key == "ActiveConfiguration" - || key == "UserChoiceConfiguration") + if (key == "ActiveConfiguration" + || key == "UserChoiceConfiguration") return; d->setSessionProperty(key, value); } /*! - Instructs the session to roam to the new access point. The old access point remains active + Instructs the session to roam to the new access point. The old access point remains active until the application calls accept(). The newConfigurationActivated() signal is emitted once roaming has been completed. @@ -590,17 +591,17 @@ void QNetworkSession::migrate() */ void QNetworkSession::ignore() { - // Needed on at least Symbian platform: the roaming must be explicitly + // Needed on at least Symbian platform: the roaming must be explicitly // ignore()'d or migrate()'d d->ignore(); } /*! - Instructs the session to permanently accept the new access point. Once this function + Instructs the session to permanently accept the new access point. Once this function has been called the session may not return to the old access point. The old access point may be closed in the process if there are no other network sessions for it. - Therefore any open socket that still uses the old access point + Therefore any open socket that still uses the old access point may become unusable and should be closed before completing the migration. */ void QNetworkSession::accept() @@ -609,7 +610,7 @@ void QNetworkSession::accept() } /*! - The new access point is not suitable for the application. By calling this function the + The new access point is not suitable for the application. By calling this function the session returns to the previous access point/configuration. This action may invalidate any socket that has been created via the not desired access point. @@ -624,10 +625,10 @@ void QNetworkSession::reject() /*! Returns the amount of data sent in bytes; otherwise 0. - This field value includes the usage across all open network + This field value includes the usage across all open network sessions which use the same network interface. - If the session is based on a service network configuration the number of + If the session is based on a service network configuration the number of sent bytes across all active member configurations are returned. This function may not always be supported on all platforms and returns 0. @@ -643,10 +644,10 @@ quint64 QNetworkSession::bytesWritten() const /*! Returns the amount of data received in bytes; otherwise 0. - This field value includes the usage across all open network + This field value includes the usage across all open network sessions which use the same network interface. - If the session is based on a service network configuration the number of + If the session is based on a service network configuration the number of sent bytes across all active member configurations are returned. This function may not always be supported on all platforms and returns 0. @@ -670,12 +671,12 @@ quint64 QNetworkSession::activeTime() const /*! \internal - This function is required to detect whether the client wants to control + This function is required to detect whether the client wants to control the roaming process. If he connects to preferredConfigurationChanged() signal he intends to influence it. Otherwise QNetworkSession always roams without registering this session as a stakeholder in the roaming process. - For more details check the Forced vs ALR roaming section in the QNetworkSession + For more details check the Forced vs ALR roaming section in the QNetworkSession class description. */ void QNetworkSession::connectNotify(const char *signal) @@ -687,7 +688,7 @@ void QNetworkSession::connectNotify(const char *signal) if (qstrcmp(signal, SIGNAL(preferredConfigurationChanged(QNetworkConfiguration,bool))) == 0) { d->setALREnabled(true); } -#endif +#endif } /*! @@ -706,8 +707,8 @@ void QNetworkSession::disconnectNotify(const char *signal) #ifdef Q_OS_SYMBIAN if (qstrcmp(signal, SIGNAL(preferredConfigurationChanged(QNetworkConfiguration,bool))) == 0) { d->setALREnabled(false); - } -#endif + } +#endif } #include "moc_qnetworksession.cpp" diff --git a/src/contacts/details/qcontactdetails.cpp b/src/contacts/details/qcontactdetails.cpp index 057a36fabd..933fad6739 100644 --- a/src/contacts/details/qcontactdetails.cpp +++ b/src/contacts/details/qcontactdetails.cpp @@ -77,9 +77,10 @@ QTM_BEGIN_NAMESPACE \class QContactSyncTarget \brief The QContactSyncTarget class provides a sync target for a contact. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-details This leaf-class has been part of the default schema since version @@ -123,6 +124,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactSyncTarget::FieldSyncTarget, "SyncTarget"); \brief The QContactEmailAddress class contains an email address of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -158,6 +160,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactEmailAddress::FieldEmailAddress, "EmailAddress" \brief The QContactFamily class contains names of family members of a contact. \ingroup contacts-details + \since 1.1 This leaf-class has been part of the default schema since version 1.1 of the Qt Mobility project. @@ -211,6 +214,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactFamily::FieldChildren, "Children"); \brief The QContactFavorite class indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites. \ingroup contacts-details + \since 1.1 This leaf-class has been part of the default schema since version 1.1 of the Qt Mobility project. @@ -244,7 +248,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactFavorite::FieldIndex, "Index"); */ /*! - \fn QContactFavorite::setFavorite(bool isFavorite) + \fn QContactFavorite::setFavorite(bool isFavorite) If \a isFavorite is true, marks the contact as a favorite. Otherwise, marks the contact as not a favorite. */ @@ -254,7 +258,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactFavorite::FieldIndex, "Index"); */ /*! - \fn QContactFavorite::setIndex(int index) + \fn QContactFavorite::setIndex(int index) Sets the index of the favorite contact to \a index. */ @@ -279,6 +283,7 @@ QContactFilter QContactFavorite::match() \class QContactAnniversary \brief The QContactAnniversary class contains an anniversary of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -434,6 +439,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactAnniversary::SubTypeMemorial, "Memorial"); \class QContactAvatar \ingroup contacts-details \brief The QContactAvatar class contains avatar URLs of a contact. + \since 1.0 Users can specify avatar URLs for a contact using this detail. Generally, a URL will specify the location of a full-sized @@ -506,6 +512,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactAvatar::FieldVideoUrl, "VideoUrl"); \class QContactAddress \brief The QContactAddress class contains an address of a contact. \ingroup contacts-details + \since 1.0 The fields in the QContactAddress class are based on the segments of the ADR property of a Versit vCard file. @@ -523,7 +530,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactAddress::DefinitionName, "Address"); /*! \variable QContactAddress::FieldStreet - +using slashes in python strings The field key constant for the value containing the street segment. The street segment contains the street number and street name of the address. \sa street(), setStreet() @@ -749,6 +756,7 @@ QContactFilter QContactAddress::match(const QString &subString) \brief The QContactUrl class contains a url associated with a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -836,6 +844,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactUrl::SubTypeBlog, "Blog"); \brief The QContactPhoneNumber class provides a phone number of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1004,6 +1013,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactPhoneNumber::SubTypeDtmfMenu, "DtmfMenu"); \class QContactBirthday \brief The QContactBirthday class contains a birthday of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1077,6 +1087,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactBirthday::FieldCalendarId, "CalendarId"); \class QContactGender \brief The QContactGender class contains the gender of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1351,6 +1362,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactGeoLocation::FieldTimestamp, "Timestamp"); \brief The QContactGuid class contains a globally unique Id of a contact, for use in synchronization with other datastores. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1425,6 +1437,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactHobby::FieldHobby, "Hobby"); \class QContactName \brief The QContactName class contains a name of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1506,7 +1519,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldCustomLabel, "CustomLabel"); /*! \fn QContactName::middleName() const - + Returns the middle (additional, or other) name segment of the name stored in this detail. */ @@ -1554,6 +1567,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactName::FieldCustomLabel, "CustomLabel"); \class QContactNickname \brief The QContactNickname class contains a nickname of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1590,6 +1604,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactNickname::FieldNickname, "Nickname"); \brief The QContactNote class contains a note associated with a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1627,6 +1642,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactNote::FieldNote, "Note"); \brief The QContactTag class contains a tag associated with a contact. \ingroup contacts-details + \since 1.0 Typically the tags associated with a contact will be distinct, although this is usually only enforced when the contact is saved @@ -1689,6 +1705,7 @@ QContactFilter QContactTag::match(const QString &subString) \ingroup contacts-details \brief The QContactThumbnail class contains a thumbnail used in display lists to represent the contact. + \since 1.0 Users can specify a thumbnail image for a contact via this detail. Support for this detail is backend specific; some managers will save @@ -1746,6 +1763,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactThumbnail::FieldThumbnail, "Thumbnail"); \brief The QContactTimestamp class contains the creation and last-modified timestamp associated with the contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1799,6 +1817,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactTimestamp::FieldCreationTimestamp, "CreationTim \class QContactType \brief The QContactType class describes the type of the contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1863,6 +1882,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactType::TypeGroup, "Group"); \brief The QContactDisplayLabel class is the (possibly synthesized) display label of a contact. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -1897,6 +1917,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactDisplayLabel::FieldLabel, "Label"); \class QContactOnlineAccount \brief The QContactOnlineAccount class provides an online account, which the contact uses to communicate with friends and family. + \since 1.0 A QContactOnlineAccount consists of the account details required to communicate with the contact, including the account URI, the capabilities @@ -2072,7 +2093,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::ProtocolYahoo, "yahoo"); /*! \fn QContactOnlineAccount::setAccountUri(const QString& accountUri) - + Sets the universal resource identifier of the contact's online account to \a accountUri. */ @@ -2098,7 +2119,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::ProtocolYahoo, "yahoo"); /*! \fn QContactOnlineAccount::setSubTypes(const QStringList& subTypes) - + Sets the subtypes which this detail implements to be those contained in the list of given \a subTypes. */ @@ -2136,6 +2157,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOnlineAccount::ProtocolYahoo, "yahoo"); \brief The QContactOrganization class provides details about an organization that the contact is either a part of, or stands for. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -2226,7 +2248,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantNam /*! \fn QContactOrganization::setDepartment(const QStringList& department) - + Sets the contact's department of the organization stored in this detail to \a department. The department is a list of progressively finer-grained information. @@ -2240,7 +2262,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantNam /*! \fn QContactOrganization::setLocation(const QString& location) - + Sets the location (e.g. city or suburb) of the organization stored in this detail to \a location. */ @@ -2274,7 +2296,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantNam /*! \fn QContactOrganization::setAssistantName(const QString& assistantName) - + Sets the name of the default assistant of contacts belonging to this organization to \a assistantName. */ @@ -2293,6 +2315,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactOrganization::FieldAssistantName, "AssistantNam \brief The QContactRingtone class provides a ringtone associated with a contact \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. @@ -2377,6 +2400,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactRingtone::FieldVibrationRingtoneUrl, "Vibration \class QContactPresence \brief The QContactPresence class provides presence information for an online account of a contact. + \since 1.0 Presence information for a particular QContactOnlineAccount detail is provided in a QContactPresence detail which is linked (via linkedDetailUris()) to the @@ -2552,6 +2576,7 @@ Q_DEFINE_LATIN1_CONSTANT(QContactPresence::FieldCustomMessage, "CustomMessage"); \brief The QContactGlobalPresence class provides aggregated presence information for a contact, synthesized or supplied by the backend. \ingroup contacts-details + \since 1.0 This leaf-class has been part of the default schema since version 1.0 of the Qt Mobility project. diff --git a/src/contacts/engines/qcontactinvalidbackend.cpp b/src/contacts/engines/qcontactinvalidbackend.cpp index 6124d658ee..115a164343 100644 --- a/src/contacts/engines/qcontactinvalidbackend.cpp +++ b/src/contacts/engines/qcontactinvalidbackend.cpp @@ -45,12 +45,13 @@ /*! \class QContactInvalidEngine - + \inmodule QtContacts - + \since 1.0 + \brief The QContactInvalidEngine class provides an implementation of QContactManagerEngine whose functions always return an error. - + The invalid engine may be used as a reference or test engine, but does nothing. */ diff --git a/src/contacts/engines/qcontactmemorybackend.cpp b/src/contacts/engines/qcontactmemorybackend.cpp index 05f21fcf9f..b97288ec33 100644 --- a/src/contacts/engines/qcontactmemorybackend.cpp +++ b/src/contacts/engines/qcontactmemorybackend.cpp @@ -59,22 +59,23 @@ QTM_BEGIN_NAMESPACE /*! \class QContactMemoryEngine - + \inmodule QtContacts - + \brief The QContactMemoryEngine class provides an in-memory implementation of a contacts backend. + \since 1.0 \internal - + It may be used as a reference implementation, or when persistent storage is not required. - + During construction, it will load the in-memory data associated with the memory store identified by the "id" parameter from the given parameters if it exists, or a new, anonymous store if it does not. - + Data stored in this engine is only available in the current process. - + This engine supports sharing, so an internal reference count is increased whenever a manager uses this backend, and is decreased when the manager no longer requires this engine. @@ -230,7 +231,7 @@ QList<QContact> QContactMemoryEngine::contacts(const QContactFilter& filter, con } /*! Saves the given contact \a theContact, storing any error to \a error and - filling the \a changeSet with ids of changed contacts as required + filling the \a changeSet with ids of changed contacts as required Returns true if the operation was successful otherwise false. */ bool QContactMemoryEngine::saveContact(QContact* theContact, QContactChangeSet& changeSet, QContactManager::Error* error) @@ -381,7 +382,7 @@ bool QContactMemoryEngine::removeContacts(const QList<QContactLocalId>& contactI *error = QContactManager::BadArgumentError; return false; } - + QContactChangeSet changeSet; QContactLocalId current; QContactManager::Error operationError = QContactManager::NoError; @@ -435,7 +436,7 @@ QList<QContactRelationship> QContactMemoryEngine::relationships(const QString& r } /*! Saves the given relationship \a relationship, storing any error to \a error and - filling the \a changeSet with ids of changed contacts and relationships as required + filling the \a changeSet with ids of changed contacts and relationships as required Returns true if the operation was successful otherwise false. */ bool QContactMemoryEngine::saveRelationship(QContactRelationship* relationship, QContactChangeSet& changeSet, QContactManager::Error* error) @@ -527,7 +528,7 @@ bool QContactMemoryEngine::saveRelationships(QList<QContactRelationship>* relati } /*! Removes the given relationship \a relationship, storing any error to \a error and - filling the \a changeSet with ids of changed contacts and relationships as required + filling the \a changeSet with ids of changed contacts and relationships as required Returns true if the operation was successful otherwise false. */ bool QContactMemoryEngine::removeRelationship(const QContactRelationship& relationship, QContactChangeSet& changeSet, QContactManager::Error* error) @@ -594,7 +595,7 @@ QMap<QString, QContactDetailDefinition> QContactMemoryEngine::detailDefinitions( } /*! Saves the given detail definition \a def, storing any error to \a error and - filling the \a changeSet with ids of changed contacts as required + filling the \a changeSet with ids of changed contacts as required Returns true if the operation was successful otherwise false. */ bool QContactMemoryEngine::saveDetailDefinition(const QContactDetailDefinition& def, const QString& contactType, QContactChangeSet& changeSet, QContactManager::Error* error) diff --git a/src/contacts/engines/qcontactsimulatorbackend.cpp b/src/contacts/engines/qcontactsimulatorbackend.cpp index fc257d9e30..d11a374713 100644 --- a/src/contacts/engines/qcontactsimulatorbackend.cpp +++ b/src/contacts/engines/qcontactsimulatorbackend.cpp @@ -66,6 +66,7 @@ using namespace Simulator; /*! * \class QContactSimulatorEngine * \brief This class provides a simulator-managed in-memory backend. + \since 1.0 * \internal */ @@ -144,7 +145,7 @@ bool QContactSimulatorEngine::saveContact(QContact* theContact, QContactChangeSe return true; } - +using slashes in python strings bool QContactSimulatorEngine::removeContact(const QContactLocalId& contactId, QContactChangeSet& changeSet, QContactManager::Error* error) { if (!mNotifySimulator) @@ -169,7 +170,7 @@ bool QContactSimulatorEngine::saveRelationship(QContactRelationship* relationshi { if (!mNotifySimulator) return QContactMemoryEngine::saveRelationship(relationship, changeSet, error); - +using slashes in python strings QLocalSocket *sendSocket = ContactConnection::instance()->sendSocket(); // save remotely diff --git a/src/contacts/filters/qcontactchangelogfilter.cpp b/src/contacts/filters/qcontactchangelogfilter.cpp index abead5ac15..3c2338e45b 100644 --- a/src/contacts/filters/qcontactchangelogfilter.cpp +++ b/src/contacts/filters/qcontactchangelogfilter.cpp @@ -50,11 +50,12 @@ QTM_BEGIN_NAMESPACE \class QContactChangeLogFilter \brief The QContactChangeLogFilter class provides a filter based around a contact timestamp criterion. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which have been updated or created within a certain period of time. */ diff --git a/src/contacts/filters/qcontactdetailfilter.cpp b/src/contacts/filters/qcontactdetailfilter.cpp index b06f5787a0..de36b07795 100644 --- a/src/contacts/filters/qcontactdetailfilter.cpp +++ b/src/contacts/filters/qcontactdetailfilter.cpp @@ -49,12 +49,13 @@ QTM_BEGIN_NAMESPACE /*! \class QContactDetailFilter \brief The QContactDetailFilter class provides a filter based around a detail value criterion - - + + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which contain a detail of a particular definition with a particular value */ diff --git a/src/contacts/filters/qcontactdetailrangefilter.cpp b/src/contacts/filters/qcontactdetailrangefilter.cpp index 0712043098..855fb5d01d 100644 --- a/src/contacts/filters/qcontactdetailrangefilter.cpp +++ b/src/contacts/filters/qcontactdetailrangefilter.cpp @@ -50,11 +50,12 @@ QTM_BEGIN_NAMESPACE \class QContactDetailRangeFilter \brief The QContactDetailRangeFilter class provides a filter based around a detail value range criterion. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which contain a detail of a particular definition with a particular value that lies in a range (either open or closed). */ diff --git a/src/contacts/filters/qcontactintersectionfilter.cpp b/src/contacts/filters/qcontactintersectionfilter.cpp index addc5f35e5..b9619b93b0 100644 --- a/src/contacts/filters/qcontactintersectionfilter.cpp +++ b/src/contacts/filters/qcontactintersectionfilter.cpp @@ -49,11 +49,12 @@ QTM_BEGIN_NAMESPACE /*! \class QContactIntersectionFilter \brief The QContactIntersectionFilter class provides a filter which intersects the results of other filters. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which match all of the filters in the intersection */ diff --git a/src/contacts/filters/qcontactinvalidfilter.cpp b/src/contacts/filters/qcontactinvalidfilter.cpp index 816d77de32..fccb99c76b 100644 --- a/src/contacts/filters/qcontactinvalidfilter.cpp +++ b/src/contacts/filters/qcontactinvalidfilter.cpp @@ -45,11 +45,12 @@ /*! \class QContactInvalidFilter \brief The QContactInvalidFilter class matches no contacts. - + \inmodule QtContacts - + \ingroup contacts-filters - + \since 1.0 + This class provides a filter which will never match any contacts */ diff --git a/src/contacts/filters/qcontactlocalidfilter.cpp b/src/contacts/filters/qcontactlocalidfilter.cpp index 1f25d61cee..ff9564060c 100644 --- a/src/contacts/filters/qcontactlocalidfilter.cpp +++ b/src/contacts/filters/qcontactlocalidfilter.cpp @@ -49,12 +49,13 @@ QTM_BEGIN_NAMESPACE /*! \class QContactLocalIdFilter \brief The QContactLocalIdFilter class provides a filter based around a list of contact ids - - + + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts whose ids are contained in the given list of ids. */ diff --git a/src/contacts/filters/qcontactrelationshipfilter.cpp b/src/contacts/filters/qcontactrelationshipfilter.cpp index b2127f81f9..32eec1d4d6 100644 --- a/src/contacts/filters/qcontactrelationshipfilter.cpp +++ b/src/contacts/filters/qcontactrelationshipfilter.cpp @@ -49,12 +49,13 @@ QTM_BEGIN_NAMESPACE \class QContactRelationshipFilter \brief The QContactRelationshipFilter class provides a filter based around relationship criteria. - - + + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which are involved in relationships which are of a certain type, or which involve certain contacts. diff --git a/src/contacts/filters/qcontactunionfilter.cpp b/src/contacts/filters/qcontactunionfilter.cpp index cb47c795f3..a1cdb3d202 100644 --- a/src/contacts/filters/qcontactunionfilter.cpp +++ b/src/contacts/filters/qcontactunionfilter.cpp @@ -50,12 +50,13 @@ QTM_BEGIN_NAMESPACE \class QContactUnionFilter \brief The QContactUnionFilter class provides a filter which unions the results of other filters. - - - \inmodule QtContacts - + + + \inmodule QtContacts + \since 1.0 + \ingroup contacts-filters - + It may be used to select contacts which match all of the filters in the union */ diff --git a/src/contacts/qcontact.cpp b/src/contacts/qcontact.cpp index 58c0f46d61..c30646a5da 100644 --- a/src/contacts/qcontact.cpp +++ b/src/contacts/qcontact.cpp @@ -54,11 +54,12 @@ QTM_BEGIN_NAMESPACE /*! \class QContact - + \brief The QContact class represents an addressbook contact. \inmodule QtContacts - + \since 1.0 + \ingroup contacts-main Individual contacts, groups, and other types of contacts are represented with @@ -82,7 +83,7 @@ QTM_BEGIN_NAMESPACE a group contact would have a \c "HasMember" relationship with the QContacts that are its members. Spouses, managers and assistants can also be represented this way. - + A QContact instance represents the in-memory version of an addressbook contact, and has no tie to a specific QContactManager. It is possible for the contents of a QContact to change independently of the contents that are stored persistently @@ -100,7 +101,7 @@ QTM_BEGIN_NAMESPACE you will need to ask a specific QContactManager for the new display label for the contact, since system settings (like the order of first or last names) can vary between managers. - + \sa QContactManager, QContactDetail */ diff --git a/src/contacts/qcontactabstractrequest.cpp b/src/contacts/qcontactabstractrequest.cpp index ba92fc147d..78f3c1100a 100644 --- a/src/contacts/qcontactabstractrequest.cpp +++ b/src/contacts/qcontactabstractrequest.cpp @@ -60,6 +60,7 @@ QTM_BEGIN_NAMESPACE asynchronous requests to be made of a manager if it supports them. \inmodule QtContacts + \since 1.0 \ingroup contacts-main diff --git a/src/contacts/qcontactchangeset.cpp b/src/contacts/qcontactchangeset.cpp index f90197158d..70150028c1 100644 --- a/src/contacts/qcontactchangeset.cpp +++ b/src/contacts/qcontactchangeset.cpp @@ -48,19 +48,20 @@ QTM_BEGIN_NAMESPACE /*! \class QContactChangeSet - + \inmodule QtContacts - + \since 1.0 + \brief The QContactChangeSet class provides a simple API to simplify the emission of state-change signals from QContactManagerEngine implementations. - + This class can be utilised by backend implementations to ensure correct emission of the \l QContactManagerEngine::dataChanged(), \l QContactManagerEngine::contactsAdded(), \l QContactManagerEngine::contactsChanged() and \l QContactManagerEngine::contactsRemoved(). - + \sa QContactManagerEngine */ diff --git a/src/contacts/qcontactdetail.cpp b/src/contacts/qcontactdetail.cpp index 84a8be1080..2c9c18058d 100644 --- a/src/contacts/qcontactdetail.cpp +++ b/src/contacts/qcontactdetail.cpp @@ -78,13 +78,14 @@ Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash) /*! \class QContactDetail - + \brief The QContactDetail class represents a single, complete detail about a contact. \inmodule QtContacts \ingroup contacts-main - + \since 1.0 + All of the information for a contact is stored in one or more QContactDetail objects. - + A detail is a group of logically related bits of data - for example, a street address is a single detail that has multiple fields (number, region, country etc). Every QContactDetail has the name of an associated QContactDetailDefinition that describes the fields, their data type, and any @@ -120,7 +121,7 @@ Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash) standardized access to values. For example, \l QContactPhoneNumber provides a convenient API for manipulating a QContactDetail as a phone number, according to the schema. - + In general, QContactDetail and the built in subclasses (like \l QContactPhoneNumber) provide constants for the names of fields (like \l QContactPhoneNumber::FieldNumber), and for predefined common values like \l QContactDetail::ContextHome. Typically the constants for field names start @@ -132,36 +133,36 @@ Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash) operation, and declare your own field constants with \l Q_DECLARE_LATIN1_CONSTANT. See the predefined detail subclasses (like \l QContactPhoneNumber, \l QContactAddress) for more information. - + QContactDetail objects act like type checked values. In general, you can assign them to and fro and have reasonable behaviour, like the following example. - + \code - + QContactPhoneNumber number; number.setNumber("555-1212"); // number.value(QContactPhoneNumber::FieldNumber) == "555-1212"; // number.definitionName() == QContactPhoneNumber::DefinitionName - + QContactDetail detail = number; // detail.value(QContactPhoneNumber::FieldNumber) == "555-1212"; // detail.definitionName() == QContactPhoneNumber::DefinitionName - + QContactPhoneNumber otherNumber = detail; // otherNumber.number() == "555-1212"; // otherNumber.definitionName() == QContactPhoneNumber::DefinitionName - + QContactAddress address = detail; // address is now a default constructed QContactAddress // address.value(QContactPhoneNumber::FieldNumber) is empty // address.definitionName() == QContactAddress::DefinitionName - + QContactAddress otherAddress = number; // otherAddress is now a default constructed QContactAddress // otherAddress.value(QContactPhoneNumber::FieldNumber) is empty // otherAddress.definitionName() == QContactAddress::DefinitionName \endcode - + \sa QContact, QContactDetailDefinition, QContactDetailFilter, QContactDetailRangeFilter, Q_DECLARE_CUSTOM_CONTACT_DETAIL */ diff --git a/src/contacts/qcontactdetaildefinition.cpp b/src/contacts/qcontactdetaildefinition.cpp index 2d82866785..1dc7f5a784 100644 --- a/src/contacts/qcontactdetaildefinition.cpp +++ b/src/contacts/qcontactdetaildefinition.cpp @@ -52,7 +52,8 @@ QTM_BEGIN_NAMESPACE \class QContactDetailDefinition \inmodule QtContacts - + \since 1.0 + The QContactDetailDefinition class provides the specification for a detail that can be included in any particular QContact. The definition does not include any data, but defines diff --git a/src/contacts/qcontactdetailfielddefinition.cpp b/src/contacts/qcontactdetailfielddefinition.cpp index 81d20f91cc..edd4d4cad3 100644 --- a/src/contacts/qcontactdetailfielddefinition.cpp +++ b/src/contacts/qcontactdetailfielddefinition.cpp @@ -51,9 +51,10 @@ QTM_BEGIN_NAMESPACE /*! \class QContactDetailFieldDefinition \brief The QContactDetailFieldDefinition class provides a field in a QContactDetail. - + \inmodule QtContacts - + \since 1.0 + Encapsulates information about a particular datum which may be part of a QContactDetail, including the type and allowable values. */ diff --git a/src/contacts/qcontactfetchhint.cpp b/src/contacts/qcontactfetchhint.cpp index f1dd2c94bd..56df42d4a2 100644 --- a/src/contacts/qcontactfetchhint.cpp +++ b/src/contacts/qcontactfetchhint.cpp @@ -54,6 +54,7 @@ QTM_BEGIN_NAMESPACE \class QContactFetchHint \inmodule QtContacts + \since 1.0 \brief The QContactFetchHint class provides hints to the manager about which contact information needs to be retrieved in an asynchronous fetch request or a synchronous diff --git a/src/contacts/qcontactfilter.cpp b/src/contacts/qcontactfilter.cpp index 78dd7ed2b7..d55e06712d 100644 --- a/src/contacts/qcontactfilter.cpp +++ b/src/contacts/qcontactfilter.cpp @@ -58,9 +58,10 @@ through a QContactManager. \inmodule QtContacts - + \since 1.0 + \ingroup contacts-main - + This class is used as a parameter to various functions offered by QContactManager, to allow selection of contacts which have certain details or properties. */ diff --git a/src/contacts/qcontactid.cpp b/src/contacts/qcontactid.cpp index 12605e6fc1..efe12b5753 100644 --- a/src/contacts/qcontactid.cpp +++ b/src/contacts/qcontactid.cpp @@ -49,12 +49,13 @@ QTM_BEGIN_NAMESPACE /*! \class QContactId - + \inmodule QtContacts - + \brief The QContactId class provides information that uniquely identifies a contact in a particular manager. - + \since 1.0 + It consists of a manager URI which identifies the manager which contains the contact, and the local id of the contact in that manager. diff --git a/src/contacts/qcontactmanager.cpp b/src/contacts/qcontactmanager.cpp index dde55ed953..a6485f9301 100644 --- a/src/contacts/qcontactmanager.cpp +++ b/src/contacts/qcontactmanager.cpp @@ -56,9 +56,10 @@ QTM_BEGIN_NAMESPACE \class QContactManager \brief The QContactManager class provides an interface which allows clients with access to contact information stored in a particular backend. \inmodule QtContacts - + \since 1.0 + \ingroup contacts-main - + This class provides an abstraction of a datastore or aggregation of datastores which contains contact information. It provides methods to retrieve and manipulate contact information, contact relationship information, and supported schema definitions. It also provides metadata and error information reporting. @@ -209,7 +210,7 @@ bool QContactManager::parseUri(const QString& uri, QString* pManagerId, QMap<QSt \a implementationVersion. This function is generally useful only if you intend to construct a manager with the \l fromUri() function, or wish to set the manager URI field in a QContactId manually (for synchronization or other purposes). Most clients will not need to use this function. */ -QString QContactManager::buildUri(const QString& managerName, const QMap<QString, QString>& params, int implementationVersion) +QString QContactManager::buildUri(const QString& managerName, const QMap<QString, QString>& params, int implementationVersion) { QString ret(QLatin1String("qtcontacts:%1:%2")); // we have to escape each param @@ -311,15 +312,15 @@ void QContactManager::createEngine(const QString& managerName, const QMap<QStrin If an empty \a managerName is specified, the default implementation for the platform will be instantiated. If the specified implementation version is not available, the manager with the name \a managerName with the default implementation version is instantiated. */ -QContactManager::QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters, QObject* parent) - : QObject(parent), - d(new QContactManagerData) -{ - QMap<QString, QString> params = parameters; +QContactManager::QContactManager(const QString& managerName, int implementationVersion, const QMap<QString, QString>& parameters, QObject* parent) + : QObject(parent), + d(new QContactManagerData) +{ + QMap<QString, QString> params = parameters; params[QString(QLatin1String(QTCONTACTS_IMPLEMENTATION_VERSION_NAME))] = QString::number(implementationVersion); - createEngine(managerName, params); -} - + createEngine(managerName, params); +} + /*! Frees the memory used by the QContactManager */ QContactManager::~QContactManager() { @@ -529,7 +530,7 @@ QContact QContactManager::contact(const QContactLocalId& contactId, const QConta Returns the list of contacts with the ids given by \a localIds. There is a one-to-one correspondence between the returned contacts and the supplied \a localIds. - + If there is an invalid id in \a localIds, then an empty QContact will take its place in the returned list. The deprecated \a errorMap parameter can be supplied to store per-input errors in. In all cases, calling \l errorMap() will return the per-input errors for the latest batch function. @@ -1060,7 +1061,7 @@ QString QContactManager::managerName() const QMap<QString, QString> QContactManager::managerParameters() const { QMap<QString, QString> params = d->m_engine->managerParameters(); - + params.remove(QString::fromAscii(QTCONTACTS_VERSION_NAME)); params.remove(QString::fromAscii(QTCONTACTS_IMPLEMENTATION_VERSION_NAME)); return params; diff --git a/src/contacts/qcontactmanagerengine.cpp b/src/contacts/qcontactmanagerengine.cpp index 5813f953ea..51e73cb7ad 100644 --- a/src/contacts/qcontactmanagerengine.cpp +++ b/src/contacts/qcontactmanagerengine.cpp @@ -74,8 +74,9 @@ static bool validateActionFilter(const QContactFilter& filter); \brief The QContactManagerEngine class provides the interface for implementations of the contact manager backend functionality. \inmodule QtContacts - + \ingroup contacts-backends + \since 1.0 Instances of this class are usually provided by a \l QContactManagerEngineFactory, which is loaded from a plugin. @@ -1687,7 +1688,7 @@ QContact QContactManagerEngine::compatibleContact(const QContact& original, QCon detail.removeValue(key); else detail.setValue(key, innerValues); - } + } if (field.dataType() == QVariant::StringList) { QStringList innerValues = variant.toStringList(); QMutableListIterator<QString> it(innerValues); @@ -2654,7 +2655,7 @@ void QContactManagerEngine::updateRelationshipRemoveRequest(QContactRelationship \brief The QContactManagerEngineV2 class provides the interface for implementations of the contact manager backend functionality. \inmodule QtContacts - + \ingroup contacts-backends Instances of this class are usually provided by a @@ -2861,7 +2862,7 @@ bool QContactManagerEngineV2::saveContacts(QList<QContact> *contacts, const QStr /*! Returns the list of contacts with the ids given by \a localIds. There is a one-to-one correspondence between the returned contacts and the supplied \a localIds. - + If there is an invalid id in \a localIds, then an empty QContact will take its place in the returned list and an entry will be inserted into \a errorMap. diff --git a/src/contacts/qcontactmanagerenginefactory.cpp b/src/contacts/qcontactmanagerenginefactory.cpp index 7fbd81b94f..5f65540827 100644 --- a/src/contacts/qcontactmanagerenginefactory.cpp +++ b/src/contacts/qcontactmanagerenginefactory.cpp @@ -48,19 +48,20 @@ QTM_BEGIN_NAMESPACE \class QContactManagerEngineFactory \brief The QContactManagerEngineFactory class provides the interface for plugins that implement QContactManagerEngine functionality. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-backends - + This class provides a simple interface for the creation of manager engine instances. Each factory has a specific id associated with it, which forms the \c managerName parameter when creating \l QContactManager objects. - + More information on writing a contacts engine plugin is available in the \l{Qt Contacts Manager Engines} documentation. - + \sa QContactManager, QContactManagerEngine */ diff --git a/src/contacts/qcontactrelationship.cpp b/src/contacts/qcontactrelationship.cpp index fe74ec22a5..8fb2772f81 100644 --- a/src/contacts/qcontactrelationship.cpp +++ b/src/contacts/qcontactrelationship.cpp @@ -57,21 +57,22 @@ QTM_BEGIN_NAMESPACE \class QContactRelationship \brief The QContactRelationship class describes a one-to-one relationship between a locally-stored contact and another (possibly remote) contact. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-main - + Each relationship is uniquely identified by the combination of the first contact id, second contact id, and the relationship type. - + A relationship should not contain a second contact which is the same as the first contact. Any local contacts which are referenced in the relationship (that is, any source contact, or any second contact whose manager URI is left empty or whose manager URI references the manager that stores the source contact, and in which the relationship will be saved) should exist. - + If any of these requirements are not met, validation of the relationship may fail when attempting to save the relationship in a QContactManager. diff --git a/src/contacts/qcontactsortorder.cpp b/src/contacts/qcontactsortorder.cpp index 3e13a3568e..1847002dfc 100644 --- a/src/contacts/qcontactsortorder.cpp +++ b/src/contacts/qcontactsortorder.cpp @@ -51,9 +51,10 @@ QTM_BEGIN_NAMESPACE /*! \class QContactSortOrder \brief The QContactSortOrder class defines how a list of contacts should be ordered according to some criteria - + \inmodule QtContacts - + \since 1.0 + */ /*! diff --git a/src/contacts/requests/qcontactdetaildefinitionfetchrequest.cpp b/src/contacts/requests/qcontactdetaildefinitionfetchrequest.cpp index 3bab01b802..920c6ee653 100644 --- a/src/contacts/requests/qcontactdetaildefinitionfetchrequest.cpp +++ b/src/contacts/requests/qcontactdetaildefinitionfetchrequest.cpp @@ -57,9 +57,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactdetaildefinitionremoverequest.cpp b/src/contacts/requests/qcontactdetaildefinitionremoverequest.cpp index ad7e90b159..41a9c0e076 100644 --- a/src/contacts/requests/qcontactdetaildefinitionremoverequest.cpp +++ b/src/contacts/requests/qcontactdetaildefinitionremoverequest.cpp @@ -56,10 +56,11 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - - + + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactdetaildefinitionsaverequest.cpp b/src/contacts/requests/qcontactdetaildefinitionsaverequest.cpp index 1b21dc79c2..b4f2f72c42 100644 --- a/src/contacts/requests/qcontactdetaildefinitionsaverequest.cpp +++ b/src/contacts/requests/qcontactdetaildefinitionsaverequest.cpp @@ -57,10 +57,11 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - - + + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactfetchrequest.cpp b/src/contacts/requests/qcontactfetchrequest.cpp index 17d30629c3..a59c826803 100644 --- a/src/contacts/requests/qcontactfetchrequest.cpp +++ b/src/contacts/requests/qcontactfetchrequest.cpp @@ -57,9 +57,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactlocalidfetchrequest.cpp b/src/contacts/requests/qcontactlocalidfetchrequest.cpp index 5c0e6f0345..a912a065fa 100644 --- a/src/contacts/requests/qcontactlocalidfetchrequest.cpp +++ b/src/contacts/requests/qcontactlocalidfetchrequest.cpp @@ -57,9 +57,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactrelationshipfetchrequest.cpp b/src/contacts/requests/qcontactrelationshipfetchrequest.cpp index f2eb770c57..913db2145d 100644 --- a/src/contacts/requests/qcontactrelationshipfetchrequest.cpp +++ b/src/contacts/requests/qcontactrelationshipfetchrequest.cpp @@ -51,6 +51,7 @@ QTM_BEGIN_NAMESPACE \brief The QContactRelationshipFetchRequest class allows a client to asynchronously request relationships from a contacts store manager. + \since 1.0 For a QContactRelationshipFetchRequest, the resultsAvailable() signal will be emitted when the resultant relationships (which may be retrieved by calling relationships()), are updated, as well as if @@ -59,9 +60,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactrelationshipremoverequest.cpp b/src/contacts/requests/qcontactrelationshipremoverequest.cpp index 7343d80cca..fbec008362 100644 --- a/src/contacts/requests/qcontactrelationshipremoverequest.cpp +++ b/src/contacts/requests/qcontactrelationshipremoverequest.cpp @@ -58,9 +58,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactrelationshipsaverequest.cpp b/src/contacts/requests/qcontactrelationshipsaverequest.cpp index beb9e863c4..caf4f03654 100644 --- a/src/contacts/requests/qcontactrelationshipsaverequest.cpp +++ b/src/contacts/requests/qcontactrelationshipsaverequest.cpp @@ -57,9 +57,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactremoverequest.cpp b/src/contacts/requests/qcontactremoverequest.cpp index 8d0fd50f93..a7e70e13c2 100644 --- a/src/contacts/requests/qcontactremoverequest.cpp +++ b/src/contacts/requests/qcontactremoverequest.cpp @@ -56,9 +56,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/contacts/requests/qcontactsaverequest.cpp b/src/contacts/requests/qcontactsaverequest.cpp index f95012447d..d90dd69790 100644 --- a/src/contacts/requests/qcontactsaverequest.cpp +++ b/src/contacts/requests/qcontactsaverequest.cpp @@ -57,9 +57,10 @@ QTM_BEGIN_NAMESPACE Please see the class documentation of QContactAbstractRequest for more information about the usage of request classes and ownership semantics. - + \inmodule QtContacts - + \since 1.0 + \ingroup contacts-requests */ diff --git a/src/location/qgeoareamonitor.cpp b/src/location/qgeoareamonitor.cpp index c92ca88e84..554de141d3 100644 --- a/src/location/qgeoareamonitor.cpp +++ b/src/location/qgeoareamonitor.cpp @@ -51,7 +51,8 @@ changes for a specified set of coordinates. \inmodule QtLocation - + \since 1.0 + \ingroup location A QGeoAreaMonitor emits signals when the current position is in @@ -172,7 +173,7 @@ qreal QGeoAreaMonitor::radius() const Returns 0 if the system has no support for position monitoring. - Note: Symbian applications will need to have the Location capability + Note: Symbian applications will need to have the Location capability otherwise this will return 0. */ QGeoAreaMonitor *QGeoAreaMonitor::createDefaultMonitor(QObject *parent) diff --git a/src/location/qgeocoordinate.cpp b/src/location/qgeocoordinate.cpp index 0439c8c3de..f67666371d 100644 --- a/src/location/qgeocoordinate.cpp +++ b/src/location/qgeocoordinate.cpp @@ -82,7 +82,8 @@ QGeoCoordinatePrivate::QGeoCoordinatePrivate() { \brief The QGeoCoordinate class defines a geographical position on the surface of the Earth. \inmodule QtLocation - + \since 1.0 + \ingroup location A QGeoCoordinate is defined by latitude, longitude, and optionally, altitude. @@ -418,16 +419,16 @@ void QGeoCoordinatePrivate::atDistanceAndAzimuth(const QGeoCoordinate &coord, } /*! - Returns the coordinate that is reached by traveling \a distance metres + Returns the coordinate that is reached by traveling \a distance metres from the current coordinate at \a azimuth (or bearing) along a great-circle. There is an assumption that the Earth is spherical for the purpose of this calculation. - + The altitude will have \a distanceUp added to it. Returns an invalid coordinate if this coordinate is invalid. */ -QGeoCoordinate QGeoCoordinate::atDistanceAndAzimuth(qreal distance, qreal azimuth, qreal distanceUp) const +QGeoCoordinate QGeoCoordinate::atDistanceAndAzimuth(qreal distance, qreal azimuth, qreal distanceUp) const { if (!isValid()) return QGeoCoordinate(); diff --git a/src/location/qgeopositioninfo.cpp b/src/location/qgeopositioninfo.cpp index 8491f7eed0..3d8e278031 100644 --- a/src/location/qgeopositioninfo.cpp +++ b/src/location/qgeopositioninfo.cpp @@ -59,7 +59,8 @@ public: \brief The QGeoPositionInfo class contains information gathered on a global position, direction and velocity at a particular point in time. \inmodule QtLocation - + \since 1.0 + \ingroup location A QGeoPositionInfo contains, at a minimum, a geographical coordinate and diff --git a/src/location/qgeopositioninfosource.cpp b/src/location/qgeopositioninfosource.cpp index c47da3ac67..ea03a0d652 100644 --- a/src/location/qgeopositioninfosource.cpp +++ b/src/location/qgeopositioninfosource.cpp @@ -73,7 +73,8 @@ QTM_BEGIN_NAMESPACE \brief The QGeoPositionInfoSource class is an abstract base class for the distribution of positional updates. \inmodule QtLocation - + \since 1.0 + \ingroup location The static function QGeoPositionInfoSource::createDefaultSource() creates a default @@ -362,7 +363,7 @@ QGeoPositionInfoSource::PositioningMethods QGeoPositionInfoSource::preferredPosi Returns 0 if the system has no default position source and no valid plugins could be found. - Note: Symbian applications will need to have the Location capability + Note: Symbian applications will need to have the Location capability otherwise this will return 0. */ diff --git a/src/location/qgeosatelliteinfo.cpp b/src/location/qgeosatelliteinfo.cpp index 5ce6fd6e97..96dbac9de6 100644 --- a/src/location/qgeosatelliteinfo.cpp +++ b/src/location/qgeosatelliteinfo.cpp @@ -60,7 +60,8 @@ public: \brief The QGeoSatelliteInfo class contains basic information about a satellite. \inmodule QtLocation - + \since 1.0 + \ingroup location \sa QGeoSatelliteInfoSource diff --git a/src/location/qgeosatelliteinfosource.cpp b/src/location/qgeosatelliteinfosource.cpp index 507b5c3499..b68b2a63db 100644 --- a/src/location/qgeosatelliteinfosource.cpp +++ b/src/location/qgeosatelliteinfosource.cpp @@ -219,7 +219,8 @@ void QGeoSatelliteInfoSourcePrivate::loadStaticPlugins(QHash<QString, QGeoPositi \brief The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates. \inmodule QtLocation - + \since 1.0 + \ingroup location The static function QGeoSatelliteInfoSource::createDefaultSource() creates a default @@ -254,8 +255,8 @@ QGeoSatelliteInfoSource::QGeoSatelliteInfoSource(QObject *parent) Returns 0 if the system has no default source and no valid plugins could be found. - - Note: Symbian applications will need to have the Location capability + + Note: Symbian applications will need to have the Location capability otherwise this will return 0. */ QGeoSatelliteInfoSource *QGeoSatelliteInfoSource::createDefaultSource(QObject *parent) diff --git a/src/location/qnmeapositioninfosource.cpp b/src/location/qnmeapositioninfosource.cpp index f088180677..19e86553aa 100644 --- a/src/location/qnmeapositioninfosource.cpp +++ b/src/location/qnmeapositioninfosource.cpp @@ -429,7 +429,8 @@ void QNmeaPositionInfoSourcePrivate::emitUpdated(const QGeoPositionInfo &update) \brief The QNmeaPositionInfoSource class provides positional information using a NMEA data source. \inmodule QtLocation - + \since 1.0 + \ingroup location NMEA is a commonly used protocol for the specification of one's global diff --git a/src/messaging/qmessage.cpp b/src/messaging/qmessage.cpp index f882d65c86..48841eeb79 100644 --- a/src/messaging/qmessage.cpp +++ b/src/messaging/qmessage.cpp @@ -60,36 +60,37 @@ QList<QByteArray> charsets; \class QMessage \brief The QMessage class provides a convenient interface for working with messages. - - + + \inmodule QtMessaging - + \ingroup messaging - - QMessage supports a number of types. Including internet email messages, + \since 1.0 + + QMessage supports a number of types. Including internet email messages, and the telephony types SMS and MMS. - - The QMessageId identifier for a message is returned by id(). Messages can be constructed by - retrieval from the messaging store via their identifier using QMessageManager::message(). A - QMessage can also be constructed piece by piece using functions such as - setType(), setFrom(), setTo(), setSubject(), setBody() and appendAttachments(). - + + The QMessageId identifier for a message is returned by id(). Messages can be constructed by + retrieval from the messaging store via their identifier using QMessageManager::message(). A + QMessage can also be constructed piece by piece using functions such as + setType(), setFrom(), setTo(), setSubject(), setBody() and appendAttachments(). + If a message has been modified since it was last constructed isModified() returns true. - A list of attachments identifiers will be returned by attachmentIds() and an identifier for the - message body will be returned by bodyId(). Attachments can be appended to the content of the + A list of attachments identifiers will be returned by attachmentIds() and an identifier for the + message body will be returned by bodyId(). Attachments can be appended to the content of the message using appendAttachments(), the body of the message can be set with setBody(). - + The folder and account a message is associated with are returned by parentFolderId() and parentAccountId() respectively. - Message data that is less commonly accessed or relatively large should be lazily retrieved + Message data that is less commonly accessed or relatively large should be lazily retrieved on demand by the associated getter function. - + Only phone numbers are valid destination addresses for SMS messages, only email addresses are valid destination addresses for Email messages, MMS messages may be addressed to either phone numbers or email addresses. - + \sa QMessageContentContainer, QMessageManager, QMessageId */ @@ -97,17 +98,17 @@ QList<QByteArray> charsets; \enum QMessage::Type This enum type is used to describe the type of a message. - + \value NoType The message type is not defined. \value Mms The message is an MMS, Multimedia Messaging Service object. \value Sms The message is an SMS, Short Message Service object. \value Email The message is an Email, Internet Message Format object. \value InstantMessage The message is an instant message object, such as XMPP. \value AnyType Bitflag value that matches any message type defined. - + \sa type(), setType() */ - + /*! \enum QMessage::Status @@ -117,7 +118,7 @@ QList<QByteArray> charsets; \value HasAttachments This flag indicates that the message contains at least one sub-part with 'Attachment' disposition. \value Incoming This flag indicates that the message has been sent from an external source. \value Removed This flag indicates that the message has been deleted from or moved on the originating server. - + \sa status(), setStatus() */ @@ -155,7 +156,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::QMessage() - + Constructs an empty message. */ @@ -163,7 +164,7 @@ QList<QByteArray> charsets; \fn QMessage::QMessage(const QMessageId& id) Constructs a message from data stored in the messaging store with identifier \a id. - + \sa QMessageManager::message() */ @@ -180,72 +181,72 @@ QList<QByteArray> charsets; /*! \fn QMessage::~QMessage() - + Destroys the message. */ /*! \fn QMessage::id() const - + Returns the identifier of the message. \sa QMessageFilter::byId() */ - + /*! \fn QMessage::type() const - + Returns the Type of the message. - + \sa setType(), QMessageFilter::byType() */ - + /*! \fn QMessage::setType(Type t) - + Sets the Type of the message to \a t. - + The type of a message may be set for non-empty messages. - + \sa type() */ /*! \fn QMessage::parentAccountId() const - - Returns the identifier of the parent account of the message if any; otherwise returns an + + Returns the identifier of the parent account of the message if any; otherwise returns an invalid identifier. */ - + /*! \fn QMessage::setParentAccountId(const QMessageAccountId &accountId) - + Sets the parent account of the message to the account with identifier \a accountId. - + This operation is only permitted on new messages that have not yet been inserted into the message store. Attempting to change the parent account of a message already in the message store will result in an error when attempting to update the message with QMessageStore::update(). */ - + /*! \fn QMessage::parentFolderId() const - - Returns the identifier of the folder that contains the message if any; otherwise returns an + + Returns the identifier of the folder that contains the message if any; otherwise returns an invalid identifier. */ /*! \fn QMessage::standardFolder() const - + Returns the standard folder of the message. - + Defaults to DraftsFolder. */ - + /*! \fn QMessage::from() const - + Returns the originating address of the message. \sa setFrom(), QMessageFilter::bySender() @@ -253,7 +254,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::setFrom(const QMessageAddress &address) - + Sets the from address, that is the originating address of the message to \a address. \sa from() @@ -261,7 +262,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::subject() const - + Returns the subject of the message, if present; otherwise returns a null string. \sa setSubject(), QMessageFilter::bySubject() @@ -269,105 +270,105 @@ QList<QByteArray> charsets; /*! \fn QMessage::setSubject(const QString &text) - + Sets the subject of the message to \a text. - + \sa subject() */ /*! \fn QMessage::date() const - - 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 a null timestamp. - + \sa setDate(), QMessageFilter::byTimeStamp() */ /*! \fn QMessage::setDate(const QDateTime &d) - + Sets the origination date header field specifying the timestamp of the message to \a d. - + \sa date() */ /*! \fn QMessage::receivedDate() const - + Returns the timestamp placed in the message during reception by the device, if present; otherwise returns a null timestamp. - + \sa setReceivedDate(), QMessageFilter::byReceptionTimeStamp() */ /*! \fn QMessage::setReceivedDate(const QDateTime &d) - + Sets the timestamp indicating the time of message reception by the device to \a d. - + \sa receivedDate() */ -/*! +/*! \fn QMessage::to() const - + Returns the list of primary recipients for the message. \sa setTo(), QMessageFilter::byRecipients() */ -/*! +/*! \fn QMessage::setTo(const QMessageAddressList& toList) - + Sets the list of primary recipients for the message to \a toList. - + \sa to() */ -/*! +/*! \fn QMessage::setTo(const QMessageAddress& address) - + Sets the primary recipient for the message to \a address. - + \sa to() */ /*! \fn QMessage::cc() const - + Returns the list of all the cc (carbon copy) recipients specified for the message. \sa to(), bcc(), setCc(), QMessageFilter::byRecipients() -*/ +*/ /*! \fn QMessage::setCc(const QMessageAddressList& ccList) - + Set the list of cc (carbon copy) recipients for the message to \a ccList. \sa cc(), setTo(), setBcc() -*/ +*/ /*! \fn QMessage::bcc() const - + Returns the list of all the bcc (blind carbon copy) recipients specified for the message. \sa to(), cc(), setBcc() -*/ +*/ /*! \fn QMessage::setBcc(const QMessageAddressList& bccList) - + Set the list of bcc (blind carbon copy) recipients for the message to \a bccList. \sa bcc(), setTo(), setCc() -*/ +*/ /*! \fn QMessage::status() const - + Returns the status flags value for the message. \sa setStatus(), QMessageFilter::byStatus() @@ -375,7 +376,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::setStatus(QMessage::StatusFlags newStatus) - + Sets the status flags value for the message to \a newStatus. \sa status() @@ -383,7 +384,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::setStatus(QMessage::Status flag, bool set) - + Sets the status flag \a flag for the message to have the value \a set. \sa status() @@ -391,7 +392,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::priority() const - + Returns the priority of the message. The default is NormalPriority. @@ -401,7 +402,7 @@ QList<QByteArray> charsets; /*! \fn QMessage::setPriority(Priority newPriority) - + Sets the priority of the message to \a newPriority. \sa priority() @@ -409,65 +410,65 @@ QList<QByteArray> charsets; /*! \fn QMessage::size() const - + Returns the complete size of the message as indicated on the originating server. - + \sa QMessageFilter::bySize() */ /*! \fn QMessage::bodyId() const - - Returns the identifier for the body content contained by the Message if a body exists; + + Returns the identifier for the body content contained by the Message if a body exists; otherwise returns an invalid identifier. - + \sa QMessageContentContainer, setBody() */ /*! \fn QMessage::setBody(const QString &body, const QByteArray &mimeType) - + Sets the body text of the message to be the string \a body. - + The internet media (MIME) content type of the body is set to \a mimeType, if provided. If the \a mimeType is not specified, the content type will default to "text/plain", and the encoding charset will be as determined by preferredCharsets(). - + \sa bodyId(), preferredCharsets() */ /*! \fn QMessage::setBody(QTextStream &in, const QByteArray &mimeType) - + Sets the body text of the message to be the text read from the stream \a in. - + The internet media (MIME) content type of the body is set to \a mimeType, if provided. If the \a mimeType is not specified, the content type will default to "text/plain", and the encoding charset will be as determined by preferredCharsets(). - + \sa bodyId(), preferredCharsets() */ /*! \fn QMessage::attachmentIds() const - + Returns a list of attachment identifiers for the message. The body of the message will not be included in the list. - + \sa appendAttachments(), clearAttachments() */ /*! \fn QMessage::appendAttachments(const QStringList &fileNames) - - Append the contents of the files specified by \a fileNames to the end of the list of - attachments for the message. The internet media (MIME) type of the attachments will be + + Append the contents of the files specified by \a fileNames to the end of the list of + attachments for the message. The internet media (MIME) type of the attachments will be determined by examining the files or file names. - - Symbian OS based devices have a limit for MMS message size. The message size limit + + Symbian OS based devices have a limit for MMS message size. The message size limit varies between different devices, but is frequently 600 000 bytes. If the attachment - size is greater than the limit then message sending will fail when + size is greater than the limit then message sending will fail when QMessageService::send() is called. \sa attachmentIds(), clearAttachments() @@ -475,16 +476,16 @@ QList<QByteArray> charsets; /*! \fn QMessage::clearAttachments() - + Clears the list of attachments for the message, leaving only the message body, if any. \sa attachmentIds(), appendAttachments() -*/ +*/ /*! \fn QMessage::isModified() const - - Returns true if the message has been modified since it was constructed; + + Returns true if the message has been modified since it was constructed; otherwise returns false. */ @@ -492,14 +493,14 @@ QList<QByteArray> charsets; \fn QMessage::createResponseMessage(ResponseType type) const Creates a new message as a response to this message, with properties predetermined according to \a type. - + \sa QMessageService::compose() */ /*! \fn QMessage::setPreferredCharsets(const QList<QByteArray> &charsetNames) - - Sets the ordered-by-preference list of names of charsets to use when encoding + + Sets the ordered-by-preference list of names of charsets to use when encoding unicode QString data to a serialized form to \a charsetNames. The set of valid charset names is returned by QTextCodec::availableCodecs(). @@ -513,8 +514,8 @@ void QMessage::setPreferredCharsets(const QList<QByteArray> &charsetNames) /*! \fn QMessage::preferredCharsets() - - Returns an ordered-by-preference list of charset names to use when encoding + + Returns an ordered-by-preference list of charset names to use when encoding unicode QString data to a serialized form. \sa setPreferredCharsets(), preferredCharsetFor(), setBody() diff --git a/src/messaging/qmessageaccount.cpp b/src/messaging/qmessageaccount.cpp index 36f21eb0ef..2750f73dea 100644 --- a/src/messaging/qmessageaccount.cpp +++ b/src/messaging/qmessageaccount.cpp @@ -44,36 +44,37 @@ \class QMessageAccount \brief The QMessageAccount class represents a messaging account in the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - A QMessageAccount is a logical entity that groups messages according to the - method by which they are sent and received. An account may either transmit messages + A QMessageAccount is a logical entity that groups messages according to the + method by which they are sent and received. An account may either transmit messages receive messages or both. - - The QMessageAccount class is used for accessing properties of the account related - to dealing with the account's folders and messages, rather than for modifying + + The QMessageAccount class is used for accessing properties of the account related + to dealing with the account's folders and messages, rather than for modifying the account itself. - + \sa QMessageManager::account() */ /*! \fn QMessageAccount::QMessageAccount() - + Creates an empty and invalid account object. */ /*! \fn QMessageAccount::QMessageAccount(const QMessageAccountId &id) - - Convenience constructor that creates a QMessageAccount by loading the data from the messaging - store as specified by the QMessageAccountId \a id. If the account does not exist in the + + Convenience constructor that creates a QMessageAccount by loading the data from the messaging + store as specified by the QMessageAccountId \a id. If the account does not exist in the store, then this constructor will create an empty and invalid QMessageAccount. - + \sa QMessageManager::account() */ @@ -83,37 +84,37 @@ Constructs a copy of \a other. */ -/*! +/*! \internal \fn QMessageAccount::operator=(const QMessageAccount& other) */ /*! \fn QMessageAccount::~QMessageAccount() - + Destroys the account object. */ /*! \fn QMessageAccount::id() const - + Returns the identifier for this account. */ /*! \fn QMessageAccount::name() const - + Returns the name of the account for display purposes. */ /*! \fn QMessageAccount::messageTypes() const - + Returns the types of messages this account handles. */ /*! \fn QMessageAccount::defaultAccount(QMessage::Type type) - + Returns the default account for messages of type \a type. */ diff --git a/src/messaging/qmessageaccountfilter.cpp b/src/messaging/qmessageaccountfilter.cpp index e79452ff81..79e2b5579d 100644 --- a/src/messaging/qmessageaccountfilter.cpp +++ b/src/messaging/qmessageaccountfilter.cpp @@ -52,14 +52,15 @@ QTM_BEGIN_NAMESPACE \brief The QMessageAccountFilter class defines the parameters used for querying a subset of all available accounts from the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 A QMessageAccountFilter is composed of an account property, an optional comparison operator - and a comparison value. The QMessageAccountFilter class is used in conjunction with the - QMessageManager::queryAccounts() and QMessageManager::countAccounts() functions to filter results + and a comparison value. The QMessageAccountFilter class is used in conjunction with the + QMessageManager::queryAccounts() and QMessageManager::countAccounts() functions to filter results which meet the criteria defined by the filter. QMessageAccountFilters can be combined using the overloaded operators (&), (|) and (~) as logical @@ -70,23 +71,23 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountFilter::QMessageAccountFilter() - + Creates a QMessageAccountFilter without specifying matching parameters. - A default-constructed filter (one for which isEmpty() returns true) matches all accounts. + A default-constructed filter (one for which isEmpty() returns true) matches all accounts. \sa isEmpty() */ /*! \fn QMessageAccountFilter::QMessageAccountFilter(const QMessageAccountFilter &other) - + Constructs a copy of \a other. */ /*! \fn QMessageAccountFilter::~QMessageAccountFilter() - + Destroys the filter. */ @@ -97,7 +98,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountFilter::setMatchFlags(QMessageDataComparator::MatchFlags matchFlags) - + Set the match flags for the search filter to \a matchFlags. \sa matchFlags() @@ -105,9 +106,9 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageDataComparator::MatchFlags QMessageAccountFilter::matchFlags() const - + Return the match flags for the search filter. - + Default is no match flags set. \sa setMatchFlags() @@ -115,8 +116,8 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountFilter::isEmpty() const - - Returns true if the filter remains empty after default construction; otherwise returns false. + + Returns true if the filter remains empty after default construction; otherwise returns false. An empty filter matches all accounts. @@ -131,17 +132,17 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountFilter::isSupported() const - + Returns true if the filter is supported on the current platform; otherwise returns false. */ /*! \fn QMessageAccountFilter::operator~() const - + Returns a filter that is the logical NOT of the value of this filter (ignoring any matchFlags() set on the filter). - If this filter is empty, the result will be a non-matching filter; if this filter is + If this filter is empty, the result will be a non-matching filter; if this filter is non-matching, the result will be an empty filter. \sa isEmpty() @@ -149,36 +150,36 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountFilter::operator&(const QMessageAccountFilter& other) const - + Returns a filter that is the logical AND of this filter and the value of filter \a other. */ /*! \fn QMessageAccountFilter::operator|(const QMessageAccountFilter& other) const - + Returns a filter that is the logical OR of this filter and the value of filter \a other. */ /*! \fn QMessageAccountFilter::operator&=(const QMessageAccountFilter& other) - + Performs a logical AND with this filter and the filter \a other and assigns the result to this filter. */ /*! \fn QMessageAccountFilter::operator|=(const QMessageAccountFilter& other) - + Performs a logical OR with this filter and the filter \a other and assigns the result to this filter. */ -/*! +/*! \internal \fn QMessageAccountFilter::operator==(const QMessageAccountFilter& other) const */ -/*! +/*! \internal */ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const @@ -188,7 +189,7 @@ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const /*! \fn QMessageAccountFilter::byId(const QMessageAccountId &id, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching accounts whose identifier matches \a id, according to \a cmp. \sa QMessageAccount::id() @@ -196,7 +197,7 @@ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const /*! \fn QMessageAccountFilter::byId(const QMessageAccountIdList &ids, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching accounts whose identifier is a member of \a ids, according to \a cmp. \sa QMessageAccount::id() @@ -204,7 +205,7 @@ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const /*! \fn QMessageAccountFilter::byId(const QMessageAccountFilter &filter, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching accounts whose identifier is a member of the set yielded by \a filter, according to \a cmp. \sa QMessageAccount::id() @@ -220,7 +221,7 @@ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const /*! \fn QMessageAccountFilter::byName(const QString &value, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching accounts whose name matches \a value, according to \a cmp. Not supported on Linux, Maemo 6 (Harmattan) and Meego.com (use InclusionComparator). @@ -230,7 +231,7 @@ bool QMessageAccountFilter::operator!=(const QMessageAccountFilter& other) const /*! \fn QMessageAccountFilter::byName(const QString &value, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching accounts whose name matches the substring \a value, according to \a cmp. \sa QMessageAccount::name() diff --git a/src/messaging/qmessageaccountid.cpp b/src/messaging/qmessageaccountid.cpp index 50c924351c..aec4246642 100644 --- a/src/messaging/qmessageaccountid.cpp +++ b/src/messaging/qmessageaccountid.cpp @@ -44,22 +44,23 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageAccountId - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageAccountId class provides a unique identifier for a QMessageAccount + \brief The QMessageAccountId class provides a unique identifier for a QMessageAccount messaging account, within the scope of the messaging store. A QMessageAccountId can be constructed from a string, or converted to a string with toString(). - A QMessageAccountId instance can be tested for validity with isValid(), and compared to other + A QMessageAccountId instance can be tested for validity with isValid(), and compared to other instances for equality. - - If the message a QMessageAccountId identifies is removed from the messaging store then the + + If the message a QMessageAccountId identifies is removed from the messaging store then the identifier will not be reused. - + \sa QMessageAccount */ @@ -79,13 +80,13 @@ QTM_BEGIN_NAMESPACE \fn QMessageAccountId::QMessageAccountId(const QString& id) Constructs an identifier from \a id. - + \sa toString() */ /*! \fn QMessageAccountId::~QMessageAccountId() - + Destroys the identifier. */ @@ -115,10 +116,10 @@ bool QMessageAccountId::operator!=(const QMessageAccountId &other) const \fn bool QMessageAccountId::toString() const Returns the string representation of this identifier. - + A null string should be returned if and only if the identifier is invalid. - String representations of identifiers should not be used to test for equality, instead + String representations of identifiers should not be used to test for equality, instead the equality operator should be used. */ diff --git a/src/messaging/qmessageaccountsortorder.cpp b/src/messaging/qmessageaccountsortorder.cpp index e1a2d730cb..87bd7c132a 100644 --- a/src/messaging/qmessageaccountsortorder.cpp +++ b/src/messaging/qmessageaccountsortorder.cpp @@ -45,28 +45,29 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageAccountSortOrder - \brief The QMessageAccountSortOrder class defines the parameters used for sorting a subset of + \brief The QMessageAccountSortOrder class defines the parameters used for sorting a subset of queried accounts from the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - A QMessageAccountSortOrder is composed of a account property to sort and a sort order. - The QMessageAccountSortOrder class is used in conjunction with the QMessageManager::queryAccounts() + A QMessageAccountSortOrder is composed of a account property to sort and a sort order. + The QMessageAccountSortOrder class is used in conjunction with the QMessageManager::queryAccounts() function to sort account results according to the criteria defined by the sort order. - + \sa QMessageManager, QMessageAccountFilter */ /*! \fn QMessageAccountSortOrder::QMessageAccountSortOrder() - + Create a QMessageAccountSortOrder with specifying matching parameters. - A default-constructed sort order (one for which isEmpty() returns true) sorts no accounts. + A default-constructed sort order (one for which isEmpty() returns true) sorts no accounts. - The result of combining an empty sort order with a non-empty sort order is the same as the original + The result of combining an empty sort order with a non-empty sort order is the same as the original non-empty sort order. The result of combining two empty sort orders is an empty sort order. @@ -74,13 +75,13 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageAccountSortOrder::QMessageAccountSortOrder(const QMessageAccountSortOrder &other) - + Constructs a copy of \a other. */ /*! \fn QMessageAccountSortOrder::~QMessageAccountSortOrder() - + Destroys the sort order. */ @@ -88,16 +89,16 @@ QTM_BEGIN_NAMESPACE \internal \fn QMessageAccountSortOrder::operator=(const QMessageAccountSortOrder& other) */ - + /*! \fn QMessageAccountSortOrder::isEmpty() const - + Returns true if the sort order remains empty after default construction; otherwise returns false. */ /*! \fn QMessageAccountSortOrder::isSupported() const - + Returns true if the sort order is supported on the current platform; otherwise returns false. */ @@ -116,7 +117,7 @@ bool QMessageAccountSortOrder::operator!=(const QMessageAccountSortOrder& other) /*! \fn QMessageAccountSortOrder::byName(Qt::SortOrder order) - + Returns an sort order that sorts accounts by name, according to \a order. \sa QMessageAccount::name() diff --git a/src/messaging/qmessageaddress.cpp b/src/messaging/qmessageaddress.cpp index eeb18110f2..992297a5cb 100644 --- a/src/messaging/qmessageaddress.cpp +++ b/src/messaging/qmessageaddress.cpp @@ -49,24 +49,25 @@ QTM_BEGIN_NAMESPACE \brief The QMessageAddress class provides an interface for a message address. - + \inmodule QtMessaging - + \ingroup messaging - + \since 1.0 + A message address consists of an addressee string and a type. -*/ +*/ /*! \enum QMessageAddress::Type This enum type is used to describe the type of a message address. - + \value System A system address. \value Phone A telephony address. \value Email An Email, Internet Message Format address. \value InstantMessage An Instant Messaging address. - + \sa type(), setType() */ @@ -176,14 +177,14 @@ void QMessageAddress::setType(Type type) * \a name is set to the name part of the email address. * \a address is set to the address part of the email address. * \a suffix is set to the suffix part of the email address. - - If the starting delimeter between the name and address part of the email address is found + + If the starting delimeter between the name and address part of the email address is found then * \a startDelimeterFound is set to true; otherwise * \a startDelimeterFound is set to false; If the starting delimeter is not found, then the parsing is ambiguous and both * \a name and * \a address will be set to the input \a emailAddress. - If the ending delimeter of the address part of the email address is found + If the ending delimeter of the address part of the email address is found then * \a endDelimeterFound is set to true; otherwise * \a endDelimeterFound is set to false; */ diff --git a/src/messaging/qmessagecontentcontainer.cpp b/src/messaging/qmessagecontentcontainer.cpp index 15a21cfd81..d1e19c438d 100644 --- a/src/messaging/qmessagecontentcontainer.cpp +++ b/src/messaging/qmessagecontentcontainer.cpp @@ -52,47 +52,48 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageContentContainer - \brief The QMessageContentContainer class provides an interface for internet media (MIME) - and Transport Neutral Encapsulation Format (TNEF) content that is possibly only + \brief The QMessageContentContainer class provides an interface for internet media (MIME) + and Transport Neutral Encapsulation Format (TNEF) content that is possibly only partially retrieved. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - A QMessageContentContainer object can either directly contain media such as text, - image, audio, video, application or message data, or contain multiple parts of content, + A QMessageContentContainer object can either directly contain media such as text, + image, audio, video, application or message data, or contain multiple parts of content, but can not contain both media and multiple parts directly. - - Container objects can be obtained via their QMessageContentContainerId + + Container objects can be obtained via their QMessageContentContainerId identifier, using the find() function of the containing QMessage object. - - For textual content using a recognized charset encoding textContent() will + + For textual content using a recognized charset encoding textContent() will return the content as a unicode string. - - For non-multipart content content() will return the content data after decoding any - transfer encoding used to represent binary data using 7-bit ASCII characters, such as + + For non-multipart content content() will return the content data after decoding any + transfer encoding used to represent binary data using 7-bit ASCII characters, such as quoted-printable and base64. - + The internet media (MIME) type of the container is returned by contentType(), - the content subtype is returned by contentSubType(), the content type charset parameter - is returned by contentCharset(), and the content suggested filename by suggestedFileName(). + the content subtype is returned by contentSubType(), the content type charset parameter + is returned by contentCharset(), and the content suggested filename by suggestedFileName(). - The type of a container that contains multiple parts of content must be "multipart" (case - insensitive). A list of identifiers for directly contained parts of content is returned + The type of a container that contains multiple parts of content must be "multipart" (case + insensitive). A list of identifiers for directly contained parts of content is returned by contentIds(). - - An indication of the size of the container and its contents on the originating server is - given by size(). If the content is entirely available on the device + + An indication of the size of the container and its contents on the originating server is + given by size(). If the content is entirely available on the device isContentAvailable() will return true. - Non-multipart content can be serialized to a QDataStream using + Non-multipart content can be serialized to a QDataStream using writeContentTo(), or to a QTextStream using writeTextContentTo(). - - A container also stores name-value pairs known as header fields. Names are ASCII strings, - while values are charset encoded unicode strings. A list of the header fields present - in a container is returned by headerFields(). The unicode string values associated + + A container also stores name-value pairs known as header fields. Names are ASCII strings, + while values are charset encoded unicode strings. A list of the header fields present + in a container is returned by headerFields(). The unicode string values associated with a particular header field name are returned by headerFieldValues(). \sa QMessage, QMessageContentContainerId @@ -100,7 +101,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::QMessageContentContainer() - + Constructs an empty container object. */ @@ -117,17 +118,17 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::~QMessageContentContainer() - + Destroys the container object. */ /*! \fn QMessageContentContainer::contentType() const - - Returns the content type of the container. Common types are "text", "image", "audio", + + Returns the content type of the container. Common types are "text", "image", "audio", "video", "application", "message" and "multipart". - The internet media (MIME) type of the container is "multipart" if the container directly + The internet media (MIME) type of the container is "multipart" if the container directly contains multiple parts rather than directly contains media. \sa contentSubType(), contentCharset() @@ -135,7 +136,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::contentSubType() const - + Returns the internet media (MIME) subtype of the content. \sa contentType(), contentCharset() @@ -143,8 +144,8 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::contentCharset() const - - Returns the internet media (MIME) content charset, when defined; + + Returns the internet media (MIME) content charset, when defined; otherwise an empty array is returned. \sa contentType(), contentSubType() @@ -152,7 +153,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::suggestedFileName() const - + Returns the suggested filename for the attachment, when defined; otherwise an empty array is returned. @@ -161,32 +162,32 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::isContentAvailable() const - - Returns true if the entirety of the content contained is available on the device; + + Returns true if the entirety of the content contained is available on the device; otherwise returns false. */ /*! \fn QMessageContentContainer::size() const - - If the size of the container is known then returns an indication of the size of the container + + If the size of the container is known then returns an indication of the size of the container on the originating server, including contents; otherwise returns 0. */ /*! \fn QMessageContentContainer::textContent() const - - For textual content encoded with a recognized charset, returns the content as a unicode string; + + For textual content encoded with a recognized charset, returns the content as a unicode string; otherwise a null string is returned. */ /*! \fn QMessageContentContainer::content() const - - Return the content after decoding any transfer encoding used to represent binary data + + Return the content after decoding any transfer encoding used to represent binary data using 7-bit ASCII characters, such as quoted-printable and base64. - - For textual content any text charset encoding such as Shift-JIS, ISO 2022-JP, KOI8-R, + + For textual content any text charset encoding such as Shift-JIS, ISO 2022-JP, KOI8-R, Windows-1251 etc will not be decoded. \sa textContent() @@ -194,22 +195,22 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::writeTextContent(QTextStream& out) const - - For a non-multipart container, writes the content as returned by textContent() + + For a non-multipart container, writes the content as returned by textContent() to the stream \a out; otherwise does nothing. */ /*! \fn QMessageContentContainer::writeContent(QDataStream& out) const - - For a non-multipart container, writes the content as returned by content() + + For a non-multipart container, writes the content as returned by content() to the stream \a out; otherwise does nothing. */ /*! \fn QMessageContentContainer::contentIds() const - - For a multipart container returns a list of identifiers for all content directly contained by + + For a multipart container returns a list of identifiers for all content directly contained by the container; otherwise returns an empty list. \sa find(), contains() @@ -217,9 +218,9 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::find(const QMessageContentContainerId &id) const - - If the container contains another container with identifier \a id either directly or - recursively, then returns the value of that other container; otherwise returns an + + If the container contains another container with identifier \a id either directly or + recursively, then returns the value of that other container; otherwise returns an empty container constructed with the default constructor. \sa contains(), contentIds() @@ -227,8 +228,8 @@ QTM_BEGIN_NAMESPACE /*! \fn bool QMessageContentContainer::contains(const QMessageContentContainerId &id) const; - - If the container contains content with the identifier \a id, either directly or recursively + + If the container contains content with the identifier \a id, either directly or recursively then returns true; otherwise returns false. \sa find(), contentIds() @@ -236,7 +237,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::headerFieldValue(const QByteArray &name) const - + Returns the value of the first header field of the container with the name \a name, if any; otherwise returns a null string. @@ -245,7 +246,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::headerFieldValues(const QByteArray &name) const - + Returns a list of values of header fields with the name \a name, if any; otherwise returns an empty list. @@ -254,7 +255,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageContentContainer::headerFields() const - + Returns a list of names of header fields of the container. \sa headerFieldValue(), headerFieldValues() diff --git a/src/messaging/qmessagefilter.cpp b/src/messaging/qmessagefilter.cpp index a00c5e0e98..40e18833ca 100644 --- a/src/messaging/qmessagefilter.cpp +++ b/src/messaging/qmessagefilter.cpp @@ -55,6 +55,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtMessaging \ingroup messaging + \since 1.0 A QMessageFilter is composed of a message property, an optional comparison operator and a comparison value. The QMessageFilter class is used in conjunction with the @@ -247,7 +248,7 @@ bool QMessageFilter::operator!=(const QMessageFilter& other) const \fn QMessageFilter::bySender(const QString &value, QMessageDataComparator::EqualityComparator cmp) Returns a filter matching messages whose sender matches \a value, according to \a cmp. - + Not supported on Linux, Maemo 6 (Harmattan) and Meego.com (use InclusionComparator). \sa QMessage::from() diff --git a/src/messaging/qmessagefolder.cpp b/src/messaging/qmessagefolder.cpp index 765fd17eb0..35942e8bdd 100644 --- a/src/messaging/qmessagefolder.cpp +++ b/src/messaging/qmessagefolder.cpp @@ -43,17 +43,18 @@ /*! \class QMessageFolder - \brief The QMessageFolder class provides an interface for folders containing messages in the + \brief The QMessageFolder class provides an interface for folders containing messages in the messaging store. - - + + \inmodule QtMessaging - + \ingroup messaging - - QMessageFolder represents a folder of messages, either fully or partially stored in the - messaging store. A QMessageFolder object has an optional parent of the same type, allowing - folders to be arranged in tree structures. Messages may be associated with folders, allowing + \since 1.0 + + QMessageFolder represents a folder of messages, either fully or partially stored in the + messaging store. A QMessageFolder object has an optional parent of the same type, allowing + folders to be arranged in tree structures. Messages may be associated with folders, allowing for simple classification and access by their parentFolderId property. \sa QMessage, QMessageStore::folder() @@ -61,17 +62,17 @@ /*! \fn QMessageFolder::QMessageFolder() - - Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which - has no path, no parent folder and no parent account. An invalid folder does not exist in + + Constructor that creates an empty and invalid QMessageFolder. An empty folder is one which + has no path, no parent folder and no parent account. An invalid folder does not exist in the database and has an invalid id. */ /*! \fn QMessageFolder::QMessageFolder(const QMessageFolderId &id) - - Constructor that creates a QMessageFolder by loading the data from the messaging store as - specified by the QMessageFolderId \a id. If the folder does not exist in the messaging + + Constructor that creates a QMessageFolder by loading the data from the messaging store as + specified by the QMessageFolderId \a id. If the folder does not exist in the messaging store, then this constructor will create an empty and invalid QMessageFolder. */ @@ -88,40 +89,40 @@ /*! \fn QMessageFolder::~QMessageFolder() - + Destroys the QMessageFolder object. */ /*! \fn QMessageFolder::id() const - - Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid + + Returns the identifier of the QMessageFolder object. A QMessageFolder with an invalid identifier does not yet exist in the messaging store. */ /*! \fn QMessageFolder::parentAccountId() const - - Returns the identifier of the parent account of the folder. If the folder is not linked to + + Returns the identifier of the parent account of the folder. If the folder is not linked to an account an invalid identifier is returned. */ /*! \fn QMessageFolder::parentFolderId() const - - Returns the identifier of the parent folder. This folder is a root folder if the parent + + Returns the identifier of the parent folder. This folder is a root folder if the parent identifier is invalid. */ /*! \fn QMessageFolder::name() const - + Returns the display name of the folder suitable for viewing in a user interface. This is typically the same as, or a simplification of the path() for the folder. */ /*! \fn QMessageFolder::path() const - + Returns the path of the folder. */ diff --git a/src/messaging/qmessagefolderfilter.cpp b/src/messaging/qmessagefolderfilter.cpp index 1d1c346418..1eaf70e17c 100644 --- a/src/messaging/qmessagefolderfilter.cpp +++ b/src/messaging/qmessagefolderfilter.cpp @@ -51,14 +51,15 @@ QTM_BEGIN_NAMESPACE \brief The QMessageFolderFilter class defines the parameters used for querying a subset of all available folders from the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 A QMessageFolderFilter is composed of a folder property, an optional comparison operator - and a comparison value. The QMessageFolderFilter class is used in conjunction with the - QMessageManager::queryFolders() and QMessageManager::countFolders() functions to filter results + and a comparison value. The QMessageFolderFilter class is used in conjunction with the + QMessageManager::queryFolders() and QMessageManager::countFolders() functions to filter results which meet the criteria defined by the filter. QMessageFolderFilters can be combined using the logical operators (&), (|) and (~) to @@ -69,23 +70,23 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderFilter::QMessageFolderFilter() - + Creates a QMessageFolderFilter without specifying matching parameters. - A default-constructed filter (one for which isEmpty() returns true) matches all folders. + A default-constructed filter (one for which isEmpty() returns true) matches all folders. \sa isEmpty() */ /*! \fn QMessageFolderFilter::QMessageFolderFilter(const QMessageFolderFilter &other) - + Constructs a copy of \a other. */ /*! \fn QMessageFolderFilter::~QMessageFolderFilter() - + Destroys the filter. */ @@ -96,7 +97,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderFilter::setMatchFlags(QMessageDataComparator::MatchFlags matchFlags) - + Set the match flags for the search filter to \a matchFlags. \sa matchFlags() @@ -104,9 +105,9 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageDataComparator::MatchFlags QMessageFolderFilter::matchFlags() const - + Return the match flags for the search filter. - + Default is no match flags set. \sa setMatchFlags() @@ -114,8 +115,8 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderFilter::isEmpty() const - - Returns true if the filter remains empty after default construction; otherwise returns false. + + Returns true if the filter remains empty after default construction; otherwise returns false. An empty filter matches all folders. @@ -130,17 +131,17 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderFilter::isSupported() const - + Returns true if the filter is supported on the current platform; otherwise returns false. */ /*! \fn QMessageFolderFilter::operator~() const - + Returns a filter that is the logical NOT of the value of this filter (ignoring any matchFlags() set on the filter). - If this filter is empty, the result will be a non-matching filter; if this filter is + If this filter is empty, the result will be a non-matching filter; if this filter is non-matching, the result will be an empty filter. \sa isEmpty() @@ -148,26 +149,26 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderFilter::operator&(const QMessageFolderFilter& other) const - + Returns a filter that is the logical AND of this filter and the value of filter \a other. */ /*! \fn QMessageFolderFilter::operator|(const QMessageFolderFilter& other) const - + Returns a filter that is the logical OR of this filter and the value of filter \a other. */ /*! \fn QMessageFolderFilter::operator&=(const QMessageFolderFilter& other) - + Performs a logical AND with this filter and the filter \a other and assigns the result to this filter. */ /*! \fn QMessageFolderFilter::operator|=(const QMessageFolderFilter& other) - + Performs a logical OR with this filter and the filter \a other and assigns the result to this filter. */ @@ -187,7 +188,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching folders whose identifier matches \a id, according to \a cmp. \sa QMessageFolder::id() @@ -195,7 +196,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byId(const QMessageFolderIdList &ids, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose identifier is a member of \a ids, according to \a cmp. \sa QMessageFolder::id() @@ -203,7 +204,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose identifier is a member of the set yielded by \a filter, according to \a cmp. \sa QMessageFolder::id() @@ -219,17 +220,17 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching folders whose display name matches \a value, according to \a cmp. Not supported on Linux, Maemo 6 (Harmattan) and Meego.com (use InclusionComparator). - + \sa QMessageFolder::name() */ /*! \fn QMessageFolderFilter::byName(const QString &value, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose display name matches the substring \a value, according to \a cmp. \sa QMessageFolder::name() @@ -245,7 +246,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching folders whose path matches \a value, according to \a cmp. Not supported on Linux, Maemo 6 (Harmattan) and Meego.com (use InclusionComparator). @@ -255,7 +256,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byPath(const QString &value, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose path matches the substring \a value, according to \a cmp. \sa QMessageFolder::path() @@ -263,7 +264,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byParentAccountId(const QMessageAccountId &id, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching folders whose parent account identifier matches \a id, according to \a cmp. \sa QMessageAccount::id() @@ -271,7 +272,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byParentAccountId(const QMessageAccountFilter &filter, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose parent account identifier is a member of the set yielded by \a filter, according to \a cmp. \sa QMessageAccount::id() @@ -279,7 +280,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byParentFolderId(const QMessageFolderId &id, QMessageDataComparator::EqualityComparator cmp) - + Returns a filter matching folders whose parent folder identifier matches \a id, according to \a cmp. \sa QMessageFolder::id() @@ -287,7 +288,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byParentFolderId(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose parent folder identifier is a member of the set yielded by \a filter, according to \a cmp. \sa QMessageFolder::id() @@ -295,7 +296,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderId &id, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose ancestor folders' identifiers contain \a id, according to \a cmp. \sa QMessageFolder::id() @@ -303,7 +304,7 @@ bool QMessageFolderFilter::operator!=(const QMessageFolderFilter& other) const /*! \fn QMessageFolderFilter::byAncestorFolderIds(const QMessageFolderFilter &filter, QMessageDataComparator::InclusionComparator cmp) - + Returns a filter matching folders whose ancestor folders' identifiers contain a member of the set yielded by \a filter, according to \a cmp. \sa QMessageFolder::id() diff --git a/src/messaging/qmessagefolderid.cpp b/src/messaging/qmessagefolderid.cpp index e2bd76ab06..488db0fc9f 100644 --- a/src/messaging/qmessagefolderid.cpp +++ b/src/messaging/qmessagefolderid.cpp @@ -44,22 +44,23 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageFolderId - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageFolderId class provides a unique identifier for a QMessageFolder message + \brief The QMessageFolderId class provides a unique identifier for a QMessageFolder message folder, within the scope of the messaging store. A QMessageFolderId can be constructed from a string, or converted to a string with toString(). - A QMessageFolderId instance can be tested for validity with isValid(), and compared to other + A QMessageFolderId instance can be tested for validity with isValid(), and compared to other instances for equality. - - If the message a QMessageFolderId identifies is removed from the messaging store then the + + If the message a QMessageFolderId identifies is removed from the messaging store then the identifier will not be reused. - + \sa QMessageFolder */ @@ -79,13 +80,13 @@ QTM_BEGIN_NAMESPACE \fn QMessageFolderId::QMessageFolderId(const QString& id) Constructs an identifier from \a id. - + \sa toString() */ /*! \fn QMessageFolderId::~QMessageFolderId() - + Destroys the identifier. */ @@ -115,10 +116,10 @@ bool QMessageFolderId::operator!=(const QMessageFolderId &other) const \fn bool QMessageFolderId::toString() const Returns the string representation of this identifier. - + A null string should be returned if and only if the identifier is invalid. - String representations of identifiers should not be used to test for equality, instead + String representations of identifiers should not be used to test for equality, instead the equality operator should be used. */ diff --git a/src/messaging/qmessagefoldersortorder.cpp b/src/messaging/qmessagefoldersortorder.cpp index b69c68f17a..300a584759 100644 --- a/src/messaging/qmessagefoldersortorder.cpp +++ b/src/messaging/qmessagefoldersortorder.cpp @@ -45,28 +45,29 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageFolderSortOrder - \brief The QMessageFolderSortOrder class defines the parameters used for sorting a subset of + \brief The QMessageFolderSortOrder class defines the parameters used for sorting a subset of queried folders from the messaging store. - + \inmodule QtMessaging - + \since 1.0 + \ingroup messaging - A QMessageFolderSortOrder is composed of a folder property to sort and a sort order. - The QMessageFolderSortOrder class is used in conjunction with the QMessageManager::queryFolders() + A QMessageFolderSortOrder is composed of a folder property to sort and a sort order. + The QMessageFolderSortOrder class is used in conjunction with the QMessageManager::queryFolders() function to sort folder results according to the criteria defined by the sort order. - + \sa QMessageManager, QMessageFolderFilter */ /*! \fn QMessageFolderSortOrder::QMessageFolderSortOrder() - + Create a QMessageFolderSortOrder with specifying matching parameters. - A default-constructed sort order (one for which isEmpty() returns true) sorts no folders. + A default-constructed sort order (one for which isEmpty() returns true) sorts no folders. - The result of combining an empty sort order with a non-empty sort order is the same as the original + The result of combining an empty sort order with a non-empty sort order is the same as the original non-empty sort order. The result of combining two empty sort orders is an empty sort order. @@ -74,13 +75,13 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageFolderSortOrder::QMessageFolderSortOrder(const QMessageFolderSortOrder &other) - + Constructs a copy of \a other. */ /*! \fn QMessageFolderSortOrder::~QMessageFolderSortOrder() - + Destroys the sort order. */ @@ -88,34 +89,34 @@ QTM_BEGIN_NAMESPACE \internal \fn QMessageFolderSortOrder::operator=(const QMessageFolderSortOrder& other) */ - + /*! \fn QMessageFolderSortOrder::isEmpty() const - + Returns true if the sort order remains empty after default construction; otherwise returns false. */ /*! \fn QMessageFolderSortOrder::isSupported() const - + Returns true if the sort order is supported on the current platform; otherwise returns false. */ /*! \fn QMessageFolderSortOrder::operator+(const QMessageFolderSortOrder& other) const - - Returns a sort order that which is the result of concatenating the vaue of this sort order and the value + + Returns a sort order that which is the result of concatenating the vaue of this sort order and the value of \a other. - + This function determines sorting precedence. */ /*! \fn QMessageFolderSortOrder::operator+=(const QMessageFolderSortOrder& other) - + Appends the value of the sort order \a other with the value of this sort order and assigns the result to this sort order. - + This function determines sorting precedence. */ @@ -134,7 +135,7 @@ bool QMessageFolderSortOrder::operator!=(const QMessageFolderSortOrder& other) c /*! \fn QMessageFolderSortOrder::byName(Qt::SortOrder order) - + Returns a sort order that sorts folders by display name, according to \a order. \sa QMessageFolder::name() @@ -142,7 +143,7 @@ bool QMessageFolderSortOrder::operator!=(const QMessageFolderSortOrder& other) c /*! \fn QMessageFolderSortOrder::byPath(Qt::SortOrder order) - + Returns a sort order that sorts messages by path according to \a order. \sa QMessageFolder::path() diff --git a/src/messaging/qmessageid.cpp b/src/messaging/qmessageid.cpp index e23e03598a..d0e63fa419 100644 --- a/src/messaging/qmessageid.cpp +++ b/src/messaging/qmessageid.cpp @@ -45,24 +45,25 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageId - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageId class provides a unique identifier for a QMessage message within the + \brief The QMessageId class provides a unique identifier for a QMessage message within the scope of the messaging store. A QMessageId can be constructed from a string, or converted to a string with toString(). A QMessageId instance can be tested for validity with isValid(), and compared to other instances for equality. - - If the message a QMessageId identifies is removed from the messaging store then the identifier + + If the message a QMessageId identifies is removed from the messaging store then the identifier will not be reused. - + The QMessageId implementation should be as small as is practical for the underlying platform. - + \sa QMessage, QMessageManager */ @@ -82,13 +83,13 @@ QTM_BEGIN_NAMESPACE \fn QMessageId::QMessageId(const QString& id) Constructs an identifier from \a id. - + \sa toString() */ /*! \fn QMessageId::~QMessageId() - + Destroys the identifier. */ @@ -118,10 +119,10 @@ bool QMessageId::operator!=(const QMessageId &other) const \fn bool QMessageId::toString() const Returns the string representation of this identifier. - + A null string should be returned if and only if the identifier is invalid. - - String representations of identifiers should not be used to test for equality, instead + + String representations of identifiers should not be used to test for equality, instead the equality operator should be used. */ diff --git a/src/messaging/qmessagemanager.cpp b/src/messaging/qmessagemanager.cpp index 08f684190a..d0a70dc7ae 100644 --- a/src/messaging/qmessagemanager.cpp +++ b/src/messaging/qmessagemanager.cpp @@ -51,47 +51,48 @@ QTM_BEGIN_NAMESPACE \brief The QMessageManager class represents the main interface for storage and retrieval of messages, folders and accounts in the system message store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 The system contains a single store for messages, which is accessed via the handle - class QMessageManager. QMessageManager provides the interface for adding, updating - and deleting messages in the system's message store. - + class QMessageManager. QMessageManager provides the interface for adding, updating + and deleting messages in the system's message store. + QMessageManager provides the countFolders() and queryFolders() functions for - counting and listing the folders contained by the messaging store, and the + counting and listing the folders contained by the messaging store, and the countAccounts() and queryAccounts() functions for counting and listing the accounts contained by the store. These functions use the QMessageFolderFilter - and QMessageFolderSortOrder classes, and the QMessageAccountFilter and + and QMessageFolderSortOrder classes, and the QMessageAccountFilter and QMessageAccountSortOrder classes to constrain their searches. - QMessageManager also implements functionality allowing the messages contained by the + QMessageManager also implements functionality allowing the messages contained by the store to be counted or listed, using various filtering and sortOrder constraints. Clients can access this functionality via the \l{QMessageService::countMessages()}{countMessages} and \l{QMessageService::queryMessages()}{queryMessages} functions of the QMessageService class. - - With the exception of Windows mobile and desktop platforms, QMessageManager functions - should not initiate network activity. Instead functions are restricted to operating - on data already on the device. See QMessageService for functions related to + + With the exception of Windows mobile and desktop platforms, QMessageManager functions + should not initiate network activity. Instead functions are restricted to operating + on data already on the device. See QMessageService for functions related to initiating network activity. If a QMessageManager operation fails, the error() function will return an error code - value indicating the failure mode encountered. A successful operation will set the + value indicating the failure mode encountered. A successful operation will set the error() result to QMessageManager::NoError. - Messages in the messaging store are identified by QMessageId objects. The data associated - with a message is retrieved in the form of a QMessage object using message(). Likewise - a folder is retrieved in the form of a QMessageFolder object using folder(), and an + Messages in the messaging store are identified by QMessageId objects. The data associated + with a message is retrieved in the form of a QMessage object using message(). Likewise + a folder is retrieved in the form of a QMessageFolder object using folder(), and an account is retrieved in the form of a QMessageAccount object using account(). - Messages can be inserted into the store using the addMessage() function, messages in the - store can be manipulated via the updateMessage() function, and removed by the + Messages can be inserted into the store using the addMessage() function, messages in the + store can be manipulated via the updateMessage() function, and removed by the removeMessage() functions. - - Messaging store manipulations involving messages are reported via the messagesAdded(), + + Messaging store manipulations involving messages are reported via the messagesAdded(), messagesUpdated() and messagesRemoved() signals. \sa QMessage, QMessageId, QMessageContentContainerId, QMessageService @@ -136,9 +137,9 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageManager::QMessageManager(QObject *parent) - + Constructs a handle to the message store. - + If \a parent is not 0 then the handle will be deleted when \a parent is deleted. */ QMessageManager::QMessageManager(QObject *parent) @@ -154,7 +155,7 @@ QMessageManager::QMessageManager(QObject *parent) /*! \fn QMessageManager::~QMessageManager() - + Destroys the handle to the message store. */ QMessageManager::~QMessageManager() @@ -163,7 +164,7 @@ QMessageManager::~QMessageManager() /*! \fn QMessageManager::error() const - + Returns the code of the last error condition reported by the messaging store. */ QMessageManager::Error QMessageManager::error() const @@ -173,19 +174,19 @@ QMessageManager::Error QMessageManager::error() const /*! \fn QMessageManager::queryMessages(const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const - - Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty - only messages matching the parameters set by \a filter will be returned, otherwise + + Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty + only messages matching the parameters set by \a filter will be returned, otherwise identifiers for all messages will be returned. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + \sa error(), countMessages() */ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) const @@ -195,19 +196,19 @@ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, cons /*! \fn QMessageManager::queryMessages(const QMessageFilter &filter, const QList<QMessageSortOrder> &sortOrders, uint limit, uint offset) const - - Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty - only messages matching the parameters set by \a filter will be returned, otherwise + + Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty + only messages matching the parameters set by \a filter will be returned, otherwise identifiers for all messages will be returned. If \a sortOrders is not empty, then the identifiers will be sorted by applying each sort order element in sequence. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + \sa error(), countMessages() */ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, const QList<QMessageSortOrder> &sortOrders, uint limit, uint offset) const @@ -225,21 +226,21 @@ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, cons /*! \fn QMessageManager::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const - - Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty - only messages matching the parameters set by \a filter and with a body containing the - string \a body will be returned, otherwise identifiers for all messages with + + Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty + only messages matching the parameters set by \a filter and with a body containing the + string \a body will be returned, otherwise identifiers for all messages with a body containing \a body will be returned. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. \a matchFlags specifies the matching method to use. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + \sa error(), countMessages() */ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) const @@ -249,21 +250,21 @@ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, cons /*! \fn QMessageManager::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QList<QMessageSortOrder> &sortOrders, uint limit, uint offset) const - - Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty - only messages matching the parameters set by \a filter and with a body containing the - string \a body will be returned, otherwise identifiers for all messages with + + Returns the \l{QMessageId}s of messages in the messaging store. If \a filter is not empty + only messages matching the parameters set by \a filter and with a body containing the + string \a body will be returned, otherwise identifiers for all messages with a body containing \a body will be returned. If \a sortOrders is not empty, then the identifiers will be sorted by applying each sort order element in sequence. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. \a matchFlags specifies the matching method to use. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + \sa error(), countMessages() */ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QList<QMessageSortOrder> &sortOrders, uint limit, uint offset) const @@ -281,16 +282,16 @@ QMessageIdList QMessageManager::queryMessages(const QMessageFilter &filter, cons /*! \fn QMessageManager::queryFolders(const QMessageFolderFilter &filter, const QMessageFolderSortOrder &sortOrder, uint limit, uint offset) const - - Returns the \l{QMessageFolderId}s of folders in the messaging store. If \a filter + + Returns the \l{QMessageFolderId}s of folders in the messaging store. If \a filter is not empty only folders matching the parameters set by \a filter will be returned, otherwise identifiers for all folders will be returned. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - + \sa error(), countFolders() */ QMessageFolderIdList QMessageManager::queryFolders(const QMessageFolderFilter &filter, const QMessageFolderSortOrder &sortOrder, uint limit, uint offset) const @@ -300,16 +301,16 @@ QMessageFolderIdList QMessageManager::queryFolders(const QMessageFolderFilter &f /*! \fn QMessageManager::queryFolders(const QMessageFolderFilter &filter, const QList<QMessageFolderSortOrder> &sortOrders, uint limit, uint offset) const - - Returns the \l{QMessageFolderId}s of folders in the messaging store. If \a filter + + Returns the \l{QMessageFolderId}s of folders in the messaging store. If \a filter is not empty only folders matching the parameters set by \a filter will be returned, otherwise identifiers for all folders will be returned. If \a sortOrders is not empty, then the identifiers will be sorted by applying each sort order element in sequence. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - + \sa error(), countFolders() */ QMessageFolderIdList QMessageManager::queryFolders(const QMessageFolderFilter &filter, const QList<QMessageFolderSortOrder> &sortOrders, uint limit, uint offset) const @@ -327,16 +328,16 @@ QMessageFolderIdList QMessageManager::queryFolders(const QMessageFolderFilter &f /*! \fn QMessageManager::queryAccounts(const QMessageAccountFilter &filter, const QMessageAccountSortOrder &sortOrder, uint limit, uint offset) const - - Returns the \l{QMessageAccountId}s of accounts in the messaging store. If \a filter - is not empty only accounts matching the parameters set by \a filter will be returned, + + Returns the \l{QMessageAccountId}s of accounts in the messaging store. If \a filter + is not empty only accounts matching the parameters set by \a filter will be returned, otherwise identifiers for all accounts will be returned. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - + \sa error(), countAccounts() */ QMessageAccountIdList QMessageManager::queryAccounts(const QMessageAccountFilter &filter, const QMessageAccountSortOrder &sortOrder, uint limit, uint offset) const @@ -346,16 +347,16 @@ QMessageAccountIdList QMessageManager::queryAccounts(const QMessageAccountFilter /*! \fn QMessageManager::queryAccounts(const QMessageAccountFilter &filter, const QList<QMessageAccountSortOrder> &sortOrders, uint limit, uint offset) const - - Returns the \l{QMessageAccountId}s of accounts in the messaging store. If \a filter - is not empty only accounts matching the parameters set by \a filter will be returned, + + Returns the \l{QMessageAccountId}s of accounts in the messaging store. If \a filter + is not empty only accounts matching the parameters set by \a filter will be returned, otherwise identifiers for all accounts will be returned. If \a sortOrders is not empty, then the identifiers will be sorted by applying each sort order element in sequence. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - + \sa error(), countAccounts() */ QMessageAccountIdList QMessageManager::queryAccounts(const QMessageAccountFilter &filter, const QList<QMessageAccountSortOrder> &sortOrders, uint limit, uint offset) const @@ -371,14 +372,14 @@ QMessageAccountIdList QMessageManager::queryAccounts(const QMessageAccountFilter /*! \fn QMessageManager::countMessages(const QMessageFilter& filter) const - - Returns the number of messages which match the filtering criteria defined - in QMessageFilter \a filter. If \a filter is empty the count of all + + Returns the number of messages which match the filtering criteria defined + in QMessageFilter \a filter. If \a filter is empty the count of all available messages is returned. - - The performance of counting messages is currently significantly less than optimal + + The performance of counting messages is currently significantly less than optimal for some filters on some platforms. - + \sa error(), queryMessages() */ int QMessageManager::countMessages(const QMessageFilter& filter) const @@ -388,11 +389,11 @@ int QMessageManager::countMessages(const QMessageFilter& filter) const /*! \fn QMessageManager::countFolders(const QMessageFolderFilter& filter) const - - Returns the number of folders which match the filtering criteria defined - in QMessageFolderFilter \a filter. If \a filter is empty the count of all + + Returns the number of folders which match the filtering criteria defined + in QMessageFolderFilter \a filter. If \a filter is empty the count of all available folders is returned. - + \sa error(), queryFolders() */ int QMessageManager::countFolders(const QMessageFolderFilter& filter) const @@ -402,11 +403,11 @@ int QMessageManager::countFolders(const QMessageFolderFilter& filter) const /*! \fn QMessageManager::countAccounts(const QMessageAccountFilter& filter) const - - Returns the number of messages which match the filtering criteria defined - in QMessageAccountFilter \a filter. If \a filter is empty the count of all + + Returns the number of messages which match the filtering criteria defined + in QMessageAccountFilter \a filter. If \a filter is empty the count of all available accounts is returned. - + \sa error(), queryAccounts() */ int QMessageManager::countAccounts(const QMessageAccountFilter& filter) const @@ -416,17 +417,17 @@ int QMessageManager::countAccounts(const QMessageAccountFilter& filter) const /*! \fn QMessageManager::removeMessage(const QMessageId& id, RemovalOption option) - - Removes the message with QMessageId \a id from the messaging store. If \a option is - QMessageManager::RemoveOnOriginatingServer then when synchronization is performed the - message should be removed from both the local message store and the originating server + + Removes the message with QMessageId \a id from the messaging store. If \a option is + QMessageManager::RemoveOnOriginatingServer then when synchronization is performed the + message should be removed from both the local message store and the originating server if any. Returns \c true if the operation successfully updates the store; otherwise returns \c false. - + To ensure the change is propagated to any affected external server QMessageService::exportUpdates() should be subsequently called. - + \a option is ignored on Windows mobile and desktop platforms. \sa removeMessages(), addMessage(), updateMessage(), QMessageService::exportUpdates() @@ -438,19 +439,19 @@ bool QMessageManager::removeMessage(const QMessageId& id, QMessageManager::Remov /*! \fn QMessageManager::removeMessages(const QMessageFilter& filter, QMessageManager::RemovalOption option) - + Removes all messages identified by the filter \a filter from the messaging store. - If \a option is QMessageManager::RemoveOnOriginatingServer then when synchronization is performed the + If \a option is QMessageManager::RemoveOnOriginatingServer then when synchronization is performed the messages should be removed from both the local message store and the originating server if any. - Returns \c true if the operation successfully updates the store; otherwise returns \c false. - + Returns \c true if the operation successfully updates the store; otherwise returns \c false. + To ensure the change is propagated to any affected external server QMessageService::exportUpdates() should be subsequently called. \a option is ignored on Windows mobile and desktop platforms. - + For example: To implement a function to remove a list messages identified by QMessageIds @@ -484,21 +485,21 @@ bool QMessageManager::removeAccount(const QMessageAccountId &id) /*! \fn QMessageManager::addMessage(QMessage *message) - - Adds a copy of the message indicated by \a message to the messaging store - and modifies the message indicated by \a message to contain the identifier + + Adds a copy of the message indicated by \a message to the messaging store + and modifies the message indicated by \a message to contain the identifier of the created message. - Returns \c true if the operation successfully updates the store; otherwise returns \c false. - + Returns \c true if the operation successfully updates the store; otherwise returns \c false. + To ensure the change is propagated to any affected external server QMessageService::exportUpdates() should be subsequently called. - - On the Maemo 5 (Fremantle) platform for SMS type messages this function is not yet + + On the Maemo 5 (Fremantle) platform for SMS type messages this function is not yet supported. - + Using this function to explicitly set a size or date is not currently supported on some platforms. - + \sa message(), updateMessage(), removeMessage(), QMessageService::exportUpdates() */ bool QMessageManager::addMessage(QMessage *m) @@ -508,22 +509,22 @@ bool QMessageManager::addMessage(QMessage *m) /*! \fn QMessageManager::updateMessage(QMessage *message) - - Updates the messaging store so that the message whose identifier is contained + + Updates the messaging store so that the message whose identifier is contained by the message at \a message contains the content at \a message. If \a message does not contain a valid identifier, no changes will result. Internal data of the QMessage object at \a message can be modified by this operation. - - Returns \c true if the operation successfully updates the store; otherwise returns \c false. - To ensure the change is propagated to any affected external server + Returns \c true if the operation successfully updates the store; otherwise returns \c false. + + To ensure the change is propagated to any affected external server QMessageService::exportUpdates() should be subsequently called. Using this function to explicitly set a size or date is not currently supported on some platforms. - - On the Maemo 5 (Fremantle) platform this function may only be used to update the priority and + + On the Maemo 5 (Fremantle) platform this function may only be used to update the priority and status of email type messages. - + \sa addMessage(), removeMessage(), QMessageService::exportUpdates() */ bool QMessageManager::updateMessage(QMessage *m) @@ -533,7 +534,7 @@ bool QMessageManager::updateMessage(QMessage *m) /*! \fn QMessageManager::message(const QMessageId& id) const - + Returns the QMessage identified by \a id from the store. */ QMessage QMessageManager::message(const QMessageId& id) const @@ -543,7 +544,7 @@ QMessage QMessageManager::message(const QMessageId& id) const /*! \fn QMessageManager::folder(const QMessageFolderId& id) const - + Returns the QMessageFolder identified by \a id from the store. */ QMessageFolder QMessageManager::folder(const QMessageFolderId& id) const @@ -553,7 +554,7 @@ QMessageFolder QMessageManager::folder(const QMessageFolderId& id) const /*! \fn QMessageManager::account(const QMessageAccountId& id) const - + Returns the QMessageAccount identified by \a id from the store. */ QMessageAccount QMessageManager::account(const QMessageAccountId& id) const @@ -565,12 +566,12 @@ QMessageAccount QMessageManager::account(const QMessageAccountId& id) const \fn NotificationFilterId QMessageManager::registerNotificationFilter(const QMessageFilter &filter); Registers a message filter that will be used to generate messageAdded(), messageRemoved() - and messageUpdated() signals. Returns an identifier value that can be used to identify the + and messageUpdated() signals. Returns an identifier value that can be used to identify the reason that a signal was emitted, and to unregister the filter at a later time. - The \a filter is applied to the state of the data after the occurrence of the event for which + The \a filter is applied to the state of the data after the occurrence of the event for which a notification may be emitted. - + On Linux, Maemo 6 (Harmattan) and Meego.com it is only possible to filter messageRemoved() signals with an empty QMessageFilter() that matches all messages. @@ -584,7 +585,7 @@ QMessageManager::NotificationFilterId QMessageManager::registerNotificationFilte /*! \fn void QMessageManager::unregisterNotificationFilter(NotificationFilterId notificationFilterId); - Removes the message filter associated with \a notificationFilterId from the set used + Removes the message filter associated with \a notificationFilterId from the set used to generate message event signals. \sa registerNotificationFilter(), messageAdded(), messageRemoved(), messageUpdated() @@ -598,9 +599,9 @@ void QMessageManager::unregisterNotificationFilter(NotificationFilterId notifica \fn void QMessageManager::messageAdded(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds); Signal that is emitted when the message identified by \a id is added to the message store. - \a matchingFilterIds contains a set of values identifiying registered notification filters + \a matchingFilterIds contains a set of values identifiying registered notification filters that matched the message. - + \sa messageRemoved(), messageUpdated(), registerNotificationFilter() */ @@ -608,10 +609,10 @@ void QMessageManager::unregisterNotificationFilter(NotificationFilterId notifica \fn void QMessageManager::messageRemoved(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds); Signal that is emitted when the message identified by \a id is removed from the message store. - \a matchingFilterIds contains a set of values identifiying registered notification filters + \a matchingFilterIds contains a set of values identifiying registered notification filters that matched the message. - Since the filters apply to the state of the data after the message removal, the only + Since the filters apply to the state of the data after the message removal, the only data item that may be subject to filtration is the identifier of the removed message. \sa messageAdded(), messageUpdated(), registerNotificationFilter() @@ -621,11 +622,11 @@ void QMessageManager::unregisterNotificationFilter(NotificationFilterId notifica \fn void QMessageManager::messageUpdated(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds); Signal that is emitted when the message identified by \a id is updated in the message store. - \a matchingFilterIds contains a set of values identifiying registered notification filters + \a matchingFilterIds contains a set of values identifiying registered notification filters that matched the message. - Since the filters apply to the state of the data after the message modification, updates - to messages which matched a given filter prior to modification but not afterwards will not + Since the filters apply to the state of the data after the message modification, updates + to messages which matched a given filter prior to modification but not afterwards will not result in the emission of the messageUpdated signal. \sa messageAdded(), messageRemoved(), registerNotificationFilter() diff --git a/src/messaging/qmessageservice.cpp b/src/messaging/qmessageservice.cpp index 7982ab6800..1249c38061 100644 --- a/src/messaging/qmessageservice.cpp +++ b/src/messaging/qmessageservice.cpp @@ -49,43 +49,44 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageService - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - \brief The QMessageService class provides the interface for requesting + \brief The QMessageService class provides the interface for requesting messaging service operations. - QMessageService provides the mechanisms for messaging clients to request services, - and to receive information in response. All requestable service operations present + QMessageService provides the mechanisms for messaging clients to request services, + and to receive information in response. All requestable service operations present the same interface for communicating status, and progress information. - All service request operations communicate changes in their operational state + All service request operations communicate changes in their operational state by emitting the stateChanged() signal. - Service request operations report progress information by emitting the + Service request operations report progress information by emitting the progressChanged() signal. - - If a requested operation fails after being initiated then the error() + + If a requested operation fails after being initiated then the error() function will return a value indicating the failure mode encountered. - - A client may attempt to cancel a requested operation after it has been + + A client may attempt to cancel a requested operation after it has been initiated. The cancel() slot is provided for this purpose. Cancelation is not guaranteed to succeed, and is not possible on all platforms. - A QMessageService instance supports only a single request at a time. Attempting - to initiate an operation on a QMessageService while another operation is already - in progress will result in function initiating the latter request returning - false. A client may, however, use multiple QMessageService instances to + A QMessageService instance supports only a single request at a time. Attempting + to initiate an operation on a QMessageService while another operation is already + in progress will result in function initiating the latter request returning + false. A client may, however, use multiple QMessageService instances to concurrently initiate a queue of requests that will be serviced sequentially. - Each QMessageService instance will report only the changes pertaining to + Each QMessageService instance will report only the changes pertaining to the request that instance initiated. - Except where noted QMessageServices may initiate network activity. - Other functions in the mobility messaging API will not initiate network - activity, with the exception of Windows mobile and desktop platforms which + Except where noted QMessageServices may initiate network activity. + Other functions in the mobility messaging API will not initiate network + activity, with the exception of Windows mobile and desktop platforms which may initiate network activity during the evaluation of any function call. */ @@ -102,203 +103,203 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::QMessageService(QObject *parent) - + Constructs a message service representation object. - + The \a parent is passed to the QObject constructor. */ /*! \fn QMessageService::~QMessageService() - + Destroys the message service representation. */ /*! \fn QMessageService::queryMessages(const QMessageFilter &filter, const QMessageSortOrder &sortOrder, uint limit, uint offset) - + Emits the messagesFound() signal providing \l{QMessageId}s of messages in the messaging - store. If \a filter is not empty only identifiers for messages matching the parameters + store. If \a filter is not empty only identifiers for messages matching the parameters set by \a filter will be emitted, otherwise identifiers for all messages will be emitted. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - Calling this function may result in the messagesFound() and progressChanged() + + Calling this function may result in the messagesFound() and progressChanged() signals being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - - The performance of querying messages is currently significantly less than + + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, QMessageSortOrder, messagesFound(), progressChanged(), countMessages() */ /*! \fn QMessageService::queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QMessageSortOrder &sortOrder, uint limit, uint offset) - + Emits the messagesFound() signal providing \l{QMessageId}s of messages in the messaging - store. If \a filter is not empty only identifiers for messages matching the parameters - set by \a filter and with a body containing the string \a body will be emitted, - otherwise identifiers for all messages with a body containing \a body using + store. If \a filter is not empty only identifiers for messages matching the parameters + set by \a filter and with a body containing the string \a body will be emitted, + otherwise identifiers for all messages with a body containing \a body using matching flags \a matchFlags will be emitted. - If \a sortOrder is not empty, then the identifiers will be sorted by the parameters + If \a sortOrder is not empty, then the identifiers will be sorted by the parameters set by \a sortOrder. - If \a limit is not zero, then \a limit places an upper bound on the number of + If \a limit is not zero, then \a limit places an upper bound on the number of ids in the list returned. \a offset specifies how many ids to skip at the beginning of the list returned. - - Calling this function may result in the messagesFound() and progressChanged() + + Calling this function may result in the messagesFound() and progressChanged() signals being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - The performance of querying messages is currently significantly less than + The performance of querying messages is currently significantly less than optimal for some querying criteria on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. - + Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, QMessageSortOrder, messagesFound(), progressChanged(), countMessages() */ /*! \fn QMessageService::countMessages(const QMessageFilter &filter) - - Emits via a messagesCounted() signal the number messages in the messaging + + Emits via a messagesCounted() signal the number messages in the messaging store matching \a filter. - - Calling this function may result in the progressChanged() + + Calling this function may result in the progressChanged() signal being emitted multiple times. An emission of the progressChanged() signal with a total of 0 indicates that the number of progress steps is unknown. - - The performance of counting messages is currently significantly less than optimal + + The performance of counting messages is currently significantly less than optimal for some filters on some platforms. - + Returns true if the operation can be initiated; otherwise returns false. - + Note: This function should not initiate network activity, instead only message data already stored on the device will be used during evaluation of the function. - + \sa QMessage, QMessageFilter, messagesCounted(), progressChanged(), queryMessages() */ /*! \fn QMessageService::send(QMessage &message) - + Transmit \a message using the account identified by the message's \l{QMessage::parentAccountId()}{parentAccountId} function. - If the message does not have a valid parentAccountId, it will be set to the + If the message does not have a valid parentAccountId, it will be set to the result of QMessageAccount::defaultAccount() for the message's \l{QMessage::Type}{type}. - + The message will be stored in the standard Outbox folder for the account before transmission, or moved to that folder if it is already stored in another folder. If transmission is successful, the message will be moved to the standard Sent folder for the account. - - Currently on the Maemo 5 (Fremantle), Symbian, and Windows Mobile platforms the service - action object enters the FinishedState when the message is queued for sending + + Currently on the Maemo 5 (Fremantle), Symbian, and Windows Mobile platforms the service + action object enters the FinishedState when the message is queued for sending rather than actually sent. - + Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessage, QMessageAccountId */ /*! \fn QMessageService::compose(const QMessage &message) - + Open a composer application using \a message as a prototype. - + The default application for handling the type of \a message should be used. - + Returns true if the operation can be initiated; otherwise returns false. - - On the QMF platform implementation of this function is left as a task for system + + On the QMF platform implementation of this function is left as a task for system integrators. - + \sa QMessage::type() */ /*! \fn QMessageService::retrieveHeader(const QMessageId& id) - - Retrieve meta data of the message identified by \a id. - The meta data (including flags, from, to, subject, and date fields where applicable) of + Retrieve meta data of the message identified by \a id. + + The meta data (including flags, from, to, subject, and date fields where applicable) of the message identified by \a id should be retrieved. If only the message envelope information is present, any other accessible header information should be retrieved. - + If the message can not be found on the originating server it will be marked as removed. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageId, QMessage::Removed */ /*! \fn QMessageService::retrieveBody(const QMessageId& id) - - Retrieve the body of the message identified by \a id. + + Retrieve the body of the message identified by \a id. If the message can not be found on the originating server it will be marked as removed. On the Symbian^3 platform this function is not yet supported. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageId, QMessage::Removed */ /*! \fn QMessageService::retrieve(const QMessageId &messageId, const QMessageContentContainerId& id) - - Retrieve the container identified by \a messageId and \a id, the contents of the container should also be + + Retrieve the container identified by \a messageId and \a id, the contents of the container should also be retrieved. - + Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageContentContainerId */ /*! \fn QMessageService::show(const QMessageId& id) - + Show the message identified by \a id. The default application for handling the type of message that \a id identifies should be used. Returns true if the operation can be initiated; otherwise returns false. - + On the Maemo 5 (Fremantle) platform this function is not yet supported for SMS type messages. - - On the QMF platform implementation of this function is left as a task for system + + On the QMF platform implementation of this function is left as a task for system integrators. - + \sa QMessageId, QMessage::type() */ - + /*! \fn QMessageService::exportUpdates(const QMessageAccountId &id) - - Initiate synchronization with external servers of local changes that have been queued by message store operations, + + Initiate synchronization with external servers of local changes that have been queued by message store operations, for messages with parent account \a id. - On Windows mobile and desktop platforms this function performs no operation, as when a connection is available, + On Windows mobile and desktop platforms this function performs no operation, as when a connection is available, local changes are opportunistically synchronized with external servers. Returns true if the operation can be initiated; otherwise returns false. - + \sa QMessageManager::addMessage(), QMessageManager::updateMessage(), QMessageManager::removeMessage(), QMessageManager::removeMessages() */ @@ -311,10 +312,10 @@ QTM_BEGIN_NAMESPACE Returns true if the operation can be initiated; otherwise returns false. */ - + /*! \fn QMessageService::state() const - + Returns the current state of the operation. \sa stateChanged() @@ -322,7 +323,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::cancel() - + Attempts to cancel the last requested operation. */ @@ -369,7 +370,7 @@ QTM_BEGIN_NAMESPACE /*! \fn QMessageService::error() const - + Returns a value indicating the last error condition encountered by the operation. */ diff --git a/src/messaging/qmessagesortorder.cpp b/src/messaging/qmessagesortorder.cpp index 23cc487d15..d42275ba76 100644 --- a/src/messaging/qmessagesortorder.cpp +++ b/src/messaging/qmessagesortorder.cpp @@ -47,16 +47,17 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageSortOrder - \brief The QMessageSortOrder class defines the parameters used for sorting a subset of + \brief The QMessageSortOrder class defines the parameters used for sorting a subset of queried messages from the messaging store. - + \inmodule QtMessaging - + \ingroup messaging + \since 1.0 - A QMessageSortOrder is composed of a message property to sort and a sort order. - The QMessageSortOrder class is used in conjunction with the QMessageManager::queryMessages() - and QMessageService::queryMessages() functions to sort message results according to + A QMessageSortOrder is composed of a message property to sort and a sort order. + The QMessageSortOrder class is used in conjunction with the QMessageManager::queryMessages() + and QMessageService::queryMessages() functions to sort message results according to the criteria defined by the sort order. For example: @@ -65,35 +66,35 @@ QTM_BEGIN_NAMESPACE QMessageSortOrder sortOrder(QMessageSortOrder::byTimeStamp(Qt::DescendingOrder)); QMessageIdList results = QMessageManager().queryMessages(QMessageFilter(), sortOrder); \endcode - + \sa QMessageManager, QMessageFilter */ /*! \fn QMessageSortOrder::QMessageSortOrder() - + Create a QMessageSortOrder with specifying matching parameters. - A default-constructed sort order (one for which isEmpty() returns true) sorts no messages. + A default-constructed sort order (one for which isEmpty() returns true) sorts no messages. - The result of combining an empty sort order with a non-empty sort order is the same as the original + The result of combining an empty sort order with a non-empty sort order is the same as the original non-empty sort order. The result of combining two empty sort orders is an empty sort order. - - Windows mobile and desktop platforms do not support sorting bySender() and byRecipients(), + + Windows mobile and desktop platforms do not support sorting bySender() and byRecipients(), additionally the Windows mobile platform does not support sorting byTimeStamp() and bySize(). */ /*! \fn QMessageSortOrder::QMessageSortOrder(const QMessageSortOrder &other) - + Constructs a copy of \a other. */ /*! \fn QMessageSortOrder::~QMessageSortOrder() - + Destroys the sort order. */ @@ -101,40 +102,40 @@ QTM_BEGIN_NAMESPACE \internal \fn QMessageSortOrder::operator=(const QMessageSortOrder& other) */ - + /*! \fn QMessageSortOrder::isEmpty() const - + Returns true if the sort order remains empty after default construction; otherwise returns false. */ /*! \fn QMessageSortOrder::isSupported() const - + Returns true if the sort order is supported on the current platform; otherwise returns false. */ /*! \fn QMessageSortOrder::operator+(const QMessageSortOrder& other) const - - Returns a sort order that which is the result of concatenating the vaue of this sort order and the value + + Returns a sort order that which is the result of concatenating the vaue of this sort order and the value of sort order \a other. This function determines sorting precedence. - - On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not + + On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not be combined with each other. */ /*! \fn QMessageSortOrder::operator+=(const QMessageSortOrder& other) - + Appends the value of the sort order \a other with the value of this sort order and assigns the result to this sort order. This function determines sorting precedence. - On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not + On the Windows Mobile platform bySubject() and byReceptionTimeStamp() sort orders can not be combined with each other. */ @@ -153,7 +154,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byType(Qt::SortOrder order) - + Returns a sort order that sorts messages by their message type, according to \a order. \sa QMessage::type() @@ -161,9 +162,9 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::bySender(Qt::SortOrder order) - + Returns a sort order that sorts messages by the address from which they were sent, according to \a order. - + Not supported on the Windows mobile and desktop platforms. \sa QMessage::from() @@ -171,17 +172,17 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byRecipients(Qt::SortOrder order) - + Returns a sort order that sorts messages by the addresses to which they were sent, according to \a order. Not supported on the Windows mobile and desktop platforms. - + \sa QMessage::to() */ /*! \fn QMessageSortOrder::bySubject(Qt::SortOrder order) - + Returns a sort order that sorts messages by their subject, according to \a order. \sa QMessage::subject() @@ -189,17 +190,17 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byTimeStamp(Qt::SortOrder order) - + Returns a sort order that sorts messages by their origination timestamp, according to \a order. Not supported on the Windows mobile platform. - + \sa QMessage::date(), byReceptionTimeStamp() */ /*! \fn QMessageSortOrder::byReceptionTimeStamp(Qt::SortOrder order) - + Returns a sort order that sorts messages by their reception timestamp, according to \a order. \sa QMessage::receivedDate() @@ -207,7 +208,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byStatus(QMessage::Status flag, Qt::SortOrder order) - + Returns a sort order that sorts messages by their status value \a flag, according to \a order. \sa QMessage::status() @@ -215,7 +216,7 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::byPriority(Qt::SortOrder order) - + Returns a sort order that sorts messages by their priority, according to \a order. \sa QMessage::priority() @@ -223,11 +224,11 @@ bool QMessageSortOrder::operator!=(const QMessageSortOrder& other) const /*! \fn QMessageSortOrder::bySize(Qt::SortOrder order) - + Returns a sort order that sorts messages by their size, according to \a order. Not supported on the Windows mobile platform. - + \sa QMessage::size() */ diff --git a/src/messaging/qmessagestore.cpp b/src/messaging/qmessagestore.cpp index fabe7a95dd..ed41342104 100644 --- a/src/messaging/qmessagestore.cpp +++ b/src/messaging/qmessagestore.cpp @@ -46,6 +46,7 @@ QTM_BEGIN_NAMESPACE /*! \class QMessageStore + \since 1.0 \internal */ diff --git a/src/multimedia/qaudiocapturesource.cpp b/src/multimedia/qaudiocapturesource.cpp index 5981ee365b..1d70bbe764 100644 --- a/src/multimedia/qaudiocapturesource.cpp +++ b/src/multimedia/qaudiocapturesource.cpp @@ -50,8 +50,9 @@ QT_BEGIN_NAMESPACE \brief The QAudioCaptureSource class provides an interface to query and select an audio input endpoint. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - QAudioCaptureSource provides access to the audio inputs available on your system. diff --git a/src/multimedia/qaudioencodercontrol.cpp b/src/multimedia/qaudioencodercontrol.cpp index 515156f7ce..fd3bc21f03 100644 --- a/src/multimedia/qaudioencodercontrol.cpp +++ b/src/multimedia/qaudioencodercontrol.cpp @@ -49,8 +49,9 @@ QT_BEGIN_NAMESPACE \class QAudioEncoderControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QAudioEncoderControl class provides access to the settings of a media service that performs audio encoding. diff --git a/src/multimedia/qaudioendpointselector.cpp b/src/multimedia/qaudioendpointselector.cpp index 1796e80939..cad0b30cb2 100644 --- a/src/multimedia/qaudioendpointselector.cpp +++ b/src/multimedia/qaudioendpointselector.cpp @@ -45,10 +45,11 @@ QT_BEGIN_NAMESPACE /*! \class QAudioEndpointSelector - + \brief The QAudioEndpointSelector class provides an audio endpoint selector media control. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 The QAudioEndpointSelector class provides descriptions of the audio endpoints available on a system and allows one to be selected as the audio diff --git a/src/multimedia/qimageencodercontrol.cpp b/src/multimedia/qimageencodercontrol.cpp index ee449dce8c..6442bfdcea 100644 --- a/src/multimedia/qimageencodercontrol.cpp +++ b/src/multimedia/qimageencodercontrol.cpp @@ -46,9 +46,10 @@ QT_BEGIN_NAMESPACE /*! \class QImageEncoderControl - + \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 \brief The QImageEncoderControl class provides access to the settings of a media service that performs image encoding. diff --git a/src/multimedia/qmediabindableinterface.cpp b/src/multimedia/qmediabindableinterface.cpp index 6f048a9900..56ad751b5c 100644 --- a/src/multimedia/qmediabindableinterface.cpp +++ b/src/multimedia/qmediabindableinterface.cpp @@ -47,8 +47,9 @@ QT_BEGIN_NAMESPACE \class QMediaBindableInterface \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaBindableInterface class is the base class for objects extending media objects functionality. \sa diff --git a/src/multimedia/qmediacontainercontrol.cpp b/src/multimedia/qmediacontainercontrol.cpp index e3348a2f2e..3fa4cadb71 100644 --- a/src/multimedia/qmediacontainercontrol.cpp +++ b/src/multimedia/qmediacontainercontrol.cpp @@ -46,11 +46,12 @@ QT_BEGIN_NAMESPACE /*! \class QMediaContainerControl - + \brief The QMediaContainerControl class provides access to the output container format of a QMediaService \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 If a QMediaService supports writing encoded data it will implement QMediaContainerControl. This control provides information about the output diff --git a/src/multimedia/qmediacontent.cpp b/src/multimedia/qmediacontent.cpp index 96f15a73d8..c0516c62bb 100644 --- a/src/multimedia/qmediacontent.cpp +++ b/src/multimedia/qmediacontent.cpp @@ -72,11 +72,12 @@ private: /*! \class QMediaContent - + \brief The QMediaContent class provides access to the resources relating to a media content. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 QMediaContent is used within the multimedia framework as the logical handle to media content. A QMediaContent object is composed of one or more diff --git a/src/multimedia/qmediacontrol.cpp b/src/multimedia/qmediacontrol.cpp index 8a62801c73..55f6e131d8 100644 --- a/src/multimedia/qmediacontrol.cpp +++ b/src/multimedia/qmediacontrol.cpp @@ -53,8 +53,9 @@ QT_BEGIN_NAMESPACE \class QMediaControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaControl class provides a base interface for media service controls. Media controls provide an interface to individual features provided by a diff --git a/src/multimedia/qmediaimageviewer.cpp b/src/multimedia/qmediaimageviewer.cpp index 386aca567a..83aa166133 100644 --- a/src/multimedia/qmediaimageviewer.cpp +++ b/src/multimedia/qmediaimageviewer.cpp @@ -139,7 +139,8 @@ void QMediaImageViewerPrivate::_q_playlistDestroyed() \brief The QMediaImageViewer class provides a means of viewing image media. \inmodule QtMultimediaKit \ingroup multimedia - + \since 1.0 + QMediaImageViewer is used together with a media display object such as QVideoWidget to present an image. A display object is attached to the diff --git a/src/multimedia/qmediaimageviewerservice.cpp b/src/multimedia/qmediaimageviewerservice.cpp index 5aa2cee230..7a374e7125 100644 --- a/src/multimedia/qmediaimageviewerservice.cpp +++ b/src/multimedia/qmediaimageviewerservice.cpp @@ -176,6 +176,7 @@ void QMediaImageViewerServicePrivate::clear() /*! \class QMediaImageViewerService + \since 1.0 \internal */ diff --git a/src/multimedia/qmediaobject.cpp b/src/multimedia/qmediaobject.cpp index 41787d89bd..0dedabcfec 100644 --- a/src/multimedia/qmediaobject.cpp +++ b/src/multimedia/qmediaobject.cpp @@ -67,11 +67,12 @@ void QMediaObjectPrivate::_q_notify() /*! \class QMediaObject - + \brief The QMediaObject class provides a common base for multimedia objects. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 QMediaObject derived classes provide access to the functionality of a QMediaService. Each media object hosts a QMediaService and uses the diff --git a/src/multimedia/qmediaplayer.cpp b/src/multimedia/qmediaplayer.cpp index 1828d07926..8d9a42a937 100644 --- a/src/multimedia/qmediaplayer.cpp +++ b/src/multimedia/qmediaplayer.cpp @@ -67,8 +67,9 @@ QT_BEGIN_NAMESPACE \brief The QMediaPlayer class allows the playing of a media source. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - The QMediaPlayer class is a high level media playback class. It can be used to playback such content as songs, movies and internet radio. The content diff --git a/src/multimedia/qmediaplayercontrol.cpp b/src/multimedia/qmediaplayercontrol.cpp index 5d0a7bace2..69592d9d9f 100644 --- a/src/multimedia/qmediaplayercontrol.cpp +++ b/src/multimedia/qmediaplayercontrol.cpp @@ -50,8 +50,9 @@ QT_BEGIN_NAMESPACE \class QMediaPlayerControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaPlayerControl class provides access to the media playing functionality of a QMediaService. diff --git a/src/multimedia/qmediaplaylist.cpp b/src/multimedia/qmediaplaylist.cpp index 94f303c2f4..e957a39b66 100644 --- a/src/multimedia/qmediaplaylist.cpp +++ b/src/multimedia/qmediaplaylist.cpp @@ -66,8 +66,9 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMediaPluginLoader, playlistIOLoader, \class QMediaPlaylist \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaPlaylist class provides a list of media content to play. QMediaPlaylist is intended to be used with other media objects, @@ -105,7 +106,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMediaPluginLoader, playlistIOLoader, /*! - Create a new playlist object for with the given \a parent. + Create a new playlist object for with the given \a parent. */ QMediaPlaylist::QMediaPlaylist(QObject *parent) @@ -126,7 +127,7 @@ QMediaPlaylist::QMediaPlaylist(QObject *parent) QMediaPlaylist::~QMediaPlaylist() { - Q_D(QMediaPlaylist); + Q_D(QMediaPlaylist);QMediaResource if (d->mediaObject) d->mediaObject->unbind(this); @@ -141,7 +142,7 @@ QMediaPlaylist::~QMediaPlaylist() QMediaObject *QMediaPlaylist::mediaObject() const { return d_func()->mediaObject; -} +}QMediaResource /*! \internal @@ -185,7 +186,7 @@ bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject) disconnect(d->control, SIGNAL(playbackModeChanged(QMediaPlaylist::PlaybackMode)), this, SIGNAL(playbackModeChanged(QMediaPlaylist::PlaybackMode))); disconnect(d->control, SIGNAL(currentIndexChanged(int)), - this, SIGNAL(currentIndexChanged(int))); + this, SIGNAL(currentQMediaResourceIndexChanged(int))); disconnect(d->control, SIGNAL(currentMediaChanged(QMediaContent)), this, SIGNAL(currentMediaChanged(QMediaContent))); @@ -213,7 +214,7 @@ bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject) connect(d->control, SIGNAL(currentMediaChanged(QMediaContent)), this, SIGNAL(currentMediaChanged(QMediaContent))); - if (oldSize) + if (oldSize)QMediaResource emit mediaRemoved(0, oldSize-1); if (playlist->mediaCount()) { @@ -340,7 +341,7 @@ bool QMediaPlaylist::addMedia(const QMediaContent &content) } /*! - Append multiple media content \a items to the playlist. + Append multiple media content \a itemsQMediaResource to the playlist. Returns true if the operation is successful, otherwise return false. */ @@ -500,7 +501,7 @@ void QMediaPlaylist::load(QIODevice * device, const char *format) QMediaPlaylistReader *reader = plugin->createReader(device,QByteArray(format)); if (reader && d->readItems(reader)) { delete reader; - emit loaded(); + emit loaded();QMediaResource return; } delete reader; @@ -518,7 +519,7 @@ void QMediaPlaylist::load(QIODevice * device, const char *format) Save playlist to \a location. If \a format is specified, it is used, otherwise format is guessed from location name. - Returns true if playlist was saved successfully, otherwise returns false. + Returns true if playlist was saved sucQMediaResourcecessfully, otherwise returns false. */ bool QMediaPlaylist::save(const QUrl &location, const char *format) { @@ -558,7 +559,7 @@ bool QMediaPlaylist::save(QIODevice * device, const char *format) foreach (QString const& key, playlistIOLoader()->keys()) { QMediaPlaylistIOInterface* plugin = qobject_cast<QMediaPlaylistIOInterface*>(playlistIOLoader()->instance(key)); - if (plugin && plugin->canWrite(device,format)) { + if (plugin && plugin->canWrite(dQMediaResourceevice,format)) { QMediaPlaylistWriter *writer = plugin->createWriter(device,QByteArray(format)); if (writer && d->writeItems(writer)) { delete writer; @@ -648,7 +649,7 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition) /*! \fn void QMediaPlaylist::currentIndexChanged(int position) - Signal emitted when playlist position changed to \a position. + Signal emitted when playlist positionQMediaResource changed to \a position. */ /*! diff --git a/src/multimedia/qmediaplaylistcontrol.cpp b/src/multimedia/qmediaplaylistcontrol.cpp index 21823e5597..e39222ca11 100644 --- a/src/multimedia/qmediaplaylistcontrol.cpp +++ b/src/multimedia/qmediaplaylistcontrol.cpp @@ -49,8 +49,9 @@ QT_BEGIN_NAMESPACE \class QMediaPlaylistControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaPlaylistControl class provides access to the playlist functionality of a QMediaService. diff --git a/src/multimedia/qmediaplaylistnavigator.cpp b/src/multimedia/qmediaplaylistnavigator.cpp index 3d5fe0c664..a66b04e307 100644 --- a/src/multimedia/qmediaplaylistnavigator.cpp +++ b/src/multimedia/qmediaplaylistnavigator.cpp @@ -192,9 +192,11 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const /*! \class QMediaPlaylistNavigator - + \brief The QMediaPlaylistNavigator class provides navigation for a media playlist. \inmodule QtMultimediaKit + \ingroup multimedia + \since 1.0 \sa QMediaPlaylist, QMediaPlaylistProvider */ diff --git a/src/multimedia/qmediaplaylistprovider.cpp b/src/multimedia/qmediaplaylistprovider.cpp index 1564b3e9a7..8b821d3854 100644 --- a/src/multimedia/qmediaplaylistprovider.cpp +++ b/src/multimedia/qmediaplaylistprovider.cpp @@ -48,9 +48,10 @@ QT_BEGIN_NAMESPACE /*! \class QMediaPlaylistProvider - + \brief The QMediaPlaylistProvider class provides an abstract list of media. \inmodule QtMultimediaKit + \since 1.0 \sa QMediaPlaylist */ diff --git a/src/multimedia/qmediaplaylistsourcecontrol.cpp b/src/multimedia/qmediaplaylistsourcecontrol.cpp index 2db83a88c6..24028d34e4 100644 --- a/src/multimedia/qmediaplaylistsourcecontrol.cpp +++ b/src/multimedia/qmediaplaylistsourcecontrol.cpp @@ -49,8 +49,9 @@ QT_BEGIN_NAMESPACE \class QMediaPlaylistSourceControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaPlaylistSourceControl class provides access to the playlist playback functionality of a QMediaService. diff --git a/src/multimedia/qmediarecorder.cpp b/src/multimedia/qmediarecorder.cpp index 51918f3eca..d9edffd416 100644 --- a/src/multimedia/qmediarecorder.cpp +++ b/src/multimedia/qmediarecorder.cpp @@ -65,8 +65,9 @@ QT_BEGIN_NAMESPACE \class QMediaRecorder \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaRecorder class is used for the recording of media content. The QMediaRecorder class is a high level media recording class. It's not @@ -320,7 +321,7 @@ bool QMediaRecorder::setMediaObject(QMediaObject *object) connect(service, SIGNAL(destroyed()), this, SLOT(_q_serviceDestroyed())); - + return true; } } diff --git a/src/multimedia/qmediarecordercontrol.cpp b/src/multimedia/qmediarecordercontrol.cpp index 0f6c60fafb..57306e110e 100644 --- a/src/multimedia/qmediarecordercontrol.cpp +++ b/src/multimedia/qmediarecordercontrol.cpp @@ -48,8 +48,9 @@ QT_BEGIN_NAMESPACE \class QMediaRecorderControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMediaRecorderControl class provides access to the recording functionality of a QMediaService. diff --git a/src/multimedia/qmediaresource.cpp b/src/multimedia/qmediaresource.cpp index 22163d251c..c907a6047d 100644 --- a/src/multimedia/qmediaresource.cpp +++ b/src/multimedia/qmediaresource.cpp @@ -49,10 +49,11 @@ QT_BEGIN_NAMESPACE /*! \class QMediaResource - + \brief The QMediaResource class provides a description of a media resource. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 A media resource is composed of a \l {url()}{URL} containing the location of the resource and a set of properties that describe the diff --git a/src/multimedia/qmediaservice.cpp b/src/multimedia/qmediaservice.cpp index fedabddcb0..22eb8a93ee 100644 --- a/src/multimedia/qmediaservice.cpp +++ b/src/multimedia/qmediaservice.cpp @@ -55,7 +55,8 @@ QT_BEGIN_NAMESPACE service implementations. \inmodule QtMultimediaKit \ingroup multimedia - + \since 1.0 + Media services provide implementations of the functionality promised by media objects, and allow multiple providers to implement a QMediaObject. diff --git a/src/multimedia/qmediaserviceprovider.cpp b/src/multimedia/qmediaserviceprovider.cpp index 1e87750b0b..12389102f3 100644 --- a/src/multimedia/qmediaserviceprovider.cpp +++ b/src/multimedia/qmediaserviceprovider.cpp @@ -81,11 +81,12 @@ public: /*! \class QMediaServiceProviderHint - + \brief The QMediaServiceProviderHint class describes what is required of a QMediaService. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 The QMediaServiceProvider class uses hints to select an appropriate media service. */ @@ -523,7 +524,7 @@ Q_GLOBAL_STATIC(QPluginServiceProvider, pluginProvider); /*! \class QMediaServiceProvider - + \brief The QMediaServiceProvider class provides an abstract allocator for media services. */ @@ -637,7 +638,7 @@ QMediaServiceProvider *QMediaServiceProvider::defaultServiceProvider() /*! \class QMediaServiceProviderPlugin - + \brief The QMediaServiceProviderPlugin class interface provides an interface for QMediaService plug-ins. diff --git a/src/multimedia/qmediastreamscontrol.cpp b/src/multimedia/qmediastreamscontrol.cpp index aa0efd71eb..7b0c0a04a5 100644 --- a/src/multimedia/qmediastreamscontrol.cpp +++ b/src/multimedia/qmediastreamscontrol.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE \brief The QMediaStreamsControl class provides a media stream selection control. \ingroup multimedia + \since 1.0 The QMediaStreamsControl class provides descriptions of the available media streams and allows individual streams to be activated and deactivated. diff --git a/src/multimedia/qmediatimerange.cpp b/src/multimedia/qmediatimerange.cpp index dd5cb4ce6f..8ff7d0c190 100644 --- a/src/multimedia/qmediatimerange.cpp +++ b/src/multimedia/qmediatimerange.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \brief The QMediaTimeInterval class represents a time interval with integer precision. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 An interval is specified by an inclusive start() and end() time. These must be set in the constructor, as this is an immutable class. The @@ -240,7 +241,7 @@ QMediaTimeRangePrivate::QMediaTimeRangePrivate(const QMediaTimeInterval &interva } void QMediaTimeRangePrivate::addInterval(const QMediaTimeInterval &interval) -{ +{ // Handle normalized intervals only if(!interval.isNormal()) return; diff --git a/src/multimedia/qmetadatareadercontrol.cpp b/src/multimedia/qmetadatareadercontrol.cpp index 70d06d20fb..cfc3bf8ac8 100644 --- a/src/multimedia/qmetadatareadercontrol.cpp +++ b/src/multimedia/qmetadatareadercontrol.cpp @@ -49,8 +49,9 @@ QT_BEGIN_NAMESPACE \class QMetaDataReaderControl \inmodule QtMultimediaKit \ingroup multimedia-serv + \since 1.0 + - \brief The QMetaDataReaderControl class provides read access to the meta-data of a QMediaService's media. diff --git a/src/multimedia/qmetadatawritercontrol.cpp b/src/multimedia/qmetadatawritercontrol.cpp index 812a9d0a88..6b9acde710 100644 --- a/src/multimedia/qmetadatawritercontrol.cpp +++ b/src/multimedia/qmetadatawritercontrol.cpp @@ -49,8 +49,9 @@ QT_BEGIN_NAMESPACE \class QMetaDataWriterControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QMetaDataWriterControl class provides write access to the meta-data of a QMediaService's media. diff --git a/src/multimedia/qpaintervideosurface.cpp b/src/multimedia/qpaintervideosurface.cpp index 6212d0ecbd..275259512d 100644 --- a/src/multimedia/qpaintervideosurface.cpp +++ b/src/multimedia/qpaintervideosurface.cpp @@ -1280,6 +1280,7 @@ QAbstractVideoSurface::Error QVideoSurfaceGlslPainter::paint( /*! \class QPainterVideoSurface + \since 1.0 \internal */ @@ -1387,7 +1388,7 @@ bool QPainterVideoSurface::present(const QVideoFrame &frame) if (!m_ready) { if (!isActive()) setError(StoppedError); - } else if (frame.isValid() + } else if (frame.isValid() && (frame.pixelFormat() != m_pixelFormat || frame.size() != m_frameSize)) { setError(IncorrectFormatError); diff --git a/src/multimedia/qradiotuner.cpp b/src/multimedia/qradiotuner.cpp index 0b9e91b277..24954c6dcc 100644 --- a/src/multimedia/qradiotuner.cpp +++ b/src/multimedia/qradiotuner.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 You can control the systems analog radio device using this interface, for example: diff --git a/src/multimedia/qradiotunercontrol.cpp b/src/multimedia/qradiotunercontrol.cpp index 06d0c38c24..3361443382 100644 --- a/src/multimedia/qradiotunercontrol.cpp +++ b/src/multimedia/qradiotunercontrol.cpp @@ -50,8 +50,9 @@ QT_BEGIN_NAMESPACE \class QRadioTunerControl \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 + - \brief The QRadioTunerControl class provides access to the radio tuning functionality of a QMediaService. diff --git a/src/multimedia/qvideodevicecontrol.cpp b/src/multimedia/qvideodevicecontrol.cpp index c46cae1104..1d2b185b9b 100644 --- a/src/multimedia/qvideodevicecontrol.cpp +++ b/src/multimedia/qvideodevicecontrol.cpp @@ -45,10 +45,11 @@ QT_BEGIN_NAMESPACE /*! \class QVideoDeviceControl - + \brief The QVideoDeviceControl class provides an video device selector media control. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 The QVideoDeviceControl class provides descriptions of the video devices available on a system and allows one to be selected as the endpoint of a diff --git a/src/multimedia/qvideoencodercontrol.cpp b/src/multimedia/qvideoencodercontrol.cpp index 97ae4b2329..ef999e8d67 100644 --- a/src/multimedia/qvideoencodercontrol.cpp +++ b/src/multimedia/qvideoencodercontrol.cpp @@ -47,9 +47,10 @@ QT_BEGIN_NAMESPACE /*! \class QVideoEncoderControl - + \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 \brief The QVideoEncoderControl class provides access to the settings of a media service that performs video encoding. diff --git a/src/multimedia/qvideorenderercontrol.cpp b/src/multimedia/qvideorenderercontrol.cpp index 10f41539b5..4f6e7a51e5 100644 --- a/src/multimedia/qvideorenderercontrol.cpp +++ b/src/multimedia/qvideorenderercontrol.cpp @@ -47,13 +47,14 @@ QT_BEGIN_NAMESPACE /*! \class QVideoRendererControl - + \brief The QVideoRendererControl class provides a control for rendering to a video surface. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 Using the surface() property of QVideoRendererControl a QAbstractVideoSurface may be set as the video render target of a diff --git a/src/multimedia/qvideowidget.cpp b/src/multimedia/qvideowidget.cpp index a738d39f87..6056b774a5 100644 --- a/src/multimedia/qvideowidget.cpp +++ b/src/multimedia/qvideowidget.cpp @@ -591,6 +591,7 @@ void QVideoWidgetPrivate::_q_dimensionsChanged() produced by a media object. \ingroup multimedia \inmodule QtMultimediaKit + \since 1.0 Attaching a QVideoWidget to a QMediaObject allows it to display the video or image output of that media object. A QVideoWidget is attached diff --git a/src/multimedia/qvideowidgetcontrol.cpp b/src/multimedia/qvideowidgetcontrol.cpp index 0e6a96b2cd..f40a7960ae 100644 --- a/src/multimedia/qvideowidgetcontrol.cpp +++ b/src/multimedia/qvideowidgetcontrol.cpp @@ -46,13 +46,14 @@ QT_BEGIN_NAMESPACE /*! \class QVideoWidgetControl - + \brief The QVideoWidgetControl class provides a media control which implements a video widget. \inmodule QtMultimediaKit \ingroup multimedia + \since 1.0 The videoWidget() property of QVideoWidgetControl provides a pointer to a video widget implemented by the control's media service. This widget is diff --git a/src/multimedia/qvideowindowcontrol.cpp b/src/multimedia/qvideowindowcontrol.cpp index cdc2b8934a..7c1202b614 100644 --- a/src/multimedia/qvideowindowcontrol.cpp +++ b/src/multimedia/qvideowindowcontrol.cpp @@ -45,10 +45,11 @@ QT_BEGIN_NAMESPACE /*! \class QVideoWindowControl - + \inmodule QtMultimediaKit \ingroup multimedia \brief The QVideoWindowControl class provides a media control for rendering video to a window. + \since 1.0 The winId() property QVideoWindowControl allows a platform specific window diff --git a/src/publishsubscribe/qmallocpool.cpp b/src/publishsubscribe/qmallocpool.cpp index ac56af559e..b31f9dec37 100644 --- a/src/publishsubscribe/qmallocpool.cpp +++ b/src/publishsubscribe/qmallocpool.cpp @@ -150,6 +150,7 @@ struct QMallocPtr \internal \inmodule QtPublishSubscribe \ingroup publishsubscribe + \since 1.0 \brief The QMallocPool class allows management of allocations within a designated memory region. @@ -193,7 +194,7 @@ struct QMallocPtr Shared pool type. The malloc pool bookkeeping data contains absolute pointers. As such, if - multiple processes intend to allocate into the malloc pool, is is essential + multiple processes intend to allocate into the malloc pool, is is essential that they map the memory region to the same virtual address location. \value Shared The bookkeeping data is stored in the managed region, and has previously been @@ -201,7 +202,7 @@ struct QMallocPtr pool type. The malloc pool bookkeeping data contains absolute pointers. As such, if - multiple processes intend to allocate into the malloc pool, is is essential + multiple processes intend to allocate into the malloc pool, is is essential that they map the memory region to the same virtual address location. */ diff --git a/src/publishsubscribe/qpacketprotocol.cpp b/src/publishsubscribe/qpacketprotocol.cpp index 18eb4f6dc4..08f16a619b 100644 --- a/src/publishsubscribe/qpacketprotocol.cpp +++ b/src/publishsubscribe/qpacketprotocol.cpp @@ -51,11 +51,12 @@ QTM_BEGIN_NAMESPACE \internal \inmodule QtPublishSubscribe \ingroup publishsubscribe + \since 1.0 \brief The QPacketProtocol class encapsulates communicating discrete packets across fragmented IO channels, such as TCP sockets. - QPacketProtocol makes it simple to send arbitrary sized data "packets" across + QPacketProtocol makes it simple to send arbitrary sized data "packets" across fragmented transports such as TCP and UDP. As transmission boundaries are not respected, sending packets over protocols @@ -146,7 +147,7 @@ public slots: void bytesWritten(qint64 bytes) { Q_ASSERT(!sendingPackets.isEmpty()); - + while(bytes) { if(sendingPackets.at(0) > bytes) { sendingPackets[0] -= bytes; @@ -233,8 +234,8 @@ QPacketProtocol::~QPacketProtocol() /*! Returns the maximum packet size allowed. By default this is - 2,147,483,647 bytes. - + 2,147,483,647 bytes. + If a packet claiming to be larger than the maximum packet size is received, the QPacketProtocol::invalidPacket() signal is emitted. @@ -264,7 +265,7 @@ qint32 QPacketProtocol::setMaximumPacketSize(qint32 max) protocol.send() << "Hello world" << 123; \endcode - will send a packet containing "Hello world" and 123. To construct more + will send a packet containing "Hello world" and 123. To construct more complex packets, explicitly construct a QPacket instance. */ QPacketAutoSend QPacketProtocol::send() @@ -389,8 +390,8 @@ QIODevice * QPacketProtocol::device() \endcode Only packets returned from QPacketProtocol::read() may be read from. QPacket - instances constructed by directly by applications are for transmission only - and are considered "write only". Attempting to read data from them will + instances constructed by directly by applications are for transmission only + and are considered "write only". Attempting to read data from them will result in undefined behavior. \sa QPacketProtocol diff --git a/src/publishsubscribe/qvaluespace.cpp b/src/publishsubscribe/qvaluespace.cpp index a3dee2d041..243340428d 100644 --- a/src/publishsubscribe/qvaluespace.cpp +++ b/src/publishsubscribe/qvaluespace.cpp @@ -64,6 +64,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtPublishSubscribe \ingroup publishsubscribe \internal + \since 1.0 To create a new layer in the Value Space subclass this class and reimplement all of the virtual functions. The new layer is installed by either calling QValueSpace::installLayer() or by diff --git a/src/publishsubscribe/qvaluespacepublisher.cpp b/src/publishsubscribe/qvaluespacepublisher.cpp index 9fbb22b342..648759bfd4 100644 --- a/src/publishsubscribe/qvaluespacepublisher.cpp +++ b/src/publishsubscribe/qvaluespacepublisher.cpp @@ -57,6 +57,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtPublishSubscribe \ingroup publishsubscribe + \since 1.0 When multiple Value Space layers are available QValueSpacePublisher only publishes values to the layer with the highest order. The layers that QValueSpacePublisher can access can be diff --git a/src/publishsubscribe/qvaluespacesubscriber.cpp b/src/publishsubscribe/qvaluespacesubscriber.cpp index 502aec5fe9..95add53391 100644 --- a/src/publishsubscribe/qvaluespacesubscriber.cpp +++ b/src/publishsubscribe/qvaluespacesubscriber.cpp @@ -59,6 +59,7 @@ QTM_BEGIN_NAMESPACE \inmodule QtPublishSubscribe \ingroup publishsubscribe + \since 1.0 By default QValueSpaceSubscriber can read values from and report change notifications for all available Value Space layers. Only data from the layer with the highest order and that diff --git a/src/sensors/qaccelerometer.cpp b/src/sensors/qaccelerometer.cpp index 2f9ab8d4ca..a9ea15b728 100644 --- a/src/sensors/qaccelerometer.cpp +++ b/src/sensors/qaccelerometer.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QAccelerometerReading) \class QAccelerometerReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QAccelerometerReading class reports on linear acceleration along the X, Y and Z axes. diff --git a/src/sensors/qambientlightsensor.cpp b/src/sensors/qambientlightsensor.cpp index da412d53e0..d5358fd73c 100644 --- a/src/sensors/qambientlightsensor.cpp +++ b/src/sensors/qambientlightsensor.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QAmbientLightReading) \class QAmbientLightReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QAmbientLightReading class represents one reading from the ambient light sensor. diff --git a/src/sensors/qcompass.cpp b/src/sensors/qcompass.cpp index 2c293b0486..9da353e7ec 100644 --- a/src/sensors/qcompass.cpp +++ b/src/sensors/qcompass.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QCompassReading) \class QCompassReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QCompassReading class represents one reading from a compass. @@ -86,7 +87,7 @@ qreal QCompassReading::azimuth() const /*! Sets the \a azimuth of the device. - + \sa {QCompassReading Units} */ void QCompassReading::setAzimuth(qreal azimuth) diff --git a/src/sensors/qmagnetometer.cpp b/src/sensors/qmagnetometer.cpp index baa3d19f46..55a80e1ed9 100644 --- a/src/sensors/qmagnetometer.cpp +++ b/src/sensors/qmagnetometer.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QMagnetometerReading) \class QMagnetometerReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QMagnetometerReading class represents one reading from the magnetometer. diff --git a/src/sensors/qorientationsensor.cpp b/src/sensors/qorientationsensor.cpp index 45e930bf04..f98ab6d764 100644 --- a/src/sensors/qorientationsensor.cpp +++ b/src/sensors/qorientationsensor.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QOrientationReading) \class QOrientationReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QOrientationReading class represents one reading from the orientation sensor. diff --git a/src/sensors/qproximitysensor.cpp b/src/sensors/qproximitysensor.cpp index 9148f5c529..b4a8e7ab74 100644 --- a/src/sensors/qproximitysensor.cpp +++ b/src/sensors/qproximitysensor.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QProximityReading) \class QProximityReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QProximityReading class represents one reading from the proximity sensor. diff --git a/src/sensors/qrotationsensor.cpp b/src/sensors/qrotationsensor.cpp index 16819fb07e..4d5e8742ca 100644 --- a/src/sensors/qrotationsensor.cpp +++ b/src/sensors/qrotationsensor.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QRotationReading) \class QRotationReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QRotationReading class represents one reading from the rotation sensor. diff --git a/src/sensors/qsensorbackend.cpp b/src/sensors/qsensorbackend.cpp index b27c781243..e59acd69bb 100644 --- a/src/sensors/qsensorbackend.cpp +++ b/src/sensors/qsensorbackend.cpp @@ -49,6 +49,7 @@ QTM_BEGIN_NAMESPACE \class QSensorBackend \ingroup sensors_backend \inmodule QtSensors + \since 1.0 \brief The QSensorBackend class is a sensor implementation. diff --git a/src/sensors/qsensormanager.cpp b/src/sensors/qsensormanager.cpp index 39438346e3..9c6c1190e4 100644 --- a/src/sensors/qsensormanager.cpp +++ b/src/sensors/qsensormanager.cpp @@ -206,6 +206,7 @@ void QSensorManagerPrivate::loadPlugins() \class QSensorManager \ingroup sensors_backend \inmodule QtSensors + \since 1.0 \brief The QSensorManager class handles registration and creation of sensor backends. diff --git a/src/sensors/qsensorplugin.cpp b/src/sensors/qsensorplugin.cpp index a67b168197..f6e78c5c30 100644 --- a/src/sensors/qsensorplugin.cpp +++ b/src/sensors/qsensorplugin.cpp @@ -46,6 +46,7 @@ \ingroup sensors_backend \inmodule QtSensors \brief The QSensorPluginInterface class is the pure virtual interface to sensor plugins. + \since 1.0 The QSensorPluginInterface class is implemented in sensor plugins to register sensor backends with QSensorManager. diff --git a/src/sensors/qtapsensor.cpp b/src/sensors/qtapsensor.cpp index 9b00648f43..8c37728579 100644 --- a/src/sensors/qtapsensor.cpp +++ b/src/sensors/qtapsensor.cpp @@ -50,6 +50,7 @@ IMPLEMENT_READING(QTapReading) \class QTapReading \ingroup sensors_reading \inmodule QtSensors + \since 1.0 \brief The QTapReading class represents one reading from the tap sensor. diff --git a/src/serviceframework/qabstractsecuritysession.cpp b/src/serviceframework/qabstractsecuritysession.cpp index 00465b2b18..e655ec44cb 100644 --- a/src/serviceframework/qabstractsecuritysession.cpp +++ b/src/serviceframework/qabstractsecuritysession.cpp @@ -49,18 +49,19 @@ QTM_BEGIN_NAMESPACE \ingroup servicefw \brief The QAbstractSecuritySession class provides a generic mechanism to enable permission checks for services. - + \since 1.0 + QAbstractSecuritySession describes the abstract interface that security/permission engines must implement in order to provide capability related functionality. A QAbstractSecuritySession encapsulates the service client's capabilities. QServiceManager - can match those capabilites with the capabilites required by a particular service. - Service capabilites are declared via the services XML description. + can match those capabilites with the capabilites required by a particular service. + Service capabilites are declared via the services XML description. The use of a security session is not mandated by the service manager. If the client is passing a security session object QServiceManager ensures that the permissions - are checked before the requested service is loaded and forwards the session to the - service in case the service intends to implement additional checks. If no security + are checked before the requested service is loaded and forwards the session to the + service in case the service intends to implement additional checks. If no security session is passed to QServiceManager capability checks are not performed. Note that the security session is no substitute for platform security such as control over a processes ability to load arbitrary plug-ins. @@ -93,11 +94,11 @@ QAbstractSecuritySession::~QAbstractSecuritySession() { } -/*! +/*! \fn bool QAbstractSecuritySession::isAllowed(const QStringList& capabilities) = 0; Returns true if the security session has sufficient rights to access the required - service \a capabilities. + service \a capabilities. */ #include "moc_qabstractsecuritysession.cpp" diff --git a/src/serviceframework/qservicecontext.cpp b/src/serviceframework/qservicecontext.cpp index d3ffd130ce..dc941c0aa2 100644 --- a/src/serviceframework/qservicecontext.cpp +++ b/src/serviceframework/qservicecontext.cpp @@ -58,13 +58,14 @@ public: \class QServiceContext \inmodule QtServiceFramework \ingroup servicefw - \brief The QServiceContext class provides context information to + \brief The QServiceContext class provides context information to services. + \since 1.0 A service context is created by clients and passed on to the service. - It enables the opportunity to pass additional context information + It enables the opportunity to pass additional context information and errors between services, clients and the service framework. - + Clients must implement this abstract class to receive context information. \sa QServiceManager @@ -76,9 +77,9 @@ public: This enum describes the type of context information. - \value DisplayContext The service provides user visible display + \value DisplayContext The service provides user visible display text such as an error message. - \value ScriptContext The service provides a script which may + \value ScriptContext The service provides a script which may be executed by the client. \value UserDefined The first context type that can be used for service specific context information. @@ -88,7 +89,7 @@ public: \fn void QServiceContext::notify(ContextType type, const QVariant& data) = 0 Services may call this function to notify the service client about service related - context information of the given \a type. The contextual information is stored in \a data. + context information of the given \a type. The contextual information is stored in \a data. */ @@ -110,7 +111,7 @@ QServiceContext::QServiceContext(QObject* parent) /*! Destroys the service context object. */ -QServiceContext::~QServiceContext() +QServiceContext::~QServiceContext() { //ServiceContextUserData deleted by QObject } diff --git a/src/serviceframework/qservicefilter.cpp b/src/serviceframework/qservicefilter.cpp index b37362f63a..770b76dcee 100644 --- a/src/serviceframework/qservicefilter.cpp +++ b/src/serviceframework/qservicefilter.cpp @@ -66,16 +66,17 @@ public: /*! \class QServiceFilter - + \ingroup servicefw \inmodule QtServiceFramework - \brief The QServiceFilter class defines criteria for defining a sub-set of + \brief The QServiceFilter class defines criteria for defining a sub-set of all available services. + \since 1.0 A QServiceFilter can be used to constrain the number of services when searching for services. Only those services that match all filter criteria are returned by \l QServiceManager::findInterfaces(). - + \sa QServiceInterfaceDescriptor, QServiceManager */ @@ -86,7 +87,7 @@ public: This enum describes how interface version matching is performed. \value ExactVersionMatch The filter matches any interface implementation that implements - the exact version provided. + the exact version provided. \value MinimumVersionMatch The filter matches any interface implementation that implements either the given major/minor version or any subsequent version. */ @@ -94,8 +95,8 @@ public: /*! \enum QServiceFilter::CapabilityMatchRule - This enum describes the capability/permission matching rules. Some platforms restrict what services clients - can access using "capabilities" or permissions. Services with more capabilities require + This enum describes the capability/permission matching rules. Some platforms restrict what services clients + can access using "capabilities" or permissions. Services with more capabilities require more privileged clients. Platforms without capabilities may ignore this type of matching rule as the default behavior is to ignore any capability restrictions. @@ -121,17 +122,17 @@ public: \row \o MatchMinimum \o \{A\} \o S2, S3, S4, S5 \row \o MatchMinimum \o \{A,B,C\} \o S4 \endtable - - \value MatchMinimum The filter matches any service that requires at least the given + + \value MatchMinimum The filter matches any service that requires at least the given filter capabilities. This may mean that the returned services may require more capabilities than the specified ones. - Such a search is equivalent to a wildcard match if the passed filter's capability list is empty. In mathematical set notation + Such a search is equivalent to a wildcard match if the passed filter's capability list is empty. In mathematical set notation this rule is equivalent to Cap\sub{(Filter)} \\ Cap\sub{(Service)} = {}. This is the default matching rule. \value MatchLoadable The filter matches any service that could be loaded by the client. Using this matching rule guarantees that the returned services do not require more capabilites than specified by this rule. It includes services with no capability requirements. If this rule - is provided alongside an empty capability search list the returned + is provided alongside an empty capability search list the returned services do not require any capabilities and thus can be accessed by any client. The equivalent set notation is Cap\sub{(Service)} \\ Cap\sub{(Filter)} = {}. */ @@ -159,7 +160,7 @@ QServiceFilter::QServiceFilter(const QServiceFilter& other) /*! \fn QServiceFilter::QServiceFilter(const QString& interfaceName, const QString& version, QServiceFilter::VersionMatchRule rule) - + Creates a new filter object that matches all service implementations implementing \a interfaceName that match the specified \a version using the given \a rule. @@ -184,8 +185,8 @@ QServiceFilter::~QServiceFilter() /*! \fn QServiceFilter& QServiceFilter::operator=(const QServiceFilter& other) - - Copies the content of the QServiceFilter object contained in + + Copies the content of the QServiceFilter object contained in \a other into this one. */ QServiceFilter& QServiceFilter::operator=(const QServiceFilter& other) @@ -204,7 +205,7 @@ QServiceFilter& QServiceFilter::operator=(const QServiceFilter& other) /*! \fn void QServiceFilter::setServiceName(const QString& serviceName) - + The filter only matches implementations which are provided by the service specified by \a serviceName. @@ -217,7 +218,7 @@ void QServiceFilter::setServiceName(const QString& serviceName) /*! \fn void QServiceFilter::setInterface(const QString &interfaceName, const QString& version, QServiceFilter::VersionMatchRule rule) - + Sets the filter to match any interface implementation that implements \a interfaceName with version \a version. The version is matched according to the given \a rule. If \a version is not set, the filter matches any version of the @@ -232,7 +233,7 @@ void QServiceFilter::setServiceName(const QString& serviceName) void QServiceFilter::setInterface(const QString &interfaceName, const QString& version, QServiceFilter::VersionMatchRule rule) { //unset interface name - if (interfaceName.isEmpty() && version.isEmpty()) + if (interfaceName.isEmpty() && version.isEmpty()) { d->interface = interfaceName; d->majorVersion = d->minorVersion = -1; @@ -261,8 +262,8 @@ void QServiceFilter::setInterface(const QString &interfaceName, const QString& v bool success = false; int temp_major = -1; int temp_minor = -1; - if (pos == 0 && list.count() == 3 - && rx.matchedLength() == version.length() ) + if (pos == 0 && list.count() == 3 + && rx.matchedLength() == version.length() ) { temp_major = list[1].toInt(&success); if ( success ) { @@ -282,7 +283,7 @@ void QServiceFilter::setInterface(const QString &interfaceName, const QString& v /*! \fn QString QServiceFilter::serviceName() const - + Returns the service name for this filter. \sa setServiceName() @@ -294,7 +295,7 @@ QString QServiceFilter::serviceName() const /*! \fn QString QServiceFilter::interfaceName() const - + Returns the interface name for this filter. \sa setInterface() @@ -306,7 +307,7 @@ QString QServiceFilter::interfaceName() const /*! \fn int QServiceFilter::majorVersion() const - + Returns the major interface version for this filter. \sa setInterface() @@ -318,7 +319,7 @@ int QServiceFilter::majorVersion() const /*! \fn int QServiceFilter::minorVersion() const - + Returns the minor interface version for this filter. \sa setInterface() @@ -330,9 +331,9 @@ int QServiceFilter::minorVersion() const /*! \fn void QServiceFilter::setCustomAttribute(const QString& key, const QString& value) - + The filter only matches implementations which have the custom attribute - \a key with the given \a value. Such constraints are specified via the + \a key with the given \a value. Such constraints are specified via the \i{<customproperty>} tag within the service xml. \sa customAttribute(), clearCustomAttribute() @@ -344,7 +345,7 @@ void QServiceFilter::setCustomAttribute(const QString& key, const QString& value /*! \fn QString QServiceFilter::customAttribute(const QString& key) const - + Returns the value for the custom attribute \a key; otherwise returns a null string. @@ -357,7 +358,7 @@ QString QServiceFilter::customAttribute(const QString& key) const /*! \fn void QServiceFilter::clearCustomAttribute(const QString &key) - + Clears the custom attribute \a key from the filter's set of constraints. If \a key is empty all custom attributes are cleared. @@ -373,7 +374,7 @@ void QServiceFilter::clearCustomAttribute(const QString &key) /*! \fn QServiceFilter::VersionMatchRule QServiceFilter::versionMatchRule() const - + Returns the version match rule for this filter. \sa setInterface() @@ -385,7 +386,7 @@ QServiceFilter::VersionMatchRule QServiceFilter::versionMatchRule() const /*! \fn QList<QString> QServiceFilter::customAttributes() const - + Returns the list of custom keys which have been added to the filter. */ QStringList QServiceFilter::customAttributes() const @@ -395,11 +396,11 @@ QStringList QServiceFilter::customAttributes() const /*! \fn void QServiceFilter::setCapabilities(QServiceFilter::CapabilityMatchRule rule, const QStringList& capabilities ) - + Sets the list of \a capabilities which are used to constrain searches for services. The capabilities are matched according to the given \a rule. - + \sa capabilities(), QAbstractSecuritySession */ void QServiceFilter::setCapabilities(QServiceFilter::CapabilityMatchRule rule, const QStringList& capabilities ) @@ -410,7 +411,7 @@ void QServiceFilter::setCapabilities(QServiceFilter::CapabilityMatchRule rule, c /*! \fn QStringList QServiceFilter::capabilities() const - + Returns the list of capabilities which are used to limit services searches. The filter matches any services that requires the given or less @@ -435,7 +436,7 @@ QServiceFilter::CapabilityMatchRule QServiceFilter::capabilityMatchRule() const } #ifndef QT_NO_DATASTREAM -/*! +/*! \fn QDataStream &operator<<(QDataStream &out, const QServiceFilter &sf) \relates QServiceFilter diff --git a/src/serviceframework/qserviceinterfacedescriptor.cpp b/src/serviceframework/qserviceinterfacedescriptor.cpp index 7d86fcb9bc..617b70486d 100644 --- a/src/serviceframework/qserviceinterfacedescriptor.cpp +++ b/src/serviceframework/qserviceinterfacedescriptor.cpp @@ -54,32 +54,33 @@ QTM_BEGIN_NAMESPACE \ingroup servicefw \inmodule QtServiceFramework \brief The QServiceInterfaceDescriptor class identifies a service implementation. + \since 1.0 - A service can implement multiple interfaces and each interface can have multiple implementations. + A service can implement multiple interfaces and each interface can have multiple implementations. The QServiceInterfaceDescriptor class enscapsulates this information, as illustrated by the diagram below. \image qserviceinterfacedescriptor.png Service-Interface-Implementation The major version tag indicates the interface version and the minor version tag identifies the implementation - version. Subsequent versions of the same interface must be binary compatible to previous versions - of the same interface. + version. Subsequent versions of the same interface must be binary compatible to previous versions + of the same interface. In the above example service A and B implement the interface \i com.nokia.qt.x. - In fact Service A provides two different implementations for the very same interface. - This is indicated by the changed minor version number. Although Service B is + In fact Service A provides two different implementations for the very same interface. + This is indicated by the changed minor version number. Although Service B is using the same interface it's implementation actually utilizes the second version of - the interface \i com.nokia.qt.x. Binary compatibility guarantees that clients + the interface \i com.nokia.qt.x. Binary compatibility guarantees that clients who know version 1 can utilize version 2. If an existing interface has to be changed in a non-compatible way a new interface (name) is required. \section1 Namespaces - A QServiceInterfaceDescriptor (the quadruble of service name, - interface name, interface version and implementation version) uniquely - identifies a service implementation on a device. Interface names follow + A QServiceInterfaceDescriptor (the quadruble of service name, + interface name, interface version and implementation version) uniquely + identifies a service implementation on a device. Interface names follow the java namespace convention. - + The namespace \i com.nokia.qt.* is reserved for future Qt development. \sa QServiceFilter, QServiceManager @@ -93,19 +94,19 @@ QTM_BEGIN_NAMESPACE \value Capabilities The capabilities attribute is a QStringList and describes the capabilities that a service client - would require to use the service if capability + would require to use the service if capability checks are enforced. \value Location This attribute points to either the location where the plug-in providing this service is stored or where the name of the service IPC path is found. If the service is plug-in based the location is the - name and/or path of the plugin. If the service is + name and/or path of the plugin. If the service is IPC based the location is the name of the socket address. \value ServiceDescription This attribute provides a general description for the service. - \value InterfaceDescription This attribute provides a description for the interface + \value InterfaceDescription This attribute provides a description for the interface implementation. - \value ServiceType This attribute specifies the QService::Type that the + \value ServiceType This attribute specifies the QService::Type that the service is being provided. */ @@ -137,14 +138,14 @@ QServiceInterfaceDescriptor::QServiceInterfaceDescriptor(const QServiceInterface /*! \fn QServiceInterfaceDescriptor& QServiceInterfaceDescriptor::operator=(const QServiceInterfaceDescriptor& other) - - Copies the content of the QServiceInterfaceDescriptor object contained + + Copies the content of the QServiceInterfaceDescriptor object contained in \a other into this one. */ QServiceInterfaceDescriptor& QServiceInterfaceDescriptor::operator=(const QServiceInterfaceDescriptor& other) { if ( !other.isValid() ) { - if (d) + if (d) delete d; d = 0; return *this; @@ -159,8 +160,8 @@ QServiceInterfaceDescriptor& QServiceInterfaceDescriptor::operator=(const QServi /*! \fn bool QServiceInterfaceDescriptor::operator==(const QServiceInterfaceDescriptor& other) const - - Compares a QServiceInterfaceDescriptor to \a other. Returns true if they + + Compares a QServiceInterfaceDescriptor to \a other. Returns true if they are equal and false otherwise. */ bool QServiceInterfaceDescriptor::operator==(const QServiceInterfaceDescriptor& other) const @@ -185,7 +186,7 @@ bool QServiceInterfaceDescriptor::operator==(const QServiceInterfaceDescriptor& /*! \fn bool QServiceInterfaceDescriptor::isValid() const - + Returns true if this descriptor is valid; otherwise returns false. */ bool QServiceInterfaceDescriptor::isValid() const @@ -195,7 +196,7 @@ bool QServiceInterfaceDescriptor::isValid() const /*! \fn bool QServiceInterfaceDescriptor::scope() const - + Returns true if this implementation is provided for all users on the system. \sa QService::Scope @@ -207,7 +208,7 @@ QService::Scope QServiceInterfaceDescriptor::scope() const /*! \fn QString QServiceInterfaceDescriptor::serviceName() const - + Returns the name of service that provides this implementation. */ QString QServiceInterfaceDescriptor::serviceName() const @@ -217,7 +218,7 @@ QString QServiceInterfaceDescriptor::serviceName() const /*! \fn QString QServiceInterfaceDescriptor::interfaceName() const - + Returns the name of the interface that is implemented. */ QString QServiceInterfaceDescriptor::interfaceName() const @@ -227,10 +228,10 @@ QString QServiceInterfaceDescriptor::interfaceName() const /*! \fn int QServiceInterfaceDescriptor::majorVersion() const - - Returns the version of the interface. - - Subsequent versions of an interface are binary compatible + + Returns the version of the interface. + + Subsequent versions of an interface are binary compatible to previous versions of the same interface. If an interface is broken it must use a new interface name. */ @@ -241,8 +242,8 @@ int QServiceInterfaceDescriptor::majorVersion() const /*! \fn int QServiceInterfaceDescriptor::minorVersion() const - - Returns the version of the implementation. + + Returns the version of the implementation. */ int QServiceInterfaceDescriptor::minorVersion() const { @@ -251,8 +252,8 @@ int QServiceInterfaceDescriptor::minorVersion() const /*! \fn QVariant QServiceInterfaceDescriptor::attribute(QServiceInterfaceDescriptor::Attribute which) const - - Returns the value for the attribute \a which; otherwise returns + + Returns the value for the attribute \a which; otherwise returns an invalid QVariant. */ QVariant QServiceInterfaceDescriptor::attribute(QServiceInterfaceDescriptor::Attribute which) const @@ -264,8 +265,8 @@ QVariant QServiceInterfaceDescriptor::attribute(QServiceInterfaceDescriptor::Att /*! \fn QString QServiceInterfaceDescriptor::customAttribute(const QString& which) const - - Returns the value for the custom attribute \a which; otherwise + + Returns the value for the custom attribute \a which; otherwise returns a null string. */ QString QServiceInterfaceDescriptor::customAttribute(const QString& which) const @@ -318,7 +319,7 @@ QDataStream &operator>>(QDataStream &in, QServiceInterfaceDescriptor::Attribute k = (QServiceInterfaceDescriptor::Attribute)key; return in; } -/*! +/*! \fn QDataStream &operator<<(QDataStream &out, const QServiceInterfaceDescriptor &dc) \relates QServiceInterfaceDescriptor @@ -335,7 +336,7 @@ QDataStream &operator<<(QDataStream &out, const QServiceInterfaceDescriptor &dc) out << magicNumber << majorVersion << minorVersion; out << valid; if (valid) { - out << dc.d->serviceName; + out << dc.d->serviceName; out << dc.d->interfaceName; out << dc.d->major; out << dc.d->minor; @@ -362,7 +363,7 @@ QDataStream &operator>>(QDataStream &in, QServiceInterfaceDescriptor &dc) qWarning() << "Datastream doesn't provide searialized QServiceInterfaceDescriptor"; return in; } - + const quint16 currentMajorVersion = 1; quint16 majorVersion = 0; quint16 minorVersion = 0; diff --git a/src/serviceframework/qservicemanager.cpp b/src/serviceframework/qservicemanager.cpp index e1670728d8..584e488cf8 100644 --- a/src/serviceframework/qservicemanager.cpp +++ b/src/serviceframework/qservicemanager.cpp @@ -87,7 +87,7 @@ static QString qservicemanager_resolveLibraryPath(const QString &libNameOrPath) return libPath; } #else - QLibrary lib(libPath); + QLibrary lib(libPath); if (lib.load()) { lib.unload(); return lib.fileName(); @@ -205,6 +205,7 @@ private slots: \inmodule QtServiceFramework \brief The QServiceManager class enables the loading of service plugins and the (de)registration of services. + \since 1.0 A service is a stand-alone component that can be used by multiple clients. Each service implementation must derive from QObject. Clients request a @@ -399,7 +400,7 @@ QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descr } const QString location = descriptor.attribute(QServiceInterfaceDescriptor::Location).toString(); - const bool isInterProcess = (descriptor.attribute(QServiceInterfaceDescriptor::ServiceType).toInt() + const bool isInterProcess = (descriptor.attribute(QServiceInterfaceDescriptor::ServiceType).toInt() == QService::InterProcess); if (isInterProcess) { //ipc service @@ -492,7 +493,7 @@ QObject* QServiceManager::loadInterface(const QServiceInterfaceDescriptor& descr the service manager will not perform any checks. Therefore it is assumed that the service manager client is trusted as it controls whether service capabilities are enforced during service loading. - + \sa setInterfaceDefault(), interfaceDefault() */ @@ -579,7 +580,7 @@ bool QServiceManager::addService(QIODevice *device) ServiceMetaDataResults results = parser.parseResults(); bool result = d->dbManager->registerService(results, scope); - + if (results.type == QService::InterProcess) return result; @@ -658,7 +659,7 @@ bool QServiceManager::removeService(const QString& serviceName) DatabaseManager::UserOnlyScope : DatabaseManager::SystemScope)) { d->setError(); return false; - } + } return true; } diff --git a/src/serviceframework/qserviceplugininterface.cpp b/src/serviceframework/qserviceplugininterface.cpp index 47af95782b..b5a3826db2 100644 --- a/src/serviceframework/qserviceplugininterface.cpp +++ b/src/serviceframework/qserviceplugininterface.cpp @@ -48,28 +48,29 @@ QTM_BEGIN_NAMESPACE \inmodule QtServiceFramework \brief The QServicePluginInterface class defines the interface that every plug-in based service must implement. + \since 1.0 */ /*! \internal */ -QServicePluginInterface::QServicePluginInterface() +QServicePluginInterface::QServicePluginInterface() { } /*! \internal */ -QServicePluginInterface::~QServicePluginInterface() +QServicePluginInterface::~QServicePluginInterface() { } - + /*! \fn QObject* QServicePluginInterface::createInstance(const QServiceInterfaceDescriptor& descriptor, QServiceContext* context, QAbstractSecuritySession* securitySession) Creates a new instance of the service specified by \a descriptor. The service - may use the given \a context and \a securitySession. \a context and \a securitySession object are owned + may use the given \a context and \a securitySession. \a context and \a securitySession object are owned by the client of the service. This function returns a null pointer if the plug-in doesn't @@ -82,17 +83,17 @@ QServicePluginInterface::~QServicePluginInterface() This function is called by QServiceManager as part of the service registration process. It can be used to initialize the environment or the creation of external settings files which may be required during the execution of the service. - + The default implementation for this function does nothing. \sa QServiceManager::addService() */ -void QServicePluginInterface::installService() +void QServicePluginInterface::installService() { } /*! - \fn bool QServicePluginInterface::uninstallService() + \fn bool QServicePluginInterface::uninstallService() This function is called bu QServiceManager as part of the deregistration process for services. This gives the service the possibility to perform cleanup operations such as the removal of setting files @@ -103,7 +104,7 @@ void QServicePluginInterface::installService() \sa QServiceManager::removeService() */ -void QServicePluginInterface::uninstallService() +void QServicePluginInterface::uninstallService() { } diff --git a/src/serviceframework/servicemetadata.cpp b/src/serviceframework/servicemetadata.cpp index 4e1d50d184..57613c2ea1 100644 --- a/src/serviceframework/servicemetadata.cpp +++ b/src/serviceframework/servicemetadata.cpp @@ -52,13 +52,13 @@ #define XML_MAX "1.1" //Service related -#define SERVICE_TAG "service" +#define SERVICE_TAG "service" #define SERVICE_FILEPATH "filepath" #define SERVICE_IPCADDRESS "ipcaddress" //Interface related #define INTERFACE_TAG "interface" -#define INTERFACE_VERSION "version" +#define INTERFACE_VERSION "version" #define INTERFACE_CAPABILITY "capabilities" #define INTERFACE_CUSTOM_PROPERTY "customproperty" @@ -88,9 +88,9 @@ QDataStream &operator>>(QDataStream &in, ServiceMetaDataResults &r) /* \class ServiceMetaData - Utility class (used by service database) that offers support for + Utility class (used by service database) that offers support for parsing metadata service xml registry file during service registration. \n - + It uses QXMLStreamReader class for parsing. Supproted Operations are: - Parse the service and interfaces defined in XML file - name, version, capabilitiesList, description and filePath of service can be retrieved @@ -100,7 +100,7 @@ QDataStream &operator>>(QDataStream &in, ServiceMetaDataResults &r) /* * Class constructor * - * @param aXmlFilePath path to the xml file that describes the service. + * @param aXmlFilePath path to the xml file that describes the service. */ ServiceMetaData::ServiceMetaData(const QString &aXmlFilePath) { @@ -123,7 +123,7 @@ ServiceMetaData::ServiceMetaData(QIODevice *device) /* * Class destructor - * + * */ ServiceMetaData::~ServiceMetaData() { @@ -158,7 +158,7 @@ QIODevice *ServiceMetaData::device() const { return serviceName; }*/ - + /* * Gets the path of the service implementation file * @@ -168,7 +168,7 @@ QIODevice *ServiceMetaData::device() const { return serviceLocation; }*/ - + /* * Gets the service description * @@ -178,7 +178,7 @@ QIODevice *ServiceMetaData::device() const { return serviceDescription; }*/ - + /* Returns the metadata of the interace at \a index; otherwise returns 0. @@ -219,7 +219,7 @@ bool ServiceMetaData::extractMetadata() Q_ASSERT(checkVersion(XML_MAX)); latestError = 0; - clearMetadata(); + clearMetadata(); QXmlStreamReader xmlReader; bool parseError = false; //Open xml file @@ -229,7 +229,7 @@ bool ServiceMetaData::extractMetadata() } else { //Load xml content xmlReader.setDevice(xmlDevice); - // Read XML doc + // Read XML doc while (!xmlReader.atEnd() && !parseError) { xmlReader.readNext(); //Found <SFW> xml versioning tag introduced in 1.1 @@ -258,7 +258,7 @@ bool ServiceMetaData::extractMetadata() if (ownsXmlDevice) xmlDevice->close(); } - + if (parseError) { //provide better error reports switch (latestError) { @@ -290,7 +290,7 @@ bool ServiceMetaData::extractMetadata() qDebug() << "Not a valid service xml"; break; case SFW_ERROR_PARSE_SERVICE: /* Error parsing service node */ - qDebug().nospace() << "Invalid tag within <service> with the supplied version(" + qDebug().nospace() << "Invalid tag within <service> with the supplied version(" << xmlVersion << ")"; break; case SFW_ERROR_PARSE_INTERFACE: /* Error parsing interface node */ @@ -321,11 +321,11 @@ bool ServiceMetaData::extractMetadata() qDebug() << "Invalid or missing version attribute in <SFW> tag"; break; case SFW_ERROR_UNSUPPORTED_IPC: /* Servicefw version doesn't support IPC */ - qDebug().nospace() << "Supplied service framework version(" << xmlVersion + qDebug().nospace() << "Supplied service framework version(" << xmlVersion << ") doesn't support the <ipcaddress> tag"; break; case SFW_ERROR_UNSUPPORTED_XML_VERSION: /* Unsupported servicefw version supplied */ - qDebug().nospace() << "Service framework version(" << xmlVersion + qDebug().nospace() << "Service framework version(" << xmlVersion << ") is higher than available support(" << QString(XML_MAX) << ")"; break; } @@ -333,7 +333,7 @@ bool ServiceMetaData::extractMetadata() } return !parseError; } - + /* Gets the latest parsing error \n @return parsing error(negative value) or 0 in case there is none @@ -342,7 +342,7 @@ int ServiceMetaData::getLatestError() const { return latestError; } - + /* Parses the service framework xml version tag and continues to parse the service */ @@ -350,7 +350,7 @@ bool ServiceMetaData::processVersionElement(QXmlStreamReader &aXMLReader) { Q_ASSERT(aXMLReader.isStartElement() && aXMLReader.name() == SERVICEFW_TAG); bool parseError = false; - + if (aXMLReader.attributes().hasAttribute("version")) { xmlVersion = aXMLReader.attributes().value("version").toString(); bool success = checkVersion(xmlVersion); @@ -376,11 +376,11 @@ bool ServiceMetaData::processVersionElement(QXmlStreamReader &aXMLReader) if (!processServiceElement(aXMLReader)) { parseError = true; } - } + } else if (aXMLReader.isEndElement() && aXMLReader.name() == SERVICEFW_TAG) { //Found </SFW>, leave the loop break; - } + } else if (aXMLReader.isStartElement() && aXMLReader.name() != SERVICE_TAG) { latestError = ServiceMetaData::SFW_ERROR_NO_SERVICE; parseError = true; @@ -442,8 +442,8 @@ bool ServiceMetaData::processServiceElement(QXmlStreamReader &aXMLReader) parseError = true; } } else if (aXMLReader.isStartElement() && aXMLReader.name() == INTERFACE_TAG) { - //Found interface> node, read module related metadata - if (!processInterfaceElement(aXMLReader)) + //Found interface> node, read module related metadata + if (!processInterfaceElement(aXMLReader)) parseError = true; } else if (aXMLReader.isStartElement() && aXMLReader.name() == "version") { //Found <version> tag on service level. We ignore this for now @@ -453,7 +453,7 @@ bool ServiceMetaData::processServiceElement(QXmlStreamReader &aXMLReader) break; } else if (aXMLReader.isEndElement() || aXMLReader.isStartElement()) { latestError = ServiceMetaData::SFW_ERROR_PARSE_SERVICE; - parseError = true; + parseError = true; } else if (aXMLReader.tokenType() == QXmlStreamReader::Invalid) { latestError = ServiceMetaData::SFW_ERROR_INVALID_XML_FILE; parseError = true; @@ -520,7 +520,7 @@ bool ServiceMetaData::processInterfaceElement(QXmlStreamReader &aXMLReader) 0 //->description }; aInterface.d = new QServiceInterfaceDescriptorPrivate; - + while (!parseError && !aXMLReader.atEnd()) { aXMLReader.readNext(); //Read interface description @@ -594,7 +594,7 @@ bool ServiceMetaData::processInterfaceElement(QXmlStreamReader &aXMLReader) parseError = true; } } - + for(int i=0;!parseError && i<4;i++) { if (dupITags[i] > 1) { parseError = true; @@ -665,7 +665,7 @@ bool ServiceMetaData::greaterThan(const QString &v1, const QString &v2) const int minorV2 = -1; transformVersion(v2, &majorV2, &minorV2); - return (majorV1 > majorV2 + return (majorV1 > majorV2 || (majorV1 == majorV2 && minorV1 > minorV2)); } diff --git a/src/systeminfo/qsystemgeneralinfo.cpp b/src/systeminfo/qsystemgeneralinfo.cpp index 54f81fa35f..f4a775417f 100644 --- a/src/systeminfo/qsystemgeneralinfo.cpp +++ b/src/systeminfo/qsystemgeneralinfo.cpp @@ -64,6 +64,7 @@ QTM_BEGIN_NAMESPACE \ingroup systeminfo \inmodule QtSystemInfo + \since 1.0 \brief The QSystemInfo class provides access to various general information from the system. diff --git a/src/versit/qversitdocumentwriter_p.cpp b/src/versit/qversitdocumentwriter_p.cpp index e8f5093aea..afb882f1c8 100644 --- a/src/versit/qversitdocumentwriter_p.cpp +++ b/src/versit/qversitdocumentwriter_p.cpp @@ -50,6 +50,7 @@ QTM_USE_NAMESPACE /*! \class QVersitDocumentWriter \internal + \since 1.0 \brief The QVersitDocumentWriter class provides an interface for writing a single versit document into a vCard text string. */ diff --git a/src/versit/qversitresourcehandler.cpp b/src/versit/qversitresourcehandler.cpp index 328bc407d9..88cbb0782a 100644 --- a/src/versit/qversitresourcehandler.cpp +++ b/src/versit/qversitresourcehandler.cpp @@ -52,6 +52,7 @@ QTM_USE_NAMESPACE behaviour for loading and saving files to disk when exporting and importing. \ingroup versit-extension \inmodule QtVersit + \since 1.0 \sa QVersitContactImporter \sa QVersitContactExporter @@ -66,7 +67,7 @@ QTM_USE_NAMESPACE /*! \fn virtual bool QVersitResourceHandler::saveResource(const QByteArray& contents, const QVersitProperty& property, QString* location) = 0; Saves the binary data \a contents to a file on a persistent storage medium. - + \a property holds the QVersitProperty which is the context in which the binary is coming from. The QVersitResourceHandler can use this, for example, to determine file extension it should choose. *\a location is filled with the contents of the file. @@ -83,14 +84,14 @@ QTM_USE_NAMESPACE /*! \class QVersitDefaultResourceHandler - + \brief The QVersitDefaultResourceHandler class provides a default implementation of a Versit resource handler. \ingroup versit-extension - + An example resource handler implementation: \snippet ../../doc/src/snippets/qtversitdocsample/qtversitdocsample.cpp Resource handler - + \sa QVersitContactImporter, QVersitContactExporter, QVersitResourceHandler */ |