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@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.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        : siptoheader.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 CSIPTOHEADER_H
williamr@2: #define CSIPTOHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipfromtoheaderbase.h"
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 SIP "To" header fields.
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPToHeader : public CSIPFromToHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPToHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "To"-header (e.g. "User <user@host>")
williamr@2: 		* @return a new instance of CSIPToHeader 
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPToHeader* DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPToHeader
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred,
williamr@2: 		* @return a new instance of CSIPToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPToHeader* NewL(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPToHeader and puts it to CleanupStack
williamr@2: 		* @pre aSIPAddress != 0
williamr@2: 		* @param aSIPAddress a name-address, the ownership is transferred,
williamr@2: 		* @return a new instance of CSIPToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPToHeader* NewLC(CSIPAddress* aSIPAddress);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a deep-copy of a CSIPFromToHeaderBase
williamr@2: 		* Note that this function can be used for creating a To-header
williamr@2: 		* using an existing From-header.
williamr@2: 		* @param aHeader CSIPFromToHeaderBase to be copied
williamr@2: 		* @return a new instance of CSIPToHeader
williamr@2: 		*/
williamr@2: 
williamr@2: 		IMPORT_C static CSIPToHeader* 
williamr@2: 			NewL(const CSIPFromToHeaderBase& aHeader);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a deep-copy of a CSIPFromToHeaderBase and 
williamr@2: 		* puts it to CleanupStack
williamr@2: 		* Note that this function can be used for creating a To-header
williamr@2: 		* using an existing From-header.
williamr@2: 		* @param aHeader CSIPFromToHeaderBaseto to be copied
williamr@2: 		* @return a new instance of CSIPToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPToHeader* 
williamr@2: 			NewLC(const CSIPFromToHeaderBase& aHeader);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPToHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPToHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPToHeader from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized object (header name not included). 
williamr@2: 		* @return an instance of a CSIPToHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPHeaderBase* 
williamr@2: 			InternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase
williamr@2: 		
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase CloneL
williamr@2: 		*/
williamr@2: 		IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* From CSIPHeaderBase Name
williamr@2: 		*/
williamr@2: 		IMPORT_C RStringF Name() const;
williamr@2: 
williamr@2: 
williamr@2: 	public: // From CSIPHeaderBase, for internal use
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2: 		RStringF CompactName() const;
williamr@2: 
williamr@2: 	public: // New functions, for internal use
williamr@2: 
williamr@2: 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 	private: // Constructors
williamr@2: 
williamr@2: 		CSIPToHeader();
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPTOHEADER_H
williamr@2: 
williamr@2: // End of File