williamr@2: /*
williamr@2: * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : sipfromtoheaderbase.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0 
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPFROMTOHEADERBASE_H
williamr@2: #define CSIPFROMTOHEADERBASE_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipparameterheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPAddress;
williamr@2: class CSIPFromToHeaderParams;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * Class provides functions for setting and getting parameters in SIP "From"
williamr@2: * and "To" header.
williamr@2: *
williamr@2: * This is an abstract class and cannot be instantiated.
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPFromToHeaderBase : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public: // Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPFromToHeaderBase.
williamr@2: 		*/
williamr@2: 		IMPORT_C virtual ~CSIPFromToHeaderBase();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Compares this instance to another "From" or "To" header object
williamr@2: 		* @param aHeader a header to compare to
williamr@2: 		* @return ETrue, if the objects are equal otherwise EFalse
williamr@2: 		*/
williamr@2: 		IMPORT_C TBool operator==(const CSIPFromToHeaderBase& aHeader) const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the name-address
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address to set, the ownership is transferred
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the name-address as const
williamr@2: 		* @return name-address object
williamr@2: 		*/
williamr@2: 		IMPORT_C const CSIPAddress& SIPAddress() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the name-address
williamr@2: 		* @return name-address object
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPAddress& SIPAddress();
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2: 		TBool HasCompactName() const;
williamr@2: 		
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */		
williamr@2: 		TPreferredPlace PreferredPlaceInMessage() const;
williamr@2: 
williamr@2: 	protected: // Constructors
williamr@2: 
williamr@2: 		CSIPFromToHeaderBase();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(CSIPAddress* aSIPAddress);
williamr@2: 		void ConstructL(CSIPAddress* aSIPAddress, const TDesC8& aTag);
williamr@2: 		void ConstructL(const CSIPFromToHeaderBase& aSIPFromToHeaderBase);
williamr@2: 
williamr@2: 	protected: // New functions
williamr@2: 
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // From CSIPHeaderBase
williamr@2: 
williamr@2: 		void ExternalizeValueL(RWriteStream& aWriteStream) const;
williamr@2: 
williamr@2: 	private: // From CSIPParameterHeaderBase
williamr@2: 
williamr@2: 		HBufC8* ToTextMandatoryPartLC() const;
williamr@2: 		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
williamr@2: 		const CSIPParamContainerBase& Params() const;
williamr@2: 		CSIPParamContainerBase& Params();
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		CSIPAddress* iSIPAddress;
williamr@2: 		CSIPFromToHeaderParams* iParams;
williamr@2: 
williamr@2: private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPFromToHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: #endif // CSIPFROMTOHEADERBASE_H
williamr@2: 
williamr@2: // End of File