1 documentparameters.h

     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // 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

     5 // which accompanies this distribution, and is available

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

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __DOCUMENTPARAMETERS_H__

    17 #define __DOCUMENTPARAMETERS_H__

    18 

    19 

    20 #include <stringpool.h>

    21 

    22 namespace Xml

    23 {

    24 

    25 class RDocumentParameters

    26 /**

    27 The RDocumentParameters class contains information about the document to be passed to the client.

    28 

    29 @publishedAll

    30 @released

    31 */

    32 	{

    33 public:

    34 

    35 /**

    36 @publishedPartner

    37 @released

    38 */

    39 	IMPORT_C RDocumentParameters();

    40 

    41 /**

    42 @publishedPartner

    43 @released

    44 */

    45 	IMPORT_C void Close();

    46 

    47 /**

    48 @publishedPartner

    49 @released

    50 */

    51 	IMPORT_C void Open(const RString& aCharacterSetName);

    52 

    53 	IMPORT_C const RString& CharacterSetName() const;

    54 

    55 private:

    56 

    57 

    58 /**

    59 @publishedPartner

    60 @released

    61 */

    62 	RDocumentParameters(const RDocumentParameters& aOriginal);

    63 

    64 /**

    65 @publishedPartner

    66 @released

    67 */

    68 	RDocumentParameters &operator=(const RDocumentParameters& aRhs);

    69 

    70 private:

    71 

    72 /**

    73 The character encoding of the document.

    74 The Internet-standard name of a character set, which is identified in Symbian OS by its UID

    75 */

    76 	RString	iCharacterSetName;

    77 

    78 	};

    79 

    80 }

    81 

    82 #endif