/**************************************************************************** ** ** Copyright (C) 2017 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtQml module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser ** General Public License version 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qdeclarativecontact_p.h" #include #include #include #include #include "qdeclarativecontactmodel_p.h" QTCONTACTS_USE_NAMESPACE QT_BEGIN_NAMESPACE /*! \qmltype Contact \instantiates QDeclarativeContact \brief The Contact element represents an addressbook contact. \ingroup qml-contacts-main \inqmlmodule QtContacts The Contact element is part of the \b{QtContacts} module. A Contact object has a collection of details (like a name, phone numbers and email addresses). Each detail (which can have multiple fields) is stored in an appropriate subclass of ContactDetail, and the Contact allows retrieving these details in various ways. If some of the contact details are not unique details, all of this type of detail values can be accessed by the property with the name in plural. For example, if there are 3 phone numbers stored in a contact, they can be accessed by contact.phoneNumbers property, which holds a list of all PhoneNumber details. If a contact does not contain a detail of particular type, the value of the corresponding singular property (e.g. phoneNumber) in undefined and the plural (e.g. phoneNumbers) is empty. The list of properties which support multiple detail instances depends on the contact engine implementations. \sa QContact */ // call-back function templates for list properties template static qsizetype list_property_count(QQmlListProperty *property) { QDeclarativeContact *object = qobject_cast(property->object); if (object) return object->details(detailType).size(); else return 0; } template static T *list_property_at(QQmlListProperty *property, qsizetype index) { QDeclarativeContact *object = qobject_cast(property->object); if (object) return qobject_cast(qvariant_cast(object->details(detailType).at(index))); else return 0; } QDeclarativeContact::QDeclarativeContact(QObject *parent) :QObject(parent) , m_modified(false) { connect(this, SIGNAL(contactChanged()), SLOT(setModified())); } QDeclarativeContact::~QDeclarativeContact() { clearDetails(); } void QDeclarativeContact::setContact(const QContact& contact) { m_id = contact.id(); m_collectionId = contact.collectionId(); foreach (QDeclarativeContactDetail *detail, m_details) delete detail; m_details.clear(); m_preferredDetails.clear(); QList details(contact.details()); foreach (const QContactDetail &detail, details) { QDeclarativeContactDetail *contactDetail = QDeclarativeContactDetailFactory::createContactDetail(static_cast(detail.type())); contactDetail->setParent(this); contactDetail->setDetail(detail); connect(contactDetail, SIGNAL(detailChanged()), this, SIGNAL(contactChanged())); m_details.append(contactDetail); } QMap prefDetails(contact.preferredDetails()); QMap::const_iterator it = prefDetails.begin(); while (it != prefDetails.end()) { m_preferredDetails.insert(it.key(), it.value().key()); it++; } m_modified = false; emit contactChanged(); } QContact QDeclarativeContact::contact() const { QContact contact; contact.setId(m_id); contact.setCollectionId(m_collectionId); foreach (QDeclarativeContactDetail *detail, m_details) contact.saveDetail(&detail->detail()); QVariantMap prefDetails = preferredDetails(); QVariantMap::const_iterator it = prefDetails.begin(); while (it != prefDetails.end()) { contact.setPreferredDetail(it.key(), it.value().value()->detail()); it++; } return contact; } /*! \qmlproperty bool Contact::modified This property holds the dirty flag of the Contact object. If the Contact has been changed, returns true, otherwise returns false. */ bool QDeclarativeContact::modified() const { return m_modified; } void QDeclarativeContact::setModified() { m_modified = true; } /*! \qmlproperty enumeration Contact::type This property holds type of the Contact, the value can be one of: \list \li Contact.Contact \li Contact.Group \li Contact.Facet \endlist */ QDeclarativeContactType::ContactType QDeclarativeContact::type() const { foreach (QDeclarativeContactDetail *detail, m_details) { if (QDeclarativeContactDetail::Type == detail->detailType()) return static_cast(detail)->type(); } return QDeclarativeContactType::Contact; } /*! \qmlmethod Contact::removeDetail(detail) Removes the given contact \a detail from the contact, returns true if successful, otherwise returns false. */ bool QDeclarativeContact::removeDetail(QDeclarativeContactDetail* detail) { if (detail) { if (!detail->removable()) return false; int key = detail->detail().key(); int i = 0; foreach (QDeclarativeContactDetail *contactDetail, m_details) { if (key == contactDetail->detail().key()) { removePreferredDetail(detail); delete contactDetail; m_details.removeAt(i); emit contactChanged(); return true; } ++i; } } return false; } void QDeclarativeContact::removePreferredDetail(QDeclarativeContactDetail* detail) { QMap cpy = m_preferredDetails; QMap::const_iterator it = cpy.begin(); while (it != cpy.end()) { if (it.value() == detail->detail().key()) { m_preferredDetails.remove(it.key()); break; } it++; } } /*! \qmlmethod Contact::addDetail(detail) Adds the given contact \a detail to the contact, returns true if successful, otherwise returns false. Note: If the \a detail has been added into the same contact before, this operation will be ignored, so if you want to add a \a detail multiple times, the \a detail should be copied before calling this function. */ bool QDeclarativeContact::addDetail(QDeclarativeContactDetail* detail) { if (!detail || m_details.contains(detail)) return false; QDeclarativeContactDetail *contactDetail = QDeclarativeContactDetailFactory::createContactDetail(detail->detailType()); contactDetail->setParent(this); contactDetail->setDetail(detail->detail()); connect(contactDetail, SIGNAL(detailChanged()), this, SIGNAL(contactChanged())); m_details.append(contactDetail); m_modified = true; emit contactChanged(); return true; } /*! \qmlmethod Contact::setPreferredDetail(actionName, detail) Set a particular detail (\a preferredDetail) as the preferred detail for any actions with the given \a actionName. The \a preferredDetail object must exist in this object, and the \a actionName cannot be empty. Returns true if the preference could be recorded, and false otherwise. \sa preferredDetail() */ bool QDeclarativeContact::setPreferredDetail(const QString& actionName, QDeclarativeContactDetail* detail) { if (actionName.isEmpty() || !detail || !m_details.contains(detail)) return false; if (m_preferredDetails.contains(actionName) && m_preferredDetails[actionName] == detail->detail().key()) return false; m_preferredDetails.insert(actionName, detail->detail().key()); m_modified = true; emit contactChanged(); return true; } /*! \qmlmethod Contact::isPreferredDetail(actionName, detail) Returns true if the given \a detail is a preferred detail for the given \a actionName, or for any action if the \a actionName is empty. \sa preferredDetail() */ bool QDeclarativeContact::isPreferredDetail(const QString& actionName, QDeclarativeContactDetail* detail) const { if (actionName.isEmpty() || !detail || !m_details.contains(detail)) return false; if (!m_preferredDetails.contains(actionName)) return false; return (m_preferredDetails[actionName] == detail->detail().key()); } /*! \qmlmethod Contact::preferredDetail(actionName, detail) Returns the preferred detail for a given \a actionName. If the \a actionName is empty, or there is no preference recorded for the supplied \a actionName, returns null. \sa preferredDetails() */ QDeclarativeContactDetail* QDeclarativeContact::preferredDetail(const QString& actionName) const { int id = m_preferredDetails.value(actionName, -1); if (id == -1) return 0; foreach (QDeclarativeContactDetail* detail, m_details) { if (detail->detail().key() == id) return detail; } return 0; } /*! \qmlproperty map Contact::preferredDetails This property holds the recorded detail preferences for action names. Each entry in the map has the action name as the key, and the corresponding preferred detail as the value. */ QVariantMap QDeclarativeContact::preferredDetails() const { QVariantMap result; QMap::const_iterator it = m_preferredDetails.begin(); while (it != m_preferredDetails.end()) { result.insert(it.key(), QVariant::fromValue(preferredDetail(it.key()))); it++; } return result; } /*! \qmlproperty string OContact::collectionId This property holds the id of collection where the contact belongs to. */ QString QDeclarativeContact::collectionId() const { return m_collectionId.toString(); } void QDeclarativeContact::setCollectionId(const QString &collectionId) { QContactCollectionId newCollectionId(QContactCollectionId::fromString(collectionId)); // in case invalid collectionId-string, fromString() will return default collectionId-string // instead of the intended collectionId-string if (newCollectionId.toString() == collectionId && m_collectionId.toString() != collectionId) { m_collectionId = newCollectionId; m_modified = true; emit contactChanged(); } } /*! \qmlproperty list Contact::contactDetails This property holds the list of all the details that the contact has. */ QQmlListProperty QDeclarativeContact::contactDetails() { return { this, nullptr, &QDeclarativeContact::_q_detail_append, &QDeclarativeContact::_q_detail_count, &QDeclarativeContact::_q_detail_at, &QDeclarativeContact::_q_detail_clear }; } /*! \qmlproperty int Contact::contactId This property holds the id of the Contact object. This property is read only. */ QString QDeclarativeContact::contactId() const { return m_id.toString(); } /*! \qmlproperty string Contact::manager This property holds the manager name which the Contact object comes from. */ QString QDeclarativeContact::manager() const { return m_id.managerUri(); } /*! \qmlmethod QDeclarativeContactDetail* QDeclarativeContact::detail(int type) Returns contactDetail object which detail name or detail type is \a name. */ QDeclarativeContactDetail* QDeclarativeContact::detail(int type) { foreach (QDeclarativeContactDetail *detail, m_details) { if (type == detail->detailType()) { return detail; } } return 0; } /*! \qmlmethod QVariantList QDeclarativeContact::details(int type) Returns a list of ContactDetail objects which detail name or detail type is \a name. */ QVariantList QDeclarativeContact::details(int type) { QVariantList list; foreach (QDeclarativeContactDetail *detail, m_details) { if (type == detail->detailType()) { list.append(QVariant::fromValue((QObject*)detail)); } } return list; } /*! \qmlmethod Contact::clearDetails() Remove all detail objects in this contact. */ void QDeclarativeContact::clearDetails() { if (m_details.isEmpty()) return; foreach (QDeclarativeContactDetail *detail, m_details) delete detail; m_details.clear(); m_modified = true; emit contactChanged(); } /*! \qmlmethod Contact::save() Saves this Contact if the contact has been modified. \sa Contact::modified */ void QDeclarativeContact::save() { if (modified()) { QDeclarativeContactModel* model = qobject_cast(parent()); if (model) { model->saveContact(this); m_modified = false; } } } // convenient access to most frequently used details /*! \qmlproperty Address Contact::address This property holds the address detail of the Contact object. In case a contact has several addresses then the first one is returned. */ QDeclarativeContactAddress* QDeclarativeContact::address() { return getDetail(QDeclarativeContactDetail::Address); } /*! \qmlproperty list
Contact::addresses This property holds the address details of the Contact object. */ QQmlListProperty QDeclarativeContact::addresses() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty Anniversary Contact::anniversary This property holds the anniversary detail of the Contact object. */ QDeclarativeContactAnniversary* QDeclarativeContact::anniversary() { return getDetail(QDeclarativeContactDetail::Anniversary); } /*! \qmlproperty Avatar Contact::avatar This property holds the avatar detail of the Contact object. */ QDeclarativeContactAvatar* QDeclarativeContact::avatar() { return getDetail(QDeclarativeContactDetail::Avatar); } /*! \qmlproperty Birthday Contact::birthday This property holds the birthday detail of the Contact object. */ QDeclarativeContactBirthday* QDeclarativeContact::birthday() { return getDetail(QDeclarativeContactDetail::Birthday); } /*! \qmlproperty DisplayLabel Contact::displayLabel This property holds the displayLabel detail of the Contact object. display label is the one which gets displayed when a contact is created as per versit doc specs this is a "FN" property */ QDeclarativeContactDisplayLabel* QDeclarativeContact::displayLabel() { return getDetail(QDeclarativeContactDetail::DisplayLabel); } /*! \qmlproperty EmailAddress Contact::email This property holds the email address detail of the Contact object. In case a contact has several email addresses then the first one is returned. */ QDeclarativeContactEmailAddress* QDeclarativeContact::email() { return getDetail(QDeclarativeContactDetail::Email); } /*! \qmlproperty list Contact::emails This property holds the email address details of the Contact object. */ QQmlListProperty QDeclarativeContact::emails() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty ExtendedDetail Contact::extendedDetail This property holds the extended detail of the Contact object. In case a contact has several extended details then the first one is returned. */ QDeclarativeContactExtendedDetail* QDeclarativeContact::extendedDetail() { return getDetail(QDeclarativeContactDetail::ExtendedDetail); } /*! \qmlproperty list Contact::extendedDetails This property holds the extended details of the Contact object. */ QQmlListProperty QDeclarativeContact::extendedDetails() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty Family Contact::family This property holds the family detail of the Contact object. */ QDeclarativeContactFamily* QDeclarativeContact::family() { return getDetail(QDeclarativeContactDetail::Family); } /*! \qmlproperty Favorite Contact::favorite This property holds the favorite detail of the Contact object. */ QDeclarativeContactFavorite* QDeclarativeContact::favorite() { return getDetail(QDeclarativeContactDetail::Favorite); } /*! \qmlproperty Gender Contact::gender This property holds the gender detail of the Contact object. */ QDeclarativeContactGender* QDeclarativeContact::gender() { return getDetail(QDeclarativeContactDetail::Gender); } /*! \qmlproperty GeoLocation Contact::geolocation This property holds the geolocation detail of the Contact object. */ QDeclarativeContactGeoLocation* QDeclarativeContact::geolocation() { return getDetail(QDeclarativeContactDetail::Geolocation); } /*! \qmlproperty GlobalPresence Contact::globalPresence This property holds the globalPresence detail of the Contact object. */ QDeclarativeContactGlobalPresence* QDeclarativeContact::globalPresence() { return getDetail(QDeclarativeContactDetail::GlobalPresence); } /*! \qmlproperty Guid Contact::guid This property holds the guid detail of the Contact object. */ QDeclarativeContactGuid* QDeclarativeContact::guid() { return getDetail(QDeclarativeContactDetail::Guid); } /*! \qmlproperty Hobby Contact::hobby This property holds the hobby detail of the Contact object. */ QDeclarativeContactHobby* QDeclarativeContact::hobby() { return getDetail(QDeclarativeContactDetail::Hobby); } /*! \qmlproperty Name Contact::name This property holds the name detail of the Contact object. */ QDeclarativeContactName* QDeclarativeContact::name() { return getDetail(QDeclarativeContactDetail::Name); } /*! \qmlproperty Nickname Contact::nickname This property holds the nickname detail of the Contact object. */ QDeclarativeContactNickname* QDeclarativeContact::nickname() { return getDetail(QDeclarativeContactDetail::NickName); } /*! \qmlproperty Note Contact::note This property holds the note detail of the Contact object. */ QDeclarativeContactNote* QDeclarativeContact::note() { return getDetail(QDeclarativeContactDetail::Note); } /*! \qmlproperty OnlineAccount Contact::onlineAccount This property holds the onlineAccount detail of the Contact object. In case a contact has several accounts then the first one is returned. */ QDeclarativeContactOnlineAccount* QDeclarativeContact::onlineAccount() { return getDetail(QDeclarativeContactDetail::OnlineAccount); } /*! \qmlproperty Organization Contact::organization This property holds the organization detail of the Contact object. */ QDeclarativeContactOrganization* QDeclarativeContact::organization() { return getDetail(QDeclarativeContactDetail::Organization); } /*! \qmlproperty list Contact::organizations This property holds the organization details of the Contact object. */ QQmlListProperty QDeclarativeContact::organizations() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty PhoneNumber Contact::phoneNumber This property holds the phone number detail of the Contact object. In case a contact has several numbers then the first one is returned. */ QDeclarativeContactPhoneNumber* QDeclarativeContact::phoneNumber() { return getDetail(QDeclarativeContactDetail::PhoneNumber); } /*! \qmlproperty list Contact::phoneNumbers This property holds the phone number details of the Contact object. */ QQmlListProperty QDeclarativeContact::phoneNumbers() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty Presence Contact::presence This property holds the presence detail of the Contact object. */ QDeclarativeContactPresence* QDeclarativeContact::presence() { return getDetail(QDeclarativeContactDetail::Presence); } /*! \qmlproperty Ringtone Contact::ringtone This property holds the ringtone detail of the Contact object. */ QDeclarativeContactRingtone* QDeclarativeContact::ringtone() { return getDetail(QDeclarativeContactDetail::Ringtone); } /*! \qmlproperty SyncTarget Contact::syncTarget This property holds the syncTarget detail of the Contact object. */ QDeclarativeContactSyncTarget* QDeclarativeContact::syncTarget() { return getDetail(QDeclarativeContactDetail::SyncTarget); } /*! \qmlproperty Tag Contact::tag This property holds the tag detail of the Contact object. */ QDeclarativeContactTag* QDeclarativeContact::tag() { return getDetail(QDeclarativeContactDetail::Tag); } /*! \qmlproperty Timestamp Contact::timestamp This property holds the timestamp detail of the Contact object. */ QDeclarativeContactTimestamp* QDeclarativeContact::timestamp() { return getDetail(QDeclarativeContactDetail::Timestamp); } /*! \qmlproperty Url Contact::url This property holds the url detail of the Contact object. */ QDeclarativeContactUrl* QDeclarativeContact::url() { return getDetail(QDeclarativeContactDetail::Url); } /*! \qmlproperty list Contact::urls This property holds the url details of the Contact object. */ QQmlListProperty QDeclarativeContact::urls() { return { this, nullptr, &list_property_count, &list_property_at }; } /*! \qmlproperty Version Contact::version This property holds the version detail of the Contact object. */ QDeclarativeContactVersion* QDeclarativeContact::version() { return getDetail(QDeclarativeContactDetail::Version); } // call-back functions for list property /*! \internal */ void QDeclarativeContact::_q_detail_append(QQmlListProperty *property, QDeclarativeContactDetail *value) { QDeclarativeContact *object = qobject_cast(property->object); if (object) { object->m_details.append(value); value->connect(value, SIGNAL(valueChanged()), SIGNAL(detailChanged()), Qt::UniqueConnection); value->connect(value, SIGNAL(detailChanged()), object, SIGNAL(contactChanged()), Qt::UniqueConnection); } } /*! \internal */ QDeclarativeContactDetail *QDeclarativeContact::_q_detail_at(QQmlListProperty *property, qsizetype index) { QDeclarativeContact *object = qobject_cast(property->object); if (object) return object->m_details.at(index); else return 0; } /*! \internal */ void QDeclarativeContact::_q_detail_clear(QQmlListProperty *property) { QDeclarativeContact *object = qobject_cast(property->object); if (object) { foreach (QDeclarativeContactDetail *obj, object->m_details) delete obj; object->m_details.clear(); } } /*! \internal */ qsizetype QDeclarativeContact::_q_detail_count(QQmlListProperty *property) { QDeclarativeContact *object = qobject_cast(property->object); if (object) return object->m_details.size(); else return 0; } QT_END_NAMESPACE #include "moc_qdeclarativecontact_p.cpp"