emailaddressselection.h 3.29 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 27
/*
    This file is part of Akonadi Contact.

    Copyright (c) 2010 KDAB
    Author: 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_EMAILADDRESSSELECTION_H
#define AKONADI_EMAILADDRESSSELECTION_H

#include "akonadi-contact_export.h"

Laurent Montel's avatar
Laurent Montel committed
28 29 30
#include <QVector>
#include <QSharedDataPointer>
#include <QString>
31

Laurent Montel's avatar
Laurent Montel committed
32 33
namespace Akonadi
{
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

class Item;

/**
 * @short An selection of an email address and corresponding name.
 *
 * This class encapsulates the selection of an email address and name
 * as it is returned by EmailAddressSelectionWidget or EmailAddressSelectionDialog.
 *
 * It offers convenience methods to retrieve the quoted version of the
 * email address and access to the Akonadi item that is associated with
 * this address.
 *
 * @author Tobias Koenig <tokoe@kde.org>
 * @since 4.5
 */
class AKONADI_CONTACT_EXPORT EmailAddressSelection
{
Guy Maurel's avatar
Guy Maurel committed
52
public:
53 54 55
    /**
     * A list of email address selection objects.
     */
Laurent Montel's avatar
Laurent Montel committed
56
    typedef QVector<EmailAddressSelection> List;
57 58 59 60 61 62 63 64 65

    /**
     * Creates a new email address selection.
     */
    EmailAddressSelection();

    /**
     * Creates a new email address selection from an @p other selection.
     */
Guy Maurel's avatar
Guy Maurel committed
66
    EmailAddressSelection(const EmailAddressSelection &other);
67 68 69 70

    /**
     * Replaces this email address selection with the @p other selection.
     */
Guy Maurel's avatar
Guy Maurel committed
71
    EmailAddressSelection &operator=(const EmailAddressSelection &other);
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

    /**
     * Destroys the email address selection.
     */
    ~EmailAddressSelection();

    /**
     * Returns whether the selection is valid.
     */
    bool isValid() const;

    /**
     * Returns the name that is associated with the selected email address.
     */
    QString name() const;

    /**
     * Returns the address part of the selected email address.
     *
     * @note If a contact group has been selected, the name of the contact
     *       group is returned here and must be expanded by the caller.
     */
    QString email() const;

    /**
     * Returns the name and email address together, properly quoted if needed.
     *
     * @note If a contact group has been selected, the name of the contact
     *       group is returned here and must be expanded by the caller.
     */
    QString quotedEmail() const;

    /**
     * Returns the Akonadi item that is associated with the selected email address.
     */
    Akonadi::Item item() const;

Guy Maurel's avatar
Guy Maurel committed
109
private:
110 111 112 113 114 115 116 117 118 119
    //@cond PRIVATE
    friend class EmailAddressSelectionWidget;

    class Private;
    QSharedDataPointer<Private> d;
    //@endcond
};

}

Guy Maurel's avatar
Guy Maurel committed
120
Q_DECLARE_TYPEINFO(Akonadi::EmailAddressSelection, Q_MOVABLE_TYPE);
121

122
#endif