Akonadi::AbstractContactFormatter Class Referenceabstract

#include <abstractcontactformatter.h>

Inheritance diagram for Akonadi::AbstractContactFormatter:

Public Types

enum  HtmlForm { SelfcontainedForm, EmbeddableForm, UserForm = SelfcontainedForm + 42 }

Public Member Functions

 AbstractContactFormatter ()
virtual ~AbstractContactFormatter ()
KContacts::Addressee contact () const
QVector< QVariantMap > customFieldDescriptions () const
Akonadi::Item item () const
void setContact (const KContacts::Addressee &contact)
void setCustomFieldDescriptions (const QVector< QVariantMap > &descriptions)
void setItem (const Akonadi::Item &item)
virtual QString toHtml (HtmlForm form=SelfcontainedForm) const =0

Detailed Description

The interface for all contact formatters.

This is the interface that can be used to format an Akonadi item with a contact payload or a contact itself as HTML.

See also
Tobias Koenig tokoe[email protected]@kde[email protected].org

Definition at line 46 of file abstractcontactformatter.h.

Member Enumeration Documentation

Describes the form of the HTML that is created.


Creates a complete HTML document.


Creates a div HTML element that can be embedded.


Point for extension.

Definition at line 52 of file abstractcontactformatter.h.

Constructor & Destructor Documentation

AbstractContactFormatter::AbstractContactFormatter ( )

Creates a new abstract contact formatter.

Definition at line 37 of file abstractcontactformatter.cpp.

AbstractContactFormatter::~AbstractContactFormatter ( )

Destroys the abstract contact formatter.

Definition at line 42 of file abstractcontactformatter.cpp.

Member Function Documentation

KContacts::Addressee AbstractContactFormatter::contact ( ) const

Returns the contact that will be formatted.

Definition at line 52 of file abstractcontactformatter.cpp.

QVector< QVariantMap > AbstractContactFormatter::customFieldDescriptions ( ) const

Returns the custom field descriptions that will be used.

Definition at line 72 of file abstractcontactformatter.cpp.

Akonadi::Item AbstractContactFormatter::item ( ) const

Returns the item who's payload will be formatted.

Definition at line 62 of file abstractcontactformatter.cpp.

void AbstractContactFormatter::setContact ( const KContacts::Addressee contact)

Sets the contact that will be formatted.

contactcontact to be formatted

Definition at line 47 of file abstractcontactformatter.cpp.

void AbstractContactFormatter::setCustomFieldDescriptions ( const QVector< QVariantMap > &  descriptions)

Sets the custom field descriptions that will be used.

The description list contains a QVariantMap for each custom field with the following keys:

  • key (string) The identifier of the field
  • title (string) The i18n'ed title of the field
  • type (string) The type description of the field Possible values for type description are
    • text
    • numeric
    • boolean
    • date
    • time
    • datetime
descriptionslist with field descriptions

Definition at line 67 of file abstractcontactformatter.cpp.

void AbstractContactFormatter::setItem ( const Akonadi::Item &  item)

Sets the item who's payload will be formatted.

The payload must be a valid KContacts::Addressee object.
itemitem, who's payload will be formatted.

Definition at line 57 of file abstractcontactformatter.cpp.

virtual QString Akonadi::AbstractContactFormatter::toHtml ( HtmlForm  form = SelfcontainedForm) const
pure virtual

This method must be reimplemented to return the contact formatted as HTML according to the requested form.

formhow to render the contact into HTML

Implemented in Akonadi::StandardContactFormatter, and KAddressBookGrantlee::GrantleeContactFormatter.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Aug 2 2020 23:07:01 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.