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        : sipstrings.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: #ifndef SIPSTRINGS_H
williamr@2: #define SIPSTRINGS_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32base.h>
williamr@2: #include <stringpool.h>
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPStrings;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2:  * @publishedAll
williamr@2:  * @released
williamr@2:  *
williamr@2:  * This class defines string pool for SIP Codec.
williamr@2:  * The client of SIP Codec must call OpenL() before 
williamr@2:  * invoking any function of SIP Codec classes.
williamr@2:  * The client must close the string pool when finished using
williamr@2:  * SIP Codec classes.
williamr@2:  *
williamr@2:  * @lib sipcodec.lib
williamr@2:  */
williamr@2: class SIPStrings
williamr@2: 	{
williamr@2: 	public:	// Constructors and destructor
williamr@2:  		
williamr@2: 		/**
williamr@2: 		* Opens SIP Codec string pool.
williamr@2: 		* Implemented with a reference count.
williamr@2: 		*/
williamr@2: 		IMPORT_C static void OpenL();
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Closes SIP Codec string pool.
williamr@2: 		* In other words decrements reference count and if it reaches
williamr@2: 		* zero, closes the string pool.	 
williamr@2: 		* The user must not call Close() if it has not called OpenL().
williamr@2: 		*/
williamr@2: 		IMPORT_C static void Close(); 
williamr@2: 
williamr@2: 
williamr@2: 	public: // New functions
williamr@2: 	
williamr@2: 		/**
williamr@2: 		* Gets a case-insensitive string specified 
williamr@2: 		* in the original string table.
williamr@2: 		*
williamr@2: 		* @param aIndex The string table enumeration value
williamr@2: 		* @return Initialised RStringF object
williamr@2: 		*/
williamr@2: 		IMPORT_C static RStringF StringF(TInt aIndex);
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the string pool used by SIP Codec.
williamr@2: 		*
williamr@2: 		* @return RStringPool: A handle to a string pool
williamr@2: 		*/
williamr@2: 		IMPORT_C static RStringPool Pool();
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Gets the string table used by SIP Codec.
williamr@2: 		*
williamr@2: 		* @return TStringTable&: The string pool table
williamr@2: 		*/
williamr@2: 		IMPORT_C static const TStringTable& Table();
williamr@2: 	
williamr@2: 	private:
williamr@2: 
williamr@2: 		static CSIPStrings* Strings();
williamr@2: 		};
williamr@2: 
williamr@2: #endif // SIPSTRINGS_H
williamr@2: 
williamr@2: // End of File