tdepim/kaddressbook/addresseeutil.h

/*
    This file is part of KAddressBook.
    Copyright (c) 2002 Mike Pilone <mpilone@slac.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

    As a special exception, permission is given to link this program
    with any edition of TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/

#ifndef ADDRESSEEUTIL_H
#define ADDRESSEEUTIL_H

#include <tqstring.h>
#include <tdeabc/addressee.h>
#include <tdeabc/vcardparser.h> // for KABC_VCARD_ENCODING_FIX define

/**
  This class provides some utility methods for transposing an
  addressee to different types (ie: clipboard). This class
  is probably just temporary until these function stablize and move
  to KABC.

  NOTE: Currently these methods are not implemented properly. The
  vCard parser in KABC needs to be updated and there is no way to get from
  TDEABC::Addressee to vCard.
*/
class AddresseeUtil
{
  public:
    /**
      Same as above function, except that an entire list of TDEABC::Addressee
      objects will be converted to vCard and put in the string.
    */
#if defined(KABC_VCARD_ENCODING_FIX)
    static TQByteArray addresseesToClipboard( const TDEABC::Addressee::List &addrList );
#else
    static TQString addresseesToClipboard( const TDEABC::Addressee::List &addrList );
#endif

    /**
      Convert a string from the clipboard into a list of addressee objects.
      If the clipboard text was not a valid vcard, an empty list
      will be returned.
     */
#if defined(KABC_VCARD_ENCODING_FIX)
    static TDEABC::Addressee::List clipboardToAddressees( const TQByteArray &clipboard );
#else
    static TDEABC::Addressee::List clipboardToAddressees( const TQString &clipboard );
#endif

    /**
      Converts the list of addressee objects into a list of email addresses.
     */
    static TQString addresseesToEmails( const TDEABC::Addressee::List &addrList );

  private:
    AddresseeUtil() {}
    ~AddresseeUtil() {}
};

#endif