http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback
Bug-Todo

Download
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XMLFormatter Class Reference

This class provides the basic formatting capabilities that are required to turn the Unicode based XML data from the parsers into a form that can be used on non-Unicode based systems, i.e. More...

#include <XMLFormatter.hpp>

Collaboration diagram for XMLFormatter:

Collaboration graph
[legend]
List of all members.

Public Types

enum  EscapeFlags {
  NoEscapes, StdEscapes, AttrEscapes, CharEscapes,
  EscapeFlags_Count, DefaultEscape = 999
}
enum  UnRepFlags { UnRep_Fail, UnRep_CharRef, UnRep_Replace, DefaultUnRep = 999 }

Public Methods

 XMLFormatter ( const XMLCh* const outEncoding , XMLFormatTarget* const target , const EscapeFlags escapeFlags = NoEscapes , const UnRepFlags unrepFlags = UnRep_Fail )
 XMLFormatter ( const char* const outEncoding , XMLFormatTarget* const target , const EscapeFlags escapeFlags = NoEscapes , const UnRepFlags unrepFlags = UnRep_Fail )
 ~XMLFormatter ()
void formatBuf ( const XMLCh* const toFormat , const unsigned int count , const EscapeFlags escapeFlags = DefaultEscape , const UnRepFlags unrepFlags = DefaultUnRep )
XMLFormatter& operator<< ( const XMLCh* const toFormat )
XMLFormatter& operator<< ( const XMLCh toFormat )
const XMLCh* getEncodingName () const
void setEscapeFlags ( const EscapeFlags newFlags )
void setUnRepFlags ( const UnRepFlags newFlags )
XMLFormatter& operator<< ( const EscapeFlags newFlags )
XMLFormatter& operator<< ( const UnRepFlags newFlags )

Detailed Description

This class provides the basic formatting capabilities that are required to turn the Unicode based XML data from the parsers into a form that can be used on non-Unicode based systems, i.e.

into local or generic text encodings.

A number of flags are provided to control whether various optional formatting operations are performed.


Member Enumeration Documentation

enum XMLFormatter::EscapeFlags
 

Enumeration values:
NoEscapes  
StdEscapes  
AttrEscapes  
CharEscapes  
EscapeFlags_Count  
DefaultEscape  

enum XMLFormatter::UnRepFlags
 

Enumeration values:
UnRep_Fail  
UnRep_CharRef  
UnRep_Replace  
DefaultUnRep  


Constructor & Destructor Documentation

XMLFormatter::XMLFormatter ( const XMLCh *const outEncoding,
XMLFormatTarget *const target,
const EscapeFlags escapeFlags = NoEscapes,
const UnRepFlags unrepFlags = UnRep_Fail )
 

XMLFormatter::XMLFormatter ( const char *const outEncoding,
XMLFormatTarget *const target,
const EscapeFlags escapeFlags = NoEscapes,
const UnRepFlags unrepFlags = UnRep_Fail )
 

XMLFormatter::~XMLFormatter ( )
 


Member Function Documentation

void XMLFormatter::formatBuf ( const XMLCh *const toFormat,
const unsigned int count,
const EscapeFlags escapeFlags = DefaultEscape,
const UnRepFlags unrepFlags = DefaultUnRep )
 

const XMLCh * XMLFormatter::getEncodingName ( ) const
 

XMLFormatter & XMLFormatter::operator<< ( const UnRepFlags newFlags )
 

XMLFormatter & XMLFormatter::operator<< ( const EscapeFlags newFlags )
 

XMLFormatter& XMLFormatter::operator<< ( const XMLCh toFormat )
 

XMLFormatter& XMLFormatter::operator<< ( const XMLCh *const toFormat )
 

void XMLFormatter::setEscapeFlags ( const EscapeFlags newFlags )
 

void XMLFormatter::setUnRepFlags ( const UnRepFlags newFlags )
 


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


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.