---

xfoifc.h

Go to the documentation of this file.

/**
 * @file    xfoifc.h
 * @brief   XSL Formatter V3 C++ Interface
 *
 * @author  Antenna House, Inc.
 *
 * Copyright (C) 2002-2003 Antenna House, Inc. All rights reserved.
 */

#ifndef XFOIFC_H__
#define XFOIFC_H__

#ifndef __cplusplus
#error  This is a header for C++ compiler.
#endif

#include <iostream>
#include "xfoifc_c.h"   /* include common definitions */

namespace XfoInterface {

class XfoCppIfObject;

/***************************************************************
 * Event class that returns the error information in the formatting process.
 */
class XFOINTERFACE_API MessageListener
{
public:
    MessageListener() {}
    virtual ~MessageListener() {}

    /**
     * Event that returns the error information(error level, error code, error message) in the formatting process.
     *
     * errLevel     - Returns the errorlevel
     * errCode      - Returns the errorcode
     * errMessage   - Returns the errormessage
     */
    virtual void onMessage(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage) {}
    virtual void onMessageW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage) {}
};

/***************************************************************
 * Event class that returns the page number in the formatting process.
 */
class XFOINTERFACE_API FormatPageListener
{
public:
    FormatPageListener() {}
    virtual ~FormatPageListener() {}

    /**
     * Event that returns the page number in the formatting process.
     *
     * pageNo       - Returns the page number
     */
    virtual void onFormatPage(long pageNo) {}
};

/***************************************************************
 * XSL Formatter V3 C++ Interface Object Class
 */
class XFOINTERFACE_API XfoObj
{
private:
    XfoCppIfObject* m_pXfoObj;  /* instance of XfoObj */

public:
    /**
     * Constructor
     */
    XfoObj();

    /**
     * Destructor
     */
    virtual ~XfoObj();

    /**
     * Get instance of XfoObj
     *
     * @return  pointer to XfoObj instance.
     */
    XfoCppIfObject* getXfoObj() const { return m_pXfoObj; }

    /**
     * Get the URL of XML document you will format.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getDocumentURI(char* pVal, int size) const;
    /**
     * Get the URL of XML document you will format.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getDocumentURIW(wchar_t* pVal, int size) const;

    /**
     * Specifies the URL of XML document you will format.
     * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
     * The document loaded from stdin are supposed to be FO files.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the URL of XML document.
     */
    void setDocumentURI(const char* newVal);

    /**
     * Specifies the URL of XML document you will format.
     * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
     * The document loaded from stdin are supposed to be FO files.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the URL of XML document.
     */
    void setDocumentURIW(const wchar_t* newVal);

    /**
     * Get the URI of XSL stylesheet for formatting.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getStylesheetURI(char* pVal, int size) const;
    /**
     * Get the URI of XSL stylesheet for formatting.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getStylesheetURIW(wchar_t* pVal, int size) const;

    /**
     * Specifies the URI of XSL stylesheet for formatting.
     * If the specified XML document is FO, or the XML file contains the processing instruction
     * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
     * Otherwise if there is no setting of this property, an error occurs.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
     */
    void setStylesheetURI(const char* newVal);

    /**
     * Specifies the URI of XSL stylesheet for formatting.
     * If the specified XML document is FO, or the XML file contains the processing instruction
     * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
     * Otherwise if there is no setting of this property, an error occurs.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
     */
    void setStylesheetURIW(const wchar_t* newVal);

    /**
     * Get the path name of the output file.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getOutputFilePath(char* pVal, int size) const;
    /**
     * Get the path name of the output file.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getOutputFilePathW(wchar_t* pVal, int size) const;

    /**
     * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
     * If both the printer name and  this property are specified, the formatted result will be stored in
     * the file by the printer driver.
     * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
     * If the property is not specified, it is considered as stdout.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
     */
    void setOutputFilePath(const char* newVal);
    /**
     * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
     * If both the printer name and  this property are specified, the formatted result will be stored in
     * the file by the printer driver.
     * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
     * If the property is not specified, it is considered as stdout.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
     */
    void setOutputFilePathW(const wchar_t* newVal);

    /**
     * Get the path name of XML-format Option setting file which describes XSL Formatter options.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @param   n       Specifies to get n-th URI. 0 means first URI.
     * @return  Returns the 'pVal'.
     */
    char*    getOptionFileURI(char* pVal, int size, int n=0) const;
    /**
     * Get the path name of XML-format Option setting file which describes XSL Formatter options.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @param   n       Specifies to get n-th URI. 0 means first URI.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getOptionFileURIW(wchar_t* pVal, int size, int n=0) const;

    /**
     * Specifies the path name of XML-format Option setting file which describes XSL Formatter options.
     * The set of former URIs is thrown away.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
     */
    void setOptionFileURI(const char* newVal);
    /**
     * Specifies the path name of XML-format Option setting file which describes XSL Formatter options.
     * The set of former URIs is thrown away.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
     */
    void setOptionFileURIW(const wchar_t* newVal);

    /**
     * Append the path name of XML-format Option setting file which describes XSL Formatter options.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
     */
    void addOptionFileURI(const char* newVal);
    /**
     * Append the path name of XML-format Option setting file which describes XSL Formatter options.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
     */
    void addOptionFileURIW(const wchar_t* newVal);

    /**
     * Get the number of URIs of XML-format Option setting file which describes XSL Formatter options.
     * @since 3.1
     *
     * @return  Returns the number of URIs.
     */
    int getOptionFileCount() const;

    /**
     * Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getOutputFOPath(char* pVal, int size) const;
    /**
     * Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getOutputFOPathW(wchar_t* pVal, int size) const;

    /**
     * Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
     * If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
     * If the setting is omitted, nothing outputs.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of output FO file.
     */
    void setOutputFOPath(const char* newVal);
    /**
     * Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
     * If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
     * If the setting is omitted, nothing outputs.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the path name of output FO file.
     */
    void setOutputFOPathW(const wchar_t* newVal);

