kaddressbook/addresseeutil.h

   1 /*
   2     This file is part of KAddressBook.
   3     Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18
  19     As a special exception, permission is given to link this program
  20     with any edition of Qt, and distribute the resulting executable,
  21     without including the source code for Qt in the source distribution.
  22 */
  23
  24 #ifndef ADDRESSEEUTIL_H
  25 #define ADDRESSEEUTIL_H
  26
  27 #include <QtCore/QString>
  28 #include <kabc/addressee.h>
  29
  30 /**
  31   This class provides some utility methods for transposing an
  32   addressee to different types (ie: clipboard). This class
  33   is probably just temporary until these function stablize and move
  34   to KABC.
  35
  36   NOTE: Currently these methods are not implemented properly. The
  37   vCard parser in KABC needs to be updated and there is no way to get from
  38   KABC::Addressee to vCard.
  39 */
  40 class AddresseeUtil
  41 {
  42   public:
  43     /**
  44       Same as above function, except that an entire list of KABC::Addressee
  45       objects will be converted to vCard and put in the string.
  46      */
  47     static QByteArray addresseesToClipboard( const KABC::Addressee::List &addrList );
  48
  49     /**
  50       Convert a string from the clipboard into a list of addressee objects.
  51       If the clipboard text was not a valid vcard, an empty list
  52       will be returned.
  53      */
  54     static KABC::Addressee::List clipboardToAddressees( const QByteArray &clipboard );
  55
  56     /**
  57       Converts the list of addressee objects into a list of email addresses.
  58      */
  59     static QString addresseesToEmails( const KABC::Addressee::List &addrList );
  60
  61   private:
  62     AddresseeUtil() {}
  63     ~AddresseeUtil() {}
  64 };
  65
  66 #endif