addressee.src.h

/*
    This file is part of libtdeabc.
    Copyright (c) 2001 Cornelius Schumacher <schumacher@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 KABC_ADDRESSEE_H
#define KABC_ADDRESSEE_H
 
#include <tqdatetime.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
 
#include <ksharedptr.h>
#include <kurl.h>
 
#include "address.h"
#include "agent.h"
#include "geo.h"
#include "key.h"
#include "phonenumber.h"
#include "picture.h"
#include "secrecy.h"
#include "sound.h"
#include "timezone.h"
 
namespace TDEABC {
 
class Resource;
class Field;
class SortMode;

class KABC_EXPORT Addressee
{
  friend KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Addressee & );
  friend KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Addressee & );
 
  public:
    typedef TQValueList<Addressee> List;
    typedef TQMap<TQString, Addressee> Map;

    Addressee();
    ~Addressee();
 
    Addressee( const Addressee & );
    Addressee &operator=( const Addressee & );
 
    bool operator==( const Addressee & ) const;
    bool operator!=( const Addressee & ) const;

    bool isEmpty() const;

    void setUid( const TQString &uid );
    TQString uid() const;
    static TQString uidLabel();

    void setUri( const TQString &uid );
    TQString uri() const;
    static TQString uriLabel();
 
    --DECLARATIONS--
    void setNameFromString( const TQString & );

    TQString realName() const;

    TQString assembledName() const;

    TQString fullEmail( const TQString &email=TQString::null ) const;

    void insertEmail( const TQString &email, bool preferred=false );

    void removeEmail( const TQString &email );

    TQString preferredEmail() const;

    TQStringList emails() const;

    void setEmails( const TQStringList& list);

    void insertPhoneNumber( const PhoneNumber &phoneNumber );

    void removePhoneNumber( const PhoneNumber &phoneNumber );

    PhoneNumber phoneNumber( int type ) const;

    PhoneNumber::List phoneNumbers() const;

    PhoneNumber::List phoneNumbers( int type ) const;

    PhoneNumber findPhoneNumber( const TQString &id ) const;

    void insertKey( const Key &key );

    void removeKey( const Key &key );

    Key key( int type, TQString customTypeString = TQString::null ) const;

    Key::List keys() const;

    void setKeys( const Key::List& keys);

    Key::List keys( int type, TQString customTypeString = TQString::null  ) const;

    Key findKey( const TQString &id ) const;

    void insertAddress( const Address &address );

    void removeAddress( const Address &address );

    Address address( int type ) const;

    Address::List addresses() const;

    Address::List addresses( int type ) const;

    Address findAddress( const TQString &id ) const;

    void insertCategory( const TQString & );

    void removeCategory( const TQString & );

    bool hasCategory( const TQString & ) const;

    void setCategories( const TQStringList & );

    TQStringList categories() const;

    void insertCustom( const TQString &app, const TQString &name,
                       const TQString &value );

    void removeCustom( const TQString &app, const TQString &name );

    TQString custom( const TQString &app, const TQString &name ) const;

    void setCustoms( const TQStringList & );

    TQStringList customs() const;

    static void parseEmailAddress( const TQString &rawEmail, TQString &fullName,
                                   TQString &email );

    void dump() const;

    TQString asString() const;

    void setResource( Resource *resource );

    Resource *resource() const;

    void setChanged( bool value );

    bool changed() const;
 
    static void setSortMode( TDEABC::SortMode *mode );
 
    bool operator< ( const Addressee &addr );
 
  private:
    void detach();
 
    struct AddresseeData;
    mutable TDESharedPtr<AddresseeData> mData;
 
  private:
    static AddresseeData* shared_null;
    static AddresseeData* makeSharedNull();
    static TDEABC::SortMode *mSortMode;
};
 
KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Addressee & );
KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Addressee & );
 
}
 
#endif