kaddressbook Library API Documentation

KAddressBookView Class Reference

Base class for all views in kaddressbook. More...

#include <kaddressbookview.h>

Inheritance diagram for KAddressBookView:

QWidget KAddressBookCardView KAddressBookIconView KAddressBookTableView List of all members.

Public Types

enum  DefaultFilterType { None = 0, Active = 1, Specific = 2 }

Public Slots

virtual void refresh (QString uid=QString::null)=0
virtual void setSelected (QString uid=QString::null, bool selected=true)=0
void popup (const QPoint &point)

Signals

void modified ()
void selected (const QString &uid)
void executed (const QString &uid)
void startDrag ()
void dropped (QDropEvent *)
void sortFieldChanged ()

Public Methods

 KAddressBookView (KAB::Core *core, QWidget *parent, const char *name)
virtual ~KAddressBookView ()
virtual QStringList selectedUids ()=0
virtual void readConfig (KConfig *config)
virtual void writeConfig (KConfig *config)
virtual QString selectedEmails ()
virtual QString type () const=0
KABC::Field::List fields () const
void setFilter (const Filter &)
DefaultFilterType defaultFilterType () const
const QStringdefaultFilterName () const
KAB::Core * core () const
virtual KABC::Field * sortField () const=0

Protected Methods

KABC::Addressee::List addressees ()
QWidgetviewWidget ()

Detailed Description

Base class for all views in kaddressbook.

This class implements all the common methods needed to provide a view to the user.

To implement a specific view (table, card, etc), just inherit from this class and implement all the pure virtuals.

Author:
Mike Pilone <mpilone@slac.com>

Definition at line 53 of file kaddressbookview.h.


Member Function Documentation

virtual QStringList KAddressBookView::selectedUids   [pure virtual]
 

Must be overloaded in subclasses.

Should return a list of all the uids of selected contacts.

Implemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

Referenced by selectedEmails().

void KAddressBookView::readConfig KConfig *    config [virtual]
 

Called whenever this view should read the config.

This can be used as a sign that the config has changed, therefore the view should assume the worst and rebuild itself if necessary. For example, in a table view this method may be called when the user adds or removes columns from the view.

If overloaded in the subclass, do not forget to call super class's method.

Parameters:
config  The KConfig object to read from. The group will already be set, so do not change the group.

Reimplemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

Definition at line 52 of file kaddressbookview.cpp.

Referenced by KAddressBookTableView::readConfig(), KAddressBookIconView::readConfig(), and KAddressBookCardView::readConfig().

void KAddressBookView::writeConfig KConfig *    config [virtual]
 

Called whenever this view should write the config.

The view should not write out information handled by the application, such as which fields are visible. The view should only write out information specific to itself (i.e.: All information in the ViewConfigWidget)

If overloaded in the subclass, do not forget to call the super class's method.

Parameters:
config  The KConfig object to read from. The group will already be set, so do not change the group.

Reimplemented in KAddressBookCardView, and KAddressBookTableView.

Definition at line 63 of file kaddressbookview.cpp.

Referenced by KAddressBookTableView::writeConfig(), and KAddressBookCardView::writeConfig().

QString KAddressBookView::selectedEmails   [virtual]
 

Returns a QString with all the selected email addresses concatenated together with a ',' seperator.

Definition at line 68 of file kaddressbookview.cpp.

References selectedUids().

virtual QString KAddressBookView::type   const [pure virtual]
 

Return the type of the view: Icon, Table, etc.

Please make sure that this is the same value that ViewWrapper::type() will return for your view.

Implemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

KABC::Field::List KAddressBookView::fields   const
 

Returns a list of the fields that should be displayed.

The list is composed of the fields proper names (ie: Home Address), so the view may need to translate them in order to get the value from the addressee.

This list is generated from the config file, so it is advisable to call this method whenever a readConfig() is called in order to get the newest list of fields.

Definition at line 123 of file kaddressbookview.cpp.

Referenced by KAddressBookTableView::refresh(), KAddressBookIconView::refresh(), KAddressBookCardView::refresh(), and KAddressBookTableView::sortField().

void KAddressBookView::setFilter const Filter  
 

Sets the active filter.

This filter will be used for filtering the list of addressees to display. The view will not automatically refresh itself, so in most cases you will want to call KAddressBookView::refresh() after this method.

