diff options
| author | Daniel Boelzle <dbo@openoffice.org> | 2001-03-15 13:56:40 +0000 |
|---|---|---|
| committer | Daniel Boelzle <dbo@openoffice.org> | 2001-03-15 13:56:40 +0000 |
| commit | 8cfb94777f9f09e16de8392d27fd62fe0221f035 (patch) | |
| tree | de61a6bbd5006514323f1177de26c945b77c87a1 /xmlscript | |
| parent | f41193139289e53309d64b7d61a50be27352cd32 (diff) | |
added documentation
Diffstat (limited to 'xmlscript')
| -rw-r--r-- | xmlscript/inc/xmlscript/xml_helper.hxx | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/xmlscript/inc/xmlscript/xml_helper.hxx b/xmlscript/inc/xmlscript/xml_helper.hxx index 3d23261c79ce..acfec1e41d5a 100644 --- a/xmlscript/inc/xmlscript/xml_helper.hxx +++ b/xmlscript/inc/xmlscript/xml_helper.hxx @@ -2,9 +2,9 @@ * * $RCSfile: xml_helper.hxx,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: dbo $ $Date: 2001-03-15 14:44:13 $ + * last change: $Author: dbo $ $Date: 2001-03-15 14:56:40 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -97,7 +97,11 @@ namespace xmlscript //================================================================================================== struct NameSpaceUid { + /** URI defining XML namespace + */ ::rtl::OUString sURI; + /** Identifier given for URI (given back in createRootContext(), createChildContext() callbacks + */ sal_Int32 nUid; inline NameSpaceUid( ::rtl::OUString const & sURI_, sal_Int32 nUid_ ) SAL_THROW( () ) @@ -106,7 +110,27 @@ struct NameSpaceUid {} }; -//================================================================================================== +/** Creates a document handler to be used for SAX1 parser that can handle namespaces. + Give a list of NameSpaceUid structs defining namespace mappings to integers (performance). + Implementing the XImporter interface, you will get a createRootContext() for the root + element of your XML document and subsequent createChildContext() callbacks for each + sub element. + Namespaces of tags are identified by their integer value. + + @param pNamespaceUids + array of namespace mappings + @param nNameSpaceUids + number of element in namespace mappings array + @param nUnknownNamespaceUid + namespace id given for unrecognized namespace prefix + (one that is not given via pNamespaceUids) + @param xImporter + initial import object being called for root context + @param bSingleThreadedUse + flag whether context management is synchronized. + @return + document handler for parser +*/ SAL_DLLEXPORT ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XDocumentHandler > SAL_CALL createDocumentHandler( NameSpaceUid const * pNamespaceUids, sal_Int32 nNameSpaceUids, |