kaddressbook Library API Documentation

KAddressBookTableView Class Reference

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

#include <kaddressbooktableview.h>

Inheritance diagram for KAddressBookTableView:

KAddressBookView QWidget List of all members.

Public Slots

virtual void reconstructListView ()

Public Member Functions

 KAddressBookTableView (KABC::AddressBook *doc, QWidget *parent, const char *name=0L)
virtual void refresh (QString uid=QString::null)
 Must be overloaded in subclasses to refresh the view.

virtual QStringList selectedUids ()
 Must be overloaded in subclasses.

virtual void setSelected (QString uid=QString::null, bool selected=false)
 This method must be overloaded in subclasses.

virtual void readConfig (KConfig *config)
 Called whenever this view should read the config.

virtual void writeConfig (KConfig *config)
 Called whenever this view should write the config.

virtual QString type () const
 Return the type of the view: Icon, Table, etc.

virtual void incrementalSearch (const QString &value, KABC::Field *field)
 This method can be overloaded in the subclass to implement incremental searching.


Protected Slots

void addresseeSelected ()
 Called whenever the user selects an addressee in the list view.

void addresseeExecuted (QListViewItem *)
 Called whenever the user executes an addressee.


Friends

class ContactListView

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

Definition at line 40 of file kaddressbooktableview.h.


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.

Definition at line 131 of file kaddressbooktableview.cpp.

References KAddressBookView::addressBook(), KAddressBookView::addressees(), QListViewItemIterator::current(), and KAddressBookView::fields().

QStringList KAddressBookTableView::selectedUids  )  [virtual]
 

Must be overloaded in subclasses.

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

Implements KAddressBookView.

Definition at line 167 of file kaddressbooktableview.cpp.

References QListViewItem::itemBelow().

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.

Definition at line 186 of file kaddressbooktableview.cpp.

References QListViewItem::itemBelow().

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.

Definition at line 105 of file kaddressbooktableview.cpp.

References KAddressBookView::readConfig().

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.

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

Reimplemented from KAddressBookView.

Definition at line 98 of file kaddressbooktableview.cpp.

References KAddressBookView::writeConfig().

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.

Definition at line 56 of file kaddressbooktableview.h.

void KAddressBookTableView::incrementalSearch const QString value,
KABC::Field *  field
[virtual]
 

This method can be overloaded in the subclass to implement incremental searching.

Incremental searching is where the user types in characters and after each character the selection is updated to select the item (addressee) that matches the search.

For example, if this method is called with value being 'p', the selection should be moved to the first item with the field matching 'p'. If the user then typed 'r', making the value 'pr', the selection should be updated to the first item with the field matching 'pr'. If there is no item matching 'pr', the selection should remain on the last valid match. If the value is empty, select the first item.

Parameters:
value The string value to match.
field The KABC::Field that should be searched

Reimplemented from KAddressBookView.

Definition at line 211 of file kaddressbooktableview.cpp.

References KAddressBookView::fields(), and QString::isEmpty().

void KAddressBookTableView::addresseeSelected  )  [protected, slot]
 

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

Definition at line 248 of file kaddressbooktableview.cpp.

References QListViewItem::isSelected(), QListViewItem::nextSibling(), and KAddressBookView::selected().

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

Definition at line 272 of file kaddressbooktableview.cpp.

References KAddressBookView::executed().


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