Unicorn XML Toolkit
Version 1.00.00

Namespace Xslt
Class COutputOptions

class COutputOptions: public CInterface {
public:
    COutputOptions();
    ~COutputOptions();
public:
    enum {
        xml,
        html,
        text
        };
public:
    bool GetStandardMethod(int &nMethod);
    bool GetExtensionMethod(
        CString &strNamespaceUri, CString &strLocalName);
    bool GetVersion(CString &strVersion);
    bool GetEncoding(CString &strEncoding);
    bool GetOmitXmlDeclaration(bool &bOmitXmlDeclaration);
    bool GetStandalone(bool &bStandalone);
    bool GetDoctypePublic(CString &strDoctypePublic);
    bool GetDoctypeSystem(CString &strDoctypeSystem);
    bool IsCdataSectionElement(
        const CString &strNamespaceUri,
        const CString &strLocalName);
    bool GetIndent(bool &bIndent);
    bool GetMediaType(CString &strMediaType);
    void SetStandardMethod(int nMethod);
    void SetExtensionMethod(
        const CString &strNamespaceUri,
        const CString &strLocalName);
    void SetVersion(const CString &strVersion);
    void SetEncoding(const CString &strEncoding);
    void SetOmitXmlDeclaration(bool bOmitXmlDeclaration);
    void SetStandalone(bool bStandalone);
    void SetDoctypePublic(const CString &strDoctypePublic);
    void SetDoctypeSystem(const CString &strDoctypeSystem);
    void AddCdataSectionElement(
        const CString &strNamespaceUri,
        const CString &strLocalName);
    void SetIndent(bool bIndent);
    void SetMediaType(const CString &strMediaType);
    };

The set of output options.

Each output option corresponds to a certain attribute on the XSLT xsl:output element.

Since:
1.00.00
Version:
1.00.00
Author:
Alexey Gokhberg
Constructor/Destructor Summary
COutputOptions ();
����������Constructs the output options.
~COutputOptions ();
����������Destroys the output options.

Function Summary
bool GetStandardMethod (int &nMethod);
����������Returns the code of the standard output method.
bool GetExtensionMethod (CString &strNamespaceUri, CString &strLocalName);
����������Returns the name of the extension output method.
bool GetVersion (CString &strVersion);
����������Returns the version of the output format.
bool GetEncoding (CString &strEncoding);
����������Returns the name of the character encoding.
bool GetOmitXmlDeclaration (bool &bOmitXmlDeclaration);
����������Returns the omit XML declaration option.
bool GetStandalone (bool &bStandalone);
����������Returns the standalone option.
bool GetDoctypePublic (CString &strDoctypePublic);
����������Returns the document type public identifier.
bool GetDoctypeSystem (CString &strDoctypeSystem);
����������Returns the document type system identifier.
bool IsCdataSectionElement (const CString &strNamespaceUri, const CString &strLocalName);
����������Tests whether the text contents of elements with the given name must be written to the output as CDATA sections.
bool GetIndent (bool &bIndent);
����������Returns the output indent option.
bool GetMediaType (CString &strMediaType);
����������Returns the output media type.
void SetStandardMethod (int nMethod);
����������Sets the code of the standard output method.
void SetExtensionMethod (const CString &strNamespaceUri, const CString &strLocalName);
����������Sets the name of the extension output method.
void SetVersion (const CString &strVersion);
����������Sets the version of the output format.
void SetEncoding (const CString &strEncoding);
����������Sets the name of the character encoding.
void SetOmitXmlDeclaration (bool bOmitXmlDeclaration);
����������Sets the omit XML declaration option.
void SetStandalone (bool bStandalone);
����������Sets the standalone option.
void SetDoctypePublic (const CString &strDoctypePublic);
����������Sets the document type public identifier.
void SetDoctypeSystem (const CString &strDoctypeSystem);
����������Sets the document type system identifier.
void AddCdataSectionElement (const CString &strNamespaceUri, const CString &strLocalName);
����������Specifies, that the text contents of elements with the given name must be written to the output as CDATA sections.
void SetIndent (bool bIndent);
����������Sets the output indent option.
void SetMediaType (const CString &strMediaType);
����������Sets the output media type.

Constructor/Destructor Detail

COutputOptions

COutputOptions();

Constructs the output options.

~COutputOptions

~COutputOptions();

Destroys the output options.

Function Detail

GetStandardMethod

bool GetStandardMethod(int &nMethod);

Returns the code of the standard output method.

Allowed values are COutputOptions::xml , COutputOptions::html and COutputOptions::text .

Parameters:
nMethod - on return, the code of the standard output method, if specified
Returns:
true if the standard output method is specified; false otherwise

GetExtensionMethod

bool GetExtensionMethod(
    CString &strNamespaceUri, CString &strLocalName);

Returns the name of the extension output method.

