1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipacceptlanguageheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,178 @@
1.4 +/*
1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* 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
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Name : sipacceptlanguageheader.h
1.19 +* Part of : SIP Codec
1.20 +* Interface : SDK API, SIP Codec API
1.21 +* Version : SIP/4.0
1.22 +*
1.23 +*/
1.24 +
1.25 +
1.26 +
1.27 +
1.28 +#ifndef CSIPACCEPTLANGUAGEHEADER_H
1.29 +#define CSIPACCEPTLANGUAGEHEADER_H
1.30 +
1.31 +// INCLUDES
1.32 +#include "sipparameterheaderbase.h"
1.33 +#include "_sipcodecdefs.h"
1.34 +
1.35 +// FORWARD DECLARATIONS
1.36 +class CSIPAcceptHeaderParams;
1.37 +
1.38 +// CLASS DECLARATION
1.39 +/**
1.40 +* @publishedAll
1.41 +* @released
1.42 +*
1.43 +* Class provides functions for setting and getting media types and
1.44 +* parameters in SIP "Accept-Language" header.
1.45 +*
1.46 +* @lib sipcodec.lib
1.47 +*/
1.48 +class CSIPAcceptLanguageHeader : public CSIPParameterHeaderBase
1.49 + {
1.50 + public: // Constructors and destructor
1.51 +
1.52 + /**
1.53 + * Constructs a CSIPAcceptLanguageHeader from textual representation
1.54 + * of the header's value part.
1.55 + * @param aValue a value part of a "Accept-Language"-header
1.56 + * @return an array containing one to many instances of
1.57 + * CSIPAcceptLanguageHeader.
1.58 + */
1.59 + IMPORT_C static RPointerArray<CSIPAcceptLanguageHeader>
1.60 + DecodeL(const TDesC8& aValue);
1.61 +
1.62 + /**
1.63 + * Creates a new instance of CSIPAcceptLanguageHeader
1.64 + * @param aLanguageRange a language-range to set
1.65 + * @return a new instance of CSIPAcceptLanguageHeader
1.66 + */
1.67 + IMPORT_C static CSIPAcceptLanguageHeader*
1.68 + NewL(const TDesC8& aLanguageRange);
1.69 +
1.70 + /**
1.71 + * Creates a new instance of CSIPAcceptLanguageHeader and puts it onto
1.72 + * the cleanup stack
1.73 + * @param aLanguageRange a language-range to set
1.74 + * @return a new instance of CSIPAcceptLanguageHeader
1.75 + */
1.76 + IMPORT_C static CSIPAcceptLanguageHeader*
1.77 + NewLC(const TDesC8& aLanguageRange);
1.78 +
1.79 + /**
1.80 + * Destructor, deletes the resources of CSIPAcceptLanguageHeader.
1.81 + */
1.82 + IMPORT_C ~CSIPAcceptLanguageHeader();
1.83 +
1.84 +
1.85 + public: // New functions
1.86 +
1.87 + /**
1.88 + * Gets the language-range from the "Accept-Language" header
1.89 + * @return a language-range
1.90 + */
1.91 + IMPORT_C const TDesC8& LanguageRange() const;
1.92 +
1.93 + /**
1.94 + * Sets the language-range in the "Accept-Language" header
1.95 + * @param aLanguageRange a language-range
1.96 + */
1.97 + IMPORT_C void SetLanguageRangeL(const TDesC8& aLanguageRange);
1.98 +
1.99 + /**
1.100 + * Gets the value of "q"-parameter
1.101 + * @return the "q"-parameter value
1.102 + */
1.103 + IMPORT_C TReal QParameter() const;
1.104 +
1.105 + /**
1.106 + * Sets the "q"-parameter value
1.107 + * @param aQValue a "q"-parameter value to set
1.108 + */
1.109 + IMPORT_C void SetQParameterL(TReal aQValue);
1.110 +
1.111 + /**
1.112 + * Constructs an instance of a CSIPAcceptLanguageHeader from a RReadStream
1.113 + * @param aReadStream a stream containing the value of the
1.114 + * externalized header object (header name not included).
1.115 + * @return an instance of a CSIPAcceptLanguageHeader
1.116 + */
1.117 + IMPORT_C static CSIPHeaderBase*
1.118 + InternalizeValueL(RReadStream& aReadStream);
1.119 +
1.120 +
1.121 + public: // From CSIPHeaderBase
1.122 +
1.123 + /**
1.124 + * From CSIPHeaderBase CloneL
1.125 + */
1.126 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.127 +
1.128 + /**
1.129 + * From CSIPHeaderBase Name
1.130 + */
1.131 + IMPORT_C RStringF Name() const;
1.132 +
1.133 +
1.134 + public: // From CSIPHeaderBase, for internal use
1.135 +
1.136 + /**
1.137 + * @internalComponent
1.138 + */
1.139 + TBool MoreThanOneAllowed() const;
1.140 +
1.141 + /**
1.142 + * @internalComponent
1.143 + */
1.144 + TPreferredPlace PreferredPlaceInMessage() const;
1.145 +
1.146 + public: // New functions, for internal use
1.147 +
1.148 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.149 +
1.150 + private: // From CSIPHeaderBase
1.151 +
1.152 + void ExternalizeValueL(RWriteStream& aWriteStream) const;
1.153 +
1.154 + private: // From CSIPParameterHeaderBase
1.155 +
1.156 + HBufC8* ToTextMandatoryPartLC() const;
1.157 + void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
1.158 + const CSIPParamContainerBase& Params() const;
1.159 + CSIPParamContainerBase& Params();
1.160 +
1.161 + private: // New functions
1.162 +
1.163 + CSIPAcceptLanguageHeader();
1.164 + void ConstructL();
1.165 + void ConstructL(const TDesC8& aLanguageRange);
1.166 + void ConstructL(const CSIPAcceptLanguageHeader& aAcceptLanguageHeader);
1.167 + void DoInternalizeValueL(RReadStream& aReadStream);
1.168 +
1.169 + private: // Data
1.170 +
1.171 + HBufC8* iLanguageRange;
1.172 + CSIPAcceptHeaderParams* iParams;
1.173 +
1.174 + private: // For testing purposes
1.175 +
1.176 + UNIT_TEST(CSIPAcceptLanguageHeaderTest)
1.177 + };
1.178 +
1.179 +#endif // CSIPACCEPTLANGUAGEHEADER_H
1.180 +
1.181 +// End of File