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        : sipacceptlanguageheader.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 CSIPACCEPTLANGUAGEHEADER_H
williamr@2: #define CSIPACCEPTLANGUAGEHEADER_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipparameterheaderbase.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPAcceptHeaderParams;
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 media types and
williamr@2: * parameters in SIP "Accept-Language" header.
williamr@2: *
williamr@2: * @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPAcceptLanguageHeader : public CSIPParameterHeaderBase
williamr@2: 	{
williamr@2: 	public: // Constructors and destructor
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs a CSIPAcceptLanguageHeader from textual representation 
williamr@2: 		* of the header's value part.
williamr@2: 		* @param aValue a value part of a "Accept-Language"-header
williamr@2: 		* @return an array containing one to many instances of 
williamr@2: 		* 		   CSIPAcceptLanguageHeader. 
williamr@2: 		*/
williamr@2: 		IMPORT_C static RPointerArray<CSIPAcceptLanguageHeader> 
williamr@2: 			DecodeL(const TDesC8& aValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPAcceptLanguageHeader
williamr@2: 		* @param aLanguageRange a language-range to set
williamr@2: 		* @return a new instance of CSIPAcceptLanguageHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPAcceptLanguageHeader* 
williamr@2: 			NewL(const TDesC8& aLanguageRange);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Creates a new instance of CSIPAcceptLanguageHeader and puts it onto
williamr@2: 		* the cleanup stack
williamr@2: 		* @param aLanguageRange a language-range to set
williamr@2: 		* @return a new instance of CSIPAcceptLanguageHeader
williamr@2: 		*/
williamr@2: 		IMPORT_C static CSIPAcceptLanguageHeader* 
williamr@2: 			NewLC(const TDesC8& aLanguageRange);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Destructor, deletes the resources of CSIPAcceptLanguageHeader.
williamr@2: 		*/
williamr@2: 		IMPORT_C ~CSIPAcceptLanguageHeader();
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the language-range from the "Accept-Language" header
williamr@2: 		* @return a language-range
williamr@2: 		*/
williamr@2: 		IMPORT_C const TDesC8& LanguageRange() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the language-range in the "Accept-Language" header
williamr@2: 		* @param aLanguageRange a language-range
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetLanguageRangeL(const TDesC8& aLanguageRange);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the value of "q"-parameter
williamr@2: 		* @return the "q"-parameter value
williamr@2: 		*/
williamr@2: 		IMPORT_C TReal QParameter() const;
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Sets the "q"-parameter value
williamr@2: 		* @param aQValue a "q"-parameter value to set
williamr@2: 		*/
williamr@2: 		IMPORT_C void SetQParameterL(TReal aQValue);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Constructs an instance of a CSIPAcceptLanguageHeader from a RReadStream
williamr@2: 		* @param aReadStream a stream containing the value of the
williamr@2: 		*        externalized header object (header name not included).
williamr@2: 		* @return an instance of a CSIPAcceptLanguageHeader
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: 		TBool MoreThanOneAllowed() const;
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: // New functions
williamr@2: 
williamr@2: 		CSIPAcceptLanguageHeader();
williamr@2: 		void ConstructL();
williamr@2: 		void ConstructL(const TDesC8& aLanguageRange);
williamr@2: 		void ConstructL(const CSIPAcceptLanguageHeader& aAcceptLanguageHeader);
williamr@2: 		void DoInternalizeValueL(RReadStream& aReadStream);
williamr@2: 
williamr@2: 	private: // Data
williamr@2: 
williamr@2: 		HBufC8* iLanguageRange;
williamr@2: 		CSIPAcceptHeaderParams* iParams;
williamr@2: 
williamr@2: 	private: // For testing purposes
williamr@4: #ifdef CPPUNIT_TEST	
williamr@4: 		friend class CSIPAcceptLanguageHeaderTest;
williamr@4: #endif
williamr@2: 	};
williamr@2: 
williamr@2: #endif // CSIPACCEPTLANGUAGEHEADER_H
williamr@2: 
williamr@2: // End of File