addressesdialog.h

/*
 *
 *  This file is part of libtdepim.
 *
 *  Copyright (c) 2003 Zack Rusin <zack@kde.org>
 *  Copyright (c) 2003 Aaron J. Seigo <aseigo@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 ADDRESSESDIALOG_H
#define ADDRESSESDIALOG_H
 
#include <tdeabc/addressee.h>
#include <kdialogbase.h>
#include <tdelistview.h>
#include <tqstringlist.h>
#include <tqptrlist.h>
#include <tqptrdict.h>
#include <tdemacros.h>
 
namespace KPIM {
 
  class AddresseeViewItem : public TQObject, public TDEListViewItem
  {
  TQ_OBJECT
  
 
  public:
    enum Category {
      To          =0,
      CC          =1,
      BCC         =2,
      Group       =3,
      Entry       =4,
      FilledGroup =5,
      DistList    =6
    };
    AddresseeViewItem( AddresseeViewItem *parent, const TDEABC::Addressee& addr, int emailIndex = 0 );
    AddresseeViewItem( TDEListView *lv, const TQString& name, Category cat=Group );
    AddresseeViewItem( AddresseeViewItem *parent, const TQString& name, const TDEABC::Addressee::List &lst );
    AddresseeViewItem( AddresseeViewItem *parent, const TQString& name );
    ~AddresseeViewItem();
 
    TDEABC::Addressee       addressee() const;
    TDEABC::Addressee::List addresses() const;
    Category              category() const;
 
    TQString name()  const;
    TQString email() const;
 
    bool matches( const TQString& ) const;
 
    virtual int compare( TQListViewItem * i, int col, bool ascending ) const;
    virtual void setSelected( bool );
 
  signals:
    void addressSelected( AddresseeViewItem*, bool );
 
  private:
    struct AddresseeViewItemPrivate;
    AddresseeViewItemPrivate *d;
  };
 
  class TDE_EXPORT AddressesDialog : public KDialogBase
  {
    TQ_OBJECT
  
  public:
    AddressesDialog( TQWidget *widget=0, const char *name=0 );
    ~AddressesDialog();
 
    TQStringList to()  const;
    TQStringList cc()  const;
    TQStringList bcc() const;
 
    TDEABC::Addressee::List toAddresses()  const;
    TDEABC::Addressee::List allToAddressesNoDuplicates()  const;
    TDEABC::Addressee::List ccAddresses()  const;
    TDEABC::Addressee::List bccAddresses() const;
 
    TQStringList toDistributionLists() const;
    TQStringList ccDistributionLists() const;
    TQStringList bccDistributionLists() const;
 
  public slots:
    void setShowCC( bool b );
    void setShowBCC( bool b );
    void setRecentAddresses( const TDEABC::Addressee::List& addr );
    void setSelectedTo( const TQStringList& l );
    void setSelectedCC( const TQStringList& l );
    void setSelectedBCC( const TQStringList& l );
 
  protected slots:
    void addSelectedTo();
    void addSelectedCC();
    void addSelectedBCC();
 
    void removeEntry();
    void saveAs();
    void searchLdap();
    void ldapSearchResult();
    void launchAddressBook();
 
    void filterChanged( const TQString & );
 
    void updateAvailableAddressees();
    void availableSelectionChanged();
    void selectedSelectionChanged();
    void availableAddressSelected( AddresseeViewItem* item, bool selected );
    void selectedAddressSelected( AddresseeViewItem* item, bool selected );
 
  protected:
    AddresseeViewItem* selectedToItem();
    AddresseeViewItem* selectedCcItem();
    AddresseeViewItem* selectedBccItem();
 
    void initConnections();
    void addDistributionLists();
    void addAddresseeToAvailable( const TDEABC::Addressee& addr,
                                  AddresseeViewItem* defaultParent=0, bool useCategory=true );
    void addAddresseeToSelected( const TDEABC::Addressee& addr,
                                 AddresseeViewItem* defaultParent=0 );
    void addAddresseesToSelected( AddresseeViewItem *parent,
                                  const TQPtrList<AddresseeViewItem>& addresses );
    TQStringList entryToString( const TDEABC::Addressee::List& l ) const;
    TDEABC::Addressee::List allAddressee( AddresseeViewItem* parent ) const;
    TDEABC::Addressee::List allAddressee( TDEListView* view, bool onlySelected = true ) const;
    TQStringList allDistributionLists( AddresseeViewItem* parent ) const;
 
  private:
    // if there's only one group in the available list, open it
    void checkForSingleAvailableGroup();
 
    // used to re-show items in the available list
    // it is recursive, but should only ever recurse once so should be fine
    void unmapSelectedAddress(AddresseeViewItem* item);
    void updateRecentAddresses();
 
    struct AddressesDialogPrivate;
    AddressesDialogPrivate *d;
 
    TQPtrList<AddresseeViewItem> selectedAvailableAddresses;
    TQPtrList<AddresseeViewItem> selectedSelectedAddresses;
    TQPtrDict<AddresseeViewItem> selectedToAvailableMapping;
  };
 
}
 
#endif /* ADDRESSESDIALOG_H */