author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 3 | e1b950c65cb4 |
permissions | -rw-r--r-- |
williamr@2 | 1 |
// Copyright (c) 1997-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 __MWAPPLUGINSP_H__ |
williamr@2 | 17 |
#define __MWAPPLUGINSP_H__ |
williamr@2 | 18 |
|
williamr@2 | 19 |
// System includes |
williamr@2 | 20 |
// |
williamr@2 | 21 |
#include <e32def.h> |
williamr@2 | 22 |
|
williamr@2 | 23 |
// Forward class declarations |
williamr@2 | 24 |
// |
williamr@2 | 25 |
class CDocumentNode; |
williamr@2 | 26 |
class CNode; |
williamr@2 | 27 |
class CDTDNode; |
williamr@2 | 28 |
class CXmlElement; |
williamr@2 | 29 |
class CAttributeLookupTable; |
williamr@2 | 30 |
|
williamr@2 | 31 |
|
williamr@2 | 32 |
typedef TAny CWmlLibrary; |
williamr@2 | 33 |
|
williamr@2 | 34 |
|
williamr@2 | 35 |
//##ModelId=3B666FA402F4 |
williamr@2 | 36 |
class MWapPluginSP |
williamr@2 | 37 |
/** |
williamr@2 | 38 |
@publishedAll |
williamr@2 | 39 |
@deprecated |
williamr@2 | 40 |
*/ |
williamr@2 | 41 |
{ |
williamr@2 | 42 |
public: |
williamr@2 | 43 |
|
williamr@2 | 44 |
/** |
williamr@2 | 45 |
Intended Usage : Resets the content data pointers in the given document |
williamr@2 | 46 |
node and any dependents. This could also reset the data pointer in an |
williamr@2 | 47 |
associated data dictionary node and its client document nodes. |
williamr@2 | 48 |
@since 6.0 |
williamr@2 | 49 |
@param aDocumentNode The pointer to the document root node |
williamr@2 | 50 |
@param aDataPtr The pointer to the new data content |
williamr@2 | 51 |
@pre None |
williamr@2 | 52 |
@post The data pointers in the specified document node and |
williamr@2 | 53 |
dependents have been set to the new data |
williamr@2 | 54 |
*/ |
williamr@2 | 55 |
//##ModelId=3B666FA40331 |
williamr@2 | 56 |
virtual void ResetDocumentNodeData(CDocumentNode* aDocumentNode, TAny* aDataPtr) const =0; |
williamr@2 | 57 |
|
williamr@2 | 58 |
/** |
williamr@2 | 59 |
Intended Usage : Gets hold of the actual node that holds the data for the |
williamr@2 | 60 |
specified document node. The document data may actually be shared amongst |
williamr@2 | 61 |
several document nodes and actually held in the data dictionary. |
williamr@2 | 62 |
@since 6.0 |
williamr@2 | 63 |
@param aDocumentNode The pointer to a document node |
williamr@2 | 64 |
@return A pointer to node that actual holds the data. |
williamr@2 | 65 |
*/ |
williamr@2 | 66 |
//##ModelId=3B666FA4032C |
williamr@2 | 67 |
virtual CNode& DataStorageNode(const CDocumentNode* aDocumentNode) const =0; |
williamr@2 | 68 |
|
williamr@2 | 69 |
/** |
williamr@2 | 70 |
Intended Usage : Preload the specified DTD for validating recieved WML |
williamr@2 | 71 |
and WMLC decks. The document data handler needs to call this as soon as it |
williamr@2 | 72 |
knows what type of DTD the document is using. When the document completes, |
williamr@2 | 73 |
this DTD will be used to validate it before the 100% complete message is |
williamr@2 | 74 |
passed up to the engine observer. |
williamr@2 | 75 |
@since 6.0 |
williamr@2 | 76 |
@param aDocType The specified DTD type |
williamr@2 | 77 |
@param aDTDURL The URL of the DTD to be fetched |
williamr@2 | 78 |
@param aDocRootNode The root node of the document to be validated |
williamr@2 | 79 |
@return A pointer to the DTD if the specified DTD is available, |
williamr@2 | 80 |
otherwise NULL. |
williamr@2 | 81 |
@todo Add the pre and post conditions. |
williamr@2 | 82 |
@pre None |
williamr@2 | 83 |
@post Unspecified |
williamr@2 | 84 |
*/ |
williamr@2 | 85 |
//##ModelId=3B666FA40328 |
williamr@2 | 86 |
virtual const CDTDNode* PrepareDTDL(const TDesC& aDocType, |
williamr@2 | 87 |
const TDesC& aDTDURL, |
williamr@2 | 88 |
const CDocumentNode* aDocRootNode) =0; |
williamr@2 | 89 |
|
williamr@2 | 90 |
/** |
williamr@2 | 91 |
Intended Usage : Provide a CWmlLibrary object. This object is ready to |
williamr@2 | 92 |
process data and build a document tree to the given root node. |
williamr@2 | 93 |
@since 6.0 |
williamr@2 | 94 |
@warning The CWmlLibrary object is owned by the WAP Engine. |
williamr@2 | 95 |
@param aDocRootNode A pointer to the root node where the document |
williamr@2 | 96 |
tree is to be built. |
williamr@2 | 97 |
@return A pointer the CWmlLibrary object. |
williamr@2 | 98 |
*/ |
williamr@2 | 99 |
//##ModelId=3B666FA40326 |
williamr@2 | 100 |
virtual CWmlLibrary* WmlLibL(CXmlElement* aDocRootNode) =0; |
williamr@2 | 101 |
|
williamr@2 | 102 |
/** |
williamr@2 | 103 |
Intended Usage : Gets the Attribute Look Up Table. |
williamr@2 | 104 |
@since 6.0 |
williamr@2 | 105 |
@return A reference to the Attribute Look Up Table. |
williamr@2 | 106 |
*/ |
williamr@2 | 107 |
//##ModelId=3B666FA4031C |
williamr@2 | 108 |
virtual CAttributeLookupTable& AttributeLUT() =0; |
williamr@2 | 109 |
|
williamr@2 | 110 |
}; |
williamr@2 | 111 |
|
williamr@2 | 112 |
#endif // __MWAPPLUGINSP_H__ |