    /**
     * Get the command line of External XSLT Processor.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getExternalXSLT(char* pVal, int size) const;
    /**
     * Get the command line of External XSLT Processor.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getExternalXSLTW(wchar_t* pVal, int size) const;

    /**
     * Specifies the command line of External XSLT Processor.
     * If this is omitted, default MSXML3 will be used. For example:
     * <pre>
     *  xslt \%param -o \%3 \%1 \%2</pre>
     *
     * These meanings are as follows.<pre>
     *  \%1 : XML Document
     *  \%2 : XSL Stylesheet
     *  \%3 : XSLT Output File
     *  \%param : xsl:param</pre>
     * \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
     * In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
     */
    void setExternalXSLT(const char* newVal);
    /**
     * Specifies the command line of External XSLT Processor.
     * If this is omitted, default MSXML3 will be used. For example:
     * <pre>
     *  xslt \%param -o \%3 \%1 \%2</pre>
     *
     * These meanings are as follows.<pre>
     *  \%1 : XML Document
     *  \%2 : XSL Stylesheet
     *  \%3 : XSLT Output File
     *  \%param : xsl:param</pre>
     * \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
     * In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
     */
    void setExternalXSLTW(const wchar_t* newVal);

    /**
     * Get the default base URI.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getBaseURI(char* pVal, int size) const;
    /**
     * Get the default base URI.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getBaseURIW(wchar_t* pVal, int size) const;

    /**
     * Specifies the default base URI.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the default base URI.
     */
    void setBaseURI(const char* newVal);
    /**
     * Specifies the default base URI.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the default base URI.
     */
    void setBaseURIW(const wchar_t* newVal);

    /**
     * Get the parameter format of xsl:param when using External XSLT Processor.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getXSLTParamFormat(char* pVal, int size) const;
    /**
     * Get the parameter format of xsl:param when using External XSLT Processor.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getXSLTParamFormatW(wchar_t* pVal, int size);

    /**
     * Specifies the parameter format of xsl:param when using External XSLT Processor.  For example:
     * <pre>
     *   -p \%p \%v</pre>
     *
     * These meanings are as follows.<pre>
     *  \%p : Parameter Name
     *  \%v : Parameter Value</pre>
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
     */
    void setXSLTParamFormat(const char* newVal);
    /**
     * Specifies the parameter format of xsl:param when using External XSLT Processor.  For example:
     * <pre>
     *   -p \%p \%v</pre>
     *
     * These meanings are as follows.<pre>
     *  \%p : Parameter Name
     *  \%v : Parameter Value</pre>
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
     */
    void setXSLTParamFormatW(const wchar_t* newVal);

    /**
     * Get the start page number of document to output.
     *
     * @return  start page number of document to output.
     */
    long getStartPage() const;

    /**
     * Specifies the start page number of document to output.
     * If the start page is omitted or the specified value is 0 or less, the start page is
     * considered from the first page.
     * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
     *
     * @param   newVal  start page number of output.
     */
    void setStartPage(long newVal);

    /**
     * Get the end page number of document to output.
     *
     * @return  end page number of output.
     */
    long getEndPage() const;

    /**
     * Specifies the end page number of document to output.
     * If the end page is omitted or the specified value exceeds the actual page number, the end page
     * is considered as the last page.
     * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
     *
     * @param   newVal  end page number of output.
     */
    void setEndPage(long newVal);

    /**
     * Effective when outputting to PDF.
     * Specifies the master password for PDF. The password must be within 32 bytes.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the master password.
     */
    void setPdfMasterPassword(const char* newVal);

    /**
     * Effective when outputting to PDF.
     * Specifies the master password for PDF. The password must be within 32 bytes.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the master password.
     */
    void setPdfMasterPasswordW(const wchar_t* newVal);

    /**
     * Effective when outputting to PDF.
     * Specifies the user password for PDF. The password must be within 32 bytes.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the user password.
     */
    void setPdfUserPassword(const char* newVal);

    /**
     * Effective when outputting to PDF.
     * Specifies the user password for PDF. The password must be within 32 bytes.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the user password.
     */
    void setPdfUserPasswordW(const wchar_t* newVal);

