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