akonadi/contact
Akonadi::ContactEditor Class Reference
An widget to edit contacts in Akonadi. More...
#include <contacteditor.h>
Inherits QWidget.
Public Types | |
enum | Mode { CreateMode, EditMode } |
Public Slots | |
void | loadContact (const Akonadi::Item &contact) |
bool | saveContact () |
Signals | |
void | contactStored (const Akonadi::Item &contact) |
void | error (const QString &errorMsg) |
Public Member Functions | |
ContactEditor (Mode mode, QWidget *parent=0) | |
ContactEditor (Mode mode, AbstractContactEditorWidget *editorWidget, QWidget *parent=0) | |
virtual | ~ContactEditor () |
void | setContactTemplate (const KABC::Addressee &contact) |
void | setDefaultAddressBook (const Akonadi::Collection &addressbook) |
Detailed Description
An widget to edit contacts in Akonadi.
This widget provides a way to create a new contact or edit an existing contact in Akonadi.
Example for creating a new contact:
using namespace Akonadi; ContactEditor *editor = new ContactEditor( Akonadi::ContactEditor::CreateMode, this ); ... if ( !editor->saveContact() ) { qDebug() << "Unable to save new contact to storage"; return; }
Example for editing an existing contact:
const Akonadi::Item contact = ...; ContactEditor *editor = new ContactEditor( Akonadi::ContactEditor::EditMode, this ); editor->loadContact( contact ); ... if ( !editor->saveContact() ) { qDebug() << "Unable to save changed contact to storage"; return; }
- Since:
- 4.4
Definition at line 83 of file contacteditor.h.
Member Enumeration Documentation
Describes the mode of the editor.
Definition at line 91 of file contacteditor.h.
Constructor & Destructor Documentation
ContactEditor::ContactEditor | ( | Mode | mode, | |
QWidget * | parent = 0 | |||
) | [explicit] |
Creates a new contact editor with the standard editor widget.
- Parameters:
-
mode The mode of the editor. parent The parent widget of the editor.
Definition at line 193 of file contacteditor.cpp.
ContactEditor::ContactEditor | ( | Mode | mode, | |
AbstractContactEditorWidget * | editorWidget, | |||
QWidget * | parent = 0 | |||
) |
Creates a new contact editor with a custom editor widget.
- Parameters:
-
mode The mode of the editor. editorWidget The contact editor widget that shall be used for editing. parent The parent widget of the editor.
Definition at line 198 of file contacteditor.cpp.
ContactEditor::~ContactEditor | ( | ) | [virtual] |
Destroys the contact editor.
Definition at line 203 of file contacteditor.cpp.
Member Function Documentation
void Akonadi::ContactEditor::contactStored | ( | const Akonadi::Item & | contact | ) | [signal] |
This signal is emitted when the contact
has been saved back to the storage.
void Akonadi::ContactEditor::error | ( | const QString & | errorMsg | ) | [signal] |
This signal is emitted when an error occurred during the save.
errorMsg
The error message.
void ContactEditor::loadContact | ( | const Akonadi::Item & | contact | ) | [slot] |
Loads the contact
into the editor.
Definition at line 208 of file contacteditor.cpp.
bool ContactEditor::saveContact | ( | ) | [slot] |
Saves the contact from the editor back to the storage.
Definition at line 224 of file contacteditor.cpp.
void ContactEditor::setContactTemplate | ( | const KABC::Addressee & | contact | ) |
Sets a contact
that is used as template in create mode.
The fields of the editor will be prefilled with the content of the contact.
Definition at line 274 of file contacteditor.cpp.
void ContactEditor::setDefaultAddressBook | ( | const Akonadi::Collection & | addressbook | ) |
Sets the addressbook
which shall be used to store new contacts.
Definition at line 279 of file contacteditor.cpp.
The documentation for this class was generated from the following files: