KDE PIM / Developers / API Docs / kaddressbook

KAddressBookView Class Reference

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

#include <kaddressbookview.h>

Inherits QWidget.

Inherited by KAddressBookCardView, KAddressBookIconView, and KAddressBookTableView.

List of all members.

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions


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>


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.

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.

void KAddressBookView::writeConfig KConfig *   )  [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.

Reimplemented in KAddressBookCardView, and KAddressBookTableView.

QString KAddressBookView::selectedEmails  )  [virtual]
 

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

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.

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.

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()

const QString & KAddressBookView::defaultFilterName  )  const
 

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

KAB::Core * KAddressBookView::core  )  const
 

Returns:
The Core object.

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.

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.

virtual void KAddressBookView::setFirstSelected bool  selected = true  )  [pure virtual, slot]
 

Selects the first contact in the view.

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.

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

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:
uid The uid of the selected addressee
See also:
KListView

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.

void KAddressBookView::viewFieldsChanged  )  [signal]
 

Emitted whenever the view fields 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.

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!


The documentation for this class was generated from the following files: