kabc Library API Documentation

KABC::AddresseeDialog Class Reference

Dialog for selecting address book entries. More...

#include <addresseedialog.h>

Inheritance diagram for KABC::AddresseeDialog:

KDialogBase KDialog QDialog List of all members.

Public Member Functions

 AddresseeDialog (QWidget *parent=0, bool multiple=false)
virtual ~AddresseeDialog ()
Addressee addressee ()
Addressee::List addressees ()

Static Public Member Functions

Addressee getAddressee (QWidget *parent)
Addressee::List getAddressees (QWidget *parent)

Protected Slots

void addressBookChanged ()

Detailed Description

Dialog for selecting address book entries.

This class provides a dialog for selecting entries from the standard KDE address book. Use the getAddressee() function to open a modal dialog, returning an address book entry.

In the dialog you can select an entry from the list with the mouse or type in the first letters of the name or email address you are searching for. The entry matching best is automatically selected. Use double click, pressing return or pressing the ok button to return the selected addressee to the application.

Definition at line 83 of file addresseedialog.h.


Constructor & Destructor Documentation

AddresseeDialog::AddresseeDialog QWidget parent = 0,
bool  multiple = false
 

Construct addressbook entry select dialog.

Parameters:
parent parent widget
Definition at line 59 of file addresseedialog.cpp.

References KListView::addColumn(), QBoxLayout::addWidget(), KCompletionBase::completionObject(), KDialogBase::plainPage(), KABC::StdAddressBook::self(), KLineEdit::setCompletionMode(), KListView::setFullWidth(), KCompletion::setIgnoreCase(), KDialogBase::setInitialSize(), QBoxLayout::setSpacing(), KDialogBase::slotOk(), and KDialog::spacingHint().

Referenced by getAddressee(), and getAddressees().

AddresseeDialog::~AddresseeDialog  )  [virtual]
 

Destructor.

Definition at line 125 of file addresseedialog.cpp.


Member Function Documentation

Addressee AddresseeDialog::addressee  ) 
 

Return the address chosen.

If it is a multiple select, this will return only the first address chosen Definition at line 194 of file addresseedialog.cpp.

References KABC::AddresseeItem::addressee().

Referenced by getAddressee().

Addressee::List AddresseeDialog::addressees  ) 
 

Return the list of addresses chosen.

Definition at line 207 of file addresseedialog.cpp.

References KABC::AddresseeItem::addressee().

Referenced by getAddressees().

Addressee AddresseeDialog::getAddressee QWidget parent  )  [static]
 

Select a single address book entry.

Open addressee select dialog and return the entry selected by the user. If the user doesn't select an entry or presses cancel, the returned addressee is empty. Definition at line 229 of file addresseedialog.cpp.

References addressee(), and AddresseeDialog().

Addressee::List AddresseeDialog::getAddressees QWidget parent  )  [static]
 

Select multiple address book entries.

Open addressee select dialog and return the entries selected by the user. If the user doesn't select an entry or presses cancel, the returned addressee list is empty. Definition at line 243 of file addresseedialog.cpp.

References AddresseeDialog(), and addressees().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kabc Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Sep 29 09:42:01 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003