epoc32/include/xml/documentparameters.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __DOCUMENTPARAMETERS_H__
williamr@2
    17
#define __DOCUMENTPARAMETERS_H__
williamr@2
    18
williamr@2
    19
williamr@2
    20
#include <stringpool.h>
williamr@2
    21
williamr@2
    22
namespace Xml
williamr@2
    23
{
williamr@2
    24
williamr@2
    25
class RDocumentParameters
williamr@2
    26
/**
williamr@2
    27
The RDocumentParameters class contains information about the document to be passed to the client.
williamr@2
    28
williamr@2
    29
@publishedAll
williamr@2
    30
@released
williamr@2
    31
*/
williamr@2
    32
	{
williamr@2
    33
public:
williamr@2
    34
williamr@2
    35
/**
williamr@2
    36
@publishedPartner
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
	IMPORT_C RDocumentParameters();
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
@publishedPartner
williamr@2
    43
@released
williamr@2
    44
*/
williamr@2
    45
	IMPORT_C void Close();
williamr@2
    46
williamr@2
    47
/**
williamr@2
    48
@publishedPartner
williamr@2
    49
@released
williamr@2
    50
*/
williamr@2
    51
	IMPORT_C void Open(const RString& aCharacterSetName);
williamr@2
    52
williamr@2
    53
	IMPORT_C const RString& CharacterSetName() const;
williamr@2
    54
williamr@2
    55
private:
williamr@2
    56
williamr@2
    57
williamr@2
    58
/**
williamr@2
    59
@publishedPartner
williamr@2
    60
@released
williamr@2
    61
*/
williamr@2
    62
	RDocumentParameters(const RDocumentParameters& aOriginal);
williamr@2
    63
williamr@2
    64
/**
williamr@2
    65
@publishedPartner
williamr@2
    66
@released
williamr@2
    67
*/
williamr@2
    68
	RDocumentParameters &operator=(const RDocumentParameters& aRhs);
williamr@2
    69
williamr@2
    70
private:
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
The character encoding of the document.
williamr@2
    74
The Internet-standard name of a character set, which is identified in Symbian OS by its UID
williamr@2
    75
*/
williamr@2
    76
	RString	iCharacterSetName;
williamr@2
    77
williamr@2
    78
	};
williamr@2
    79
williamr@2
    80
}
williamr@2
    81
williamr@2
    82
#endif