Akonadi Contacts

standardcontactgroupformatter.h
1 /*
2  This file is part of Akonadi Contact.
3 
4  SPDX-FileCopyrightText: 2010 Tobias Koenig <[email protected]>
5 
6  SPDX-License-Identifier: LGPL-2.0-or-later
7 */
8 
9 #pragma once
10 
11 #include "akonadi-contact_export.h"
12 
13 #include "abstractcontactgroupformatter.h"
14 
15 namespace Akonadi
16 {
17 /**
18  * @short A class that formats a contact group as HTML code.
19  *
20  * Examples:
21  *
22  * @code
23  *
24  * using namespace Akonadi;
25  *
26  * const KContacts::ContactGroup group = ...
27  *
28  * StandardContactGroupFormatter formatter;
29  * formatter.setContactGroup( group );
30  *
31  * QTextBrowser *view = new QTextBrowser;
32  * view->setHtml( formatter.toHtml() );
33  *
34  * @endcode
35  *
36  * @author Tobias Koenig <[email protected]>
37  * @since 4.6
38  */
39 class AKONADI_CONTACT_EXPORT StandardContactGroupFormatter : public AbstractContactGroupFormatter
40 {
41 public:
42  /**
43  * Creates a new standard contact group formatter.
44  */
46 
47  /**
48  * Destroys the standard contact group formatter.
49  */
51 
52  /**
53  * Returns the contact group formatted as HTML.
54  */
55  Q_REQUIRED_RESULT QString toHtml(HtmlForm form = SelfcontainedForm) const override;
56 
57 private:
58  //@cond PRIVATE
59  class Private;
60  Private *const d;
61  //@endcond
62 };
63 }
64 
A class that formats a contact group as HTML code.
The interface for all contact group formatters.
HtmlForm
Describes the form of the HTML that is created.
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Jun 17 2021 23:09:02 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.