    /**
     * Effective when outputting to PDF.
     * Disables printing the PDF file.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables printing the PDF file.
     */
    void setPdfNoPrinting(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables printing the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables printing the PDF file.
     *          If nonezero is returned, Disables printing the PDF file.
     */
    long getPdfNoPrinting() const;

    /**
     * Effective when outputting to PDF.
     * Disables making changes of the PDF file.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables making changes of the PDF file.
     */
    void setPdfNoChanging(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables making changes of the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables making changes of the PDF file.
     *          If nonezero is returned, Disables making changes of the PDF file.
     */
    long getPdfNoChanging() const;

    /**
     * Effective when outputting to PDF.
     * Disables copying the content of the PDF file.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables copying the content of the PDF file.
     */
    void setPdfNoContentCopying(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables copying the content of the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables copying the content of the PDF file.
     *          If nonezero is returned, Disables copying the content of the PDF file.
     */
    long getPdfNoContentCopying() const;

    /**
     * Effective when outputting to PDF.
     * Disables adding comments and form fields to the PDF file.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables adding comments and form fields to the PDF file.
     */
    void setPdfNoAddingOrChangingCommnets(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables adding comments and form fields to the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables adding comments and form fields to the PDF file.
     *          If nonezero is returned, Disables adding comments and form fields to the PDF file.
     */
    long getPdfNoAddingOrChangingCommnets() const;

    /**
     * Effective when outputting to PDF.
     * Disables adding comments and form fields to the PDF file.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables adding comments and form fields to the PDF file.
     */
    void setPdfNoAddingOrChangingComments(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables adding comments and form fields to the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables adding comments and form fields to the PDF file.
     *          If nonezero is returned, Disables adding comments and form fields to the PDF file.
     */
    long getPdfNoAddingOrChangingComments() const;

    /**
     * Effective when outputting to PDF.
     * Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.
     * @since 3.1
     *
     * @param   newVal  Specifies the version of PDF.
     */
    void setPdfVersion(PDFVERSION newVal);

    /**
     * Effective when outputting to PDF.
     * Get the version of PDF.
     * @since 3.1
     *
     * @return  the version of PDF.
     */
    PDFVERSION  getPdfVersion() const;

    /**
     * Effective when outputting to PDF.
     * Disables filling in of form fields and signing of the PDF file.
     * This parameter is effective only when you specify PDF1.4 or later to PDF version.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables filling in of form fields and signing of the PDF file.
     */
    void setPdfNoFillForm(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables filling in of form fields and signing of the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables filling in of form fields and signing of the PDF file.
     *          If nonezero is returned, Disables filling in of form fields and signing of the PDF file.
     */
    long getPdfNoFillForm() const;

    /**
     * Effective when outputting to PDF.
     * Disables text access for screen reader devices of the PDF file.
     * This parameter is effective only when you specify 1.4 or later with PDF version.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables text access for screen reader devices of the PDF file.
     */
    void setPdfNoAccessibility(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables text access for screen reader devices of the PDF file.
     * @since 3.1
     *
     * @return  If zero is returned, Enables text access for screen reader devices of the PDF file.
     *          If nonezero is returned, Disables text access for screen reader devices of the PDF file.
     */
    long getPdfNoAccessibility() const;

    /**
     * Effective when outputting to PDF.
     * Disables inserting, deleting and rotating the PDF pages.
     * This parameter is effective only when you specify 1.4 or later with PDF version
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.
     */
    void setPdfNoAssembleDoc(long newVal);

    /**
     * Effective when outputting to PDF.
     * Get disables inserting, deleting and rotating the PDF pages.
     * @since 3.1
     *
     * @return  If zero is returned, Enables inserting, deleting and rotating the PDF pages.
     *          If nonezero is returned, Disables inserting, deleting and rotating the PDF pages.
     */
    long getPdfNoAssembleDoc() const;

    /**
     * Effective when outputting to PDF.
     * Specifies the key length when encrypting the PDF file during outputting.
     * The key length can be specified as either 40 or 128 (bit).
     * This parameter is effective only when you specify PDF1.4 or later with PDF version
     * @since 3.1
     *
     * @param   newVal  Specifies the key length.
     */
    void setPdfEncryptLevel(PDFENCRYPTLEVEL newVal);

    /**
     * Effective when outputting to PDF.
     * Get the key length when encrypting the PDF file during outputting.
     * @since 3.1
     *
     * @return  the key length.
     */
    PDFENCRYPTLEVEL getPdfEncryptLevel() const;

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to embed all embeddable fonts in PDF.
     * @since 3.1
     *
     * @return  the value of whether to embed all embeddable fonts
     */
    long getPdfEmbedAllFonts() const;

    /**
     * Effective when outputting to PDF.
     * Embeds all embeddable fonts in PDF to create.
     * @since 3.1
     *
     * @param   newVal  If the value is 'true' is specified, Embeds all embeddable fonts
     */
    void setPdfEmbedAllFonts(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the font specified to be embedded in PDF.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  the font specified to be embedded
     */
    char* getPdfEmbedFonts(char* pVal, int size) const;

    /**
     * Effective when outputting to PDF.
     * Gets the font specified to be embedded in PDF.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  the font specified to be embedded
     */
    wchar_t* getPdfEmbedFontsW(wchar_t* pVal, int size) const;

    /**
     * Effective when outputting to PDF.
     * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
     * @since 3.1
     *
     * @param   newVal  fonts specified to embed
     */
    void setPdfEmbedFonts(const char* newVal);

    /**
     * Effective when outputting to PDF.
     * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
     * @since 3.1
     *
     * @param   newVal  fonts specified to embed
     */
    void setPdfEmbedFontsW(const wchar_t* newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to issues the error when failing to embed fonts.
     * @since 3.1
     *
     * @return  the value of whether to issues the error
     */
    long getPdfErrorOnEmbedFault() const;

    /**
     * Effective when outputting to PDF.
     * an error is issued in case of failing to embed fonts.
     * @since 3.1
     *
     * @param   newVal  If the value is 'true' is specified, an error is issued.
     */
    void setPdfErrorOnEmbedFault(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to issues the error when missing glyph.
     * @since 3.3
     *
     * @return  the value of whether to issues the error
     */
    long getPdfErrorOnMissingGlyph() const;

    /**
     * Effective when outputting to PDF.
     * an error is issued in case of missing glyph.
     * @since 3.3
     *
     * @param   newVal  If the value is 'true' is specified, an error is issued.
     */
    void setPdfErrorOnMissingGlyph(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to print the resulting PDF file or not.
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
     *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
     *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
     * </table>
     *
     * @return  the value of printing allowed
     */
    PDFPRINTALLOW getPdfPrintingAllowed() const;

    /**
     * Effective when outputting to PDF.
     * Spesifies whether to permit printing PDF to create with one of the following values.
     * This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
     *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
     *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
     * </table>
     *
     * @param   newVal  the value of printing allowed
     */
    void setPdfPrintingAllowed(PDFPRINTALLOW newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of how to compress the color images embedded in PDF.
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
     *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
     *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
     * </table>
     *
     * @return  the value of how raster graphics are compressed and stored
     */
    PDFIMAGECOMPRESSION getPdfImageCompression() const;

    /**
     * Effective when outputting to PDF.
     * When the color image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
     * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
This is the setting for the color image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfMonochromeImageCompression for the monochrome image.
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
     *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
     *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
     * </table>
     *
     * @param   newVal  the value of how raster graphics are compressed and stored
     */
    void setPdfImageCompression(PDFIMAGECOMPRESSION newVal);

    /**
     * Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.
     * @since 3.1
     *
     * @return  the value of the quality of JPEG format
     */
    int  getPdfJPEGQuality() const;

    /**
     * Effective when outputting to PDF.
     * For the color image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR>
     * CAUTION:     It is not for changing the quality of a JPEG format image.<BR>
     * This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.
     * @since 3.1
     *
     * @param   newVal  the value of the quality of JPEG format
     */
    void setPdfJPEGQuality(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
     * @since 3.1
     *
     * @return  the value of whether make the size of PDF smaller or not
     */
    long getPdfCompressContentStream() const;

    /**
     * Effective when outputting to PDF.
     * Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
     * @since 3.1
     *
     * @param   newVal  If the value is 'true' is specified, make the PDF compress
     */
    void setPdfCompressContentStream(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of how to transform external link specified by the relative address in the PDF link.
     * @since 3.1
     *
     * @return  the value of how to transform external link
     */
    long getPdfUseLaunchForRelativeURI() const;

    /**
     * Effective when outputting to PDF.
     * Specifies whether the external link specified by the relative address is transformed into 'Open the file' or into 'World Wide Web link' in the PDF link properties.
     * @since 3.1
     *
     * @param   newVal  If nonezero is specified, it is transformed to 'Open the file'. If zero is specified, it is transformed to 'World Wide Web link'
     */
    void setPdfUseLaunchForRelativeURI(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
     *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
     *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
     *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
     * </table>
     *
     * @return  the value of how to convert
     */
    PDFRGBCONVERSION getPdfRGBConversion() const;

    /**
     * Effective when outputting to PDF.
     * Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
     * @since 3.1
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
     *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
     *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
     *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
     * </table>
     *
     * @param   newVal  the value of how to convert
     */
    void setPdfRGBConversion(PDFRGBCONVERSION newVal);

#if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))

    /**
     * Effective when outputting to PDF.
     * Gets the value of the rasterised-resolution of the transformed raster images.
     * @since 3.1
     *
     * @return  Rasterised-resolution
     */
    int getPdfRasterizeResolution() const;

    /**
     * Effective when outputting to PDF.
     * Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in PDF as vectors without being transformed to raster images.
     * This setting is effective only with Windows version.
     * @since 3.1
     *
     * @param   newVal  Rasterised-resolution (70 to 500)
     */
    void setPdfRasterizeResolution(int newVal);

#endif

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to output linearize PDF or not.
     * @since 3.3
     *
     * @return  the value of whether to output linearize pdf or not.
     */
    long getPdfLinearize() const;

    /**
     * Effective when outputting to PDF.
     * Specifies whether to output linearize PDF or not.
     * @since 3.3
     *
     * @param   newVal  If the value is 'true' is specified, output linearlize PDF.
     */
    void setPdfLinearize(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of whether to embed all embeddable fonts
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
     *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
     *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
     * </table>
     *
     * @return  the value of whether to embed all embeddable fonts
     */
    EMBEDALLFONT getPdfEmbedAllFontsEx(void) const;

    /**
     * Effective when outputting to PDF.
     * Specifies whether to embed the all outline data of fonts in PDF or not with one of the following values, which are True type fonts and Type1 Fonts and are embeddable in the formatted result.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
     *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
     *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
     * </table>
     *
     *If the value is EMBALLFONT_PART, only fonts specified in setPdfEmbedFonts are embedded. If the value is EMBALLFONT_ALL, all fonts that can be embedded except Base 14 fonts will be embedded. If the value is EMBALLFONT_BASE14, all fonts including Base 14 fonts that can be embedded will be embedded.
     *
     * @param   newVal  the value of whether to embed all embeddable fonts
     */
    void setPdfEmbedAllFontsEx(EMBEDALLFONT newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of method to downsample the color image
     * @since 3.3
     *
     * @return  the value of method to downsample the color image
     */
    IMAGEDOWNSAMPLING getPdfImageDownSampling(void) const;

    /**
     * Effective when outputting to PDF.
     * Specifies the following either of method to downsample the color image that is put into PDF.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
     *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
     * </table>
     *
     * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfImageDownSamplingDPI will be downsampled into the resolution specified by setPdfImageDownSamplingTarget.
This is the setting for the color image. Spesify setPdfGrayscaleImageDownSampling for the grayscale image, and setPdfMonochromeImageDownSampling for the monochrome image.
     *
     * @param   newVal  the value of method to downsample the color image
     */
    void setPdfImageDownSampling(IMAGEDOWNSAMPLING newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution when the color image is downsampled.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfImageDownSamplingTarget(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution when the color image is downsampled.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfImageDownSamplingTarget(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution of the color image which performs a downsampling.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfImageDownSamplingDPI(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution of the color image which performs a downsampling.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfImageDownSamplingDPI(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.
     * @since 3.3
     *
     * @return  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
     */
    long getPdfPutImageColorProfile(void) const;

    /**
     * Effective when outputting to PDF.
     * Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.
     * @since 3.3
     *
     * @param   newVal  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
     */
    void setPdfPutImageColorProfile(long newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of how to compress the grayscale images embedded in PDF.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
     *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
     *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
     * </table>
     *
     * @return  the value of how raster graphics are compressed and stored
     */
    PDFIMAGECOMPRESSION getPdfGrayscaleImageCompression(void) const;

    /**
     * Effective when outputting to PDF.
     * When the grayscale image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
     * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of setPdfGrayscaleJPEGQuality and setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
This is the setting for the grayscale image. Spesify setPdfImageCompression for the color image, and setPdfMonochromeImageCompression for the monochrome image.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
     *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
     *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
     * </table>
     *
     * @param   newVal  the value of how raster graphics are compressed and stored
     */
    void setPdfGrayscaleImageCompression(PDFIMAGECOMPRESSION newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of the quality of JPEG format that is specified by xfo_setPdfGrayscaleImageCompression stored in PDF.
     * @since 3.3
     *
     * @return  the value of the quality of JPEG format
     */
    int getPdfGrayscaleJPEGQuality(void) const;

    /**
     * Effective when outputting to PDF.
     * For the grayscale image format that can not be stored directly in PDF, specifies the image quality by the numerical value within the range of 1-100 when IMGCMPR_JPEG is specified by setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR>
     * CAUTION: It is not for changing the quality of a JPEG format image.<BR>
     * This is the setting for the grayscale image. Spesify setPdfJPEGQuality for the color image.
     * @since 3.3
     *
     * @param   newVal  the value of the quality of JPEG format
     */
    void setPdfGrayscaleJPEGQuality(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of method to downsample the grayscale image
     * @since 3.3
     *
     * @return  the value of method to downsample the grayscale image
     */
    IMAGEDOWNSAMPLING getPdfGrayscaleImageDownSampling(void) const;

    /**
     * Effective when outputting to PDF.
     * Specifies the following either of method to downsample the grayscale image that is put into PDF.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
     *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
     * </table>
     *
     * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by setPdfGrayscaleImageDownSamplingTarget.
This is the setting for the grayscale image. Spesify setPdfImageDownSampling for the color image, and setPdfMonochromeImageDownSampling for the monochrome image.
     *
     * @param   newVal  the value of method to downsample the grayscale image
     */
    void setPdfGrayscaleImageDownSampling(IMAGEDOWNSAMPLING newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution when the grayscale image is downsampled.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfGrayscaleImageDownSamplingTarget(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution when the grayscale image is downsampled.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfGrayscaleImageDownSamplingTarget(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution of the grayscale image which performs a downsampling.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfGrayscaleImageDownSamplingDPI(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution of the grayscale image which performs a downsampling.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfGrayscaleImageDownSamplingDPI(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of how to compress the monochrome images embedded in PDF.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
     *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
     *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
     *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
     *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
     * </table>
     *
     * @return  the value of how raster graphics are compressed and stored
     */
    MONOCHROMECOMPRESSION getPdfMonochromeImageCompression(void) const;

    /**
     * Effective when outputting to PDF.
     * When the monochrome image format cannot be stored directly in PDF, the image is stored after being transformed into the bit map format which is compatible with PDF. The compression method of the data stored in a PDF file is then specified by one of the following values.<BR>
This is the setting for the monochrome image. Spesify setPdfGrayscaleImageCompression for the grayscale image, and setPdfImageCompression for the color image.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
     *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
     *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
     *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
     *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
     * </table>
     *
     * @param   newVal  the value of how raster graphics are compressed and stored
     */
    void setPdfMonochromeImageCompression(MONOCHROMECOMPRESSION newVal);

    /**
     * Effective when outputting to PDF.
     * Gets the value of method to downsample the monochrome image
     * @since 3.3
     *
     * @return  the value of method to downsample the monochrome image
     */
    IMAGEDOWNSAMPLING getPdfMonochromeImageDownSampling(void) const;

    /**
     * Effective when outputting to PDF.
     * Specifies the following either of method to downsample the monochrome image that is put into PDF.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
     *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
     *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
     * </table>
     *
     * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by setPdfMonochromeImageDownSamplingTarget.
This is the setting for the monochrome image. Spesify setPdfImageDownSampling for the color image, and setPdfGrayscaleImageDownSampling for the grayscale image.
     *
     * @param   newVal  the value of method to downsample the monochrome image
     */
    void setPdfMonochromeImageDownSampling(IMAGEDOWNSAMPLING newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution when the monochrome image is downsampled.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfMonochromeImageDownSamplingTarget(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution when the monochrome image is downsampled.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfMonochromeImageDownSamplingTarget(int newVal);

    /**
     * Effective when outputting to PDF.
     * Gets resolution of the monochrome image which performs a downsampling.
     * @since 3.3
     *
     * @return  the value of resolution.
     */
    int getPdfMonochromeImageDownSamplingDPI(void) const;

    /**
     * Effective when outputting to PDF.
     * Set resolution of the monochrome image which performs a downsampling.
     * @since 3.3
     *
     * @param   newVal  the value of resolution.
     */
    void setPdfMonochromeImageDownSamplingDPI(int newVal);

    /**
     * Effective when outputting to SVG.
     * Get the version of SVG.
     * @since 3.3
     *
     * @return  the version of SVG.
     */
    SVGVERSION  getSvgVersion() const;

    /**
     * Effective when outputting to SVG.
     * Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
     * @since 3.3
     *
     * @param   newVal  Specifies the version of SVG.
     */
    void setSvgVersion(SVGVERSION newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
     * @since 3.3
     *
     * @return  whether gzip compression or not.
     */
    long getSvgGzipCompression() const;

    /**
     * Effective when outputting to SVG.
     * Specifies whether to compress the outputted SVG into gzip format or not.
     * @since 3.3
     *
     * @param   newVal      If the value is 'true' is specified, enables to compress data into gzip format.
     */
    void setSvgGzipCompression(long newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the setting indicating whether to embed fonts in the outputted SVG.
     * @since 3.3
     *
     * @return  whether embeds fonts or not.
     */
    long getSvgEmbedAllFonts() const;

    /**
     * Effective when outputting to SVG.
     * Specifies whether to embed fonts in the outputted SVG.
     * @since 3.3
     *
     * @param   newVal      If the value is 'true' is specified, embeds fonts.
     */
    void setSvgEmbedAllFonts(long newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the format for naming files when the outputted SVG becomes multiple.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char* getSvgFormat(char* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Gets the format for naming files when the outputted SVG becomes multiple.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getSvgFormatW(wchar_t* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Specifies the format for naming files when the outputted SVG becomes multiple.
     * @since 3.3
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
     */
    void setSvgFormat(const char* newVal);

    /**
     * Effective when outputting to SVG.
     * Specifies the format for naming files when the outputted SVG becomes multiple.
     * @since 3.3
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
     */
    void setSvgFormatW(const wchar_t* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the font specified to be embedded in SVG.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char* getSvgEmbedFonts(char* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Gets the font specified to be embedded in SVG.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getSvgEmbedFontsW(wchar_t* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
     * @since 3.3
     *
     * @param   newVal  fonts specified to embed
     */
    void setSvgEmbedFonts(const char* newVal);

    /**
     * Effective when outputting to SVG.
     * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
     * @since 3.3
     *
     * @param   newVal  fonts specified to embed
     */
    void setSvgEmbedFontsW(const wchar_t* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the value of whether to issues the error when failing to embed fonts.
     * @since 3.3
     *
     * @return  the value of whether to issues the error
     */
    long getSvgErrorOnEmbedFault() const;

    /**
     * Effective when outputting to SVG.
     * an error is issued in case of failing to embed fonts.
     * @since 3.3
     *
     * @param   newVal  If the value is 'true' is specified, an error is issued.
     */
    void setSvgErrorOnEmbedFault(long newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the value of how to compress the images embedded in SVG.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
     *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
     * </table>
     *
     * @return  the value of how raster graphics are compressed and stored
     */
    IMAGECONVERSION getSvgImageConversion() const;

    /**
     * Effective when outputting to SVG.
     * Selects how to compress the images embedded in SVG to create from the following.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
     *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
     *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
     * </table>
     *
     * @param   newVal  the value of how raster graphics are compressed and stored
     */
    void setSvgImageConversion(IMAGECONVERSION newVal);

    /**
     * Gets the value of the quality of JPEG format that is specified by setSvgImageConversion() stored in SVG.
     * @since 3.3
     *
     * @return  the value of the quality
     */
    int getSvgJPEGQuality() const;

    /**
     * Effective when outputting to SVG.
     * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100.
     * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
     * The initial value is 80.
     * @since 3.3
     *
     * @param   newVal  JPEG quality (1 to 100)
     */
    void setSvgJPEGQuality(int newVal);

    /**
     * Effective when outputting to SVG.
     * Gets specification how to treat the referred image.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
     *  <tr><td>IMGPT_COPY_ALL  </td><td>= 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.</td></tr>
     *  <tr><td>IMGPT_LINK      </td><td>= 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.</td></tr>
     *  <tr><td>IMGPT_COPY      </td><td>= 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.</td></tr>
     * </table>
     *
     * @return  specification how to treat the referred image.
     */
    IMAGEPROCTYPE getSvgImageProcessingType() const;

    /**
     * Effective when outputting to SVG.
     * Specifies how to treat the referred image.
     * @since 3.3
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
     *  <tr><td>IMGPT_COPY_ALL  </td><td>= 1 Copies all image files to the destination that is specified by setSvgImageCopyPath, and then links.</td></tr>
     *  <tr><td>IMGPT_LINK      </td><td>= 2 Links images that have been linked, and embeds the embedded image. However, the raster images other than JPEG and PNG are always embedded.</td></tr>
     *  <tr><td>IMGPT_COPY      </td><td>= 3 Copies images that have been linked to the destination that is specified by setSvgImageCopyPath, and links. The embedded image are embedded.</td></tr>
     * </table>
     *
     * @param   newVal  specification how to treat the referred image.
     */
    void setSvgImageProcessingType(IMAGEPROCTYPE newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char* getSvgImageCopyPath(char* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
     * @since 3.3
     *
     * @param   newVal  Pointer to a null-terminated string to be used as image copy path
     */
    void setSvgImageCopyPath(const char* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getSvgImageCopyPathW(wchar_t* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by setSvgImageProcessingType.
     * @since 3.3
     *
     * @param   newVal  Pointer to a null-terminated string to be used as image copy path
     */
    void setSvgImageCopyPathW(const wchar_t* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
     * @since 3.3
     *
     * @return  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
     */
    long getSvgSingleFile() const;

    /**
     * Effective when outputting to SVG.
     * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
     * If the value is true, outputs one SVG. If the value is false, outputs multiple SVG. When multiple SVG is output, the file name is modified by specifying format. <BR>
     * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
     * @since 3.3
     *
     * @param   newVal  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
     */
    void setSvgSingleFile(long newVal);

    /**
     * Effective when outputting to SVG.
     * Gets specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
     * @since 3.3
     *
     * @return  specification whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name.
     */
    long getSvgImageRename() const;

    /**
     * Effective when outputting to SVG.
     * When images are copied to the directory specified by setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.
     * @since 3.3
     *
     * @param   newVal  specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original nam
     */
    void setSvgImageRename(long newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char* getSvgImagePrefix(char* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
     * @since 3.3
     *
     * @param   newVal  the prefix of the file name.
     */
    void setSvgImagePrefix(const char* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets the prefix of the file name when images are copied to the directory specified by setSvgImageCopyPath and processed.
     * @since 3.3
     *
     * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getSvgImagePrefixW(wchar_t* pVal, int size) const;

    /**
     * Effective when outputting to SVG.
     * When images are copied to the directory specified by setSvgImageCopyPath and processed, specifies the prefix of the file name. The file name will be prefix with sequence numbers. Default is empty character string with only sequential numbers.
     * @since 3.3
     *
     * @param   newVal  the prefix of the file name.
     */
    void setSvgImagePrefixW(const wchar_t* newVal);

    /**
     * Effective when outputting to SVG.
     * Gets specification whether to add sequential number to the output SVG even if it has only one-page.
     * @since 3.3
     *
     * @return  specification whether to add sequential number to the output SVG even if it has only one-page.
     */
    long getSvgSinglePageNumber() const;

    /**
     * Effective when outputting to SVG.
     * When xfo_setSvgSingleFile = 0 is specified, specifies whether to add sequential number to the output SVG even if it has only one-page. It is not added in case of false.
     * @since 3.3
     *
     * @param   newVal  specification whether to add sequential number to the output SVG even if it has only one-page.
     */
    void setSvgSinglePageNumber(long newVal);


#if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
    /**
     * Effective when outputting to SVG.
     * Gets the value of the rasterised-resolution of the transformed raster images.
     * @since 3.3
     *
     * @return  Rasterised-resolution
     */
    int getSvgRasterizeResolution() const;

    /**
     * Effective when outputting to SVG.
     * Specifies the value of the rasterised-resolution of the transformed raster images in the range from 70 to 500(dpi). SVG, EMF and WMF are drawn in SVG as vectors without being transformed to raster images.
     * This setting is effective only with Windows version.
     * @since 3.3
     *
     * @param   newVal  Rasterised-resolution (70 to 500)
     */
    void setSvgRasterizeResolution(int newVal);
#endif

    /**
     * Get the start volume of document to output.
     * @since 3.2
     *
     * @return  start volume of document to output.
     */
    long getStartVolume() const;

    /**
     * Specifies the start volume of document to output.
     * If the start volume is omitted or the specified value is 0 or less, the start volume is
     * considered from the first volume.
     * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
     * @since 3.2
     *
     * @param   newVal  start volume of output.
     */
    void setStartVolume(long newVal);

    /**
     * Get the end volume of document to output.
     * @since 3.2
     *
     * @return  end volume of output.
     */
    long getEndVolume() const;

    /**
     * Specifies the end volume of document to output.
     * If the end volume is omitted or the specified value exceeds the actual volume, the end volume
     * is considered as the last volume.
     * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
     * @since 3.2
     *
     * @param   newVal  end volume of output.
     */
    void setEndVolume(long newVal);

    /**
     * Get multiple volume  of PDF output.
     * @since 3.2
     *
     * @return  If zero is returned, multiple volume don't specified.
     *            If nonezero is returned, multiple volume specified.
     */
    long getMultiVolume() const;

    /**
     * Specifies multiple volume of PDF output.
     * @since 3.2
     *
     * @param   newVal  Specifies zero or nonzero.
     */
    void setMultiVolume(long newVal);

    /**
     * Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.
     * @since 3.2
     *
     * @return  Returns total volume count.
     */
    long getTotalVolumeCount() const;

    /**
     * Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.
     * @since 3.2
     *
     * @return  Returns output volume count.
     */
    long getOutputVolumeCount() const;

    /**
     * Get the error level to abort formatting process.
     *
     * @return  Returns the error level.
     */
    XfoIfErrorLevel getExitLevel() const;

    /**
     * Error level to abort formatting process. XSL Formatter will stop formatting when the detected
     * error level is equal to ExitLevel property or higher. The default value is 2 (Warning).
     * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be
     * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered
     * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be
     * aborted unconditionally.
     * BTW : An error is not displayed no matter what value may be specified to be this property.
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
     *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
     *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
     *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
     * </table>
     *
     * @param   newVal  error level to abort formatting process.
     */
    void setExitLevel(XfoIfErrorLevel newVal);

    /**
     * Returns the error level of the error that occurred during the formatting process.
     *
     * <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
     *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
     *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
     *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
     * </table>
     *
     * @return  Returns the error level.
     */
    XfoIfErrorLevel getErrorLevel() const;

    /**
     * Returns the error code of the error that occurred during the formatting process.
     * Zero means no error. Non-zero indicates any error occurred.
     *
     * @return  Returns the error code.
     */
    XfoIfErrorCode getErrorCode() const;

    /**
     * Returns the error message of the error that occurred during the formatting process.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getErrorMessage(char* pVal, int size) const;
    /**
     * Returns the error message of the error that occurred during the formatting process.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;

    /**
     * Sets the substitution of font name. This substitution acts on the font names existing in FO.
     * The font name 'fontName' is replaced to 'aliasName'.
     *
     * @param   src     Specifies the font name which is replaced.
     * @param   dst     Specifies the aliasName.
     */
    void setFontAlias(const char* src, const char* dst);
    /**
     * Sets the substitution of font name. This substitution acts on the font names existing in FO.
     * The font name 'fontName' is replaced to 'aliasName'.
     *
     * @param   src     Specifies the font name which is replaced.
     * @param   dst     Specifies the aliasName.
     */
    void setFontAliasW(const wchar_t* src, const wchar_t* dst);

    /**
     * Clear all substitutions of font name.
     *
     */
    void clearFontAlias();

    /**
     * Erase the substitution of font name 'fontName'.
     *
     * @param   src Specifies the font name which is replaced.
     */
    void eraseFontAlias(const char* src);
    /**
     * Erase the substitution of font name 'fontName'.
     *
     * @param   src Specifies the font name which is replaced.
     */
    void eraseFontAliasW(const wchar_t* src);

    /**
     * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
     *
     * @return  Returns the error code. Zero means no error. Non-zero indicates any error occurred.
     */
    XfoIfErrorCode execute(bool bNoThrow=false);

    /**
     * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
     * @since 3.3
     *
     * @param   src
     * @param   out
     */
    void render(std::istream& src, std::ostream& out);
    /**
     * Initialize formatting engine.
     *
     */
    void clear();

    /**
     * Set parameter name and value for xsl:param.
     *
     * @param   paramName name.
     * @param   value   parameter value.
     */
    void setXSLTParam(const char* paramName, const char* value);
    /**
     * Set parameter name and value for xsl:param.
     *
     * @param   paramName name.
     * @param   value   parameter value.
     */
    void setXSLTParamW(const wchar_t* paramName, const wchar_t* value);

    /**
     * Clear all parameter name and value for xsl:param.
     *
     */
    void clearXSLTParam();

    /**
     * Register the MessageListener interface to the instance of implemented class
     * The error that occurred during the formatting process can be received as the event.
     *
     * @param   listener Pointer of the MessageListener instance.
     */
    void setMessageListener(MessageListener* listener);

    /**
     * Register the FormatPageListener interface to the instance of implemented class
     * The page number that formatted during the formatting process can be received as the event.
     *
     * @param   listener Pointer of the FormatPageListener instance.
     */
    void setFormatPageListener(FormatPageListener* listener);

    /**
     * Get the error output type.
     *
     * @return  Error output type.
     */
    XfoErrorStreamType getErrorStreamType() const;

    /**
     * Set the error output type.
     *
     * @param   type        Error output type.
     *  <table border="0" cellspacing="0" cellpadding="0">
     *  <tr><td>OST_NONE    </td><td>: No error output</td></tr>
     *  <tr><td>OST_STDOUT  </td><td>: Error output to stdout</td></tr>
     *  <tr><td>OST_STDERR  </td><td>: Error output to stderr</td></tr>
     *  </table>
     */
    void setErrorStreamType(XfoErrorStreamType type);

    /**
     * Get the printer name where the formatted result is outputted.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getPrinterName(char* pVal, int size) const;
    /**
     * Get the printer name where the formatted result is outputted.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getPrinterNameW(wchar_t* pVal, int size) const;

    /**
     * Specifies the printer name where the formatted result is outputted. If it is omitted, "\@PDF" is
     * automatically specified. When "\@STDPRN" is specified, standard printer is used.
     * If  "\@PDF" is specified as the printer name, the formatted result is not outputted to a printer
     * but rather to PDF.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
     */
    void setPrinterName(const char* newVal);
    /**
     * Specifies the printer name where the formatted result is outputted. If it is omitted, "\@PDF" is
     * automatically specified. When "\@STDPRN" is specified, standard printer is used.
     * If  "\@PDF" is specified as the printer name, the formatted result is not outputted to a printer
     * but rather to PDF.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
     */
    void setPrinterNameW(const wchar_t* newVal);

    /**
     * Get formatted total pages.
     * @since 3.2
     *
     * @return  the value of formatted total pages.
     */
    long getFormattedPages() const;

#if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))

    /**
     * Get the printer setting file URI.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getPrinterSettingURI(char* pVal, int size) const;
    /**
     * Get the printer setting file URI.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getPrinterSettingURIW(wchar_t* pVal, int size) const;

    /**
     * Specifies the printer setting file URI.
     * This setting is effective only with Windows version.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
     */
    void setPrinterSettingURI(const char* newVal);
    /**
     * Specifies the printer setting file URI.
     * This setting is effective only with Windows version.
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
     */
    void setPrinterSettingURIW(const wchar_t* newVal);

    /**
     * Get the number of copies. Effective when outputting to printer.
     *
     * @return  Returns the number of copies.
     */
    long getPrnCopies() const;

    /**
     * Specifies the number of copies. Effective when outputting to printer.
     * If nothing is specified, the value is considered as 1.
     * This setting is effective only with Windows version.
     *
     * @param   newVal  the number of copies.
     */
    void setPrnCopies(long newVal);

    /**
     * Get collation of multiple copies.
     *
     * @return  If zero is returned, the same page is multi-copied continuously.
     *            If nonezero is returned, the pages specified from start to end are printed repeatedly.
     */
    long getPrnCollate() const;

    /**
     * Specifies collation of multiple copies. Effective when outputting to printer and the number of
     * copies is plural. If it is not specified or the value zero is specified, the same page is
     * multi-copied continuously.
     * If nonezero is specified, the pages specified from start to end are printed repeatedly.
     * This setting is effective only with Windows version.
     *
     * @param   newVal  Zpecifies zero or nonzero.
     */
    void setPrnCollate(long newVal);

    /**
     * Get the setting of whether print dialog box is displayed or not when printing
     *
     * @return  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
     */
    long getBatchPrint() const;

    /**
     * When the value 'false' is specified, the print dialog box is displayed when printing.
     * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed.
     * This setting is effective only with Windows version.
     *
     * @param   newVal  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
     */
    void setBatchPrint(long newVal);

    /**
     * Get the text of XML document you will format.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getDocumentText(char* pVal, int size) const;

    /**
     * Get the text of XML document you will format.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getDocumentTextW(wchar_t* pVal, int size) const;

    /**
     * Specifies the XML document you will format.
     * MSXML3/MSXML4 is required when formatting.
     * This setting is effective only with Windows version.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the text of XML document.
     */
    void setDocumentText(const char* newVal);

    /**
     * Specifies the XML document you will format.
     * MSXML3/MSXML4 is required when formatting.
     * This setting is effective only with Windows version.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the text of XML document.
     */
    void setDocumentTextW(const wchar_t* newVal);

    /**
     * Get the text of XSL stylesheet for formatting.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getStylesheetText(char* pVal, int size) const;

    /**
     * Get the text of XSL stylesheet for formatting.
     * @since 3.1
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getStylesheetTextW(wchar_t* pVal, int size) const;

    /**
     * Specifies the text of XSL stylesheet for formatting.
     * If the specified XML document is FO, or the XML file contains the processing instruction
     * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
     * Otherwise if there is no setting of this property, an error occurs.
     * MSXML3/MSXML4 is required when formatting.
     * This setting is effective only with Windows version.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the text of XSL stylesheet.
     */
    void setStylesheetText(const char* newVal);

    /**
     * Specifies the text of XSL stylesheet for formatting.
     * If the specified XML document is FO, or the XML file contains the processing instruction
     * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
     * Otherwise if there is no setting of this property, an error occurs.
     * MSXML3/MSXML4 is required when formatting.
     * This setting is effective only with Windows version.
     * @since 3.1
     *
     * @param   newVal  Pointer to a null-terminated string to be used as the text of XSL stylesheet.
     */
    void setStylesheetTextW(const wchar_t* newVal);

#endif  /* WIN32 */

};


/***************************************************************
 * Exception class that returns the error information in the formatting process.
 */
class XFOINTERFACE_API XfoException
{
public:
    /**
     * Constructor
     */
    XfoException(XfoIfErrorLevel errorLevel, XfoIfErrorCode errorCode, const wchar_t* errorMessage);

    /**
     * Copy constructor
     */
    XfoException(const XfoException &e);

    /**
     * Destructor
     */
    ~XfoException();

private:
    XfoIfErrorLevel m_errorLevel;           /* Error level */
    XfoIfErrorCode  m_errorCode;            /* Error code */
    wchar_t*        m_errorMessage;         /* Error message */

public:
    /**
     * Get the error level.
     *
     * @return  Returns the error level.
     */
    XfoIfErrorLevel getErrorLevel() const;

    /**
     * Get the error code.
     *
     * @return  Returns the error code.
     */
    XfoIfErrorCode getErrorCode() const;

    /**
     * Get the error message.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    char*    getErrorMessage(char* pVal, int size) const;

    /**
     * Get the error message.
     *
     * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
     *            the string is truncated and terminated with a NULL character.
     * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
     * @return  Returns the 'pVal'.
     */
    wchar_t* getErrorMessageW(wchar_t* pVal, int size) const;

};

}

#endif  /* XFOIFC_H__ */

---