kaddressbook Library API Documentation

KABBasicLook Class Reference

This is a pure virtual base class that defines the interface for how to display and change entries of the KDE addressbook. More...

#include <look_basic.h>

Inheritance diagram for KABBasicLook:

QWidget KABDetailedView List of all members.

Public Slots

virtual void setReadonly (bool state)
 Set read-write state.


Signals

void entryChanged ()
 This signal is emitted when the user changed the entry.

void saveMe ()
 This signal indicates that the entry needs to be changed immidiately in the database.

void sendEmail (const QString &)
 The user acticated the email address displayed.

void browse (const QString &)
 The user activated one of the displayed HTTP URLs.


Public Member Functions

 KABBasicLook (QWidget *parent=0, const char *name=0)
 The constructor.

virtual void setEntry (const KABC::Addressee &addressee)
 Set the entry.

virtual KABC::Addressee entry ()
 Get the current entry.

virtual void configure (KConfig *config)
 Configure the view from the configuration file.

bool readonly () const
 Retrieve read-write state.


Protected Attributes

KABC::Addressee current
 The displayed entry.

bool m_ro
 Read-Only?


Detailed Description

This is a pure virtual base class that defines the interface for how to display and change entries of the KDE addressbook.

This basic widget does not show anything in its client space. Derive it and implement its look and how the user may edit the entry.

The paintEvent() has to paint the whole widget, since repaint() calls will not delete the widgets background.

Definition at line 35 of file look_basic.h.


Constructor & Destructor Documentation

KABBasicLook::KABBasicLook QWidget parent = 0,
const char *  name = 0
 

The constructor.

Definition at line 20 of file look_basic.cpp.


Member Function Documentation

void KABBasicLook::setEntry const KABC::Addressee &  addressee  )  [virtual]
 

Set the entry.

It will be displayed automatically.

Reimplemented in KABDetailedView.

Definition at line 37 of file look_basic.cpp.

References current, and QWidget::repaint().

Referenced by KABDetailedView::setEntry().

KABC::Addressee KABBasicLook::entry  )  [virtual]
 

Get the current entry.

Definition at line 46 of file look_basic.cpp.

References current.

void KABBasicLook::configure KConfig *  config  )  [virtual]
 

Configure the view from the configuration file.

Reimplemented in KABDetailedView.

Definition at line 51 of file look_basic.cpp.

bool KABBasicLook::readonly  )  const
 

Retrieve read-write state.

Definition at line 32 of file look_basic.cpp.

References m_ro.

void KABBasicLook::entryChanged  )  [signal]
 

This signal is emitted when the user changed the entry.

void KABBasicLook::saveMe  )  [signal]
 

This signal indicates that the entry needs to be changed immidiately in the database.

This might be due to changes in values that are available in menus.

void KABBasicLook::sendEmail const QString  )  [signal]
 

The user acticated the email address displayed.

This may happen by, for example, clicking on the displayed mailto-URL.

Referenced by KABDetailedView::mousePressEvent().

void KABBasicLook::browse const QString  )  [signal]
 

The user activated one of the displayed HTTP URLs.

For example by clicking on the displayed homepage address.

Referenced by KABDetailedView::mousePressEvent().

void KABBasicLook::setReadonly bool  state  )  [virtual, slot]
 

Set read-write state.

Reimplemented in KABDetailedView.

Definition at line 26 of file look_basic.cpp.

References m_ro.

Referenced by KABDetailedView::setReadonly().


Member Data Documentation

KABC::Addressee KABBasicLook::current [protected]
 

The displayed entry.

Definition at line 67 of file look_basic.h.

Referenced by entry(), KABDetailedView::mousePressEvent(), KABDetailedView::paintEvent(), KABDetailedView::setEntry(), and setEntry().

bool KABBasicLook::m_ro [protected]
 

Read-Only?

Definition at line 69 of file look_basic.h.

Referenced by KABDetailedView::mousePressEvent(), readonly(), and setReadonly().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.4.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sat Oct 18 02:47:10 2003 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001