Akonadi::ContactGroupEditorDialog Class
A dialog for creating or editing a contact group in Akonadi. More...
| Header: | #include <Akonadi/ContactGroupEditorDialog> |
| CMake: | find_package(KPim6AkonadiContactWidgets REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::AkonadiContactWidgets) |
Public Types
| enum | Mode { CreateMode, EditMode } |
Public Functions
| ContactGroupEditorDialog(Akonadi::ContactGroupEditorDialog::Mode mode, QWidget *parent = nullptr) | |
| virtual | ~ContactGroupEditorDialog() override |
| Akonadi::ContactGroupEditor * | editor() const |
| void | setContactGroup(const Akonadi::Item &group) |
| void | setDefaultAddressBook(const Akonadi::Collection &addressbook) |
Signals
| void | contactGroupStored(const Akonadi::Item &group) |
Detailed Description
This dialog provides a way to create a new contact group or edit an existing contact group in Akonadi.
Example for creating a new contact group:
using namespace Akonadi;
ContactGroupEditorDialog *dlg = new ContactGroupEditorDialog( ContactGroupEditorDialog::CreateMode, this );
connect( dlg, SIGNAL(contactGroupStored(Akonadi::Item)),
this, SLOT(contactGroupStored(Akonadi::Item)) );
dlg->show();
Example for editing an existing contact group:
using namespace Akonadi;
const Item contactGroup = ...;
ContactGroupEditorDialog *dlg = new ContactGroupEditorDialog( ContactGroupEditorDialog::EditMode, this );
connect( dlg, SIGNAL(contactGroupStored(Akonadi::Item)),
this, SLOT(contactGroupStored(Akonadi::Item)) );
dlg->setContactGroup( contactGroup );
dlg->show();
Author: Tobias Koenig <tokoe@kde.org>
Member Type Documentation
enum ContactGroupEditorDialog::Mode
Describes the mode of the contact group editor.
Member Function Documentation
[explicit] ContactGroupEditorDialog::ContactGroupEditorDialog(Akonadi::ContactGroupEditorDialog::Mode mode, QWidget *parent = nullptr)
Creates a new contact group editor dialog.
mode The mode of the dialog. parent The parent widget of the dialog.
[override virtual noexcept] ContactGroupEditorDialog::~ContactGroupEditorDialog()
Destroys the contact group editor dialog.
[signal] void ContactGroupEditorDialog::contactGroupStored(const Akonadi::Item &group)
This signal is emitted whenever a contact group was updated or stored.
group The contact group.
Akonadi::ContactGroupEditor *ContactGroupEditorDialog::editor() const
Returns the ContactGroupEditor that is used by the dialog.
void ContactGroupEditorDialog::setContactGroup(const Akonadi::Item &group)
Sets the contact group to edit when in EditMode.
void ContactGroupEditorDialog::setDefaultAddressBook(const Akonadi::Collection &addressbook)
Sets the addressbook that shall be selected as default for storage in create mode.