Akonadi::AbstractContactFormatter Class Reference

#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

StandardContactFormatter

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.5

Definition at line 37 of file abstractcontactformatter.h.

Member Enumeration Documentation

HtmlForm

enum Akonadi::AbstractContactFormatter::HtmlForm

Describes the form of the HTML that is created.

Enumerator
SelfcontainedForm	Creates a complete HTML document.
EmbeddableForm	Creates a div HTML element that can be embedded.
UserForm	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 ( )

virtualdefault

Destroys the abstract contact formatter.

Member Function Documentation

contact()

KContacts::Addressee AbstractContactFormatter::contact ( ) const

nodiscard

Returns the contact that will be formatted.

Definition at line 36 of file abstractcontactformatter.cpp.

customFieldDescriptions()

QList< QVariantMap > AbstractContactFormatter::customFieldDescriptions ( ) const

nodiscard

Returns the custom field descriptions that will be used.

Definition at line 56 of file abstractcontactformatter.cpp.

item()

Akonadi::Item AbstractContactFormatter::item ( ) const

nodiscard

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.

Parameters

contact

contact 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

Parameters

descriptions

list 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.

Note

The payload must be a valid KContacts::Addressee object.

Parameters

item	item, 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.

Parameters

form	how to render the contact into HTML

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

---

The documentation for this class was generated from the following files:

• abstractcontactformatter.h
• abstractcontactformatter.cpp