Parameters:
strNamespaceUri - on return, the namespace URI of the extension output method, if specified
strLocalName - on return, the local name of the extension output method, if specified
Returns:
true if the extension output method is specified; false otherwise

GetVersion

bool GetVersion(CString &strVersion);

Returns the version of the output format.

Parameters:
strVersion - the version of the output format, if specified
Returns:
true if the version of the output format is specified; false otherwise

GetEncoding

bool GetEncoding(CString &strEncoding);

Returns the name of the character encoding.

Parameters:
strEncoding - on return, the name of the character encoding, if specified
Returns:
true if the name of the character encoding is specified; false otherwise

GetOmitXmlDeclaration

bool GetOmitXmlDeclaration(bool &bOmitXmlDeclaration);

Returns the omit XML declaration option.

Parameters:
bOmitXmlDeclaration - on return, the boolean value of the omit XML declaration option, if specified
Returns:
true if the omit XML declaration option is specified; false otherwise

GetStandalone

bool GetStandalone(bool &bStandalone);

Returns the standalone option.

Parameters:
bStandalone - on return, the boolean value of the standalone option, if specified
Returns:
true if the standalone option is specified; false otherwise

GetDoctypePublic

bool GetDoctypePublic(CString &strDoctypePublic);

Returns the document type public identifier.

Parameters:
strDoctypePublic - on return, the name of the document type public identifier, if specified
Returns:
true if the document type public identifier is specified; false otherwise

GetDoctypeSystem

bool GetDoctypeSystem(CString &strDoctypeSystem);

Returns the document type system identifier.

Parameters:
strDoctypeSystem - on return, the name of the document type system identifier, if specified
Returns:
true if the document type system identifier is specified; false otherwise

IsCdataSectionElement

bool IsCdataSectionElement(
    const CString &strNamespaceUri,
    const CString &strLocalName);

Tests whether the text contents of elements with the given name must be written to the output as CDATA sections.

Parameters:
strNamespaceUri - the namespace URI of the element
strLocalName - the local name of the element
Returns:
true if the text contents of elements with the given name must be written to the output as CDATA sections; false otherwise

GetIndent

bool GetIndent(bool &bIndent);

Returns the output indent option.

Parameters:
bIndent - on return, the boolean value of the output indent option, if specified
Returns:
true if the output indent option is specified; false otherwise

GetMediaType

bool GetMediaType(CString &strMediaType);

Returns the output media type.

Parameters:
strMediaType - on return, the name of the output media type, if specified
Returns:
true if the output media type is specified; false otherwise

SetStandardMethod

void SetStandardMethod(int nMethod);

Sets the code of the standard output method.

Allowed values are COutputOptions::xml , COutputOptions::html and COutputOptions::text .

Parameters:
nMethod - the code of the standard output method

SetExtensionMethod

void SetExtensionMethod(
    const CString &strNamespaceUri,
    const CString &strLocalName);

Sets the name of the extension output method.

Parameters:
strNamespaceUri - the namespace URI of the extension output method
strLocalName - the local name of the extension output method

SetVersion

void SetVersion(const CString &strVersion);

Sets the version of the output format.

Parameters:
strVersion - the version of the output format

SetEncoding

void SetEncoding(const CString &strEncoding);

Sets the name of the character encoding.

Parameters:
strEncoding - the name of character encoding

SetOmitXmlDeclaration

void SetOmitXmlDeclaration(bool bOmitXmlDeclaration);

Sets the omit XML declaration option.

Parameters:
bOmitXmlDeclaration - the boolean omit XML declaration option

SetStandalone

void SetStandalone(bool bStandalone);

Sets the standalone option.

Parameters:
bStandalone - the boolean standalone option

SetDoctypePublic

void SetDoctypePublic(const CString &strDoctypePublic);

Sets the document type public identifier.

Parameters:
strDoctypePublic - the document type public identifier

SetDoctypeSystem

void SetDoctypeSystem(const CString &strDoctypeSystem);

Sets the document type system identifier.

Parameters:
strDoctypeSystem - the document type system identifier

AddCdataSectionElement

void AddCdataSectionElement(
    const CString &strNamespaceUri,
    const CString &strLocalName);

Specifies, that the text contents of elements with the given name must be written to the output as CDATA sections.

Parameters:
strNamespaceUri - the namespace URI of the element
strLocalName - the local name of the element

SetIndent

void SetIndent(bool bIndent);

Sets the output indent option.

Parameters:
bIndent - the boolean output indent option

SetMediaType

void SetMediaType(const CString &strMediaType);

Sets the output media type.

Parameters:
strMediaType - the output media type

Unicorn XML Toolkit
Version 1.00.00


This document was created using Unicorn DOC++.

Copyright 1999-2001 Unicorn Enterprises SA.
All Rights Reserved.