• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

libkdepim

KPIM::AddresseeView

KPIM::AddresseeView Class Reference

#include <addresseeview.h>

Inheritance diagram for KPIM::AddresseeView:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 45 of file addresseeview.h.


Public Types

enum  FieldMask {
  NoFields = 0, BirthdayFields = 1, AddressFields = 2, EmailFields = 4,
  PhoneFields = 8, URLFields = 16, IMFields = 32, CustomFields = 64,
  DefaultFields = AddressFields | EmailFields | PhoneFields | URLFields
}
enum  LinkMask {
  NoLinks = 0, AddressLinks = 1, EmailLinks = 2, PhoneLinks = 4,
  URLLinks = 8, IMLinks = 16, DefaultLinks = AddressLinks | EmailLinks | PhoneLinks | URLLinks | IMLinks
}

Signals

void addressClicked (const QString &uid)
void emailHighlighted (const QString &email)
void faxNumberHighlighted (const QString &number)
void highlightedMessage (const QString &message)
void phoneNumberHighlighted (const QString &number)
void urlHighlighted (const QString &url)

Public Member Functions

KABC::Addressee addressee () const
 AddresseeView (QWidget *parent=0, KConfig *config=0)
void enableLinks (int linkMask)
void setAddressee (const KABC::Addressee &addr)
 ~AddresseeView ()

Static Public Member Functions

static QString pixmapAsDataUrl (const QPixmap &pixmap)
static QString vCardAsHTML (const KABC::Addressee &addr,::KIMProxy *proxy, LinkMask linkMask=DefaultLinks, bool internalLoading=true, FieldMask fieldMask=DefaultFields)

Protected Member Functions

virtual void contextMenuEvent (QContextMenuEvent *e)
virtual void emailClicked (const QString &mail)
virtual void faxNumberClicked (const QString &number)
virtual void imAddressClicked ()
virtual void phoneNumberClicked (const QString &number)
virtual void sendSMS (const QString &number, const QString &msg)
virtual void smsTextClicked (const QString &number)
virtual void urlClicked (const QString &url)

Member Enumeration Documentation

enum KPIM::AddresseeView::FieldMask

This enums are used by vCardAsHTML to decide which fields shall be shown.

Enumerator:
NoFields 
BirthdayFields 
AddressFields 
EmailFields 
PhoneFields 
URLFields 
IMFields 
CustomFields 
DefaultFields 

Definition at line 96 of file addresseeview.h.

enum KPIM::AddresseeView::LinkMask

This enums are used by enableLinks to set which kind of links shall be enabled.

Enumerator:
NoLinks 
AddressLinks 
EmailLinks 
PhoneLinks 
URLLinks 
IMLinks 
DefaultLinks 

Definition at line 76 of file addresseeview.h.


Constructor & Destructor Documentation

AddresseeView::AddresseeView ( QWidget *  parent = 0,
KConfig *  config = 0 
) [explicit]

Constructor.

Parameters:
config The config object where the settings are stored which fields will be shown.

Definition at line 58 of file addresseeview.cpp.

AddresseeView::~AddresseeView (  ) 

Definition at line 108 of file addresseeview.cpp.


Member Function Documentation

void KPIM::AddresseeView::addressClicked ( const QString &  uid  )  [signal]

KABC::Addressee AddresseeView::addressee (  )  const

Returns the current addressee object.

Definition at line 551 of file addresseeview.cpp.

void AddresseeView::contextMenuEvent ( QContextMenuEvent *  e  )  [protected, virtual]

Definition at line 640 of file addresseeview.cpp.

void AddresseeView::emailClicked ( const QString &  mail  )  [protected, virtual]

Definition at line 561 of file addresseeview.cpp.

void KPIM::AddresseeView::emailHighlighted ( const QString &  email  )  [signal]

void AddresseeView::enableLinks ( int  linkMask  ) 

Sets which parts of the contact shall be presented as links.

The mask can be OR'ed LinkMask. By default all links are enabled.

Definition at line 139 of file addresseeview.cpp.

void AddresseeView::faxNumberClicked ( const QString &  number  )  [protected, virtual]

Definition at line 620 of file addresseeview.cpp.

void KPIM::AddresseeView::faxNumberHighlighted ( const QString &  number  )  [signal]

void KPIM::AddresseeView::highlightedMessage ( const QString &  message  )  [signal]

void AddresseeView::imAddressClicked (  )  [protected, virtual]

Definition at line 635 of file addresseeview.cpp.

void AddresseeView::phoneNumberClicked ( const QString &  number  )  [protected, virtual]

Definition at line 569 of file addresseeview.cpp.

void KPIM::AddresseeView::phoneNumberHighlighted ( const QString &  number  )  [signal]

QString AddresseeView::pixmapAsDataUrl ( const QPixmap &  pixmap  )  [static]

Encodes a QPixmap as a PNG into a data: URL (rfc2397), readable by the data kio protocol.

Parameters:
pixmap the pixmap to encode
Returns:
a data: URL

Definition at line 471 of file addresseeview.cpp.

void AddresseeView::sendSMS ( const QString &  number,
const QString &  msg 
) [protected, virtual]

Definition at line 601 of file addresseeview.cpp.

void AddresseeView::setAddressee ( const KABC::Addressee &  addr  ) 

Sets the addressee object.

The addressee is displayed immediately.

Parameters:
addr The addressee object.

Definition at line 125 of file addresseeview.cpp.

void AddresseeView::smsTextClicked ( const QString &  number  )  [protected, virtual]

Definition at line 584 of file addresseeview.cpp.

void AddresseeView::urlClicked ( const QString &  url  )  [protected, virtual]

Definition at line 556 of file addresseeview.cpp.

void KPIM::AddresseeView::urlHighlighted ( const QString &  url  )  [signal]

QString AddresseeView::vCardAsHTML ( const KABC::Addressee &  addr,
::KIMProxy *  proxy,
LinkMask  linkMask = DefaultLinks,
bool  internalLoading = true,
FieldMask  fieldMask = DefaultFields 
) [static]

Returns the HTML representation of a contact.

The HTML code looks like <div> <table> ... </table> </div>

Parameters:
addr The addressee object.
linkMask The mask for which parts of the contact will be displayed as links. The links looks like this: "addr://&lt;addr id&gt;" for addresses "mailto:&lt;email address&gt;" for emails "phone://&lt;phone number&gt;" for phone numbers "http://&lt;url&gt;" for urls "im:&lt;im addrss&gt;" for instant messaging addresses "sms://&lt;phone number&gt;" for sending a sms
internalLoading If true, the loading of internal pictures is done automatically.
fieldMask The mask for which fields of the contact will be displayed.

Definition at line 144 of file addresseeview.cpp.


The documentation for this class was generated from the following files:
  • addresseeview.h
  • addresseeview.cpp

libkdepim

Skip menu "libkdepim"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal