messagecore/emailaddressrequester.h

   1 /*
   2   Copyright (c) 2001 Marc Mutz <mutz@kde.org>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License along
  15   with this program; if not, write to the Free Software Foundation, Inc.,
  16   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17 */
  18
  19 #ifndef MESSAGECORE_EMAILADDRESSREQUESTER_H
  20 #define MESSAGECORE_EMAILADDRESSREQUESTER_H
  21
  22 #include "messagecore_export.h"
  23
  24 #include <QtGui/QWidget>
  25
  26 class KLineEdit;
  27
  28 namespace MessageCore {
  29
  30 /**
  31  * @short A widget to input one or more email addresses.
  32  *
  33  * @author Marc Mutz <mutz@kde.org>
  34  */
  35 class MESSAGECORE_EXPORT EmailAddressRequester : public QWidget
  36 {
  37   Q_OBJECT
  38
  39   Q_PROPERTY( QString text READ text WRITE setText NOTIFY textChanged USER true )
  40
  41   public:
  42     /**
  43      * Creates a new email address requester.
  44      *
  45      * @param parent The parent widget.
  46      */
  47     explicit EmailAddressRequester( QWidget* parent = 0 );
  48
  49     /**
  50      * Destroys the email address requester.
  51      */
  52     ~EmailAddressRequester();
  53
  54     /**
  55      * Clears the text of the email address requester.
  56      */
  57     void clear();
  58
  59     /**
  60      * Sets the @p text of the email address requester.
  61      */
  62     void setText( const QString &text );
  63
  64     /**
  65      * Returns the text of the email address requester.
  66      */
  67     QString text() const;
  68
  69     /**
  70      * Returns the line edit that is used by the email address requester.
  71      */
  72     KLineEdit* lineEdit() const;
  73
  74   Q_SIGNALS:
  75     /**
  76      * This signal is emitted whenever the text of the email address requester
  77      * has been changed.
  78      */
  79     void textChanged();
  80
  81   private:
  82     //@cond PRIVATE
  83     class Private;
  84     Private* const d;
  85
  86     Q_PRIVATE_SLOT( d, void slotAddressBook() )
  87     //@endcond
  88 };
  89
  90 }
  91
  92 #endif