• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

akonadi/contact

  • Akonadi
  • ContactEditor
Public Types | Public Slots | Signals | Public Member Functions | List of all members
Akonadi::ContactEditor Class Reference

#include <contacteditor.h>

Inherits QWidget.

Public Types

enum  DisplayMode { FullMode, VCardMode }
 
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)
 
 ContactEditor (Mode mode, DisplayMode displayMode, QWidget *parent=0)
 
virtual ~ContactEditor ()
 
KABC::Addressee contact ()
 
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;
}
Author
Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org
Since
4.4

Definition at line 83 of file contacteditor.h.

Member Enumeration Documentation

enum Akonadi::ContactEditor::Mode

Describes the mode of the editor.

Enumerator
CreateMode 

Creates a new contact.

EditMode 

Edits an existing contact.

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
modeThe mode of the editor.
parentThe parent widget of the editor.

Definition at line 203 of file contacteditor.cpp.

ContactEditor::ContactEditor ( Mode  mode,
AbstractContactEditorWidget *  editorWidget,
QWidget *  parent = 0 
)

Creates a new contact editor with a custom editor widget.

Parameters
modeThe mode of the editor.
editorWidgetThe contact editor widget that shall be used for editing.
parentThe parent widget of the editor.

Definition at line 208 of file contacteditor.cpp.

ContactEditor::ContactEditor ( Mode  mode,
DisplayMode  displayMode,
QWidget *  parent = 0 
)

Creates a new contact editor dialog with a custom editor widget.

Parameters
modeThe mode of the dialog.
editorWidgetThe contact editor widget that shall be used for editing.
parentThe parent widget of the dialog.
Since
4.10

Definition at line 213 of file contacteditor.cpp.

ContactEditor::~ContactEditor ( )
virtual

Destroys the contact editor.

Definition at line 219 of file contacteditor.cpp.

Member Function Documentation

KABC::Addressee ContactEditor::contact ( )

ContactEditor::contact.

Since
4.10
Returns

Definition at line 241 of file contacteditor.cpp.

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 224 of file contacteditor.cpp.

bool ContactEditor::saveContact ( )
slot

Saves the contact from the editor back to the storage.

Definition at line 248 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 301 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 306 of file contacteditor.cpp.


The documentation for this class was generated from the following files:
  • contacteditor.h
  • contacteditor.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:28:44 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi/contact

Skip menu "akonadi/contact"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal