epoc32/include/mw/sipfromtoheaderbase.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/sipfromtoheaderbase.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,135 @@
     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        : sipfromtoheaderbase.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 CSIPFROMTOHEADERBASE_H
    1.29 +#define CSIPFROMTOHEADERBASE_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 CSIPAddress;
    1.37 +class CSIPFromToHeaderParams;
    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 "From"
    1.45 +* and "To" header.
    1.46 +*
    1.47 +* This is an abstract class and cannot be instantiated.
    1.48 +*
    1.49 +* @lib sipcodec.lib
    1.50 +*/
    1.51 +class CSIPFromToHeaderBase : public CSIPParameterHeaderBase
    1.52 +	{
    1.53 +	public: // Constructors and destructor
    1.54 +
    1.55 +		/**
    1.56 +		* Destructor, deletes the resources of CSIPFromToHeaderBase.
    1.57 +		*/
    1.58 +		IMPORT_C virtual ~CSIPFromToHeaderBase();
    1.59 +
    1.60 +
    1.61 +	public: // New functions
    1.62 +
    1.63 +		/**
    1.64 +		* Compares this instance to another "From" or "To" header object
    1.65 +		* @param aHeader a header to compare to
    1.66 +		* @return ETrue, if the objects are equal otherwise EFalse
    1.67 +		*/
    1.68 +		IMPORT_C TBool operator==(const CSIPFromToHeaderBase& aHeader) const;
    1.69 +
    1.70 +		/**
    1.71 +		* Sets the name-address
    1.72 +		* @pre aSIPAddress != 0
    1.73 +		* @param aSIPAddress a name-address to set, the ownership is transferred
    1.74 +		*/
    1.75 +		IMPORT_C void SetSIPAddressL(CSIPAddress* aSIPAddress);
    1.76 +
    1.77 +		/**
    1.78 +		* Gets the name-address as const
    1.79 +		* @return name-address object
    1.80 +		*/
    1.81 +		IMPORT_C const CSIPAddress& SIPAddress() const;
    1.82 +
    1.83 +		/**
    1.84 +		* Gets the name-address
    1.85 +		* @return name-address object
    1.86 +		*/
    1.87 +		IMPORT_C CSIPAddress& SIPAddress();
    1.88 +
    1.89 +
    1.90 +	public: // From CSIPHeaderBase, for internal use
    1.91 +
    1.92 +        /**
    1.93 +        * @internalComponent
    1.94 +        */
    1.95 +		TBool HasCompactName() const;
    1.96 +		
    1.97 +        /**
    1.98 +        * @internalComponent
    1.99 +        */		
   1.100 +		TPreferredPlace PreferredPlaceInMessage() const;
   1.101 +
   1.102 +	protected: // Constructors
   1.103 +
   1.104 +		CSIPFromToHeaderBase();
   1.105 +		void ConstructL();
   1.106 +		void ConstructL(CSIPAddress* aSIPAddress);
   1.107 +		void ConstructL(CSIPAddress* aSIPAddress, const TDesC8& aTag);
   1.108 +		void ConstructL(const CSIPFromToHeaderBase& aSIPFromToHeaderBase);
   1.109 +
   1.110 +	protected: // New functions
   1.111 +
   1.112 +		void DoInternalizeValueL(RReadStream& aReadStream);
   1.113 +
   1.114 +	private: // From CSIPHeaderBase
   1.115 +
   1.116 +		void ExternalizeValueL(RWriteStream& aWriteStream) const;
   1.117 +
   1.118 +	private: // From CSIPParameterHeaderBase
   1.119 +
   1.120 +		HBufC8* ToTextMandatoryPartLC() const;
   1.121 +		void ParseMandatoryPartL(const TDesC8& aMandatoryPart);
   1.122 +		const CSIPParamContainerBase& Params() const;
   1.123 +		CSIPParamContainerBase& Params();
   1.124 +
   1.125 +	private: // Data
   1.126 +
   1.127 +		CSIPAddress* iSIPAddress;
   1.128 +		CSIPFromToHeaderParams* iParams;
   1.129 +
   1.130 +private: // For testing purposes
   1.131 +	
   1.132 +		UNIT_TEST(CSIPFromToHeaderTest)
   1.133 +	};
   1.134 +
   1.135 +
   1.136 +#endif // CSIPFROMTOHEADERBASE_H
   1.137 +
   1.138 +// End of File