Akonadi::EmailAddressSelectionDialog Class

A dialog to select email addresses from Akonadi. More...

Header: #include <Akonadi/EmailAddressSelectionDialog>
CMake: find_package(KPim6AkonadiContactWidgets REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiContactWidgets)

Public Functions

EmailAddressSelectionDialog(QWidget *parent = nullptr)
EmailAddressSelectionDialog(QAbstractItemModel *model, QWidget *parent = nullptr)
virtual ~EmailAddressSelectionDialog() override

Reimplemented Public Functions

virtual Akonadi::EmailAddressSelection::List selectedAddresses() const override
virtual Akonadi::EmailAddressSelectionWidget *view() const override

Detailed Description

This dialog allows the user to select an name and email address from the Akonadi storage. The selected addresses are returned as EmailAddressSelectionWidget::Selection objects which encapsulate the name, email address and the Akonadi item that has been selected.

Example:

Akonadi::EmailAddressSelectionDialog dlg( this );
if ( dlg.exec() ) {
  const Akonadi::EmailAddressSelectionWidget::Selection::List selections = dlg.selectedAddresses();
  foreach ( const Akonadi::EmailAddressSelectionWidget::Selection &selection, selections ) {
    qCDebug(AKONADICONTACT_LOG) << "Name:" << selection.name() << "Email:" << selection.email();
  }
}

Author: Tobias Koenig <tokoe@kde.org>

Member Function Documentation

[explicit] EmailAddressSelectionDialog::EmailAddressSelectionDialog(QWidget *parent = nullptr)

Creates a new email address selection dialog.

parent The parent widget.

[explicit] EmailAddressSelectionDialog::EmailAddressSelectionDialog(QAbstractItemModel *model, QWidget *parent = nullptr)

Creates a new email address selection dialog.

model A custom, ContactsTreeModel based model to use. parent The parent widget.

[override virtual noexcept] EmailAddressSelectionDialog::~EmailAddressSelectionDialog()

Destroys the email address selection dialog.

[override virtual] Akonadi::EmailAddressSelection::List EmailAddressSelectionDialog::selectedAddresses() const

Returns the list of selected email addresses.

[override virtual] Akonadi::EmailAddressSelectionWidget *EmailAddressSelectionDialog::view() const

Returns the email address selection view that is used.