epoc32/include/xml/attribute.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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 __ATTRIBUTE_H__
williamr@2
    17
#define __ATTRIBUTE_H__
williamr@2
    18
williamr@2
    19
#include <xml/taginfo.h>
williamr@2
    20
williamr@2
    21
namespace Xml
williamr@2
    22
{
williamr@2
    23
williamr@2
    24
enum TAttributeType
williamr@2
    25
/**
williamr@2
    26
Specifies the type of this attribute object.
williamr@2
    27
These values are defined in the xml specification.
williamr@2
    28
For other specifications they may also be used or 'none'.
williamr@2
    29
@see http://www.w3.org/TR/REC-xml#sec-attribute-types
williamr@2
    30
williamr@2
    31
@publishedAll
williamr@2
    32
@released
williamr@2
    33
*/
williamr@2
    34
	{
williamr@2
    35
/**
williamr@2
    36
Specifies a string type.
williamr@2
    37
*/
williamr@2
    38
	EAttributeType_CDATA,
williamr@2
    39
williamr@2
    40
/**
williamr@2
    41
Specifies a tokenized type.
williamr@2
    42
*/
williamr@2
    43
	EAttributeType_ID,
williamr@2
    44
williamr@2
    45
/**
williamr@2
    46
Specifies a tokenized type.
williamr@2
    47
*/		
williamr@2
    48
	EAttributeType_IDREF,
williamr@2
    49
williamr@2
    50
/**
williamr@2
    51
Specifies a tokenized type.
williamr@2
    52
*/	
williamr@2
    53
	EAttributeType_IDREFS,
williamr@2
    54
williamr@2
    55
/**
williamr@2
    56
Specifies a tokenized type.
williamr@2
    57
*/	
williamr@2
    58
	EAttributeType_NMTOKEN,
williamr@2
    59
williamr@2
    60
/**
williamr@2
    61
Specifies a tokenized type.
williamr@2
    62
*/	
williamr@2
    63
	EAttributeType_NMTOKENS,
williamr@2
    64
williamr@2
    65
/**
williamr@2
    66
Specifies a tokenized type.
williamr@2
    67
*/	
williamr@2
    68
	EAttributeType_ENTITY,
williamr@2
    69
williamr@2
    70
/**
williamr@2
    71
Specifies a tokenized type.
williamr@2
    72
*/	
williamr@2
    73
	EAttributeType_ENTITIES,
williamr@2
    74
williamr@2
    75
/**
williamr@2
    76
Specifies a tokenized type.
williamr@2
    77
*/	
williamr@2
    78
	EAttributeType_NOTATION,
williamr@2
    79
williamr@2
    80
/**
williamr@2
    81
Specifies no type, or unsupported.
williamr@2
    82
*/	
williamr@2
    83
	EAttributeType_NONE,
williamr@2
    84
williamr@2
    85
	};
williamr@2
    86
williamr@2
    87
williamr@2
    88
williamr@2
    89
williamr@2
    90
class RAttribute
williamr@2
    91
/**
williamr@2
    92
The RAttribute class holds an attribute's description belonging to an element.
williamr@2
    93
@see RAttributeArray
williamr@2
    94
williamr@2
    95
@publishedAll
williamr@2
    96
@released
williamr@2
    97
*/
williamr@2
    98
	{
williamr@2
    99
public:
williamr@2
   100
williamr@2
   101
/**
williamr@2
   102
@publishedPartner
williamr@2
   103
@released
williamr@2
   104
*/
williamr@2
   105
	IMPORT_C RAttribute();
williamr@2
   106
williamr@2
   107
/**
williamr@2
   108
@publishedPartner
williamr@2
   109
@released
williamr@2
   110
*/
williamr@2
   111
	IMPORT_C RAttribute Copy();
williamr@2
   112
williamr@2
   113
/**
williamr@2
   114
@publishedPartner
williamr@2
   115
@released
williamr@2
   116
*/
williamr@2
   117
	IMPORT_C void Close();
williamr@2
   118
williamr@2
   119
/**
williamr@2
   120
@publishedPartner
williamr@2
   121
@released
williamr@2
   122
*/
williamr@2
   123
	IMPORT_C void Open(const RString& aUri, const RString& aPrefix, const RString& aLocalName,
williamr@2
   124
					   const TAttributeType aType = EAttributeType_NONE);
williamr@2
   125
					   
williamr@2
   126
/**
williamr@2
   127
@publishedPartner
williamr@2
   128
@released
williamr@2
   129
*/
williamr@2
   130
	IMPORT_C void Open(const RString& aUri, const RString& aPrefix, const RString& aLocalName,
williamr@2
   131
					   const RString& aValue, const TAttributeType aType = EAttributeType_NONE);
williamr@2
   132
williamr@2
   133
	IMPORT_C const RTagInfo& Attribute() const;
williamr@2
   134
	IMPORT_C const RString& Value() const;
williamr@2
   135
	IMPORT_C TAttributeType Type() const;
williamr@2
   136
williamr@2
   137
/**
williamr@2
   138
@publishedPartner
williamr@2
   139
@released
williamr@2
   140
*/
williamr@2
   141
	IMPORT_C void SetValue(const RString& aValue);
williamr@2
   142
williamr@2
   143
private:
williamr@2
   144
williamr@2
   145
/**
williamr@2
   146
Holds information about the attribute.
williamr@2
   147
*/
williamr@2
   148
	RTagInfo iAttribute;
williamr@2
   149
williamr@2
   150
/**
williamr@2
   151
Holds the attribute's value.
williamr@2
   152
*/
williamr@2
   153
	RString iValue;
williamr@2
   154
williamr@2
   155
/**
williamr@2
   156
Holds the attribute's type.
williamr@2
   157
*/
williamr@2
   158
	TAttributeType iType;
williamr@2
   159
williamr@2
   160
	};
williamr@2
   161
williamr@2
   162
williamr@2
   163
/**
williamr@2
   164
Defines a list of attributes for an element.
williamr@2
   165
@see MContentHandler
williamr@2
   166
williamr@2
   167
@publishedAll
williamr@2
   168
@released
williamr@2
   169
*/
williamr@2
   170
typedef RArray<RAttribute> RAttributeArray; 
williamr@2
   171
williamr@2
   172
}
williamr@2
   173
williamr@2
   174
#endif //__ATTRIBUTE_H__