Symbian^3 Application Developer Library >

Xml::RDocumentParameters Class Reference

class Xml::RDocumentParameters

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

Public Member Functions
RDocumentParameters ()
IMPORT_C const RString & CharacterSetName ()
IMPORT_C void Close ()
IMPORT_C void Open (const RString &)
Private Member Functions
RDocumentParameters (const RDocumentParameters &)
RDocumentParameters & operator= (const RDocumentParameters &)
Private Attributes
RString iCharacterSetName

Constructor & Destructor Documentation

RDocumentParameters()

IMPORT_C RDocumentParameters ( )

Default Constructor

Only Parsers have this access. CParser

RDocumentParameters(const RDocumentParameters &)

RDocumentParameters ( const RDocumentParameters & aOriginal ) [private]

Parameters

const RDocumentParameters & aOriginal

Member Functions Documentation

CharacterSetName()

IMPORT_C const RString & CharacterSetName ( ) const

This method returns a handle to the character encoding name, which is the Internet-standard name of a character set, which is identified in Symbian OS by its UID.

Pre-condition
The objects member have been pre-set accordingly.

Close()

IMPORT_C void Close ( )

This method cleans up the object before destruction. It releases all resources in accordance to the R Class pattern.

Post-condition
This object may be allowed to go out of scope.
Only Parsers have this access. CParser

Open(const RString &)

IMPORT_C void Open ( const RString & aCharacterSetName )

This method opens and sets all the parameters contents. We do not own any resources.

Pre-condition
The object has just been constructed.
Post-condition
The objects members have been set to the values given.
Only Parsers have this access. CParser

Parameters

const RString & aCharacterSetName the Internet-standard name of a character set, which is identified in Symbian OS by its UID.

operator=(const RDocumentParameters &)

RDocumentParameters & operator= ( const RDocumentParameters & aRhs ) [private]

Parameters

const RDocumentParameters & aRhs

Member Data Documentation

RString iCharacterSetName

RString iCharacterSetName [private]

The character encoding of the document. The Internet-standard name of a character set, which is identified in Symbian OS by its UID

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.