Search for usage in LXR

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
QList< QVariantMap > customFieldDescriptions () const
Akonadi::Item item () const
void setContact (const KContacts::Addressee &contact)
void setCustomFieldDescriptions (const QList< 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.nosp@m.@kde.nosp@m..org

Definition at line 37 of file abstractcontactformatter.h.

Member Enumeration Documentation

◆ HtmlForm

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 43 of file abstractcontactformatter.h.

Constructor & Destructor Documentation

◆ AbstractContactFormatter()

AbstractContactFormatter::AbstractContactFormatter ( )

Creates a new abstract contact formatter.

Definition at line 24 of file abstractcontactformatter.cpp.

◆ ~AbstractContactFormatter()

AbstractContactFormatter::~AbstractContactFormatter ( )

Destroys the abstract contact formatter.

Member Function Documentation

◆ contact()

KContacts::Addressee AbstractContactFormatter::contact ( ) const

Returns the contact that will be formatted.

Definition at line 36 of file abstractcontactformatter.cpp.

◆ customFieldDescriptions()

QList< QVariantMap > AbstractContactFormatter::customFieldDescriptions ( ) const

Returns the custom field descriptions that will be used.

Definition at line 56 of file abstractcontactformatter.cpp.

◆ item()

Akonadi::Item AbstractContactFormatter::item ( ) const

Returns the item who's payload will be formatted.

Definition at line 46 of file abstractcontactformatter.cpp.

◆ setContact()

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

Sets the contact that will be formatted.

contactcontact to be formatted

Definition at line 31 of file abstractcontactformatter.cpp.

◆ setCustomFieldDescriptions()

void AbstractContactFormatter::setCustomFieldDescriptions ( const QList< 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 51 of file abstractcontactformatter.cpp.

◆ setItem()

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 41 of file abstractcontactformatter.cpp.

◆ toHtml()

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 KAddressBookGrantlee::GrantleeContactFormatter, and Akonadi::StandardContactFormatter.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:50:38 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.