Definition at line 128 of file kaddressbookview.cpp.

KAddressBookView::DefaultFilterType KAddressBookView::defaultFilterType   const
 

Returns:
The default filter type selection. If the selection is SpecificFilter, the name of the filter can be retrieved with defaultFilterName()

Definition at line 133 of file kaddressbookview.cpp.

const QString & KAddressBookView::defaultFilterName   const
 

Returns:
The name of the default filter. This string is only valid if defaultFilterType() is returning SpecificFilter.

Definition at line 138 of file kaddressbookview.cpp.

KAB::Core * KAddressBookView::core   const
 

Returns:
The Core object.

Definition at line 143 of file kaddressbookview.cpp.

Referenced by KAddressBookTableView::refresh(), KAddressBookIconView::refresh(), and KAddressBookCardView::refresh().

virtual KABC::Field* KAddressBookView::sortField   const [pure virtual]
 

Returns:
The current sort field.

Implemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

virtual void KAddressBookView::refresh QString    uid = QString::null [pure virtual, slot]
 

Must be overloaded in subclasses to refresh the view.

Refreshing includes updating the view to ensure that only items in the document are visible. If uid is valid, only the addressee with uid needs to be refreshed. This is an optimization only.

Implemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

Referenced by ViewManager::dropped().

virtual void KAddressBookView::setSelected QString    uid = QString::null,
bool    selected = true
[pure virtual, slot]
 

This method must be overloaded in subclasses.

Select (highlight) the addressee matching uid. If uid is equal to QString::null, then all addressees should be selected.

Implemented in KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

void KAddressBookView::popup const QPoint   point [slot]
 

Call this slot to popup a rmb menu.

Parameters:
point  The position where the menu shall appear.

Definition at line 148 of file kaddressbookview.cpp.

References QPopupMenu::popup().

Referenced by KAddressBookTableView::rmbClicked().

void KAddressBookView::modified   [signal]
 

This signal should be emitted by a subclass whenever an addressee is modified.

void KAddressBookView::selected const QString   uid [signal]
 

This signal should be emitted by a subclass whenever an addressee is selected.

Selected means that the addressee was given the focus. Some widgets may call this 'highlighted'. The view is responsible for emitting this signal multiple times if multiple items are selected, with the last item selected being the last emit.

Parameters:
uid  The uid of the selected addressee.
See also:
KListView

Referenced by KAddressBookTableView::addresseeSelected(), KAddressBookCardView::refresh(), KAddressBookTableView::setSelected(), KAddressBookIconView::setSelected(), and KAddressBookCardView::setSelected().

void KAddressBookView::executed const QString   uid [signal]
 

This signal should be emitted by a subclass whenever an addressee is executed.

This is defined by the KDE system wide config, but it either means single or doubleclicked.

Parameters:
ui  The uid of the selected addressee
See also:
KListView

Referenced by KAddressBookTableView::addresseeExecuted(), KAddressBookIconView::readConfig(), and KAddressBookCardView::readConfig().

void KAddressBookView::startDrag   [signal]
 

This signal is emitted whenever a user attempts to start a drag in the view.

The slot connected to this signal would usually want to create a QDragObject.

void KAddressBookView::dropped QDropEvent   [signal]
 

This signal is emitted whenever the user drops something on the view.

The individual view should handle checking if the item is droppable (ie: if it is a vcard).

void KAddressBookView::sortFieldChanged   [signal]
 

This signal is emitted whenever the sort field changed.

KABC::Addressee::List KAddressBookView::addressees   [protected]
 

Returns a list of the addressees that should be displayed.

This method should always be used by the subclass to get a list of addressees. This method internally takes many factors into account, including the current filter.

Definition at line 100 of file kaddressbookview.cpp.

References Filter::filterAddressee().

Referenced by KAddressBookTableView::refresh(), KAddressBookIconView::refresh(), and KAddressBookCardView::refresh().

QWidget * KAddressBookView::viewWidget   [protected]
 

This method returns the widget that should be used as the parent for all view components.

By using this widget as the parent and not 'this', the view subclass has the option of placing other widgets around the view (ie: search fields, etc). Do not delete this widget!

Definition at line 161 of file kaddressbookview.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kaddressbook Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:38:54 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003