epoc32/include/mwappluginsp.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/mwappluginsp.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mwappluginsp.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,112 @@
     1.4 -mwappluginsp.h
     1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __MWAPPLUGINSP_H__
    1.21 +#define __MWAPPLUGINSP_H__
    1.22 +
    1.23 +// System includes
    1.24 +//
    1.25 +#include <e32def.h>
    1.26 +
    1.27 +// Forward class declarations
    1.28 +//
    1.29 +class CDocumentNode;
    1.30 +class CNode;
    1.31 +class CDTDNode;
    1.32 +class CXmlElement;
    1.33 +class CAttributeLookupTable;
    1.34 +
    1.35 +
    1.36 +typedef TAny CWmlLibrary;
    1.37 +
    1.38 +
    1.39 +//##ModelId=3B666FA402F4
    1.40 +class MWapPluginSP
    1.41 +/**
    1.42 +@publishedAll
    1.43 +@deprecated
    1.44 +*/
    1.45 +	{
    1.46 +public:
    1.47 +
    1.48 +/**
    1.49 +	Intended Usage	:	Resets the content data pointers in the given document 
    1.50 +	node and any dependents. This could also reset the data pointer in an 
    1.51 +	associated data dictionary node and its client document nodes.
    1.52 +	@since			6.0
    1.53 +	@param			aDocumentNode	The pointer to the document root node
    1.54 +	@param			aDataPtr		The pointer to the new data content
    1.55 +	@pre 			None
    1.56 +	@post			The data pointers in the specified document node and 
    1.57 +	dependents have been set to the new data
    1.58 + */
    1.59 +	//##ModelId=3B666FA40331
    1.60 +	virtual void ResetDocumentNodeData(CDocumentNode* aDocumentNode, TAny* aDataPtr) const =0;
    1.61 +
    1.62 +/**
    1.63 +	Intended Usage	:	Gets hold of the actual node that holds the data for the
    1.64 +	specified document node. The document data may actually be shared amongst 
    1.65 +	several document nodes and actually held in the data dictionary.
    1.66 +	@since			6.0
    1.67 +	@param			aDocumentNode The pointer to a document node
    1.68 +	@return			A pointer to node that actual holds the data.
    1.69 + */
    1.70 +	//##ModelId=3B666FA4032C
    1.71 +	virtual CNode& DataStorageNode(const CDocumentNode* aDocumentNode) const =0;
    1.72 +
    1.73 +/**
    1.74 +	Intended Usage	:	Preload the specified DTD for validating recieved WML 
    1.75 +	and WMLC decks. The document data handler needs to call this as soon as it
    1.76 +	knows what type of DTD the document is using. When the document completes,
    1.77 +	this DTD will be used to validate it before the 100% complete message is 
    1.78 +	passed up to the engine observer.
    1.79 +	@since			6.0
    1.80 +	@param			aDocType		The specified DTD type
    1.81 +	@param			aDTDURL			The URL of the DTD to be fetched
    1.82 +	@param			aDocRootNode	The root node of the document to be validated
    1.83 +	@return			A pointer to the DTD if the specified DTD is available, 
    1.84 +	otherwise NULL.
    1.85 +	@todo			Add the pre and post conditions.
    1.86 +	@pre 			None
    1.87 +	@post			Unspecified
    1.88 + */
    1.89 +	//##ModelId=3B666FA40328
    1.90 +	virtual const CDTDNode* PrepareDTDL(const TDesC& aDocType, 
    1.91 +										const TDesC& aDTDURL,
    1.92 +										const CDocumentNode* aDocRootNode) =0;
    1.93 +
    1.94 +/**
    1.95 +	Intended Usage	:	Provide a CWmlLibrary object. This object is ready to 
    1.96 +	process data and build a document tree to the given root node.
    1.97 +	@since			6.0
    1.98 +	@warning		The CWmlLibrary object is owned by the WAP Engine.
    1.99 +	@param			aDocRootNode	A pointer to the root node where the document
   1.100 +	tree is to be built.
   1.101 +	@return			A pointer the CWmlLibrary object. 
   1.102 + */
   1.103 +	//##ModelId=3B666FA40326
   1.104 +	virtual CWmlLibrary* WmlLibL(CXmlElement* aDocRootNode) =0;
   1.105 +
   1.106 +/**
   1.107 +	Intended Usage	:	Gets the Attribute Look Up Table.
   1.108 +	@since			6.0
   1.109 +	@return			A reference to the Attribute Look Up Table.
   1.110 + */
   1.111 +	//##ModelId=3B666FA4031C
   1.112 +	virtual CAttributeLookupTable& AttributeLUT() =0;
   1.113 +
   1.114 +	};
   1.115 +
   1.116 +#endif	// __MWAPPLUGINSP_H__