kaddressbook/contactselectiondialog.h

   1 /*
   2     Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
   3
   4     This library is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU Library General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or (at your
   7     option) any later version.
   8
   9     This library is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  12     License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to the
  16     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17     02110-1301, USA.
  18 */
  19
  20 #ifndef CONTACTSELECTIONDIALOG_H
  21 #define CONTACTSELECTIONDIALOG_H
  22
  23 #include <kabc/addressee.h>
  24 #include <kdialog.h>
  25
  26 class ContactSelectionWidget;
  27
  28 class QItemSelectionModel;
  29
  30 namespace Akonadi
  31 {
  32 class Collection;
  33 }
  34
  35 /**
  36  * @short A dialog to select a group of contacts.
  37  *
  38  * @author Tobias Koenig <tokoe@kde.org>
  39  */
  40 class ContactSelectionDialog : public KDialog
  41 {
  42   Q_OBJECT
  43
  44   public:
  45     /**
  46      * Creates a new contact selection dialog.
  47      *
  48      * @param selectionModel The model that contains the currently selected contacts.
  49      * @param parent The parent widget.
  50      */
  51     explicit ContactSelectionDialog( QItemSelectionModel *selectionModel, QWidget *parent = 0 );
  52
  53     /**
  54      * Sets the @p message text.
  55      */
  56     void setMessageText( const QString &message );
  57
  58     /**
  59      * Sets the default addressbook.
  60      */
  61     void setDefaultAddressBook( const Akonadi::Collection &addressBook );
  62
  63     /**
  64      * Returns the list of selected contacts.
  65      */
  66     KABC::Addressee::List selectedContacts() const;
  67
  68   private:
  69     ContactSelectionWidget *mSelectionWidget;
  70 };
  71
  72 #endif