test: epoc32/include/sipstrings.h@2fe1408b6811

     1 /*

     2 * Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * 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

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : sipstrings.h

    16 * Part of     : SIP Codec

    17 * Interface   : SDK API, SIP Codec API

    18 * Version     : SIP/4.0

    19 *

    20 */

    24 #ifndef SIPSTRINGS_H

    25 #define SIPSTRINGS_H

    27 //  INCLUDES

    28 #include <e32base.h>

    29 #include <stringpool.h>

    30 #include "_sipcodecdefs.h"

    32 // FORWARD DECLARATIONS

    33 class CSIPStrings;

    35 // CLASS DECLARATION

    36 /**

    37  * @publishedAll

    38  * @released

    39  *

    40  * This class defines string pool for SIP Codec.

    41  * The client of SIP Codec must call OpenL() before

    42  * invoking any function of SIP Codec classes.

    43  * The client must close the string pool when finished using

    44  * SIP Codec classes.

    45  *

    46  * @lib sipcodec.lib

    47  */

    48 class SIPStrings

    49 	{

    50 	public:	// Constructors and destructor

    52 		/**

    53 		* Opens SIP Codec string pool.

    54 		* Implemented with a reference count.

    55 		*/

    56 		IMPORT_C static void OpenL();

    58 		/**

    59 		* Closes SIP Codec string pool.

    60 		* In other words decrements reference count and if it reaches

    61 		* zero, closes the string pool.

    62 		* The user must not call Close() if it has not called OpenL().

    63 		*/

    64 		IMPORT_C static void Close();

    67 	public: // New functions

    69 		/**

    70 		* Gets a case-insensitive string specified

    71 		* in the original string table.

    72 		*

    73 		* @param aIndex The string table enumeration value

    74 		* @return Initialised RStringF object

    75 		*/

    76 		IMPORT_C static RStringF StringF(TInt aIndex);

    78 		/**

    79 		* Gets the string pool used by SIP Codec.

    80 		*

    81 		* @return RStringPool: A handle to a string pool

    82 		*/

    83 		IMPORT_C static RStringPool Pool();

    85 		/**

    86 		* Gets the string table used by SIP Codec.

    87 		*

    88 		* @return TStringTable&: The string pool table

    89 		*/

    90 		IMPORT_C static const TStringTable& Table();

    92 	private:

    94 		static CSIPStrings* Strings();

    95 		};

    97 #endif // SIPSTRINGS_H

    99 // End of File

author	William Roberts <williamr@symbian.org>
	Tue, 16 Mar 2010 16:12:26 +0000
branch	Symbian2
changeset 2	2fe1408b6811
parent 0	061f57f2323e
permissions	-rw-r--r--