Mako 7.2.0 API
Loading...
Searching...
No Matches
JawsMako::IAnnotationUtils Class Reference

#include <interactive.h>

Classes

class  CXMLResource
 Simple class for tracking streams associated with XML generated by generateXMLForDocument() More...
 

Static Public Member Functions

static JAWSMAKO_API IRAInputStreamPtr generateXMLForDocument (const IJawsMakoPtr &jawsMako, const IDocumentPtr &document, CXMLResourceVect &resources)
 Generate an XML version of the Annotations and Forms content in the given IDocument.
 
static JAWSMAKO_API IAnnotationReferencePtr createAnnotationReferenceFromTag (const U8String &tag)
 Generate an IAnnotationReference from an Annotation Tag attribute found in the XML.
 

Detailed Description

Utility class for dealing with XML representations of annotations and forms.

Member Function Documentation

◆ createAnnotationReferenceFromTag()

static JAWSMAKO_API IAnnotationReferencePtr JawsMako::IAnnotationUtils::createAnnotationReferenceFromTag ( const U8String &  tag)
static

Generate an IAnnotationReference from an Annotation Tag attribute found in the XML.

Parameters
tagAnnotation Tag
Returns
IAnnotationReferencePtr A smart pointer to the new annotation reference

◆ generateXMLForDocument()

static JAWSMAKO_API IRAInputStreamPtr JawsMako::IAnnotationUtils::generateXMLForDocument ( const IJawsMakoPtr &  jawsMako,
const IDocumentPtr &  document,
CXMLResourceVect &  resources 
)
static

Generate an XML version of the Annotations and Forms content in the given IDocument.

Parameters
jawsMakoThe JawsMako instance
documentThe document to generate the XML stream for
resourcesA reference to a vector to receive any streams that hold sounds, embedded files, or other embedded streams referenced from annotations
Returns
IRAInputStreamPtr A smart pointer to a stream containing the XML representation of the Annotations and Form content

The documentation for this class was generated from the following file: