kaddressbook/contactselectionwidget.cpp

   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 #include "contactselectionwidget.h"
  21 #include "utils.h"
  22
  23 #include <Akonadi/CollectionComboBox>
  24 #include <Akonadi/EntityTreeModel>
  25 #include <Akonadi/ItemFetchJob>
  26 #include <Akonadi/ItemFetchScope>
  27 #include <Akonadi/RecursiveItemFetchJob>
  28
  29 #include <KLocale>
  30
  31 #include <QButtonGroup>
  32 #include <QCheckBox>
  33 #include <QGridLayout>
  34 #include <QGroupBox>
  35 #include <QItemSelectionModel>
  36 #include <QLabel>
  37 #include <QRadioButton>
  38 #include <QVBoxLayout>
  39
  40 ContactSelectionWidget::ContactSelectionWidget( QItemSelectionModel *selectionModel,
  41                                                 QWidget *parent )
  42   : QWidget( parent ), mSelectionModel( selectionModel )
  43 {
  44   initGui();
  45
  46   mSelectedContactsButton->setEnabled( mSelectionModel->hasSelection() );
  47   mAddressBookSelection->setEnabled( false );
  48   mAddressBookSelectionRecursive->setEnabled( false );
  49
  50   connect( mAddressBookContactsButton, SIGNAL(toggled(bool)),
  51            mAddressBookSelection, SLOT(setEnabled(bool)) );
  52   connect( mAddressBookContactsButton, SIGNAL(toggled(bool)),
  53            mAddressBookSelectionRecursive, SLOT(setEnabled(bool)) );
  54
  55   // apply default configuration
  56   if ( mSelectionModel->hasSelection() ) {
  57     mSelectedContactsButton->setChecked( true );
  58   } else {
  59     mAllContactsButton->setChecked( true );
  60   }
  61 }
  62
  63 void ContactSelectionWidget::setMessageText( const QString &message )
  64 {
  65   mMessageLabel->setText( message );
  66 }
  67
  68 void ContactSelectionWidget::setDefaultAddressBook( const Akonadi::Collection &addressBook )
  69 {
  70   mAddressBookSelection->setDefaultCollection( addressBook );
  71 }
  72
  73 KABC::Addressee::List ContactSelectionWidget::selectedContacts() const
  74 {
  75   if ( mAllContactsButton->isChecked() ) {
  76     return collectAllContacts();
  77   } else if ( mSelectedContactsButton->isChecked() ) {
  78     return collectSelectedContacts();
  79   } else if ( mAddressBookContactsButton->isChecked() ) {
  80     return collectAddressBookContacts();
  81   }
  82
  83   return KABC::Addressee::List();
  84 }
  85
  86 Akonadi::Item::List ContactSelectionWidget::selectedContactsItem() const
  87 {
  88   if ( mAllContactsButton->isChecked() ) {
  89     return collectAllContactsItem();
  90   } else if ( mSelectedContactsButton->isChecked() ) {
  91     return collectSelectedContactsItem();
  92   } else if ( mAddressBookContactsButton->isChecked() ) {
  93     return collectAddressBookContactsItem();
  94   }
  95
  96   return Akonadi::Item::List();
  97 }
  98
  99
 100 void ContactSelectionWidget::initGui()
 101 {
 102   QVBoxLayout *layout = new QVBoxLayout( this );
 103
 104   mMessageLabel = new QLabel;
 105   layout->addWidget( mMessageLabel );
 106
 107   QButtonGroup *group = new QButtonGroup( this );
 108
 109   QGroupBox *groupBox = new QGroupBox;
 110
 111   QGridLayout *boxLayout = new QGridLayout;
 112   groupBox->setLayout( boxLayout );
 113
 114   mAllContactsButton = new QRadioButton( i18nc( "@option:radio", "All contacts" ) );
 115   mAllContactsButton->setToolTip(
 116     i18nc( "@info:tooltip", "All contacts from all your address books" ) );
 117   mAllContactsButton->setWhatsThis(
 118     i18nc( "@info:whatsthis",
 119            "Choose this option you want to select all your contacts from "
 120            "all your address books." ) );
 121
 122   mSelectedContactsButton = new QRadioButton( i18nc( "@option:radio","Selected contacts" ) );
 123   mSelectedContactsButton->setToolTip(
 124     i18nc( "@info:tooltip", "Only the contacts currently selected" ) );
 125   mSelectedContactsButton->setWhatsThis(
 126     i18nc( "@info:whatsthis",
 127            "Choose this option if you want only the contacts you have already "
 128            "selected in the graphical interface." ) );
 129
 130   mAddressBookContactsButton = new QRadioButton( i18nc( "@option:radio", "All contacts from:" ) );
 131   mAddressBookContactsButton->setToolTip(
 132     i18nc( "@info:tooltip", "All contacts from a chosen address book" ) );
 133   mAddressBookContactsButton->setWhatsThis(
 134     i18nc( "@info:whatsthis",
 135            "Choose this option if you want to select all the contacts from only one "
 136            "of your address books.  Once this option is clicked you will be provided "
 137            "a drop down box listing all those address books and permitted to select "
 138            "the one you want." ) );
 139
 140   mAddressBookSelection = new Akonadi::CollectionComboBox;
 141   mAddressBookSelection->setMimeTypeFilter( QStringList() << KABC::Addressee::mimeType() );
 142   mAddressBookSelection->setAccessRightsFilter( Akonadi::Collection::ReadOnly );
 143   mAddressBookSelection->setExcludeVirtualCollections( true );
 144   mAddressBookSelectionRecursive = new QCheckBox( i18nc( "@option:check", "Include Subfolders" ) );
 145   mAddressBookSelectionRecursive->setToolTip(
 146     i18nc( "@info:tooltip", "Select all subfolders including the top-level folder" ) );
 147   mAddressBookSelectionRecursive->setWhatsThis(
 148     i18nc( "@info:whatsthis",
 149            "Check this box if you want to select all contacts from this folder, "
 150            "including all subfolders.  If you only want the contacts from the "
 151            "top-level folder then leave this box unchecked." ) );
 152
 153   group->addButton( mAllContactsButton );
 154   group->addButton( mSelectedContactsButton );
 155   group->addButton( mAddressBookContactsButton );
 156
 157   boxLayout->addWidget( mAllContactsButton, 0, 0, 1, 2 );
 158   boxLayout->addWidget( mSelectedContactsButton, 1, 0, 1, 2 );
 159   boxLayout->addWidget( mAddressBookContactsButton, 2, 0, Qt::AlignTop );
 160
 161   QVBoxLayout *addressBookLayout = new QVBoxLayout;
 162   addressBookLayout->setMargin( 0 );
 163   addressBookLayout->addWidget( mAddressBookSelection );
 164   addressBookLayout->addWidget( mAddressBookSelectionRecursive );
 165
 166   boxLayout->addLayout( addressBookLayout, 2, 1 );
 167
 168   layout->addWidget( groupBox );
 169   layout->addStretch( 1 );
 170 }
 171
 172 KABC::Addressee::List ContactSelectionWidget::collectAllContacts() const
 173 {
 174   Akonadi::RecursiveItemFetchJob *job =
 175     new Akonadi::RecursiveItemFetchJob( Akonadi::Collection::root(),
 176                                         QStringList() << KABC::Addressee::mimeType() );
 177   job->fetchScope().fetchFullPayload();
 178
 179   KABC::Addressee::List contacts;
 180   if ( !job->exec() ) {
 181     return contacts;
 182   }
 183
 184   foreach ( const Akonadi::Item &item, job->items() ) {
 185     if ( item.isValid() && item.hasPayload<KABC::Addressee>() ) {
 186       contacts.append( item.payload<KABC::Addressee>() );
 187     }
 188   }
 189
 190   return contacts;
 191 }
 192
 193 Akonadi::Item::List ContactSelectionWidget::collectAllContactsItem() const
 194 {
 195   Akonadi::RecursiveItemFetchJob *job =
 196     new Akonadi::RecursiveItemFetchJob( Akonadi::Collection::root(),
 197                                         QStringList() << KABC::Addressee::mimeType() );
 198   job->fetchScope().fetchFullPayload();
 199
 200   Akonadi::Item::List lst;
 201   if ( !job->exec() ) {
 202     return lst;
 203   }
 204
 205   foreach ( const Akonadi::Item &item, job->items() ) {
 206     if ( item.isValid() && item.hasPayload<KABC::Addressee>() ) {
 207       lst.append( item );
 208     }
 209   }
 210
 211   return lst;
 212 }
 213
 214 Akonadi::Item::List ContactSelectionWidget::collectSelectedContactsItem() const
 215 {
 216     Akonadi::Item::List lst = Utils::collectSelectedContactsItem(mSelectionModel);
 217
 218     return lst;
 219 }
 220
 221 KABC::Addressee::List ContactSelectionWidget::collectSelectedContacts() const
 222 {
 223   KABC::Addressee::List contacts;
 224
 225   const QModelIndexList indexes = mSelectionModel->selectedRows( 0 );
 226   for ( int i = 0; i < indexes.count(); ++i ) {
 227     const QModelIndex index = indexes.at( i );
 228     if ( index.isValid() ) {
 229       const Akonadi::Item item =
 230         index.data( Akonadi::EntityTreeModel::ItemRole ).value<Akonadi::Item>();
 231       if ( item.isValid() && item.hasPayload<KABC::Addressee>() ) {
 232         contacts.append( item.payload<KABC::Addressee>() );
 233       }
 234     }
 235   }
 236
 237   return contacts;
 238 }
 239
 240 KABC::Addressee::List ContactSelectionWidget::collectAddressBookContacts() const
 241 {
 242   KABC::Addressee::List contacts;
 243
 244   const Akonadi::Collection collection = mAddressBookSelection->currentCollection();
 245   if ( !collection.isValid() ) {
 246     return contacts;
 247   }
 248
 249   if ( mAddressBookSelectionRecursive->isChecked() ) {
 250     Akonadi::RecursiveItemFetchJob *job =
 251       new Akonadi::RecursiveItemFetchJob( collection,
 252                                           QStringList() << KABC::Addressee::mimeType() );
 253     job->fetchScope().fetchFullPayload();
 254
 255     if ( !job->exec() ) {
 256       return contacts;
 257     }
 258
 259     foreach ( const Akonadi::Item &item, job->items() ) {
 260       if ( item.hasPayload<KABC::Addressee>() ) {
 261         contacts.append( item.payload<KABC::Addressee>() );
 262       }
 263     }
 264   } else {
 265     Akonadi::ItemFetchJob *job = new Akonadi::ItemFetchJob( collection );
 266     job->fetchScope().fetchFullPayload();
 267
 268     if ( !job->exec() ) {
 269       return contacts;
 270     }
 271
 272     foreach ( const Akonadi::Item &item, job->items() ) {
 273       if ( item.hasPayload<KABC::Addressee>() ) {
 274         contacts.append( item.payload<KABC::Addressee>() );
 275       }
 276     }
 277   }
 278
 279   return contacts;
 280 }
 281
 282
 283 Akonadi::Item::List ContactSelectionWidget::collectAddressBookContactsItem() const
 284 {
 285   Akonadi::Item::List lst;
 286
 287   const Akonadi::Collection collection = mAddressBookSelection->currentCollection();
 288   if ( !collection.isValid() ) {
 289     return lst;
 290   }
 291
 292   if ( mAddressBookSelectionRecursive->isChecked() ) {
 293     Akonadi::RecursiveItemFetchJob *job =
 294       new Akonadi::RecursiveItemFetchJob( collection,
 295                                           QStringList() << KABC::Addressee::mimeType() );
 296     job->fetchScope().fetchFullPayload();
 297
 298     if ( !job->exec() ) {
 299       return lst;
 300     }
 301
 302     foreach ( const Akonadi::Item &item, job->items() ) {
 303       if ( item.hasPayload<KABC::Addressee>() ) {
 304         lst.append( item );
 305       }
 306     }
 307   } else {
 308     Akonadi::ItemFetchJob *job = new Akonadi::ItemFetchJob( collection );
 309     job->fetchScope().fetchFullPayload();
 310
 311     if ( !job->exec() ) {
 312       return lst;
 313     }
 314
 315     foreach ( const Akonadi::Item &item, job->items() ) {
 316       if ( item.hasPayload<KABC::Addressee>() ) {
 317         lst.append( item );
 318       }
 319     }
 320   }
 321
 322   return lst;
 323 }