KContacts

nickname.h
1 /*
2  This file is part of the KContacts framework.
3  SPDX-FileCopyrightText: 2016-2019 Laurent Montel <[email protected]>
4 
5  SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7 
8 #ifndef NICKNAME_H
9 #define NICKNAME_H
10 
11 #include "kcontacts_export.h"
12 #include <QSharedDataPointer>
13 #include <QString>
14 #include <QMap>
15 
16 namespace KContacts {
20 class KCONTACTS_EXPORT NickName
21 {
22  friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const NickName &);
23  friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, NickName &);
24 public:
25  NickName();
26  NickName(const NickName &other);
27  NickName(const QString &nickname);
28 
29  ~NickName();
30 
31  typedef QVector<NickName> List;
32 
33  void setNickName(const QString &nickname);
34  Q_REQUIRED_RESULT QString nickname() const;
35 
36  Q_REQUIRED_RESULT bool isValid() const;
37 
38  void setParameters(const QMap<QString, QStringList> &params);
39  Q_REQUIRED_RESULT QMap<QString, QStringList> parameters() const;
40 
41  Q_REQUIRED_RESULT bool operator==(const NickName &other) const;
42  Q_REQUIRED_RESULT bool operator!=(const NickName &other) const;
43 
44  NickName &operator=(const NickName &other);
45 
46  Q_REQUIRED_RESULT QString toString() const;
47 private:
48  class Private;
50 };
51 KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const NickName &object);
52 
53 KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, NickName &object);
54 }
55 Q_DECLARE_TYPEINFO(KContacts::NickName, Q_MOVABLE_TYPE);
56 #endif // NICKNAME_H
QDataStream & operator>>(QDataStream &in, KDateTime::Spec &spec)
QDataStream & operator<<(QDataStream &out, const KDateTime::Spec &spec)
Class that holds a NickName for a contact.
Definition: nickname.h:20
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Aug 6 2020 22:54:05 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.