Akonadi::EmailAddressSelectionWidget Class
A widget to select email addresses from Akonadi. More...
| Header: | #include <Akonadi/EmailAddressSelectionWidget> |
| CMake: | find_package(KPim6AkonadiContactWidgets REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::AkonadiContactWidgets) |
Public Functions
| EmailAddressSelectionWidget(QWidget *parent = nullptr) | |
| EmailAddressSelectionWidget(QAbstractItemModel *model, QWidget *parent = nullptr) | |
| EmailAddressSelectionWidget(bool showOnlyContactWithEmail, QAbstractItemModel *model = nullptr, QWidget *parent = nullptr) | |
| virtual | ~EmailAddressSelectionWidget() override |
| QLineEdit * | searchLineEdit() const |
| Akonadi::EmailAddressSelection::List | selectedAddresses() const |
| QTreeView * | view() const |
Signals
| void | doubleClicked() |
Detailed Description
This widget 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::EmailAddressSelectionWidget *widget = new Akonadi::EmailAddressSelectionWidget( this );
widget->view()->setSelectionMode( QAbstractItemView::MultiSelection );
...
foreach ( const Akonadi::EmailAddressSelection &selection, widget->selectedAddresses() ) {
qCDebug(AKONADICONTACT_LOG) << "Name:" << selection.name() << "Email:" << selection.email();
}
Author: Tobias Koenig <tokoe@kde.org>
Member Function Documentation
[explicit] EmailAddressSelectionWidget::EmailAddressSelectionWidget(QWidget *parent = nullptr)
Creates a new email address selection widget.
parent The parent widget.
[explicit] EmailAddressSelectionWidget::EmailAddressSelectionWidget(QAbstractItemModel *model, QWidget *parent = nullptr)
Creates a new email address selection widget.
model A custom, ContactsTreeModel based model to use. parent The parent widget.
[explicit] EmailAddressSelectionWidget::EmailAddressSelectionWidget(bool showOnlyContactWithEmail, QAbstractItemModel *model = nullptr, QWidget *parent = nullptr)
Creates a new email address selection widget. showOnlyContactWithEmail Allow to specify if you want to see only contact with email (by default yes in other constructor) model A custom ContactsTreeModel based model to use. parent The parent widget.
[override virtual noexcept] EmailAddressSelectionWidget::~EmailAddressSelectionWidget()
Destroys the email address selection widget.
[signal] void EmailAddressSelectionWidget::doubleClicked()
QLineEdit *EmailAddressSelectionWidget::searchLineEdit() const
Returns the line edit that is used for the search line.
Akonadi::EmailAddressSelection::List EmailAddressSelectionWidget::selectedAddresses() const
Returns the list of selected email addresses.
QTreeView *EmailAddressSelectionWidget::view() const
Returns the tree view that is used to list the items.