contacteditor.h 5.07 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
    This file is part of Akonadi Contact.

    Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_CONTACTEDITOR_H
#define AKONADI_CONTACTEDITOR_H

#include "akonadi-contact_export.h"

27
#include <QWidget>
28

Laurent Montel's avatar
Laurent Montel committed
29 30
namespace KContacts
{
31 32 33
class Addressee;
}

Laurent Montel's avatar
Laurent Montel committed
34 35
namespace Akonadi
{
36 37 38 39 40

class AbstractContactEditorWidget;
class Collection;
class Item;

Tobias Koenig's avatar
Tobias Koenig committed
41 42 43
/**
 * @short An widget to edit contacts in Akonadi.
 *
Tobias Koenig's avatar
Tobias Koenig committed
44 45 46 47 48 49 50 51 52 53 54 55 56
 * This widget provides a way to create a new contact or edit
 * an existing contact in Akonadi.
 *
 * Example for creating a new contact:
 *
 * @code
 *
 * using namespace Akonadi;
 *
 * ContactEditor *editor = new ContactEditor( Akonadi::ContactEditor::CreateMode, this );
 *
 * ...
 *
57
 * if ( !editor->saveContactInAddressBook() ) {
Laurent Montel's avatar
Laurent Montel committed
58
 *   qCDebug(AKONADICONTACT_LOG) << "Unable to save new contact to storage";
Tobias Koenig's avatar
Tobias Koenig committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 *   return;
 * }
 *
 * @endcode
 *
 * Example for editing an existing contact:
 *
 * @code
 *
 * const Akonadi::Item contact = ...;
 *
 * ContactEditor *editor = new ContactEditor( Akonadi::ContactEditor::EditMode, this );
 * editor->loadContact( contact );
 *
 * ...
 *
75
 * editor->saveContactInAddressBook();
Tobias Koenig's avatar
Tobias Koenig committed
76 77 78
 *
 * @endcode
 *
Tobias Koenig's avatar
Tobias Koenig committed
79
 * @author Tobias Koenig <tokoe@kde.org>
Tobias Koenig's avatar
Tobias Koenig committed
80
 * @since 4.4
Tobias Koenig's avatar
Tobias Koenig committed
81
 */
82 83
class AKONADI_CONTACT_EXPORT ContactEditor : public QWidget
{
Guy Maurel's avatar
Guy Maurel committed
84
    Q_OBJECT
85

Guy Maurel's avatar
Guy Maurel committed
86
public:
87 88 89
    /**
     * Describes the mode of the editor.
     */
90
    enum Mode {
Guy Maurel's avatar
Guy Maurel committed
91 92
        CreateMode, ///< Creates a new contact
        EditMode    ///< Edits an existing contact
93 94
    };

95
    enum DisplayMode {
Guy Maurel's avatar
Guy Maurel committed
96 97
        FullMode, ///< Show all pages
        VCardMode ///< Show just pages with elements stored in vcard.
98 99
    };

100 101 102 103 104 105
    /**
     * Creates a new contact editor with the standard editor widget.
     *
     * @param mode The mode of the editor.
     * @param parent The parent widget of the editor.
     */
Laurent Montel's avatar
Laurent Montel committed
106
    explicit ContactEditor(Mode mode, QWidget *parent = nullptr);
107 108 109 110 111 112 113 114

    /**
     * Creates a new contact editor with a custom editor widget.
     *
     * @param mode The mode of the editor.
     * @param editorWidget The contact editor widget that shall be used for editing.
     * @param parent The parent widget of the editor.
     */
Laurent Montel's avatar
Laurent Montel committed
115
    ContactEditor(Mode mode, AbstractContactEditorWidget *editorWidget, QWidget *parent = nullptr);
116

117 118 119 120
    /**
     * Creates a new contact editor dialog with a custom editor widget.
     *
     * @param mode The mode of the dialog.
Kevin Krammer's avatar
Kevin Krammer committed
121
     * @param displayMode mode for displaying the editor
122 123 124
     * @param parent The parent widget of the dialog.
     * @since 4.10
     */
Laurent Montel's avatar
Laurent Montel committed
125
    ContactEditor(Mode mode, DisplayMode displayMode, QWidget *parent = nullptr);
126

127 128 129 130 131
    /**
     * Destroys the contact editor.
     */
    virtual ~ContactEditor();

132 133
    /**
     * Sets a @p contact that is used as template in create mode.
Kevin Krammer's avatar
Kevin Krammer committed
134 135
     * The fields of the editor will be prefilled with the content of the contact.
     * @param contact the contact to use as template content
136
     */
Aleix Pol Gonzalez's avatar
Aleix Pol Gonzalez committed
137
    void setContactTemplate(const KContacts::Addressee &contact);
138 139 140 141 142

    /**
     * Sets the @p addressbook which shall be used to store new
     * contacts.
     */
Guy Maurel's avatar
Guy Maurel committed
143
    void setDefaultAddressBook(const Akonadi::Collection &addressbook);
144

145 146 147 148 149
    /**
     * @since 4.10
     * @brief ContactEditor::contact
     * @return
     */
Aleix Pol Gonzalez's avatar
Aleix Pol Gonzalez committed
150
    KContacts::Addressee contact();
Guy Maurel's avatar
Guy Maurel committed
151
public Q_SLOTS:
152 153 154
    /**
     * Loads the @p contact into the editor.
     */
Guy Maurel's avatar
Guy Maurel committed
155
    void loadContact(const Akonadi::Item &contact);
156

157 158
    /**
     * Save the contact from the editor back to the storage. And return error.
Laurent Montel's avatar
Laurent Montel committed
159
     * Need to connect to finished() signal, to keep time to Q_EMIT signal.
160
     * @since 4.11
161
     */
162
    void saveContactInAddressBook();
163

Guy Maurel's avatar
Guy Maurel committed
164
Q_SIGNALS:
165 166 167 168
    /**
     * This signal is emitted when the @p contact has been saved back
     * to the storage.
     */
Guy Maurel's avatar
Guy Maurel committed
169
    void contactStored(const Akonadi::Item &contact);
170 171 172

    /**
     * This signal is emitted when an error occurred during the save.
Kevin Krammer's avatar
Kevin Krammer committed
173
     * @param errorMsg The error message.
174
     * @since 4.11
175
     */
Guy Maurel's avatar
Guy Maurel committed
176
    void error(const QString &errorMsg);
177

178 179 180 181 182
    /**
     * @brief finished
     * @since 4.11
     */
    void finished();
Guy Maurel's avatar
Guy Maurel committed
183
private:
184 185
    //@cond PRIVATE
    class Private;
Guy Maurel's avatar
Guy Maurel committed
186
    Private *const d;
187

Guy Maurel's avatar
Guy Maurel committed
188 189 190 191
    Q_PRIVATE_SLOT(d, void itemFetchDone(KJob *))
    Q_PRIVATE_SLOT(d, void parentCollectionFetchDone(KJob *))
    Q_PRIVATE_SLOT(d, void storeDone(KJob *))
    Q_PRIVATE_SLOT(d, void itemChanged(const Akonadi::Item &, const QSet<QByteArray> &))
192
    //@endcond
193 194 195 196 197
};

}

#endif