File indexing completed on 2024-07-21 03:39:45

0001 /*
0002     This file is part of the KContacts framework.
0003     SPDX-FileCopyrightText: 2016-2019 Laurent Montel <montel@kde.org>
0004 
0005     SPDX-License-Identifier: LGPL-2.0-or-later
0006 */
0007 
0008 #ifndef FIELDGROUP_H
0009 #define FIELDGROUP_H
0010 
0011 #include "kcontacts_export.h"
0012 
0013 #include <QMap>
0014 #include <QSharedDataPointer>
0015 #include <QString>
0016 
0017 class FieldGroupTest;
0018 
0019 namespace KContacts
0020 {
0021 class ParameterMap;
0022 
0023 /** @short Class that holds a FieldGroup for a contact.
0024  *  @since 5.3
0025  */
0026 class KCONTACTS_EXPORT FieldGroup
0027 {
0028     friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const FieldGroup &);
0029     friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, FieldGroup &);
0030     friend class VCardTool;
0031     friend class ::FieldGroupTest;
0032 
0033 public:
0034     FieldGroup();
0035     FieldGroup(const FieldGroup &other);
0036     FieldGroup(const QString &fieldGroupName);
0037 
0038     ~FieldGroup();
0039 
0040     typedef QList<FieldGroup> List;
0041 
0042     void setFieldGroupName(const QString &fieldGroup);
0043     Q_REQUIRED_RESULT QString fieldGroupName() const;
0044 
0045     Q_REQUIRED_RESULT bool isValid() const;
0046 
0047     void setValue(const QString &value);
0048     Q_REQUIRED_RESULT QString value() const;
0049 
0050     Q_REQUIRED_RESULT bool operator==(const FieldGroup &other) const;
0051     Q_REQUIRED_RESULT bool operator!=(const FieldGroup &other) const;
0052 
0053     FieldGroup &operator=(const FieldGroup &other);
0054 
0055     Q_REQUIRED_RESULT QString toString() const;
0056 
0057 private:
0058     void setParams(const ParameterMap &params);
0059     Q_REQUIRED_RESULT ParameterMap params() const;
0060 
0061     class Private;
0062     QSharedDataPointer<Private> d;
0063 };
0064 KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const FieldGroup &object);
0065 
0066 KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, FieldGroup &object);
0067 }
0068 Q_DECLARE_TYPEINFO(KContacts::FieldGroup, Q_RELOCATABLE_TYPE);
0069 #endif // FIELDGROUP_H