|
|
/*** Warning! This file has been generated by the script makeaddressee ***/ /* This file is part of libkabc. Copyright (c) 2001 Cornelius SchumacherThis 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef KABC_ADDRESSEE_H #define KABC_ADDRESSEE_H // $Id: addressee.h,v 1.18.2.1 2002/06/15 10:53:24 cschumac Exp $ #include #include #include #include #include #include #include "phonenumber.h" #include "address.h" #include "geo.h" #include "timezone.h" namespace KABC { /** @short address book entry This class represents an entry in the address book. The data of this class is implicitly shared. You can pass this class by value. */ class Addressee { public: typedef QValueList List; /** Construct an empty address book entry. */ Addressee(); ~Addressee(); Addressee( const Addressee & ); Addressee &operator=( const Addressee & ); /** Return, if the address book entry is empty. */ bool isEmpty() const; /* Set unique identifier. */ void setUid( const QString &uid ); /* Return unique identifier. */ QString uid() const; /* Set name. */ void setName( const QString &name ); /* Return name. */ QString name() const; /* Set formatted name. */ void setFormattedName( const QString &formattedName ); /* Return formatted name. */ QString formattedName() const; /* Set family name. */ void setFamilyName( const QString &familyName ); /* Return family name. */ QString familyName() const; /* Set given name. */ void setGivenName( const QString &givenName ); /* Return given name. */ QString givenName() const; /* Set additional names. */ void setAdditionalName( const QString &additionalName ); /* Return additional names. */ QString additionalName() const; /* Set honorific prefixes. */ void setPrefix( const QString &prefix ); /* Return honorific prefixes. */ QString prefix() const; /* Set honorific suffixes. */ void setSuffix( const QString &suffix ); /* Return honorific suffixes. */ QString suffix() const; /* Set nick name. */ void setNickName( const QString &nickName ); /* Return nick name. */ QString nickName() const; /* Set birthday. */ void setBirthday( const QDateTime &birthday ); /* Return birthday. */ QDateTime birthday() const; /* Set mail client. */ void setMailer( const QString &mailer ); /* Return mail client. */ QString mailer() const; /* Set time zone. */ void setTimeZone( const TimeZone &timeZone ); /* Return time zone. */ TimeZone timeZone() const; /* Set geographic position. */ void setGeo( const Geo &geo ); /* Return geographic position. */ Geo geo() const; /* Set title. */ void setTitle( const QString &title ); /* Return title. */ QString title() const; /* Set role. */ void setRole( const QString &role ); /* Return role. */ QString role() const; /* Set organization. */ void setOrganization( const QString &organization ); /* Return organization. */ QString organization() const; /* Set note. */ void setNote( const QString ¬e ); /* Return note. */ QString note() const; /* Set product identifier. */ void setProductId( const QString &productId ); /* Return product identifier. */ QString productId() const; /* Set revision date. */ void setRevision( const QDateTime &revision ); /* Return revision date. */ QDateTime revision() const; /* Set sort string. */ void setSortString( const QString &sortString ); /* Return sort string. */ QString sortString() const; /* Set URL. */ void setUrl( const KURL &url ); /* Return URL. */ KURL url() const; /** Set name fields by parsing the given string and trying to associate the parts of the string with according fields. This function should probably be a bit more clever. */ void setNameFromString( const QString & ); /** Return the name of the addressee. This is calculated from all the name fields. */ QString realName() const; /** Return email address including real name. @param email Email address to be used to construct the full email string. If this is QString::null the preferred email address is used. */ QString fullEmail( const QString &email=QString::null ) const; /** Insert an email address. If the email address already exists in this addressee it is not duplicated. @param email Email address @param preferred Set to true, if this is the preferred email address of the addressee. */ void insertEmail( const QString &email, bool preferred=false ); /** Remove email address. If the email address doesn't exist, nothing happens. */ void removeEmail( const QString &email ); /** Return preferred email address. This is the first email address or the last one added with @ref isnertEmail() with a set preferred parameter. */ QString preferredEmail() const; /** Return list of all email addresses. */ QStringList emails() const; /** Insert a phone number. If a phoen number with the same id already exists in this addressee it is not duplicated. */ void insertPhoneNumber( const PhoneNumber &phoneNumber ); /** Remove phone number. If no phone number with the given id exists for this addresse nothing happens. */ void removePhoneNumber( const PhoneNumber &phoneNumber ); /** Return phone number, which matches the given type. */ PhoneNumber phoneNumber( int type ) const; /** Return list of all phone numbers. */ PhoneNumber::List phoneNumbers() const; /** Return phone number with the given id. */ PhoneNumber findPhoneNumber( const QString &id ) const; /** Insert an address. If an address with the same id already exists in this addressee it is not duplicated. */ void insertAddress( const Address &address ); /** Remove address. If no address with the given id exists for this addresse nothing happens. */ void removeAddress( const Address &address ); /** Return address, which matches the given type. */ Address address( int type ) const; /** Return list of all addresses. */ Address::List addresses() const; /** Return address with the given id. */ Address findAddress( const QString &id ) const; /** Insert category. If the category already exists it is not dulicated. */ void insertCategory( const QString & ); /** Remove category. */ void removeCategory( const QString & ); /** Return, if addressee has the given category. */ bool hasCategory( const QString & ) const; /** Set categories to given value. */ void setCategories( const QStringList & ); /** Return list of all set categories. */ QStringList categories() const; /** Insert custom entry. The entry is identified by the name of the inserting application and a unique name. If an entry with the given app and name already exists its value is replaced with the ne given value. */ void insertCustom( const QString &app, const QString &name, const QString &value ); /** Remove custom entry. */ void removeCustom( const QString &app, const QString &name ); /** Return value of custom entry, identified by app and entry name. */ QString custom( const QString &app, const QString &name ) const; /** Set all custom entries. */ void setCustoms( const QStringList & ); /** Return list of all custom entries. */ QStringList customs() const; /** Debug output. */ void dump() const; private: Addressee copy(); void detach(); struct AddresseeData; KSharedPtr mData; }; } #endif
Generated by: hany on w1.md.megaloman.sk on Tue Aug 12 21:21:23 2003, using kdoc 2.0a54. |