xml/xmlfw/src/xmlframework/documentparameters.cpp
changeset 0 e35f40988205
equal deleted inserted replaced
-1:000000000000 0:e35f40988205
       
     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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #include <xml/documentparameters.h>
       
    17 
       
    18 using namespace Xml;
       
    19 
       
    20 
       
    21 EXPORT_C RDocumentParameters::RDocumentParameters()
       
    22 /**
       
    23 Default Constructor
       
    24 
       
    25 Only Parsers have this access.
       
    26 @see CParser
       
    27 */
       
    28 	{
       
    29 	// do nothing;
       
    30 	}
       
    31 
       
    32 
       
    33 
       
    34 EXPORT_C void RDocumentParameters::Close()
       
    35 /**
       
    36 This method cleans up the object before destruction. It releases all resources in
       
    37 accordance to the R Class pattern.
       
    38 
       
    39 @post				This object may be allowed to go out of scope.
       
    40 
       
    41 Only Parsers have this access.
       
    42 @see CParser
       
    43 
       
    44 */
       
    45 	{
       
    46 	iCharacterSetName.Close();
       
    47 	}
       
    48 
       
    49 
       
    50 
       
    51 EXPORT_C void RDocumentParameters::Open(const RString& aCharacterSetName)
       
    52 /**
       
    53 This method opens and sets all the parameters contents.
       
    54 We do not own any resources.
       
    55 
       
    56 @pre				The object has just been constructed.
       
    57 @post				The objects members have been set to the values given.
       
    58 
       
    59 @param				aCharacterSetName the Internet-standard name of a character set, 
       
    60 					which is identified in Symbian OS by its UID.
       
    61 
       
    62 Only Parsers have this access.
       
    63 @see CParser
       
    64 
       
    65 */
       
    66 	{
       
    67 	iCharacterSetName = aCharacterSetName;
       
    68 	}
       
    69 
       
    70 
       
    71 
       
    72 EXPORT_C const RString& RDocumentParameters::CharacterSetName() const
       
    73 /**
       
    74 This method returns a handle to the character encoding name, which is 
       
    75 the Internet-standard name of a character set, which is identified in Symbian OS by its UID.
       
    76 
       
    77 @return				The character encoding name.
       
    78 
       
    79 @pre				The objects member have been pre-set accordingly.
       
    80 
       
    81 */
       
    82 	{
       
    83 	return iCharacterSetName;
       
    84 	}