Akonadi Contacts

abstractcontactgroupformatter.h
1 /*
2  This file is part of Akonadi Contact.
3 
4  Copyright (c) 2010 Tobias Koenig <[email protected]>
5 
6  This library is free software; you can redistribute it and/or modify it
7  under the terms of the GNU Library General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or (at your
9  option) any later version.
10 
11  This library is distributed in the hope that it will be useful, but WITHOUT
12  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
14  License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to the
18  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19  02110-1301, USA.
20 */
21 
22 #ifndef AKONADI_ABSTRACTCONTACTGROUPFORMATTER_H
23 #define AKONADI_ABSTRACTCONTACTGROUPFORMATTER_H
24 
25 #include "akonadi-contact_export.h"
26 
27 #include <QVariant>
28 
29 namespace KContacts {
30 class ContactGroup;
31 }
32 
33 namespace Akonadi {
34 class Item;
35 
46 class AKONADI_CONTACT_EXPORT AbstractContactGroupFormatter
47 {
48 public:
52  enum HtmlForm {
55  UserForm = SelfcontainedForm + 42
56  };
57 
62 
67 
71  void setContactGroup(const KContacts::ContactGroup &group);
72 
76  Q_REQUIRED_RESULT KContacts::ContactGroup contactGroup() const;
77 
85  void setItem(const Akonadi::Item &item);
86 
90  Q_REQUIRED_RESULT Akonadi::Item item() const;
91 
103  void setAdditionalFields(const QVector<QVariantMap> &fields);
104 
108  Q_REQUIRED_RESULT QVector<QVariantMap> additionalFields() const;
109 
114  virtual QString toHtml(HtmlForm form = SelfcontainedForm) const = 0;
115 
116 private:
117  //@cond PRIVATE
118  Q_DISABLE_COPY(AbstractContactGroupFormatter)
119 
120  class Private;
121  Private *const d;
122  //@endcond
123 };
124 }
125 
126 #endif
The interface for all contact group formatters.
Creates a div HTML element that can be embedded.
HtmlForm
Describes the form of the HTML that is created.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 7 2020 23:06:02 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.