1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/siprefertoheader.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,137 @@
     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        : siprefertoheader.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 CSIPREFERTOHEADER_H
    1.29 +#define CSIPREFERTOHEADER_H
    1.30 +
    1.31 +//  INCLUDES
    1.32 +#include "sipaddressheaderbase.h"
    1.33 +#include "_sipcodecdefs.h"
    1.34 +
    1.35 +// FORWARD DECLARATIONS
    1.36 +class CSIPAddress;
    1.37 +class CSIPHeaderGenericParams;
    1.38 +
    1.39 +// CLASS DECLARATION
    1.40 +/**
    1.41 +* @publishedAll
    1.42 +* @released
    1.43 +*
    1.44 +* Class provides functions for setting and getting parameters in SIP 
    1.45 +* "Refer-To" header.
    1.46 +*
    1.47 +*  @lib sipcodec.lib
    1.48 +*/
    1.49 +class CSIPReferToHeader : public CSIPAddressHeaderBase
    1.50 +	{
    1.51 +	public:	// Constructors and destructor
    1.52 +
    1.53 +		/**
    1.54 +		* Constructs a CSIPReferToHeader from textual representation 
    1.55 +		* of the header's value part.
    1.56 +		* @param aValue a value part of a "Refer-To"-header 
    1.57 +		*        (e.g. "User <user@host>")
    1.58 +		* @return a new instance of CSIPReferToHeader   
    1.59 +		*/
    1.60 +		IMPORT_C static CSIPReferToHeader* DecodeL(const TDesC8& aValue);
    1.61 +
    1.62 +		/**
    1.63 +		* Creates a new instance of CSIPReferToHeader
    1.64 +		* @pre aSIPAddress != 0
    1.65 +		* @param aSIPAddress a name-address, the ownership is transferred.
    1.66 +		* @return a new instance of CSIPReferToHeader
    1.67 +		*/
    1.68 +		IMPORT_C static CSIPReferToHeader* NewL(CSIPAddress* aSIPAddress);
    1.69 +
    1.70 +		/**
    1.71 +		* Creates a new instance of CSIPReferToHeader and puts it to CleanupStack
    1.72 +		* @pre aSIPAddress != 0
    1.73 +		* @param aSIPAddress a name-address, the ownership is transferred,
    1.74 +		* @return a new instance of CSIPReferToHeader
    1.75 +		*/
    1.76 +		IMPORT_C static CSIPReferToHeader* NewLC(CSIPAddress* aSIPAddress);
    1.77 +
    1.78 +		/**
    1.79 +		* Destructor, deletes the resources of CSIPReferToHeader.
    1.80 +		*/
    1.81 +		IMPORT_C virtual ~CSIPReferToHeader();
    1.82 +
    1.83 +
    1.84 +	public: // New functions
    1.85 +
    1.86 +		/**
    1.87 +		* Constructs an instance of a CSIPReferToHeader from a RReadStream
    1.88 +		* @param aReadStream a stream containing the value of the
    1.89 +		*        externalized object (header name not included). 
    1.90 +		* @return an instance of a CSIPReferToHeader
    1.91 +		*/
    1.92 +		IMPORT_C static CSIPHeaderBase* InternalizeValueL(RReadStream& aReadStream);
    1.93 +
    1.94 +
    1.95 +	public: // From CSIPHeaderBase
    1.96 +
    1.97 +		/**
    1.98 +		* From CSIPHeaderBase CloneL
    1.99 +		*/
   1.100 +		IMPORT_C CSIPHeaderBase* CloneL() const;
   1.101 +
   1.102 +		/**
   1.103 +		* From CSIPHeaderBase Name
   1.104 +		*/
   1.105 +		IMPORT_C RStringF Name() const;
   1.106 +
   1.107 +
   1.108 +	public: // From CSIPHeaderBase, for internal use
   1.109 +
   1.110 +        /**
   1.111 +        * @internalComponent
   1.112 +        */
   1.113 +		TBool HasCompactName() const;
   1.114 +		
   1.115 +        /**
   1.116 +        * @internalComponent
   1.117 +        */		
   1.118 +		RStringF CompactName() const;
   1.119 +		
   1.120 +        /**
   1.121 +        * @internalComponent
   1.122 +        */		
   1.123 +		TPreferredPlace PreferredPlaceInMessage() const;
   1.124 +
   1.125 +	public: // New functions, for internal use
   1.126 +
   1.127 +		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   1.128 +
   1.129 +	private: // Constructors
   1.130 +
   1.131 +		CSIPReferToHeader();
   1.132 +
   1.133 +    private: // For testing purposes
   1.134 +	
   1.135 +		UNIT_TEST(CSIPReferToHeaderTest)
   1.136 +	};
   1.137 +
   1.138 +#endif // end of CSIPREFERTOHEADER_H
   1.139 +
   1.140 +// End of File