Akonadi::StandardContactFormatter

Search for usage in LXR

Akonadi::StandardContactFormatter Class Reference

#include <standardcontactformatter.h>

Inheritance diagram for Akonadi::StandardContactFormatter:

Public Member Functions

 StandardContactFormatter ()
 
 ~StandardContactFormatter () override
 
bool displayQRCode () const
 
void setDisplayQRCode (bool show)
 
QString toHtml (HtmlForm form=SelfcontainedForm) const override
 
- Public Member Functions inherited from Akonadi::AbstractContactFormatter
 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)
 

Additional Inherited Members

- Public Types inherited from Akonadi::AbstractContactFormatter
enum  HtmlForm { SelfcontainedForm , EmbeddableForm , UserForm = SelfcontainedForm + 42 }
 

Detailed Description

A class that formats a contact as HTML code.

Examples:

using namespace Akonadi;
StandardContactFormatter formatter;
formatter.setContact( contact );
view->setHtml( formatter.toHtml() );
KContacts::Addressee contact() const
Returns the contact that will be formatted.
A widget for editing the display name of a contact.
void setHtml(const QString &text)
Author
Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org
Since
4.5

Definition at line 43 of file standardcontactformatter.h.

Constructor & Destructor Documentation

◆ StandardContactFormatter()

StandardContactFormatter::StandardContactFormatter ( )

Creates a new standard contact formatter.

Definition at line 32 of file standardcontactformatter.cpp.

◆ ~StandardContactFormatter()

StandardContactFormatter::~StandardContactFormatter ( )
overridedefault

Destroys the standard contact formatter.

Member Function Documentation

◆ displayQRCode()

bool StandardContactFormatter::displayQRCode ( ) const
nodiscard

Definition at line 335 of file standardcontactformatter.cpp.

◆ setDisplayQRCode()

void StandardContactFormatter::setDisplayQRCode ( bool show)

Definition at line 330 of file standardcontactformatter.cpp.

◆ toHtml()

QString StandardContactFormatter::toHtml ( HtmlForm form = SelfcontainedForm) const
nodiscardoverridevirtual

Returns the contact formatted as HTML.

Implements Akonadi::AbstractContactFormatter.

Definition at line 49 of file standardcontactformatter.cpp.


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 Mon Nov 4 2024 16:36:45 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.