• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
  • contact
abstractcontactformatter.h
1/*
2 This file is part of Akonadi Contact.
3
4 Copyright (c) 2010 Tobias Koenig <tokoe@kde.org>
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_ABSTRACTCONTACTFORMATTER_H
23#define AKONADI_ABSTRACTCONTACTFORMATTER_H
24
25#include "akonadi-contact_export.h"
26
27#include <QtCore/QVariantMap>
28
29namespace KABC {
30class Addressee;
31}
32
33namespace Akonadi {
34class Item;
35
46class AKONADI_CONTACT_EXPORT AbstractContactFormatter
47{
48 public:
52 enum HtmlForm {
53 SelfcontainedForm,
54 EmbeddableForm,
55 UserForm = SelfcontainedForm + 42
56 };
57
61 AbstractContactFormatter();
62
66 virtual ~AbstractContactFormatter();
67
72 void setContact( const KABC::Addressee &contact );
73
77 KABC::Addressee contact() const;
78
85 void setItem( const Akonadi::Item &item );
86
90 Akonadi::Item item() const;
91
110 void setCustomFieldDescriptions( const QList<QVariantMap> &descriptions );
111
115 QList<QVariantMap> customFieldDescriptions() const;
116
122 virtual QString toHtml( HtmlForm form = SelfcontainedForm ) const = 0;
123
124 private:
125 //@cond PRIVATE
126 Q_DISABLE_COPY( AbstractContactFormatter )
127
128 class Private;
129 Private* const d;
130 //@endcond
131};
132
133}
134
135#endif
Akonadi::AbstractContactFormatter
The interface for all contact formatters.
Definition abstractcontactformatter.h:47
Akonadi::AbstractContactFormatter::toHtml
virtual QString toHtml(HtmlForm form=SelfcontainedForm) const =0
This method must be reimplemented to return the contact formatted as HTML according to the requested ...
Akonadi::AbstractContactFormatter::HtmlForm
HtmlForm
Describes the form of the HTML that is created.
Definition abstractcontactformatter.h:52
Akonadi::AbstractContactFormatter::EmbeddableForm
@ EmbeddableForm
Creates a div HTML element that can be embedded.
Definition abstractcontactformatter.h:54
Akonadi::AbstractContactFormatter::SelfcontainedForm
@ SelfcontainedForm
Creates a complete HTML document.
Definition abstractcontactformatter.h:53
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal