kabc
KABC::AddresseeDialog Class Reference
Dialog for selecting address book entries. More...
#include <addresseedialog.h>
Inherits KDialog.
Public Member Functions | |
AddresseeDialog (QWidget *parent=0, bool multiple=false) | |
virtual | ~AddresseeDialog () |
Addressee | addressee () const |
Addressee::List | addressees () const |
Static Public Member Functions | |
static Addressee | getAddressee (QWidget *parent) |
static Addressee::List | getAddressees (QWidget *parent) |
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 98 of file addresseedialog.h.
Constructor & Destructor Documentation
AddresseeDialog::AddresseeDialog | ( | QWidget * | parent = 0 , |
|
bool | multiple = false | |||
) | [explicit] |
Construct addressbook entry select dialog.
- Parameters:
-
parent parent widget multiple if true, indicates a multiple selection.
Definition at line 106 of file addresseedialog.cpp.
AddresseeDialog::~AddresseeDialog | ( | ) | [virtual] |
Destructor.
Definition at line 185 of file addresseedialog.cpp.
Member Function Documentation
Addressee AddresseeDialog::addressee | ( | ) | const |
Return the address chosen.
If it is a multiple select, this will return only the first address chosen
Definition at line 190 of file addresseedialog.cpp.
Addressee::List AddresseeDialog::addressees | ( | ) | const |
Return the list of addresses chosen.
Definition at line 209 of file addresseedialog.cpp.
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.
- Parameters:
-
parent The QWidget parent for the dialog.
Definition at line 234 of file addresseedialog.cpp.
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.
- Parameters:
-
parent The QWidget parent for the dialog.
Definition at line 248 of file addresseedialog.cpp.
The documentation for this class was generated from the following files: