Akonadi::ContactViewer Class Reference

A viewer component for contacts in Akonadi. More...

#include <contactviewer.h>

Inherits QWidget, and Akonadi::ItemMonitor.

List of all members.

Public Slots

void setContact (const Akonadi::Item &contact)

Signals

void addressClicked (const KABC::Address &address)
void emailClicked (const QString &name, const QString &email)
void phoneNumberClicked (const KABC::PhoneNumber &number)
void urlClicked (const KUrl &url)

Public Member Functions

 ContactViewer (QWidget *parent=0)
 ~ContactViewer ()
Akonadi::Item contact () const

Detailed Description

A viewer component for contacts in Akonadi.

This widgets provides a way to show a contact from the Akonadi storage.

Example:

 using namespace Akonadi;

 const Item contact = ...

 ContactViewer *viewer = new ContactViewer( this );
 viewer->setContact( contact );
Author:
Tobias Koenig <tokoe@kde.org>
Since:
4.4

Definition at line 62 of file contactviewer.h.


Constructor & Destructor Documentation

ContactViewer::ContactViewer ( QWidget *  parent = 0  ) 

Creates a new contact viewer.

Parameters:
parent The parent widget.

Definition at line 88 of file contactviewer.cpp.

ContactViewer::~ContactViewer (  ) 

Destroys the contact viewer.

Definition at line 108 of file contactviewer.cpp.


Member Function Documentation

void Akonadi::ContactViewer::addressClicked ( const KABC::Address &  address  )  [signal]

This signal is emitted whenever the user has clicked on an address in the viewer.

Parameters:
address The corresponding address.
Akonadi::Item ContactViewer::contact (  )  const

Returns the contact that is currently displayed.

Definition at line 113 of file contactviewer.cpp.

void Akonadi::ContactViewer::emailClicked ( const QString &  name,
const QString &  email 
) [signal]

This signal is emitted whenever the user has clicked on an email address in the viewer.

Parameters:
name The name of the contact.
email The plain email address of the contact.
void Akonadi::ContactViewer::phoneNumberClicked ( const KABC::PhoneNumber &  number  )  [signal]

This signal is emitted whenever the user has clicked on a phone number (that includes fax numbers as well) in the viewer.

Parameters:
number The corresponding phone number.
void ContactViewer::setContact ( const Akonadi::Item &  contact  )  [slot]

Sets the contact that shall be displayed in the viewer.

Definition at line 118 of file contactviewer.cpp.

void Akonadi::ContactViewer::urlClicked ( const KUrl &  url  )  [signal]

This signal is emitted whenever the user has clicked on a url (e.g.

homepage or blog url) in the viewer.

Parameters:
url The url that has been clicked.

The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys