KContacts

note.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 NOTE_H
9 #define NOTE_H
10 
11 #include "kcontacts_export.h"
12 #include <QSharedDataPointer>
13 #include <QString>
14 #include <QMap>
15 
16 namespace KContacts {
20 class KCONTACTS_EXPORT Note
21 {
22  friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Note &);
23  friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Note &);
24 public:
25  Note();
26  Note(const Note &other);
27  Note(const QString &note);
28 
29  ~Note();
30 
31  typedef QVector<Note> List;
32 
33  void setNote(const QString &note);
34  Q_REQUIRED_RESULT QString note() 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 Note &other) const;
42  Q_REQUIRED_RESULT bool operator!=(const Note &other) const;
43 
44  Note &operator=(const Note &other);
45 
46  Q_REQUIRED_RESULT QString toString() const;
47 private:
48  class Private;
50 };
51 KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const Note &object);
52 
53 KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, Note &object);
54 }
55 Q_DECLARE_TYPEINFO(KContacts::Note, Q_MOVABLE_TYPE);
56 #endif // NOTE_H
Class that holds a Note for a contact.
Definition: note.h:20
QDataStream & operator>>(QDataStream &in, KDateTime::Spec &spec)
QDataStream & operator<<(QDataStream &out, const KDateTime::Spec &spec)
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Aug 4 2020 22:53:59 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.