distributionlist.h

/*
    This file is part of libtdepim.
    Copyright (c) 2004-2005 David Faure <faure@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef DISTRIBUTIONLIST_H
#define DISTRIBUTIONLIST_H
 
#include <tdeabc/addressee.h>
 
namespace TDEABC {
class AddressBook;
}
 
namespace KPIM {
 
class DistributionList : public TDEABC::Addressee
{
  public:
    struct Entry
    {
      typedef TQValueList<Entry> List;
 
      Entry() {}
      Entry( const Addressee &_addressee, const TQString &_email ) :
          addressee( _addressee ), email( _email ) {}
 
      Addressee addressee;
      TQString email;
    };
 
    typedef TQValueList<DistributionList> List;
 
    DistributionList();
    DistributionList( const TDEABC::Addressee& addr );
 
    ~DistributionList() {}
 
    void setName( const TQString &name );
 
    TQString name() const { return formattedName(); }
 
    void insertEntry( const Addressee &, const TQString &email=TQString() );
 
    void removeEntry( const Addressee &, const TQString &email=TQString() );
 
    void insertEntry( const TQString& uid, const TQString& email=TQString() );
    void removeEntry( const TQString& uid, const TQString& email=TQString() );
 
 
    TQStringList emails( TDEABC::AddressBook* book ) const;
 
    Entry::List entries( TDEABC::AddressBook* book ) const;
 
    // KDE4: should be a method of Addressee
    static bool isDistributionList( const TDEABC::Addressee& addr );
 
    // KDE4: should be a method of AddressBook
    static DistributionList findByName( TDEABC::AddressBook* book,
                                        const TQString& name,
                                        bool caseSensitive = true );
    // KDE4: should be a method of AddressBook
    // A bit slow (but no more than findByName).
    // From KAddressbook, use Core::distributionLists() instead.
    static TQValueList<DistributionList> allDistributionLists( TDEABC::AddressBook* book );
 
 
  private:
    // can't have any data here, use Addressee's methods instead
};
 
}
 
#endif /* DISTRIBUTIONLIST_H */