KDE PIM / Developers / API Docs / kaddressbook

KAddressBookTableView Class Reference

This class is the table view for kaddressbook. Table View. More...

#include <kaddressbooktableview.h>

Inherits KAddressBookView.

List of all members.

Public Slots

Public Member Functions

Protected Slots

Friends


Detailed Description

This class is the table view for kaddressbook. Table View.

This view is a KListView with multiple columns for the selected fields.

Author:
Don Sanders <dsanders@kde.org>
Version:
0.1


Member Function Documentation

void KAddressBookTableView::refresh QString  uid = QString::null  )  [virtual]
 

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.

Implements KAddressBookView.

QStringList KAddressBookTableView::selectedUids  )  [virtual]
 

Must be overloaded in subclasses.

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

Implements KAddressBookView.

void KAddressBookTableView::setSelected QString  uid = QString::null,
bool  selected = false
[virtual]
 

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.

Implements KAddressBookView.

void KAddressBookTableView::setFirstSelected bool  selected = true  )  [virtual]
 

Selects the first contact in the view.

Implements KAddressBookView.

KABC::Field * KAddressBookTableView::sortField  )  const [virtual]
 

Returns:
The current sort field.

Implements KAddressBookView.

void KAddressBookTableView::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 from KAddressBookView.

void KAddressBookTableView::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.

Reimplemented from KAddressBookView.

virtual QString KAddressBookTableView::type  )  const [inline, 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.

Implements KAddressBookView.

void KAddressBookTableView::addresseeSelected  )  [protected, slot]
 

Called whenever the user selects an addressee in the list view.

void KAddressBookTableView::addresseeExecuted QListViewItem *   )  [protected, slot]
 

Called whenever the user executes an addressee.

In terms of the list view, this is probably a double click

void KAddressBookTableView::rmbClicked KListView *  ,
QListViewItem *  ,
const QPoint & 
[protected, slot]
 

RBM menu called.

void KAddressBookTableView::updatePresence const QString &  uid  )  [protected, slot]
 

Called to update the presence of a single item.


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