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 QAbstractItemModel;
  29 class QItemSelectionModel;
  30
  31 namespace Akonadi
  32 {
  33 class Collection;
  34 }
  35
  36 /**
  37  * @short A dialog to select a group of contacts.
  38  *
  39  * @author Tobias Koenig <tokoe@kde.org>
  40  */
  41 class ContactSelectionDialog : public KDialog
  42 {
  43   Q_OBJECT
  44
  45   public:
  46     /**
  47      * Creates a new contact selection dialog.
  48      *
  49      * @param model The model that contains all available contacts.
  50      * @param selectionModel The model that contains the currently selected contacts.
  51      * @param parent The parent widget.
  52      */
  53     ContactSelectionDialog( QAbstractItemModel *model, QItemSelectionModel *selectionModel, QWidget *parent = 0 );
  54
  55     /**
  56      * Sets the @p message text.
  57      */
  58     void setMessageText( const QString &message );
  59
  60     /**
  61      * Sets the default addressbook.
  62      */
  63     void setDefaultAddressBook( const Akonadi::Collection &addressBook );
  64
  65     /**
  66      * Returns the list of selected contacts.
  67      */
  68     KABC::Addressee::List selectedContacts() const;
  69
  70   private:
  71     ContactSelectionWidget *mSelectionWidget;
  72 };
  73
  74 #endif