File indexing completed on 2024-09-29 12:03:23

 /*
     This file is part of the KContacts framework.
     SPDX-FileCopyrightText: 2015-2019 Laurent Montel <montel@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef RESOURCELOCATORURL_H
 #define RESOURCELOCATORURL_H
 
 #include "kcontacts_export.h"
 
 #include <QMap>
 #include <QMetaType>
 #include <QSharedDataPointer>
 #include <QString>
 #include <QUrl>
 
 class ResourceLocatorUrlTest;
 
 namespace KContacts
 {
 class ParameterMap;
 
 /** @short Class that holds a Resource Locator
  *  @since 5.0
  */
 class KCONTACTS_EXPORT ResourceLocatorUrl
 {
     friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const ResourceLocatorUrl &);
     friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, ResourceLocatorUrl &);
     friend class VCardTool;
     friend class ::ResourceLocatorUrlTest;
 
     Q_GADGET
     Q_PROPERTY(QUrl url READ url WRITE setUrl)
     Q_PROPERTY(bool isValid READ isValid)
     Q_PROPERTY(Type type READ type WRITE setType)
     Q_PROPERTY(bool isPreferred READ isPreferred WRITE setPreferred)
 
 public:
     ResourceLocatorUrl();
     ResourceLocatorUrl(const ResourceLocatorUrl &other);
 
     ~ResourceLocatorUrl();
 
     typedef QVector<ResourceLocatorUrl> List;
 
     /** URL types.
      *  @since 5.12
      *  @see Type
      */
     enum TypeFlag {
         Unknown = 0, /**< No or unknown URL type is set. */
         Home = 1, /**< Personal website. */
         Work = 2, /**< Work website. */
         Profile = 4, /**< Profile website. */
         Other = 8, /**< Other websie. */
     };
 
     /**
      * Stores a combination of #TypeFlag values.
      */
     Q_DECLARE_FLAGS(Type, TypeFlag)
     Q_FLAG(Type)
 
     Q_REQUIRED_RESULT bool isValid() const;
 
     void setUrl(const QUrl &url);
     Q_REQUIRED_RESULT QUrl url() const;
 
     /**
      * Returns the type of the URL.
      * @since 5.12
      */
     Type type() const;
     /**
      * Sets the URL type.
      * @since 5.12
      */
     void setType(Type type);
 
     /**
      * Returns whether this is the preferred website.
      * @since 5.12
      */
     bool isPreferred() const;
     /**
      * Sets that this is the preferred website.
      * @since 5.12
      */
     void setPreferred(bool preferred);
 
 #if KCONTACTS_ENABLE_DEPRECATED_SINCE(5, 88)
     /**
      * @deprecated Since 5.88 for lack of usage
      */
     KCONTACTS_DEPRECATED_VERSION(5, 88, "For lack of usage.")
     void setParameters(const QMap<QString, QStringList> &params);
 #endif
 
 #if KCONTACTS_ENABLE_DEPRECATED_SINCE(5, 88)
     /**
      * @deprecated Since 5.88 for lack of usage
      */
     Q_REQUIRED_RESULT
     KCONTACTS_DEPRECATED_VERSION(5, 88, "For lack of usage.")
     QMap<QString, QStringList> parameters() const;
 #endif
 
     Q_REQUIRED_RESULT bool operator==(const ResourceLocatorUrl &other) const;
     Q_REQUIRED_RESULT bool operator!=(const ResourceLocatorUrl &other) const;
 
     ResourceLocatorUrl &operator=(const ResourceLocatorUrl &other);
 
     Q_REQUIRED_RESULT QString toString() const;
 
 private:
     // exported for ResourceLocatorUrlTest
     void setParams(const ParameterMap &params);
     Q_REQUIRED_RESULT ParameterMap params() const;
 
     class Private;
     QSharedDataPointer<Private> d;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(ResourceLocatorUrl::Type)
 
 KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const ResourceLocatorUrl &object);
 
 KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, ResourceLocatorUrl &object);
 }
 Q_DECLARE_METATYPE(KContacts::ResourceLocatorUrl)
 Q_DECLARE_TYPEINFO(KContacts::ResourceLocatorUrl, Q_MOVABLE_TYPE);
 
 #endif // RESOURCELOCATORURL_H