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        : sipcontentdispositionheader.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 CSIPCONTENTDISPOSITIONHEADER_H
williamr@2: #define CSIPCONTENTDISPOSITIONHEADER_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 CSIPHeaderGenericParams;
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 
williamr@2: * SIP "Content-Disposition" header.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPContentDispositionHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPContentDispositionHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Content-Disposition"-header
williamr@2: 		* @return a new instance of CSIPContentDispositionHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPContentDispositionHeader* 
williamr@2: 			DecodeL (const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPContentDispositionHeader
williamr@2: 		* @param aDispType a Disp-Type value
williamr@2: 		* @return a new instance of CSIPContentDispositionHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPContentDispositionHeader* 
williamr@2: 			NewL(const TDesC8& aDispType);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPContentDispositionHeader 
williamr@2: 		* and puts it to CleanupStack
williamr@2: 		* @param aDispType a Disp-Type value
williamr@2: 		* @return a new instance of CSIPContentDispositionHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPContentDispositionHeader* 
williamr@2: 			NewLC(const TDesC8& aDispType);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor. deletes the resources of CSIPContentDispositionHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPContentDispositionHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the disp-type parameter from the "Content-Disposition" header
williamr@2: 		* @return the disp-type parameter
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& DispType() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the disp-type parameter in the "Content-Disposition" header; 
williamr@2: 		* @param aTag a disp-type parameter to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetDispTypeL(const TDesC8& aDispType);
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPContentDispositionHeader 
williamr@2: 		* 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 CSIPContentDispositionHeader
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: 		TPreferredPlace PreferredPlaceInMessage() 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: // 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: // Constructors
williamr@2: 
williamr@2: 		CSIPContentDispositionHeader();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aDispType);
williamr@2: 		void ConstructL(const TDesC8& aDispType, const TDesC8& aHandlingParam);
williamr@2: 		void ConstructL(const CSIPContentDispositionHeader& aHeader);
williamr@2: 
williamr@2: 	private: // New functions
williamr@2: 
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		HBufC8* iDispType;
williamr@2: 		CSIPHeaderGenericParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@2: 	
williamr@2: 		UNIT_TEST(CSIPContentDispositionHeaderTest)
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPCONTENTDISPOSITIONHEADER_H
williamr@2: 
williamr@2: // End of File