File indexing completed on 2024-07-14 03:52:31

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 TITLE_H
0009 #define TITLE_H
0010 
0011 #include "kcontacts_export.h"
0012 
0013 #include <QMap>
0014 #include <QSharedDataPointer>
0015 #include <QString>
0016 
0017 class TitleTest;
0018 
0019 namespace KContacts
0020 {
0021 class ParameterMap;
0022 
0023 /** @short Class that holds a Title for a contact.
0024  *  @since 5.3
0025  */
0026 class KCONTACTS_EXPORT Title
0027 {
0028     friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Title &);
0029     friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Title &);
0030     friend class VCardTool;
0031     friend class ::TitleTest;
0032 
0033 public:
0034     Title();
0035     Title(const Title &other);
0036     Title(const QString &title);
0037 
0038     ~Title();
0039 
0040     typedef QList<Title> List;
0041 
0042     void setTitle(const QString &title);
0043     Q_REQUIRED_RESULT QString title() const;
0044 
0045     Q_REQUIRED_RESULT bool isValid() const;
0046 
0047     Q_REQUIRED_RESULT bool operator==(const Title &other) const;
0048     Q_REQUIRED_RESULT bool operator!=(const Title &other) const;
0049 
0050     Title &operator=(const Title &other);
0051 
0052     Q_REQUIRED_RESULT QString toString() const;
0053 
0054 private:
0055     // exported for TitleTest
0056     void setParams(const ParameterMap &params);
0057     Q_REQUIRED_RESULT ParameterMap params() const;
0058 
0059     class Private;
0060     QSharedDataPointer<Private> d;
0061 };
0062 KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const Title &object);
0063 
0064 KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, Title &object);
0065 }
0066 Q_DECLARE_TYPEINFO(KContacts::Title, Q_RELOCATABLE_TYPE);
0067 #endif // TITLE_H