Main Page   Namespace List   Compound List   File List   Compound Members   File Members   Related Pages  

xfoifc_c.h

Go to the documentation of this file.
00001 /**
00002  * @file    xfoifc_c.h
00003  * @brief   AH Formatter C Interface
00004  *
00005  * @author  Antenna House, Inc.
00006  *
00007  *
00008  * Copyright (C) 2002-2011 Antenna House, Inc. All rights reserved.
00009  */
00010 
00011 #ifndef XFOIFC_C_H__
00012 #define XFOIFC_C_H__
00013 
00014 #include <stddef.h>
00015 
00016 #if !defined(_DOXYGEN) && defined(_MSC_VER) && defined(_WIN32)
00017     #ifdef XFOINTERFACE_EXPORTS
00018         #define XFOINTERFACE_API    __declspec( dllexport )
00019     #else
00020         #define XFOINTERFACE_API    __declspec( dllimport )
00021     #endif
00022 #else
00023     #define XFOINTERFACE_API
00024 #endif
00025 
00026 /**
00027  * Error Code
00028  */
00029 typedef long XfoIfErrorCode;    /* 0 means no error */
00030 
00031 /**
00032  * Error Level
00033  */
00034 typedef enum {
00035     ELVL_NORMAL         = 0,    /* no error */
00036     ELVL_INFORMATION    = 1,
00037     ELVL_WARNING        = 2,
00038     ELVL_RECOVERABLE    = 3,
00039     ELVL_FATAL          = 4
00040 } XfoIfErrorLevel;
00041 
00042 /**
00043  * Error Stream Type for MessageListener
00044  */
00045 typedef enum {
00046     EST_NONE,               /* no output */
00047     EST_STDOUT,             /* output to stdout */
00048     EST_STDERR              /* output to stderr */
00049 } XfoErrorStreamType;
00050 
00051 /**
00052  * PDF version
00053  */
00054 typedef enum  {
00055     PDF_13 = 0,             /* PDF 1.3 */
00056     PDF_14 = 1,             /* PDF 1.4 */
00057     PDF_15 = 2,             /* PDF 1.5 */
00058     PDF_16 = 3,             /* PDF 1.6 */
00059     PDF_17 = 4,             /* PDF 1.7 */
00060     PDFX_1a_2001= 101,      /* ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3) */
00061     PDFX_3_2002 = 103,      /* ISO 15930-3:2002 PDF/X-3-2002  (based on PDF1.3) */
00062     PDFX_1a_2003= 104,      /* ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4) */
00063     PDFX_2_2003 = 105,      /* ISO 15930-5:2003 PDF/X-2-2003  (based on PDF1.4) */
00064     PDFX_3_2003 = 106,      /* ISO 15930-6:2003 PDF/X-3-2003  (based on PDF1.4) */
00065     PDFX_4_2008 = 107,      /* ISO 15930-7:2008 PDF/X-4       (based on PDF1.6) */
00066     PDFA_1a_2005= 200,      /* ISO 19005-1:2005 (based on PDF1.4) */
00067     PDFA_1b_2005= 400       /* ISO 19005-1:2005 (based on PDF1.4) */
00068 } XfoPDFVERSION;
00069 
00070 /**
00071  * PDF encrypt level
00072  */
00073 typedef enum  {
00074     ENCLEVEL_40RC4  = 0,    /*  40-bit RC4 */
00075     ENCLEVEL_128RC4,        /* 128-bit RC4 */
00076     ENCLEVEL_128AES,        /* 128-bit AES */
00077     ENCLEVEL_256AES,        /* 256-bit AES */
00078     ENCLEVEL_40     = ENCLEVEL_40RC4,
00079     ENCLEVEL_128    = ENCLEVEL_128RC4
00080 } XfoPDFENCRYPTLEVEL;
00081 
00082 /**
00083  * PDF print allow
00084  */
00085 typedef enum {
00086     PRALLOW_NONE,           /* not allowed */
00087     PRALLOW_LOW,            /* low resolution printing */
00088     PRALLOW_HIGH            /* high resolution printing */
00089 } XfoPDFPRINTALLOW;
00090 
00091 /**
00092  * PDF image compression
00093  */
00094 typedef enum {
00095     IMGCMPR_AUTO,           /* auto */
00096     IMGCMPR_JPEG,           /* JPEG */
00097     IMGCMPR_ZLIB,           /* ZLIB */
00098     IMGCMPR_JPEG2K          /* JPEG2000 */
00099 } XfoPDFIMAGECOMPRESSION;
00100 
00101 /**
00102  * PDF RGB conversion
00103  */
00104 typedef enum {
00105     RGBCONV_NONE,           /* no conversion */
00106     RGBCONV_BLACK,          /* black to devicegray */
00107     RGBCONV_GRAY,           /* gray to devicegray */
00108     RGBCONV_ALL             /* all rgb to devicegray */
00109 } XfoPDFRGBCONVERSION;
00110 
00111 /**
00112  * Embed font
00113  */
00114 typedef enum {
00115     EMBALLFONT_PART,        /* specified fonts */
00116     EMBALLFONT_ALL,         /* all fonts except Base14 fonts */
00117     EMBALLFONT_BASE14       /* all fonts */
00118 } XfoEMBEDALLFONT;
00119 
00120 /**
00121  * Image downsampling
00122  */
00123 typedef enum {
00124     IMGDOWNSAMPLING_NONE,       /* no downsampling */
00125     IMGDOWNSAMPLING_AVERAGE,    /* average downsampling */
00126     IMGDOWNSAMPLING_BICUBIC,    /* bicubic downsampling */
00127     IMGDOWNSAMPLING_SUBSAMPLING /* subsampling */
00128 } XfoIMAGEDOWNSAMPLING;
00129 
00130 /**
00131  * Monochrome compression
00132  */
00133 typedef enum {
00134     MONOCMPR_CCITT4,        /* CCITTFaxDecode group 4 filter,default value */
00135     MONOCMPR_CCITT3,        /* CCITTFaxDecode group 3 filter */
00136     MONOCMPR_RUNLENGTH,     /* RunLengthDecode filter */
00137     MONOCMPR_ZLIB,          /* FlateDecode filter */
00138     MONOCMPR_OFF            /* no filter */
00139 } XfoMONOCHROMECOMPRESSION;
00140 
00141 /**
00142  * SVG version
00143  */
00144 typedef enum {
00145     SVG_11,                 /* SVG 1.1 */
00146     SVG_Basic,              /* SVG Basic */
00147     SVG_Tiny                /* SVG Tiny */
00148 } XfoSVGVERSION;
00149 
00150 /**
00151  * Image processing
00152  */
00153 typedef enum {
00154     IMGPT_EMBED_ALL,        /* embed all */
00155     IMGPT_COPY_ALL,         /* copy all */
00156     IMGPT_LINK,             /* link */
00157     IMGPT_COPY              /* copy */
00158 } XfoIMAGEPROCTYPE;
00159 
00160 /**
00161  * Image conversion
00162  */
00163 typedef enum {
00164     IMGCNV_AUTO,            /* auto */
00165     IMGCNV_JPEG,            /* jpeg conversion except png */
00166     IMGCNV_PNG,             /* png conversion except jpeg */
00167     IMGCNV_JPEGALL          /* jpeg-all conversion */
00168 } XfoIMAGECONVERSION;
00169 
00170 /**
00171  * Formatter type
00172  */
00173 typedef enum {
00174     FMTTYP_AUTO,            /* auto */
00175     FMTTYP_HTML,            /* html */
00176     FMTTYP_XHTML,           /* xhtml */
00177     FMTTYP_XMLCSS,          /* xml+css */
00178     FMTTYP_XSLFO            /* xsl-fo */
00179 } XfoFORMATTERTYPE;
00180 
00181 /**
00182  * INX output mode
00183  */
00184 typedef enum  {
00185     INXOM_TEXT,             /* text area output mode */
00186     INXOM_LINE,             /* line area output */
00187     INXOM_BLOCK             /* block area output */
00188 } XfoINXOUTPUTMODE;
00189 
00190 /**
00191  * MIF output mode
00192  */
00193 typedef enum  {
00194     MIFOM_TEXT,             /* text area output mode */
00195     MIFOM_LINE,             /* line area output */
00196     MIFOM_BLOCK             /* block area output */
00197 } XfoMIFOUTPUTMODE;
00198 
00199 /**
00200  * MIF Image processiong mode
00201  */
00202 typedef enum {
00203     MIFIP_EMBED,                /* image embed mode*/
00204     MIFIP_LINK_R,               /* link image relative path mode */
00205     MIFIP_LINK_A                /* link image absolute path mode */
00206 } XfoMIFIMAGEPROCMODE;
00207 
00208 /***************************************************************
00209  * for compatibility -- obsolete types
00210  */
00211 typedef XfoPDFVERSION           PDFVERSION;
00212 typedef XfoPDFENCRYPTLEVEL      PDFENCRYPTLEVEL;
00213 typedef XfoPDFPRINTALLOW        PDFPRINTALLOW;
00214 typedef XfoPDFIMAGECOMPRESSION  PDFIMAGECOMPRESSION;
00215 typedef XfoPDFRGBCONVERSION     PDFRGBCONVERSION;
00216 typedef XfoEMBEDALLFONT         EMBEDALLFONT;
00217 typedef XfoIMAGEDOWNSAMPLING    IMAGEDOWNSAMPLING;
00218 typedef XfoMONOCHROMECOMPRESSION MONOCHROMECOMPRESSION;
00219 typedef XfoSVGVERSION           SVGVERSION;
00220 typedef XfoIMAGEPROCTYPE        IMAGEPROCTYPE;
00221 typedef XfoIMAGECONVERSION      IMAGECONVERSION;
00222 typedef XfoFORMATTERTYPE        FORMATTERTYPE;
00223 typedef XfoINXOUTPUTMODE        INXOUTPUTMODE;
00224 typedef XfoMIFOUTPUTMODE        MIFOUTPUTMODE;
00225 typedef XfoMIFIMAGEPROCMODE     MIFIMAGEPROCMODE;
00226 
00227 /***************************************************************
00228  * format information
00229  */
00230 
00231 #ifdef __cplusplus
00232 extern "C" {
00233 #endif
00234 
00235 /** Pointer to XfoObj instance. */
00236 typedef void*   CXfoObjPtr;
00237 
00238 /**
00239  * Error callback handler
00240  */
00241 typedef void (XfoOnMessageProc)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
00242 typedef void (XfoOnMessageProcW)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);
00243 typedef void (XfoOnFormatPageProc)(long pageNo);
00244 
00245 typedef void (XfoOnMessageProcEx)(void* pAnyObj, XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
00246 typedef void (XfoOnMessageProcExW)(void* pAnyObj, XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);
00247 typedef void (XfoOnFormatPageProcEx)(void* pAnyObj, long pageNo);
00248 
00249 /**
00250  * Create instance of XfoObj
00251  *
00252  * @return  Pointer to XfoObj instance.
00253  */
00254 XFOINTERFACE_API CXfoObjPtr xfo_createXfoObject();
00255 
00256 /**
00257  * Release instance of XfoObj
00258  *
00259  * @param   pXfoObj Pointer to XfoObj instance.
00260  */
00261 XFOINTERFACE_API void xfo_releaseXfoObject(CXfoObjPtr pXfoObj);
00262 
00263 /**
00264  * Get formatter type.
00265  * only after Formatter 5.
00266  *
00267  * @param   pXfoObj Pointer to XfoObj instance.
00268  * @return  type of formatter.
00269  */
00270 XFOINTERFACE_API XfoFORMATTERTYPE xfo_getFormatterType(CXfoObjPtr pXfoObj);
00271 
00272 /**
00273  * Set formatter type.
00274  * only after Formatter 5.
00275  *
00276  * @param   pXfoObj Pointer to XfoObj instance.
00277  * @param   newVal type of formatter.
00278  */
00279 XFOINTERFACE_API void xfo_setFormatterType(CXfoObjPtr pXfoObj, XfoFORMATTERTYPE newVal);
00280 
00281 
00282 /**
00283  * Get the URL of XML document you will format.
00284  *
00285  * @param   pXfoObj Pointer to XfoObj instance.
00286  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00287  *            the string is truncated and terminated with a NULL character.
00288  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00289  * @return  Returns the 'pVal'.
00290  */
00291 XFOINTERFACE_API char* xfo_getDocumentURI(CXfoObjPtr pXfoObj, char* pVal, int size);
00292 /**
00293  * Get the URL of XML document you will format.
00294  *
00295  * @param   pXfoObj Pointer to XfoObj instance.
00296  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00297  *            the string is truncated and terminated with a NULL character.
00298  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00299  * @return  Returns the 'pVal'.
00300  */
00301 XFOINTERFACE_API wchar_t* xfo_getDocumentURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00302 
00303 /**
00304  * Specifies the URL of XML document you will format.
00305  * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
00306  * The document loaded from stdin are supposed to be FO files.
00307  *
00308  * @param   pXfoObj Pointer to XfoObj instance.
00309  * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL document.
00310  */
00311 XFOINTERFACE_API void xfo_setDocumentURI(CXfoObjPtr pXfoObj, const char* newVal);
00312 /**
00313  * Specifies the URL of XML document you will format.
00314  * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
00315  * The document loaded from stdin are supposed to be FO files.
00316  *
00317  * @param   pXfoObj Pointer to XfoObj instance.
00318  * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL document.
00319  */
00320 XFOINTERFACE_API void xfo_setDocumentURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00321 
00322 /**
00323  * Get the URI of XSL stylesheet for formatting.
00324  *
00325  * @param   pXfoObj Pointer to XfoObj instance.
00326  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00327  *            the string is truncated and terminated with a NULL character.
00328  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00329  * @return  Returns the 'pVal'.
00330  */
00331 XFOINTERFACE_API char* xfo_getStylesheetURI(CXfoObjPtr pXfoObj, char* pVal, int size);
00332 /**
00333  * Get the URI of XSL stylesheet for formatting.
00334  *
00335  * @param   pXfoObj Pointer to XfoObj instance.
00336  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00337  *            the string is truncated and terminated with a NULL character.
00338  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00339  * @return  Returns the 'pVal'.
00340  */
00341 XFOINTERFACE_API wchar_t* xfo_getStylesheetURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00342 
00343 /**
00344  * Specifies the URI of XSL stylesheet for formatting.
00345  * If the specified XML document is FO, or the XML file contains the processing instruction
00346  * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
00347  * Otherwise if there is no setting of this property, an error occurs.
00348  *
00349  * @param   pXfoObj Pointer to XfoObj instance.
00350  * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
00351  */
00352 XFOINTERFACE_API void xfo_setStylesheetURI(CXfoObjPtr pXfoObj, const char* newVal);
00353 /**
00354  * Specifies the URI of XSL stylesheet for formatting.
00355  * If the specified XML document is FO, or the XML file contains the processing instruction
00356  * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
00357  * Otherwise if there is no setting of this property, an error occurs.
00358  *
00359  * @param   pXfoObj Pointer to XfoObj instance.
00360  * @param   newVal  Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
00361  */
00362 XFOINTERFACE_API void xfo_setStylesheetURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00363 
00364 /**
00365  * Append the path name of user stylesheet file which describes AH Formatter options.
00366  * @since 5.0
00367  *
00368  * @param   pXfoObj Pointer to XfoObj instance.
00369  * @param   newVal  Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.
00370  */
00371 XFOINTERFACE_API void xfo_addUserStylesheetURI(CXfoObjPtr pXfoObj, const char* newVal);
00372 /**
00373  * Append the path name of user stylesheet file which describes AH Formatter options.
00374  * @since 5.0
00375  *
00376  * @param   pXfoObj Pointer to XfoObj instance.
00377  * @param   newVal  Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.
00378  */
00379 XFOINTERFACE_API void xfo_addUserStylesheetURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00380 
00381 /**
00382  * Get the prior stylesheet title.
00383  *
00384  * @param   pXfoObj Pointer to XfoObj instance.
00385  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00386  *            the string is truncated and terminated with a NULL character.
00387  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00388  * @return  Returns the 'pVal'.
00389  */
00390 XFOINTERFACE_API char* xfo_getStylesheetTitle(CXfoObjPtr pXfoObj, char* pVal, int size);
00391 /**
00392  * Get the prior stylesheet title.
00393  *
00394  * @param   pXfoObj Pointer to XfoObj instance.
00395  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00396  *            the string is truncated and terminated with a NULL character.
00397  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00398  * @return  Returns the 'pVal'.
00399  */
00400 XFOINTERFACE_API wchar_t* xfo_getStylesheetTitleW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00401 
00402 /**
00403  * Set the prior stylesheet title.
00404  *
00405  * @param   pXfoObj Pointer to XfoObj instance.
00406  * @param   newVal  Pointer to a null-terminated string to be used as the title of priority stylesheet.
00407  */
00408 XFOINTERFACE_API void xfo_setStylesheetTitle(CXfoObjPtr pXfoObj, const char* newVal);
00409 /**
00410  * Set the prior stylesheet title.
00411  *
00412  * @param   pXfoObj Pointer to XfoObj instance.
00413  * @param   newVal  Pointer to a null-terminated string to be used as the title of priority stylesheet.
00414  */
00415 XFOINTERFACE_API void xfo_setStylesheetTitleW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00416 
00417 /**
00418  * Get html default charset.
00419  *
00420  * @param   pXfoObj Pointer to XfoObj instance.
00421  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00422  *            the string is truncated and terminated with a NULL character.
00423  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00424  * @return  Returns the 'pVal'.
00425  */
00426 XFOINTERFACE_API char* xfo_getHtmlDefaultCharset(CXfoObjPtr pXfoObj, char* pVal, int size);
00427 /**
00428  * Get html default charset.
00429  *
00430  * @param   pXfoObj Pointer to XfoObj instance.
00431  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00432  *            the string is truncated and terminated with a NULL character.
00433  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00434  * @return  Returns the 'pVal'.
00435  */
00436 XFOINTERFACE_API wchar_t* xfo_getHtmlDefaultCharsetW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00437 
00438 /**
00439  * Set html default charset.
00440  *
00441  * @param   pXfoObj Pointer to XfoObj instance.
00442  * @param   newVal  Pointer to a null-terminated string to be used as the html default charset.
00443  */
00444 XFOINTERFACE_API void xfo_setHtmlDefaultCharset(CXfoObjPtr pXfoObj, const char* newVal);
00445 /**
00446  * Set html default charset.
00447  *
00448  * @param   pXfoObj Pointer to XfoObj instance.
00449  * @param   newVal  Pointer to a null-terminated string to be used as the html default charset.
00450  */
00451 XFOINTERFACE_API void xfo_setHtmlDefaultCharsetW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00452 
00453 /**
00454  * Get the path name of the output file.
00455  *
00456  * @param   pXfoObj Pointer to XfoObj instance.
00457  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00458  *            the string is truncated and terminated with a NULL character.
00459  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00460  * @return  Returns the 'pVal'.
00461  */
00462 XFOINTERFACE_API char* xfo_getOutputFilePath(CXfoObjPtr pXfoObj, char* pVal, int size);
00463 /**
00464  * Get the path name of the output file.
00465  *
00466  * @param   pXfoObj Pointer to XfoObj instance.
00467  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00468  *            the string is truncated and terminated with a NULL character.
00469  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00470  * @return  Returns the 'pVal'.
00471  */
00472 XFOINTERFACE_API wchar_t* xfo_getOutputFilePathW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00473 
00474 /**
00475  * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
00476  * If both the printer name and  this property are specified, the formatted result will be stored in
00477  * the file by the printer driver.
00478  * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
00479  * If the property is not specified, it is considered as stdout.
00480  *
00481  * @param   pXfoObj Pointer to XfoObj instance.
00482  * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
00483  */
00484 XFOINTERFACE_API void xfo_setOutputFilePath(CXfoObjPtr pXfoObj, const char* newVal);
00485 /**
00486  * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
00487  * If both the printer name and  this property are specified, the formatted result will be stored in
00488  * the file by the printer driver.
00489  * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
00490  * If the property is not specified, it is considered as stdout.
00491  *
00492  * @param   pXfoObj Pointer to XfoObj instance.
00493  * @param   newVal  Pointer to a null-terminated string to be used as the path name of the output file.
00494  */
00495 XFOINTERFACE_API void xfo_setOutputFilePathW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00496 
00497 /**
00498  * Get the path name of XML-format Option setting file which describes AH Formatter options.
00499  *
00500  * @param   pXfoObj Pointer to XfoObj instance.
00501  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00502  *            the string is truncated and terminated with a NULL character.
00503  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00504  * @param   n       Specifies to get n-th URI. 0 means first URI.
00505  * @return  Returns the 'pVal'.
00506  */
00507 XFOINTERFACE_API char* xfo_getOptionFileURI(CXfoObjPtr pXfoObj, char* pVal, int size, int n);
00508 /**
00509  * Get the path name of XML-format Option setting file which describes AH Formatter options.
00510  *
00511  * @param   pXfoObj Pointer to XfoObj instance.
00512  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00513  *            the string is truncated and terminated with a NULL character.
00514  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00515  * @param   n       Specifies to get n-th URI. 0 means first URI.
00516  * @return  Returns the 'pVal'.
00517  */
00518 XFOINTERFACE_API wchar_t* xfo_getOptionFileURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size, int n);
00519 
00520 /**
00521  * Specifies the path name of XML-format Option setting file which describes AH Formatter options.
00522  * The set of former URIs is thrown away.
00523  *
00524  * @param   pXfoObj Pointer to XfoObj instance.
00525  * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
00526  */
00527 XFOINTERFACE_API void xfo_setOptionFileURI(CXfoObjPtr pXfoObj, const char* newVal);
00528 /**
00529  * Specifies the path name of XML-format Option setting file which describes AH Formatter options.
00530  * The set of former URIs is thrown away.
00531  *
00532  * @param   pXfoObj Pointer to XfoObj instance.
00533  * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
00534  */
00535 XFOINTERFACE_API void xfo_setOptionFileURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00536 
00537 /**
00538  * Append the path name of XML-format Option setting file which describes AH Formatter options.
00539  * @since 3.1
00540  *
00541  * @param   pXfoObj Pointer to XfoObj instance.
00542  * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
00543  */
00544 XFOINTERFACE_API void xfo_addOptionFileURI(CXfoObjPtr pXfoObj, const char* newVal);
00545 /**
00546  * Append the path name of XML-format Option setting file which describes AH Formatter options.
00547  * @since 3.1
00548  *
00549  * @param   pXfoObj Pointer to XfoObj instance.
00550  * @param   newVal  Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
00551  */
00552 XFOINTERFACE_API void xfo_addOptionFileURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00553 
00554 /**
00555  * Get the number of URIs of XML-format Option setting file which describes AH Formatter options.
00556  * @since 3.1
00557  *
00558  * @param   pXfoObj Pointer to XfoObj instance.
00559  * @return  Returns the number of URIs.
00560  */
00561 XFOINTERFACE_API int xfo_getOptionFileCount(CXfoObjPtr pXfoObj);
00562 
00563 /**
00564  * Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
00565  *
00566  * @param   pXfoObj Pointer to XfoObj instance.
00567  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00568  *            the string is truncated and terminated with a NULL character.
00569  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00570  * @return  Returns the 'pVal'.
00571  */
00572 XFOINTERFACE_API char* xfo_getOutputFOPath(CXfoObjPtr pXfoObj, char* pVal, int size);
00573 /**
00574  * Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
00575  *
00576  * @param   pXfoObj Pointer to XfoObj instance.
00577  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00578  *            the string is truncated and terminated with a NULL character.
00579  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00580  * @return  Returns the 'pVal'.
00581  */
00582 XFOINTERFACE_API wchar_t* xfo_getOutputFOPathW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00583 
00584 /**
00585  * Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
00586  * If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
00587  * If the setting is omitted, nothing outputs.
00588  *
00589  * @param   pXfoObj Pointer to XfoObj instance.
00590  * @param   newVal  Pointer to a null-terminated string to be used as the path name of output FO file.
00591  */
00592 XFOINTERFACE_API void xfo_setOutputFOPath(CXfoObjPtr pXfoObj, const char* newVal);
00593 /**
00594  * Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
00595  * If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
00596  * If the setting is omitted, nothing outputs.
00597  *
00598  * @param   pXfoObj Pointer to XfoObj instance.
00599  * @param   newVal  Pointer to a null-terminated string to be used as the path name of output FO file.
00600  */
00601 XFOINTERFACE_API void xfo_setOutputFOPathW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00602 
00603 /**
00604      * Get the command line of External XSLT Processor.
00605  *
00606  * @param   pXfoObj Pointer to XfoObj instance.
00607  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00608  *            the string is truncated and terminated with a NULL character.
00609  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00610  * @return  Returns the 'pVal'.
00611  */
00612 XFOINTERFACE_API char* xfo_getExternalXSLT(CXfoObjPtr pXfoObj, char* pVal, int size);
00613 /**
00614      * Get the command line of External XSLT Processor.
00615  *
00616  * @param   pXfoObj Pointer to XfoObj instance.
00617  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00618  *            the string is truncated and terminated with a NULL character.
00619  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00620  * @return  Returns the 'pVal'.
00621  */
00622 XFOINTERFACE_API wchar_t* xfo_getExternalXSLTW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00623 
00624 /**
00625  * Specifies the command line of External XSLT Processor.
00626  * If this is omitted, default MSXML3 will be used. For example:
00627  * <pre>
00628  *  xslt \%param -o \%3 \%1 \%2</pre>
00629  *
00630  * These meanings are as follows.<pre>
00631  *  \%1 : XML Document
00632  *  \%2 : XSL Stylesheet
00633  *  \%3 : XSLT Output File
00634  *  \%param : xsl:param</pre>
00635  * \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
00636  * In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
00637  *
00638  * @param   pXfoObj Pointer to XfoObj instance.
00639  * @param   newVal  Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
00640  */
00641 XFOINTERFACE_API void xfo_setExternalXSLT(CXfoObjPtr pXfoObj, const char* newVal);
00642 
00643 /**
00644  * Specifies the command line of External XSLT Processor.
00645  * If this is omitted, default MSXML3 will be used. For example:
00646  * <pre>
00647  *  xslt \%param -o \%3 \%1 \%2</pre>
00648  *
00649  * These meanings are as follows.<pre>
00650  *  \%1 : XML Document
00651  *  \%2 : XSL Stylesheet
00652  *  \%3 : XSLT Output File
00653  *  \%param : xsl:param</pre>
00654  * \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
00655  * In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
00656  *
00657  * @param   pXfoObj Pointer to XfoObj instance.
00658  * @param   newVal  Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
00659  */
00660 XFOINTERFACE_API void xfo_setExternalXSLTW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00661 
00662 /**
00663  * Get the default base URI.
00664  *
00665  * @param   pXfoObj Pointer to XfoObj instance.
00666  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00667  *            the string is truncated and terminated with a NULL character.
00668  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00669  * @return  Returns the 'pVal'.
00670  */
00671 XFOINTERFACE_API char* xfo_getBaseURI(CXfoObjPtr pXfoObj, char* pVal, int size);
00672 /**
00673  * Get the default base URI.
00674  *
00675  * @param   pXfoObj Pointer to XfoObj instance.
00676  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00677  *            the string is truncated and terminated with a NULL character.
00678  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00679  * @return  Returns the 'pVal'.
00680  */
00681 XFOINTERFACE_API wchar_t* xfo_getBaseURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00682 
00683 /**
00684  * Specifies the default base URI.
00685  *
00686  * @param   pXfoObj Pointer to XfoObj instance.
00687  * @param   newVal  Pointer to a null-terminated string to be used as the default base URI.
00688  */
00689 XFOINTERFACE_API void xfo_setBaseURI(CXfoObjPtr pXfoObj, const char* newVal);
00690 /**
00691  * Specifies the default base URI.
00692  *
00693  * @param   pXfoObj Pointer to XfoObj instance.
00694  * @param   newVal  Pointer to a null-terminated string to be used as the default base URI.
00695  */
00696 XFOINTERFACE_API void xfo_setBaseURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00697 
00698 /**
00699  * Get the parameter format of xsl:param when using External XSLT Processor.
00700  *
00701  * @param   pXfoObj Pointer to XfoObj instance.
00702  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00703  *            the string is truncated and terminated with a NULL character.
00704  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00705  * @return  Returns the 'pVal'.
00706  */
00707 XFOINTERFACE_API char* xfo_getXSLTParamFormat(CXfoObjPtr pXfoObj, char* pVal, int size);
00708 /**
00709  * Get the parameter format of xsl:param when using External XSLT Processor.
00710  *
00711  * @param   pXfoObj Pointer to XfoObj instance.
00712  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
00713  *            the string is truncated and terminated with a NULL character.
00714  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
00715  * @return  Returns the 'pVal'.
00716  */
00717 XFOINTERFACE_API wchar_t* xfo_getXSLTParamFormatW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
00718 
00719 /**
00720  * Specifies the parameter format of xsl:param when using External XSLT Processor.  For example:
00721  * <pre>
00722  *   -p \%p \%v</pre>
00723  *
00724  * These meanings are as follows.<pre>
00725  *  \%p : Parameter Name
00726  *  \%v : Parameter Value</pre>
00727  *
00728  * @param   pXfoObj Pointer to XfoObj instance.
00729  * @param   newVal  Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
00730  */
00731 XFOINTERFACE_API void xfo_setXSLTParamFormat(CXfoObjPtr pXfoObj, const char* newVal);
00732 /**
00733  * Specifies the parameter format of xsl:param when using External XSLT Processor.  For example:
00734  * <pre>
00735  *   -p \%p \%v</pre>
00736  *
00737  * These meanings are as follows.<pre>
00738  *  \%p : Parameter Name
00739  *  \%v : Parameter Value</pre>
00740  *
00741  * @param   pXfoObj Pointer to XfoObj instance.
00742  * @param   newVal  Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
00743  */
00744 XFOINTERFACE_API void xfo_setXSLTParamFormatW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00745 
00746 /**
00747  * Get the start page number of document to output.
00748  *
00749  * @param   pXfoObj Pointer to XfoObj instance.
00750  * @return  start page number of output.
00751  */
00752 XFOINTERFACE_API long xfo_getStartPage(CXfoObjPtr pXfoObj);
00753 
00754 /**
00755  * Specifies the start page number of document to output.
00756  * If the start page is omitted or the specified value is 0 or less, the start page is
00757  * considered from the first page.
00758  * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
00759  *
00760  * @param   pXfoObj Pointer to XfoObj instance.
00761  * @param   newVal  start page number of output.
00762  */
00763 XFOINTERFACE_API void xfo_setStartPage(CXfoObjPtr pXfoObj, long newVal);
00764 
00765 /**
00766  * Get the end page number of document to output.
00767  *
00768  * @param   pXfoObj Pointer to XfoObj instance.
00769  * @return  end page number of output.
00770  */
00771 XFOINTERFACE_API long xfo_getEndPage(CXfoObjPtr pXfoObj);
00772 
00773 /**
00774  * Specifies the end page number of document to output.
00775  * If the end page is omitted or the specified value exceeds the actual page number, the end page
00776  * is considered as the last page.
00777  * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
00778  *
00779  * @param   pXfoObj Pointer to XfoObj instance.
00780  * @param   newVal  end page number of output.
00781  */
00782 XFOINTERFACE_API void xfo_setEndPage(CXfoObjPtr pXfoObj, long newVal);
00783 
00784 /**
00785  * @deprecated
00786  * Effective when outputting to PDF.
00787  * Specifies the master password for PDF. The password must be within 32 bytes.
00788  * @since 3.1
00789  *
00790  * @param   pXfoObj Pointer to XfoObj instance.
00791  * @param   newVal  Pointer to a null-terminated string to be used as the master password.
00792  */
00793 XFOINTERFACE_API void xfo_setPdfMasterPassword(CXfoObjPtr pXfoObj, const char* newVal);
00794 
00795 /**
00796  * @deprecated
00797  * Effective when outputting to PDF.
00798  * Specifies the master password for PDF. The password must be within 32 bytes.
00799  * @since 3.1
00800  *
00801  * @param   pXfoObj Pointer to XfoObj instance.
00802  * @param   newVal  Pointer to a null-terminated string to be used as the master password.
00803  */
00804 XFOINTERFACE_API void xfo_setPdfMasterPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00805 
00806 /**
00807  * Effective when outputting to PDF.
00808  * Specifies the owner password for PDF. The password must be within 32 bytes.
00809  * @since 3.1
00810  *
00811  * @param   pXfoObj Pointer to XfoObj instance.
00812  * @param   newVal  Pointer to a null-terminated string to be used as the owner password.
00813  */
00814 XFOINTERFACE_API void xfo_setPdfOwnerPassword(CXfoObjPtr pXfoObj, const char* newVal);
00815 
00816 /**
00817  * Effective when outputting to PDF.
00818  * Specifies the owner password for PDF. The password must be within 32 bytes.
00819  * @since 3.1
00820  *
00821  * @param   pXfoObj Pointer to XfoObj instance.
00822  * @param   newVal  Pointer to a null-terminated string to be used as the owner password.
00823  */
00824 XFOINTERFACE_API void xfo_setPdfOwnerPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00825 
00826 /**
00827  * Effective when outputting to PDF.
00828  * Specifies the user password for PDF. The password must be within 32 bytes.
00829  * @since 3.1
00830  *
00831  * @param   pXfoObj Pointer to XfoObj instance.
00832  * @param   newVal  Pointer to a null-terminated string to be used as the user password.
00833  */
00834 XFOINTERFACE_API void xfo_setPdfUserPassword(CXfoObjPtr pXfoObj, const char* newVal);
00835 
00836 /**
00837  * Effective when outputting to PDF.
00838  * Specifies the user password for PDF. The password must be within 32 bytes.
00839  * @since 3.1
00840  *
00841  * @param   pXfoObj Pointer to XfoObj instance.
00842  * @param   newVal  Pointer to a null-terminated string to be used as the user password.
00843  */
00844 XFOINTERFACE_API void xfo_setPdfUserPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
00845 
00846 /**
00847  * Effective when outputting to PDF.
00848  * Disables printing the PDF file.
00849  * @since 3.1
00850  *
00851  * @param   pXfoObj Pointer to XfoObj instance.
00852  * @param   newVal  If nonezero is specified, Disables printing the PDF file.
00853  */
00854 XFOINTERFACE_API void xfo_setPdfNoPrinting(CXfoObjPtr pXfoObj, long newVal);
00855 
00856 /**
00857  * Effective when outputting to PDF.
00858  * Get disables printing the PDF file.
00859  * @since 3.1
00860  *
00861  * @param   pXfoObj Pointer to XfoObj instance.
00862  * @return  If zero is returned, Enables printing the PDF file.
00863  *          If nonezero is returned, Disables printing the PDF file.
00864  */
00865 XFOINTERFACE_API long xfo_getPdfNoPrinting(CXfoObjPtr pXfoObj);
00866 
00867 /**
00868  * Effective when outputting to PDF.
00869  * Disables making changes of the PDF file.
00870  * @since 3.1
00871  *
00872  * @param   pXfoObj Pointer to XfoObj instance.
00873  * @param   newVal  If nonezero is specified, Disables making changes of the PDF file.
00874  */
00875 XFOINTERFACE_API void xfo_setPdfNoChanging(CXfoObjPtr pXfoObj, long newVal);
00876 
00877 /**
00878  * Effective when outputting to PDF.
00879  * Get disables making changes of the PDF file.
00880  * @since 3.1
00881  *
00882  * @param   pXfoObj Pointer to XfoObj instance.
00883  * @return  If zero is returned, Enables making changes of the PDF file.
00884  *          If nonezero is returned, Disables making changes of the PDF file.
00885  */
00886 XFOINTERFACE_API long xfo_getPdfNoChanging(CXfoObjPtr pXfoObj);
00887 
00888 /**
00889  * Effective when outputting to PDF.
00890  * Disables copying the content of the PDF file.
00891  * @since 3.1
00892  *
00893  * @param   pXfoObj Pointer to XfoObj instance.
00894  * @param   newVal  If nonezero is specified, Disables copying the content of the PDF file.
00895  */
00896 XFOINTERFACE_API void xfo_setPdfNoContentCopying(CXfoObjPtr pXfoObj, long newVal);
00897 
00898 /**
00899  * Effective when outputting to PDF.
00900  * Get disables copying the content of the PDF file.
00901  * @since 3.1
00902  *
00903  * @param   pXfoObj Pointer to XfoObj instance.
00904  * @return  If zero is returned, Enables copying the content of the PDF file.
00905  *          If nonezero is returned, Disables copying the content of the PDF file.
00906  */
00907 XFOINTERFACE_API long xfo_getPdfNoContentCopying(CXfoObjPtr pXfoObj);
00908 
00909 /**
00910  * Effective when outputting to PDF.
00911  * Disables adding comments and form fields to the PDF file.
00912  * @since 3.1
00913  *
00914  * @param   pXfoObj Pointer to XfoObj instance.
00915  * @param   newVal  If nonezero is specified, Disables adding comments and form fields to the PDF file.
00916  */
00917 XFOINTERFACE_API void xfo_setPdfNoAddingOrChangingComments(CXfoObjPtr pXfoObj, long newVal);
00918 
00919 /**
00920  * Effective when outputting to PDF.
00921  * Get disables adding comments and form fields to the PDF file.
00922  * @since 3.1
00923  *
00924  * @param   pXfoObj Pointer to XfoObj instance.
00925  * @return  If zero is returned, Enables adding comments and form fields to the PDF file.
00926  *          If nonezero is returned, Disables adding comments and form fields to the PDF file.
00927  */
00928 XFOINTERFACE_API long xfo_getPdfNoAddingOrChangingComments(CXfoObjPtr pXfoObj);
00929 
00930 /**
00931  * Effective when outputting to PDF.
00932  * Set the version of PDF.
00933  * @since 3.1
00934  *
00935  * @param   pXfoObj Pointer to XfoObj instance.
00936  * @param   newVal  Specifies the version of PDF.
00937  */
00938 XFOINTERFACE_API void xfo_setPdfVersion(CXfoObjPtr pXfoObj, XfoPDFVERSION newVal);
00939 
00940 /**
00941  * Effective when outputting to PDF.
00942  * Get the version of PDF.
00943  * @since 3.1
00944  *
00945  * @param   pXfoObj Pointer to XfoObj instance.
00946  * @return  the version of PDF.
00947  */
00948 XFOINTERFACE_API XfoPDFVERSION  xfo_getPdfVersion(CXfoObjPtr pXfoObj);
00949 
00950 /**
00951  * Effective when outputting to PDF.
00952  * Disables filling in of form fields and signing of the PDF file.
00953  * This parameter is effective only when you specify PDF1.4 or later to PDF version.
00954  * @since 3.1
00955  *
00956  * @param   pXfoObj Pointer to XfoObj instance.
00957  * @param   newVal  If nonezero is specified, Disables filling in of form fields and signing of the PDF file.
00958  */
00959 XFOINTERFACE_API void xfo_setPdfNoFillForm(CXfoObjPtr pXfoObj, long newVal);
00960 
00961 /**
00962  * Effective when outputting to PDF.
00963  * Get disables filling in of form fields and signing of the PDF file.
00964  * @since 3.1
00965  *
00966  * @param   pXfoObj Pointer to XfoObj instance.
00967  * @return  If zero is returned, Enables filling in of form fields and signing of the PDF file.
00968  *          If nonezero is returned, Disables filling in of form fields and signing of the PDF file.
00969  */
00970 XFOINTERFACE_API long xfo_getPdfNoFillForm(CXfoObjPtr pXfoObj);
00971 
00972 /**
00973  * Effective when outputting to PDF.
00974  * Disables text access for screen reader devices of the PDF file.
00975  * This parameter is effective only when you specify 1.4 or later with PDF version.
00976  * @since 3.1
00977  *
00978  * @param   pXfoObj Pointer to XfoObj instance.
00979  * @param   newVal  If nonezero is specified, Disables text access for screen reader devices of the PDF file.
00980  */
00981 XFOINTERFACE_API void xfo_setPdfNoAccessibility(CXfoObjPtr pXfoObj, long newVal);
00982 
00983 /**
00984  * Effective when outputting to PDF.
00985  * Get disables text access for screen reader devices of the PDF file.
00986  * @since 3.1
00987  *
00988  * @param   pXfoObj Pointer to XfoObj instance.
00989  * @return  If zero is returned, Enables text access for screen reader devices of the PDF file.
00990  *          If nonezero is returned, Disables text access for screen reader devices of the PDF file.
00991  */
00992 XFOINTERFACE_API long xfo_getPdfNoAccessibility(CXfoObjPtr pXfoObj);
00993 
00994 /**
00995  * Effective when outputting to PDF.
00996  * Disables inserting, deleting and rotating the PDF pages.
00997  * This parameter is effective only when you specify 1.4 or later with PDF version
00998  * @since 3.1
00999  *
01000  * @param   pXfoObj Pointer to XfoObj instance.
01001  * @param   newVal  If nonezero is specified, Disables inserting, deleting and rotating the PDF pages.
01002  */
01003 XFOINTERFACE_API void xfo_setPdfNoAssembleDoc(CXfoObjPtr pXfoObj, long newVal);
01004 
01005 /**
01006  * Effective when outputting to PDF.
01007  * Get disables inserting, deleting and rotating the PDF pages.
01008  * @since 3.1
01009  *
01010  * @param   pXfoObj Pointer to XfoObj instance.
01011  * @return  If zero is returned, Enables inserting, deleting and rotating the PDF pages.
01012  *          If nonezero is returned, Disables inserting, deleting and rotating the PDF pages.
01013  */
01014 XFOINTERFACE_API long xfo_getPdfNoAssembleDoc(CXfoObjPtr pXfoObj);
01015 
01016 /**
01017  * Effective when outputting to PDF.
01018  * Specifies the key length when encrypting the PDF file during outputting.
01019  * The key length can be specified as either 40 or 128 (bit).
01020  * This parameter is effective only when you specify PDF1.4 or later with PDF version
01021  * @since 3.1
01022  *
01023  * @param   pXfoObj Pointer to XfoObj instance.
01024  * @param   newVal  Specifies the key length.
01025  */
01026 XFOINTERFACE_API void xfo_setPdfEncryptLevel(CXfoObjPtr pXfoObj, XfoPDFENCRYPTLEVEL newVal);
01027 
01028 /**
01029  * Effective when outputting to PDF.
01030  * Get the key length when encrypting the PDF file during outputting.
01031  * @since 3.1
01032  *
01033  * @param   pXfoObj Pointer to XfoObj instance.
01034  * @return  the key length.
01035  */
01036 XFOINTERFACE_API XfoPDFENCRYPTLEVEL xfo_getPdfEncryptLevel(CXfoObjPtr pXfoObj);
01037 
01038 /**
01039  * Effective when outputting to PDF.
01040  * Gets the value of whether to embed all embeddable fonts in PDF.
01041  * @since 3.1
01042  *
01043  * @param   pXfoObj Pointer to XfoObj instance.
01044  * @return  the value of whether to embed all embeddable fonts
01045  */
01046 XFOINTERFACE_API long xfo_getPdfEmbedAllFonts(CXfoObjPtr pXfoObj);
01047 
01048 /**
01049  * Effective when outputting to PDF.
01050  * Embeds all embeddable fonts in PDF to create.
01051  * @since 3.1
01052  *
01053  * @param   pXfoObj Pointer to XfoObj instance.
01054  * @param   newVal  If the value is 'true' is specified, Embeds all embeddable fonts
01055  */
01056 XFOINTERFACE_API void xfo_setPdfEmbedAllFonts(CXfoObjPtr pXfoObj, long newVal);
01057 
01058 /**
01059  * Effective when outputting to PDF.
01060  * Gets the font specified to be embedded in PDF.
01061  * @since 3.1
01062  *
01063  * @param   pXfoObj Pointer to XfoObj instance.
01064  * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
01065  *            the string is truncated and terminated with a NULL character.
01066  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01067  * @return  Returns the 'pVal'.
01068  */
01069 XFOINTERFACE_API char* xfo_getPdfEmbedFonts(CXfoObjPtr pXfoObj, char* pVal, int size);
01070 
01071 /**
01072  * Effective when outputting to PDF.
01073  * Gets the font specified to be embedded in PDF.
01074  * @since 3.1
01075  *
01076  * @param   pXfoObj Pointer to XfoObj instance.
01077  * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
01078  *            the string is truncated and terminated with a NULL character.
01079  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01080  * @return  Returns the 'pVal'.
01081  */
01082 XFOINTERFACE_API wchar_t* xfo_getPdfEmbedFontsW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
01083 
01084 /**
01085  * Effective when outputting to PDF.
01086  * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
01087  * @since 3.1
01088  *
01089  * @param   pXfoObj Pointer to XfoObj instance.
01090  * @param   newVal  fonts specified to embed
01091  */
01092 XFOINTERFACE_API void xfo_setPdfEmbedFonts(CXfoObjPtr pXfoObj, const char* newVal);
01093 
01094 /**
01095  * Effective when outputting to PDF.
01096  * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts.
01097  * @since 3.1
01098  *
01099  * @param   pXfoObj Pointer to XfoObj instance.
01100  * @param   newVal  fonts specified to embed
01101  */
01102 XFOINTERFACE_API void xfo_setPdfEmbedFontsW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
01103 
01104 /**
01105  * Effective when outputting to PDF.
01106  * Gets the value of whether to issues the error when failing to embed fonts.
01107  * @since 3.1
01108  *
01109  * @param   pXfoObj Pointer to XfoObj instance.
01110  * @return  the value of whether to issues the error
01111  */
01112 XFOINTERFACE_API long xfo_getPdfErrorOnEmbedFault(CXfoObjPtr pXfoObj);
01113 
01114 /**
01115  * Effective when outputting to PDF.
01116  * An error is issued in case of failing to embed fonts.
01117  * @since 3.1
01118  *
01119  * @param   pXfoObj Pointer to XfoObj instance.
01120  * @param   newVal  If the value is 'true' is specified, an error is issued.
01121  */
01122 XFOINTERFACE_API void xfo_setPdfErrorOnEmbedFault(CXfoObjPtr pXfoObj, long newVal);
01123 
01124 /**
01125  * Effective when outputting to PDF.
01126  * Gets the value of whether to issues the error when missing glyph.
01127  * @since 3.3
01128  *
01129  * @param   pXfoObj Pointer to XfoObj instance.
01130  * @return  the value of whether to issues the error
01131  */
01132 XFOINTERFACE_API long xfo_getPdfErrorOnMissingGlyph(CXfoObjPtr pXfoObj);
01133 
01134 /**
01135  * Effective when outputting to PDF.
01136  * An error is issued in case of missing glyph.
01137  * @since 3.3
01138  *
01139  * @param   pXfoObj Pointer to XfoObj instance.
01140  * @param   newVal  If the value is 'true' is specified, an error is issued.
01141  */
01142 XFOINTERFACE_API void xfo_setPdfErrorOnMissingGlyph(CXfoObjPtr pXfoObj, long newVal);
01143 
01144 /**
01145  * Effective when outputting to PDF.
01146  * Subset embedded fonts when percent of characters used is less than.
01147  * @since 5.2
01148  *
01149  * @param   pXfoObj Pointer to XfoObj instance.
01150  * @return  the value of percent to embeds subset font
01151  */
01152 XFOINTERFACE_API long xfo_getPdfEmbedSubsetFontPercentage(CXfoObjPtr pXfoObj);
01153 
01154 /**
01155  * Effective when outputting to PDF.
01156  * Subset embedded fonts when percent of characters used is less than.
01157  * @since 5.2
01158  *
01159  * @param   pXfoObj Pointer to XfoObj instance.
01160  * @param   newVal  percent to embeds subset font
01161  */
01162 XFOINTERFACE_API void xfo_setPdfEmbedSubsetFontPercentage(CXfoObjPtr pXfoObj, long newVal);
01163 
01164 /**
01165  * Effective when outputting to PDF.
01166  * Gets the value of whether to print the resulting PDF file or not.
01167  * @since 3.1
01168  *
01169  * <table border="0" cellspacing="0" cellpadding="0">
01170  *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
01171  *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
01172  *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
01173  * </table>
01174  *
01175  * @param   pXfoObj Pointer to XfoObj instance.
01176  * @return  the value of printing allowed
01177  */
01178 XFOINTERFACE_API XfoPDFPRINTALLOW xfo_getPdfPrintingAllowed(CXfoObjPtr pXfoObj);
01179 
01180 /**
01181  * Effective when outputting to PDF.
01182  * Spesifies whether to permit printing PDF to create with one of the following values.
01183  * This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion).
01184  * @since 3.1
01185  *
01186  * <table border="0" cellspacing="0" cellpadding="0">
01187  *  <tr><td>PRALLOW_NONE    </td><td>= 0 Not Allowed</td></tr>
01188  *  <tr><td>PRALLOW_LOW     </td><td>= 1 Low Resolution Printing</td></tr>
01189  *  <tr><td>PRALLOW_HIGH    </td><td>= 2 High Resolution Printing</td></tr>
01190  * </table>
01191  *
01192  * @param   pXfoObj Pointer to XfoObj instance.
01193  * @param   newVal  the value of printing allowed
01194  */
01195 XFOINTERFACE_API void xfo_setPdfPrintingAllowed(CXfoObjPtr pXfoObj, XfoPDFPRINTALLOW newVal);
01196 
01197 /**
01198  * Effective when outputting to PDF.
01199  * Gets the value of how to compress the color images embedded in PDF.
01200  * @since 3.1
01201  *
01202  * <table border="0" cellspacing="0" cellpadding="0">
01203  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
01204  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
01205  *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
01206  *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
01207  * </table>
01208  *
01209  * @param   pXfoObj Pointer to XfoObj instance.
01210  * @return  the value of how raster graphics are compressed and stored
01211  */
01212 XFOINTERFACE_API XfoPDFIMAGECOMPRESSION xfo_getPdfImageCompression(CXfoObjPtr pXfoObj);
01213 
01214 /**
01215  * Effective when outputting to PDF.
01216  * 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>
01217  * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of xfo_setPdfJPEGQuality and xfo_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
01218 This is the setting for the color image. Spesify xfo_setPdfGrayscaleImageCompression for the grayscale image, and xfo_setPdfMonochromeImageCompression for the monochrome image.
01219  * @since 3.1
01220  *
01221  * <table border="0" cellspacing="0" cellpadding="0">
01222  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
01223  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
01224  *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
01225  *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
01226  * </table>
01227  *
01228  * @param   pXfoObj Pointer to XfoObj instance.
01229  * @param   newVal  the value of how raster graphics are compressed and stored
01230  */
01231 XFOINTERFACE_API void xfo_setPdfImageCompression(CXfoObjPtr pXfoObj, XfoPDFIMAGECOMPRESSION newVal);
01232 
01233 /**
01234  * Gets the value of the quality of JPEG format that is specified by xfo_setPdfImageCompression() stored in PDF.
01235  * @since 3.1
01236  *
01237  * @param   pXfoObj Pointer to XfoObj instance.
01238  * @return  the value of the quality of JPEG format
01239  */
01240 XFOINTERFACE_API int     xfo_getPdfJPEGQuality(CXfoObjPtr pXfoObj);
01241 
01242 /**
01243  * Effective when outputting to PDF.
01244  * 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>
01245  * CAUTION:     It is not for changing the quality of a JPEG format image.<BR>
01246  * This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image.
01247  * @since 3.1
01248  *
01249  * @param   pXfoObj Pointer to XfoObj instance.
01250  * @param   newVal  the value of the quality of JPEG format
01251  */
01252 XFOINTERFACE_API void xfo_setPdfJPEGQuality(CXfoObjPtr pXfoObj, int newVal);
01253 
01254 /**
01255  * Effective when outputting to PDF.
01256  * 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.
01257  * @since 3.1
01258  *
01259  * @param   pXfoObj Pointer to XfoObj instance.
01260  * @return  the value of whether make the size of PDF smaller or not
01261  */
01262 XFOINTERFACE_API long xfo_getPdfCompressContentStream(CXfoObjPtr pXfoObj);
01263 
01264 /**
01265  * Effective when outputting to PDF.
01266  * Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not.
01267  * @since 3.1
01268  *
01269  * @param   pXfoObj Pointer to XfoObj instance.
01270  * @param   newVal  If the value is 'true' is specified, make the PDF compress
01271  */
01272 XFOINTERFACE_API void xfo_setPdfCompressContentStream(CXfoObjPtr pXfoObj, long newVal);
01273 
01274 /**
01275  * Effective when outputting to PDF.
01276  * Gets the value of how to transform external link specified by the relative address in the PDF link.
01277  * @since 3.1
01278  *
01279  * @param   pXfoObj Pointer to XfoObj instance.
01280  * @return  the value of how to transform external link
01281  */
01282 XFOINTERFACE_API long xfo_getPdfUseLaunchForRelativeURI(CXfoObjPtr pXfoObj);
01283 
01284 /**
01285  * Effective when outputting to PDF.
01286  * 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.
01287  * @since 3.1
01288  *
01289  * @param   pXfoObj Pointer to XfoObj instance.
01290  * @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'
01291  */
01292 XFOINTERFACE_API void xfo_setPdfUseLaunchForRelativeURI(CXfoObjPtr pXfoObj, long newVal);
01293 
01294 /**
01295  * Effective when outputting to PDF.
01296  * Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray.
01297  * @since 3.1
01298  *
01299  * <table border="0" cellspacing="0" cellpadding="0">
01300  *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
01301  *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
01302  *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
01303  *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
01304  * </table>
01305  *
01306  * @param   pXfoObj Pointer to XfoObj instance.
01307  * @return  the value of how to convert
01308  */
01309 XFOINTERFACE_API XfoPDFRGBCONVERSION xfo_getPdfRGBConversion(CXfoObjPtr pXfoObj);
01310 
01311 /**
01312  * Effective when outputting to PDF.
01313  * Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray.
01314  * @since 3.1
01315  *
01316  * <table border="0" cellspacing="0" cellpadding="0">
01317  *  <tr><td>RGBCONV_NONE    </td><td>= 0 No Conversion</td></tr>
01318  *  <tr><td>RGBCONV_BLACK   </td><td>= 1 Black to DeviceGray</td></tr>
01319  *  <tr><td>RGBCONV_GRAY    </td><td>= 2 Gray to DeviceGray</td></tr>
01320  *  <tr><td>RGBCONV_ALL     </td><td>= 3 All RGB to DeviceGray</td></tr>
01321  * </table>
01322  *
01323  * @param   pXfoObj Pointer to XfoObj instance.
01324  * @param   newVal  the value of how to convert
01325  */
01326 XFOINTERFACE_API void xfo_setPdfRGBConversion(CXfoObjPtr pXfoObj, XfoPDFRGBCONVERSION newVal);
01327 
01328 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01329 
01330 /**
01331  * Effective when outputting to PDF.
01332  * Gets the value of the rasterised-resolution of the transformed raster images.
01333  * @since 3.1
01334  *
01335  * @param   pXfoObj Pointer to XfoObj instance.
01336  * @return  Rasterised-resolution
01337  */
01338 XFOINTERFACE_API int xfo_getPdfRasterizeResolution(CXfoObjPtr pXfoObj);
01339 
01340 /**
01341  * Effective when outputting to PDF.
01342  * 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.
01343  * This setting is effective only with Windows version.
01344  * @since 3.1
01345  *
01346  * @param   pXfoObj Pointer to XfoObj instance.
01347  * @param   newVal  Rasterised-resolution (70 to 500)
01348  */
01349 XFOINTERFACE_API void xfo_setPdfRasterizeResolution(CXfoObjPtr pXfoObj, int newVal);
01350 
01351 #endif
01352 
01353 /**
01354  * Effective when outputting to PDF.
01355  * Gets the value of whether to output linearize PDF or not.
01356  * @since 3.3
01357  *
01358  * @param   pXfoObj Pointer to XfoObj instance.
01359  * @return  the value of whether to output linearize pdf or not.
01360  */
01361 XFOINTERFACE_API long xfo_getPdfLinearize(CXfoObjPtr pXfoObj);
01362 
01363 /**
01364  * Effective when outputting to PDF.
01365  * Specifies whether to output linearize PDF or not.
01366  * @since 3.3
01367  *
01368  * @param   pXfoObj Pointer to XfoObj instance.
01369  * @param   newVal  If the value is 'true' is specified, output linearlize PDF.
01370  */
01371 XFOINTERFACE_API void xfo_setPdfLinearize(CXfoObjPtr pXfoObj, long newVal);
01372 
01373 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
01374 
01375 /**
01376  * Effective when outputting to PDF.
01377  * Gets the value of whether to sign a signature to PDF or not.
01378  * @since 4.2
01379  *
01380  * @param   pXfoObj Pointer to XfoObj instance.
01381  * @return  the value of whether to sign a signature to PDF or not.
01382  */
01383 XFOINTERFACE_API long xfo_getPdfSignature(CXfoObjPtr pXfoObj);
01384 
01385 /**
01386  * Effective when outputting to PDF.
01387  * Specifies whether to sign a signature to PDF or not.
01388  * @since 4.2
01389  *
01390  * @param   pXfoObj Pointer to XfoObj instance.
01391  * @param   newVal  If the value is 'true' is specified, sign a signature to PDF.
01392  */
01393 XFOINTERFACE_API void xfo_setPdfSignature(CXfoObjPtr pXfoObj, long newVal);
01394 
01395 /**
01396  * Effective when outputting to PDF.
01397  * Gets the value of a signature information name.
01398  * @since 4.2
01399  *
01400  * @param   pXfoObj Pointer to XfoObj instance.
01401  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01402  *            the string is truncated and terminated with a NULL character.
01403  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01404  * @return  the value of a signature information name.
01405  */
01406 XFOINTERFACE_API char* xfo_getPdfSignatureName(CXfoObjPtr pXfoObj, char* pVal, int size);
01407 
01408 /**
01409  * Effective when outputting to PDF.
01410  * Gets the value of a signature information name.
01411  * @since 4.2
01412  *
01413  * @param   pXfoObj Pointer to XfoObj instance.
01414  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01415  *            the string is truncated and terminated with a NULL character.
01416  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01417  * @return  the value of a signature information name.
01418  */
01419 XFOINTERFACE_API wchar_t* xfo_getPdfSignatureNameW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
01420 
01421 /**
01422  * Effective when outputting to PDF.
01423  * Sets a signature information name.
01424  * @since 4.2
01425  *
01426  * @param   pXfoObj Pointer to XfoObj instance.
01427  * @param   newVal  the value of a signature information name.
01428  */
01429 XFOINTERFACE_API void xfo_setPdfSignatureName(CXfoObjPtr pXfoObj, const char* newVal);
01430 
01431 /**
01432  * Effective when outputting to PDF.
01433  * Sets a signature information name.
01434  * @since 4.2
01435  *
01436  * @param   pXfoObj Pointer to XfoObj instance.
01437  * @param   newVal  the value of a signature information name.
01438  */
01439 XFOINTERFACE_API void xfo_setPdfSignatureNameW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
01440 
01441 /**
01442  * Effective when outputting to PDF.
01443  * Gets the value of a certificate information name.
01444  * @since 4.2
01445  *
01446  * @param   pXfoObj Pointer to XfoObj instance.
01447  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01448  *            the string is truncated and terminated with a NULL character.
01449  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01450  * @return  the value of a certificate information name.
01451  */
01452 XFOINTERFACE_API char* xfo_getPdfCertificateName(CXfoObjPtr pXfoObj, char* pVal, int size);
01453 
01454 /**
01455  * Effective when outputting to PDF.
01456  * Gets the value of a certificate information name.
01457  * @since 4.2
01458  *
01459  * @param   pXfoObj Pointer to XfoObj instance.
01460  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
01461  *            the string is truncated and terminated with a NULL character.
01462  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01463  * @return  the value of a certificate information name.
01464  */
01465 XFOINTERFACE_API wchar_t* xfo_getPdfCertificateNameW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
01466 
01467 /**
01468  * Effective when outputting to PDF.
01469  * Sets a certificate information name.
01470  * @since 4.2
01471  *
01472  * @param   pXfoObj Pointer to XfoObj instance.
01473  * @param   newVal  the value of a certificate information name.
01474  */
01475 XFOINTERFACE_API void xfo_setPdfCertificateName(CXfoObjPtr pXfoObj, const char* newVal);
01476 
01477 /**
01478  * Effective when outputting to PDF.
01479  * Sets a certificate information name.
01480  * @since 4.2
01481  *
01482  * @param   pXfoObj Pointer to XfoObj instance.
01483  * @param   newVal  the value of a certificate information name.
01484  */
01485 XFOINTERFACE_API void xfo_setPdfCertificateNameW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
01486 
01487 #endif
01488 
01489 /**
01490  * Effective when outputting to PDF.
01491  * Gets the value of whether to embed all embeddable fonts
01492  * @since 3.3
01493  *
01494  * <table border="0" cellspacing="0" cellpadding="0">
01495  *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
01496  *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
01497  *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
01498  * </table>
01499  *
01500  * @param   pXfoObj Pointer to XfoObj instance.
01501  * @return  the value of whether to embed all embeddable fonts
01502  */
01503 XFOINTERFACE_API XfoEMBEDALLFONT xfo_getPdfEmbedAllFontsEx(CXfoObjPtr pXfoObj);
01504 
01505 /**
01506  * Effective when outputting to PDF.
01507  * 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.
01508  * @since 3.3
01509  *
01510  * <table border="0" cellspacing="0" cellpadding="0">
01511  *  <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr>
01512  *  <tr><td>EMBALLFONT_ALL  </td><td>= 1 All fonts except Base14 fonts</td></tr>
01513  *  <tr><td>EMBALLFONT_BASE14   </td><td>= 2 All fonts</td></tr>
01514  * </table>
01515  *
01516  *If the value is EMBALLFONT_PART, only fonts specified in xfo_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.
01517  *
01518  * @param   pXfoObj Pointer to XfoObj instance.
01519  * @param   newVal  the value of whether to embed all embeddable fonts
01520  */
01521 XFOINTERFACE_API void xfo_setPdfEmbedAllFontsEx(CXfoObjPtr pXfoObj, XfoEMBEDALLFONT newVal);
01522 
01523 /**
01524  * Effective when outputting to PDF.
01525  * Gets the value of method to downsample the color image
01526  * @since 3.3
01527  *
01528  * @param   pXfoObj Pointer to XfoObj instance.
01529  * @return  the value of method to downsample the color image
01530  */
01531 XFOINTERFACE_API XfoIMAGEDOWNSAMPLING xfo_getPdfImageDownSampling(CXfoObjPtr pXfoObj);
01532 
01533 /**
01534  * Effective when outputting to PDF.
01535  * Specifies the following either of method to downsample the color image that is put into PDF.
01536  * @since 3.3
01537  *
01538  * <table border="0" cellspacing="0" cellpadding="0">
01539  *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
01540  *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
01541  *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
01542  *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
01543  * </table>
01544  *
01545  * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfImageDownSamplingTarget.
01546 This is the setting for the color image. Spesify xfo_setPdfGrayscaleImageDownSampling for the grayscale image, and xfo_setPdfMonochromeImageDownSampling for the monochrome image.
01547  *
01548  * @param   pXfoObj Pointer to XfoObj instance.
01549  * @param   newVal  the value of method to downsample the color image
01550  */
01551 XFOINTERFACE_API void xfo_setPdfImageDownSampling(CXfoObjPtr pXfoObj, XfoIMAGEDOWNSAMPLING newVal);
01552 
01553 /**
01554  * Effective when outputting to PDF.
01555  * Gets resolution when the color image is downsampled.
01556  * @since 3.3
01557  *
01558  * @param   pXfoObj Pointer to XfoObj instance.
01559  * @return  the value of resolution.
01560  */
01561 XFOINTERFACE_API int xfo_getPdfImageDownSamplingTarget(CXfoObjPtr pXfoObj);
01562 
01563 /**
01564  * Effective when outputting to PDF.
01565  * Set resolution when the color image is downsampled.
01566  * @since 3.3
01567  *
01568  * @param   pXfoObj Pointer to XfoObj instance.
01569  * @param   newVal  the value of resolution.
01570  */
01571 XFOINTERFACE_API void xfo_setPdfImageDownSamplingTarget(CXfoObjPtr pXfoObj, int newVal);
01572 
01573 /**
01574  * Effective when outputting to PDF.
01575  * Gets resolution of the color image which performs a downsampling.
01576  * @since 3.3
01577  *
01578  * @param   pXfoObj Pointer to XfoObj instance.
01579  * @return  the value of resolution.
01580  */
01581 XFOINTERFACE_API int xfo_getPdfImageDownSamplingDPI(CXfoObjPtr pXfoObj);
01582 
01583 /**
01584  * Effective when outputting to PDF.
01585  * Set resolution of the color image which performs a downsampling.
01586  * @since 3.3
01587  *
01588  * @param   pXfoObj Pointer to XfoObj instance.
01589  * @param   newVal  the value of resolution.
01590  */
01591 XFOINTERFACE_API void xfo_setPdfImageDownSamplingDPI(CXfoObjPtr pXfoObj, int newVal);
01592 
01593 /**
01594  * Effective when outputting to PDF.
01595  * Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF.
01596  * @since 3.3
01597  *
01598  *
01599  * @param   pXfoObj Pointer to XfoObj instance.
01600  * @return  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
01601  */
01602 XFOINTERFACE_API long xfo_getPdfPutImageColorProfile(CXfoObjPtr pXfoObj);
01603 
01604 /**
01605  * Effective when outputting to PDF.
01606  * Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF.
01607  * @since 3.3
01608  *
01609  * @param   pXfoObj Pointer to XfoObj instance.
01610  * @param   newVal  If nonezero is specified, it is embedded. If zero is specified, it is not embedded.
01611  */
01612 XFOINTERFACE_API void xfo_setPdfPutImageColorProfile(CXfoObjPtr pXfoObj, long newVal);
01613 
01614 /**
01615  * Effective when outputting to PDF.
01616  * Gets the value of how to compress the grayscale images embedded in PDF.
01617  * @since 3.3
01618  *
01619  * <table border="0" cellspacing="0" cellpadding="0">
01620  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
01621  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
01622  *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
01623  *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
01624  * </table>
01625  *
01626  * @param   pXfoObj Pointer to XfoObj instance.
01627  * @return  the value of how raster graphics are compressed and stored
01628  */
01629 XFOINTERFACE_API XfoPDFIMAGECOMPRESSION xfo_getPdfGrayscaleImageCompression(CXfoObjPtr pXfoObj);
01630 
01631 /**
01632  * Effective when outputting to PDF.
01633  * 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>
01634  * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of xfo_setPdfGrayscaleJPEGQuality and xfo_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR>
01635 This is the setting for the grayscale image. Spesify xfo_setPdfImageCompression for the color image, and xfo_setPdfMonochromeImageCompression for the monochrome image.
01636  * @since 3.3
01637  *
01638  * <table border="0" cellspacing="0" cellpadding="0">
01639  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto</td></tr>
01640  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG compression</td></tr>
01641  *  <tr><td>IMGCMPR_ZLIB    </td><td>= 2 ZLIB compression</td></tr>
01642  *  <tr><td>IMGCMPR_JPEG2K  </td><td>= 3 JPEG2000 compression</td></tr>
01643  * </table>
01644  *
01645  * @param   pXfoObj Pointer to XfoObj instance.
01646  * @param   newVal  the value of how raster graphics are compressed and stored
01647  */
01648 XFOINTERFACE_API void xfo_setPdfGrayscaleImageCompression(CXfoObjPtr pXfoObj, XfoPDFIMAGECOMPRESSION newVal);
01649 
01650 /**
01651  * Effective when outputting to PDF.
01652  * Gets the value of the quality of JPEG format that is specified by xfo_setPdfGrayscaleImageCompression stored in PDF.
01653  * @since 3.3
01654  *
01655  * @param   pXfoObj Pointer to XfoObj instance.
01656  * @return  the value of the quality of JPEG format
01657  */
01658 XFOINTERFACE_API int xfo_getPdfGrayscaleJPEGQuality(CXfoObjPtr pXfoObj);
01659 
01660 /**
01661  * Effective when outputting to PDF.
01662  * 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 xfo_setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR>
01663  * CAUTION: It is not for changing the quality of a JPEG format image.<BR>
01664  * This is the setting for the grayscale image. Spesify xfo_setPdfJPEGQuality for the color image.
01665  * @since 3.3
01666  *
01667  * @param   pXfoObj Pointer to XfoObj instance.
01668  * @param   newVal  the value of the quality of JPEG format
01669  */
01670 XFOINTERFACE_API void xfo_setPdfGrayscaleJPEGQuality(CXfoObjPtr pXfoObj, int newVal);
01671 
01672 /**
01673  * Effective when outputting to PDF.
01674  * Gets the value of method to downsample the grayscale image
01675  * @since 3.3
01676  *
01677  * @param   pXfoObj Pointer to XfoObj instance.
01678  * @return  the value of method to downsample the grayscale image
01679  */
01680 XFOINTERFACE_API XfoIMAGEDOWNSAMPLING xfo_getPdfGrayscaleImageDownSampling(CXfoObjPtr pXfoObj);
01681 
01682 /**
01683  * Effective when outputting to PDF.
01684  * @since 3.3
01685  *
01686  * @param   pXfoObj Pointer to XfoObj instance.
01687  * @param   newVal
01688  */
01689 XFOINTERFACE_API void xfo_setPdfGrayscaleImageDownSampling(CXfoObjPtr pXfoObj, XfoIMAGEDOWNSAMPLING newVal);
01690 
01691 /**
01692  * Effective when outputting to PDF.
01693  * Gets resolution when the grayscale image is downsampled.
01694  * @since 3.3
01695  *
01696  * @param   pXfoObj Pointer to XfoObj instance.
01697  * @return  the value of resolution.
01698  */
01699 XFOINTERFACE_API int xfo_getPdfGrayscaleImageDownSamplingTarget(CXfoObjPtr pXfoObj);
01700 
01701 /**
01702  * Effective when outputting to PDF.
01703  * Specifies the following either of method to downsample the grayscale image that is put into PDF.
01704  * @since 3.3
01705  *
01706  * <table border="0" cellspacing="0" cellpadding="0">
01707  *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
01708  *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
01709  *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
01710  *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
01711  * </table>
01712  *
01713  * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfGrayscaleImageDownSamplingTarget.
01714 This is the setting for the grayscale image. Spesify xfo_setPdfImageDownSampling for the color image, and xfo_setPdfMonochromeImageDownSampling for the monochrome image.
01715  *
01716  * @param   pXfoObj Pointer to XfoObj instance.
01717  * @param   newVal  the value of method to downsample the grayscale image
01718  */
01719 XFOINTERFACE_API void xfo_setPdfGrayscaleImageDownSamplingTarget(CXfoObjPtr pXfoObj, int newVal);
01720 
01721 /**
01722  * Effective when outputting to PDF.
01723  * Gets resolution of the grayscale image which performs a downsampling.
01724  * @since 3.3
01725  *
01726  * @param   pXfoObj Pointer to XfoObj instance.
01727  * @return  the value of resolution.
01728  */
01729 XFOINTERFACE_API int xfo_getPdfGrayscaleImageDownSamplingDPI(CXfoObjPtr pXfoObj);
01730 
01731 /**
01732  * Effective when outputting to PDF.
01733  * Set resolution of the grayscale image which performs a downsampling.
01734  * @since 3.3
01735  *
01736  * @param   pXfoObj Pointer to XfoObj instance.
01737  * @param   newVal  the value of resolution.
01738  */
01739 XFOINTERFACE_API void xfo_setPdfGrayscaleImageDownSamplingDPI(CXfoObjPtr pXfoObj, int newVal);
01740 
01741 /**
01742  * Effective when outputting to PDF.
01743  * Gets the value of how to compress the monochrome images embedded in PDF.
01744  * @since 3.3
01745  *
01746  * <table border="0" cellspacing="0" cellpadding="0">
01747  *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
01748  *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
01749  *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
01750  *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
01751  *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
01752  * </table>
01753  *
01754  * @param   pXfoObj Pointer to XfoObj instance.
01755  * @return  the value of how raster graphics are compressed and stored
01756  */
01757 XFOINTERFACE_API XfoMONOCHROMECOMPRESSION xfo_getPdfMonochromeImageCompression(CXfoObjPtr pXfoObj);
01758 
01759 /**
01760  * Effective when outputting to PDF.
01761  * 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>
01762 This is the setting for the monochrome image. Spesify xfo_setPdfGrayscaleImageCompression for the grayscale image, and xfo_setPdfImageCompression for the color image.
01763  * @since 3.3
01764  *
01765  * <table border="0" cellspacing="0" cellpadding="0">
01766  *  <tr><td>MONOCMPR_CCITT4     </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr>
01767  *  <tr><td>MONOCMPR_CCITT3     </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr>
01768  *  <tr><td>MONOCMPR_RUNLENGTH  </td><td>= 2 RunLengthDecode filter</td></tr>
01769  *  <tr><td>MONOCMPR_ZLIB       </td><td>= 3 FlateDecode filter</td></tr>
01770  *  <tr><td>MONOCMPR_OFF        </td><td>= 4 no filter</td></tr>
01771  * </table>
01772  *
01773  * @param   pXfoObj Pointer to XfoObj instance.
01774  * @param   newVal  the value of how raster graphics are compressed and stored
01775  */
01776 XFOINTERFACE_API void xfo_setPdfMonochromeImageCompression(CXfoObjPtr pXfoObj, XfoMONOCHROMECOMPRESSION newVal);
01777 
01778 /**
01779  * Effective when outputting to PDF.
01780  * Gets the value of method to downsample the monochrome image
01781  * @since 3.3
01782  *
01783  * @param   pXfoObj Pointer to XfoObj instance.
01784  * @return  the value of method to downsample the monochrome image
01785  */
01786 XFOINTERFACE_API XfoIMAGEDOWNSAMPLING xfo_getPdfMonochromeImageDownSampling(CXfoObjPtr pXfoObj);
01787 
01788 /**
01789  * Effective when outputting to PDF.
01790  * Specifies the following either of method to downsample the monochrome image that is put into PDF.
01791  * @since 3.3
01792  *
01793  * <table border="0" cellspacing="0" cellpadding="0">
01794  *  <tr><td>IMGDOWNSAMPLING_NONE    </td><td>= 0 No downsampling </td></tr>
01795  *  <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr>
01796  *  <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr>
01797  *  <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr>
01798  * </table>
01799  *
01800  * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by xfo_setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by xfo_setPdfMonochromeImageDownSamplingTarget.
01801 This is the setting for the monochrome image. Spesify xfo_setPdfImageDownSampling for the color image, and xfo_setPdfGrayscaleImageDownSampling for the grayscale image.
01802  *
01803  * @param   pXfoObj Pointer to XfoObj instance.
01804  * @param   newVal  the value of method to downsample the monochrome image
01805  */
01806 XFOINTERFACE_API void xfo_setPdfMonochromeImageDownSampling(CXfoObjPtr pXfoObj, XfoIMAGEDOWNSAMPLING newVal);
01807 
01808 /**
01809  * Effective when outputting to PDF.
01810  * Gets resolution when the monochrome image is downsampled.
01811  * @since 3.3
01812  *
01813  * @param   pXfoObj Pointer to XfoObj instance.
01814  * @return  the value of resolution.
01815  */
01816 XFOINTERFACE_API int xfo_getPdfMonochromeImageDownSamplingTarget(CXfoObjPtr pXfoObj);
01817 
01818 /**
01819  * Effective when outputting to PDF.
01820  * Set resolution when the monochrome image is downsampled.
01821  * @since 3.3
01822  *
01823  * @param   pXfoObj Pointer to XfoObj instance.
01824  * @param   newVal  the value of resolution.
01825  */
01826 XFOINTERFACE_API void xfo_setPdfMonochromeImageDownSamplingTarget(CXfoObjPtr pXfoObj, int newVal);
01827 
01828 /**
01829  * Effective when outputting to PDF.
01830  * Gets resolution of the monochrome image which performs a downsampling.
01831  * @since 3.3
01832  *
01833  * @param   pXfoObj Pointer to XfoObj instance.
01834  * @return  the value of resolution.
01835  */
01836 XFOINTERFACE_API int xfo_getPdfMonochromeImageDownSamplingDPI(CXfoObjPtr pXfoObj);
01837 
01838 /**
01839  * Effective when outputting to PDF.
01840  * Set resolution of the monochrome image which performs a downsampling.
01841  * @since 3.3
01842  *
01843  * @param   pXfoObj Pointer to XfoObj instance.
01844  * @param   newVal  the value of resolution.
01845  */
01846 XFOINTERFACE_API void xfo_setPdfMonochromeImageDownSamplingDPI(CXfoObjPtr pXfoObj, int newVal);
01847 
01848 /**
01849  * Gets the specification of two pass format.
01850  * @since 4.1
01851  *
01852  * @param   pXfoObj Pointer to XfoObj instance.
01853  * @return  the specification of two pass format.
01854  */
01855 XFOINTERFACE_API long xfo_getTwoPassFormatting(CXfoObjPtr pXfoObj);
01856 
01857 /**
01858  * Set the specification of two pass format.
01859  * @since 4.1
01860  *
01861  * @param   pXfoObj Pointer to XfoObj instance.
01862  * @param   newVal  the specification of two pass format..
01863  */
01864 XFOINTERFACE_API void xfo_setTwoPassFormatting(CXfoObjPtr pXfoObj, long newVal);
01865 
01866 /**
01867  * Effective when outputting to PDF.
01868  * Gets the value of whether to output Tagged PDF or not.
01869  * @since 4.0
01870  *
01871  * @param   pXfoObj Pointer to XfoObj instance.
01872  * @return  the value of whether to output Tagged pdf or not.
01873  */
01874 XFOINTERFACE_API long xfo_getPdfTag(CXfoObjPtr pXfoObj);
01875 
01876 /**
01877  * Effective when outputting to PDF.
01878  * Generates Tagged PDF. Ignored if PDF cannot be tagged depending on the PDF versions.
01879  * @since 4.0
01880  *
01881  * @param   pXfoObj Pointer to XfoObj instance.
01882  * @param   newVal  If the value is 'true' is specified, output Tagged PDF.
01883  */
01884 XFOINTERFACE_API void xfo_setPdfTag(CXfoObjPtr pXfoObj, long newVal);
01885 
01886 /**
01887  * Effective when outputting to PDF.
01888  * Gets the width of PDF to output.
01889  * @since 4.0
01890  *
01891  * @param   pXfoObj Pointer to XfoObj instance.
01892  * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01893  *            the string is truncated and terminated with a NULL character.
01894  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01895  * @return  Returns the 'pVal'.
01896  */
01897 XFOINTERFACE_API char* xfo_getPdfOutputWidth(CXfoObjPtr pXfoObj, char* pVal, int size);
01898 
01899 /**
01900  * Effective when outputting to PDF.
01901  * Gets the width of PDF to output.
01902  * @since 4.0
01903  *
01904  * @param   pXfoObj Pointer to XfoObj instance.
01905  * @param   pVal        Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer,
01906  *            the string is truncated and terminated with a NULL character.
01907  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01908  * @return  Returns the 'pVal'.
01909  */
01910 XFOINTERFACE_API wchar_t* xfo_getPdfOutputWidthW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
01911 
01912 /**
01913  * Effective when outputting to PDF.
01914  * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01915  * @since 4.0
01916  *
01917  * @param   pXfoObj Pointer to XfoObj instance.
01918  * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01919  */
01920 XFOINTERFACE_API void xfo_setPdfOutputWidth(CXfoObjPtr pXfoObj, const char* newVal);
01921 
01922 /**
01923  * Effective when outputting to PDF.
01924  * Scales the width of PDF to output. A value with a unit or % value can be specified as length.
01925  * @since 4.0
01926  *
01927  * @param   pXfoObj Pointer to XfoObj instance.
01928  * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01929  */
01930 XFOINTERFACE_API void xfo_setPdfOutputWidthW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
01931 
01932 /**
01933  * Effective when outputting to PDF.
01934  * Gets the height of PDF to output.
01935  * @since 4.0
01936  *
01937  * @param   pXfoObj Pointer to XfoObj instance.
01938  * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01939  *            the string is truncated and terminated with a NULL character.
01940  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01941  * @return  Returns the 'pVal'.
01942  */
01943 XFOINTERFACE_API char* xfo_getPdfOutputHeight(CXfoObjPtr pXfoObj, char* pVal, int size);
01944 
01945 /**
01946  * Effective when outputting to PDF.
01947  * Gets the height of PDF to output.
01948  * @since 4.0
01949  *
01950  * @param   pXfoObj Pointer to XfoObj instance.
01951  * @param   pVal        Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer,
01952  *            the string is truncated and terminated with a NULL character.
01953  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
01954  * @return  Returns the 'pVal'.
01955  */
01956 XFOINTERFACE_API wchar_t* xfo_getPdfOutputHeightW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
01957 
01958 /**
01959  * Effective when outputting to PDF.
01960  * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01961  * @since 4.0
01962  *
01963  * @param   pXfoObj Pointer to XfoObj instance.
01964  * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01965  */
01966 XFOINTERFACE_API void xfo_setPdfOutputHeight(CXfoObjPtr pXfoObj, const char* newVal);
01967 
01968 /**
01969  * Effective when outputting to PDF.
01970  * Scales the height of PDF to output. A value with a unit or % value can be specified as length.
01971  * @since 4.0
01972  *
01973  * @param   pXfoObj Pointer to XfoObj instance.
01974  * @param   newVal  Pointer to a null-terminated string to be used as the width of PDF to output.
01975  */
01976 XFOINTERFACE_API void xfo_setPdfOutputHeightW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
01977 
01978 /**
01979  * Effective when outputting to PDF.
01980  * Gets the value of whether to issue error or not when PDF/X is generating.
01981  * @since 4.0
01982  *
01983  * @param   pXfoObj Pointer to XfoObj instance.
01984  * @return  the value of whether to issue error.
01985  */
01986 XFOINTERFACE_API long xfo_getPdfErrorOnPDFXFault(CXfoObjPtr pXfoObj);
01987 
01988 /**
01989  * Effective when outputting to PDF.
01990  * An error is not issued when PDF/X is generating.
01991  * @since 4.0
01992  *
01993  * @param   pXfoObj Pointer to XfoObj instance.
01994  * @param   newVal  If the value is 'true' is specified, no error is issued.
01995  */
01996 XFOINTERFACE_API void xfo_setPdfErrorOnPDFXFault(CXfoObjPtr pXfoObj, long newVal);
01997 
01998 /**
01999  * Effective when outputting to PDF.
02000  * Output reverse page or not.
02001  * @since 5.2
02002  *
02003  * @param   pXfoObj Pointer to XfoObj instance.
02004  * @return  the value of whether to output reverse page or not.
02005  */
02006 XFOINTERFACE_API long xfo_getPdfReversePage(CXfoObjPtr pXfoObj);
02007 
02008 /**
02009  * Effective when outputting to PDF.
02010  * Output reverse page or not.
02011  * @since 5.2
02012  *
02013  * @param   pXfoObj Pointer to XfoObj instance.
02014  * @param   newVal  If the value is 'true' is reverse page.
02015  */
02016 XFOINTERFACE_API void xfo_setPdfReversePage(CXfoObjPtr pXfoObj, long newVal);
02017 
02018 /**
02019  * Effective when outputting to PDF.
02020  * Import 3D annotations or not.
02021  * @since 5.2
02022  *
02023  * @param   pXfoObj Pointer to XfoObj instance.
02024  * @return  the value of whether to import 3D annotations or not.
02025  */
02026 XFOINTERFACE_API long xfo_getPdfImport3DAnnotation(CXfoObjPtr pXfoObj);
02027 
02028 /**
02029  * Effective when outputting to PDF.
02030  * Import 3D annotations or not.
02031  * @since 5.2
02032  *
02033  * @param   pXfoObj Pointer to XfoObj instance.
02034  * @param   newVal  If the value is 'true' is import 3D annotations.
02035  */
02036 XFOINTERFACE_API void xfo_setPdfImport3DAnnotation(CXfoObjPtr pXfoObj, long newVal);
02037 
02038 /**
02039  * Effective when outputting to PDF.
02040  * Convert image color space or not.
02041  * @since 5.2
02042  *
02043  * @param   pXfoObj Pointer to XfoObj instance.
02044  * @return  the value of whether to convert image color space or not.
02045  */
02046 XFOINTERFACE_API long xfo_getPdfConvertImageColorSpace(CXfoObjPtr pXfoObj);
02047 
02048 /**
02049  * Effective when outputting to PDF.
02050  * Convert image color space or not.
02051  * @since 5.2
02052  *
02053  * @param   pXfoObj Pointer to XfoObj instance.
02054  * @param   newVal  If the value is 'true' is convert image color space.
02055  */
02056 XFOINTERFACE_API void xfo_setPdfConvertImageColorSpace(CXfoObjPtr pXfoObj, long newVal);
02057 
02058 /**
02059  * Effective when outputting to SVG.
02060  * Get the version of SVG.
02061  * @since 3.3
02062  *
02063  * @param   pXfoObj Pointer to XfoObj instance.
02064  * @return  the version of SVG.
02065  */
02066 XFOINTERFACE_API XfoSVGVERSION  xfo_getSvgVersion(CXfoObjPtr pXfoObj);
02067 
02068 /**
02069  * Effective when outputting to SVG.
02070  * Enables specifying whether the version of SVG is 1.1, Basic or Tiny.
02071  * @since 3.3
02072  *
02073  * @param   pXfoObj Pointer to XfoObj instance.
02074  * @param   newVal  Specifies the version of SVG.
02075  */
02076 XFOINTERFACE_API void xfo_setSvgVersion(CXfoObjPtr pXfoObj, XfoSVGVERSION newVal);
02077 
02078 /**
02079  * Effective when outputting to SVG.
02080  * Gets the setting indicating whether to compress the outputted SVG into gzip format or not.
02081  * @since 3.3
02082  *
02083  * @param   pXfoObj Pointer to XfoObj instance.
02084  * @return  whether gzip compression or not.
02085  */
02086 XFOINTERFACE_API long xfo_getSvgGzipCompression(CXfoObjPtr pXfoObj);
02087 
02088 /**
02089  * Effective when outputting to SVG.
02090  * Specifies whether to compress the outputted SVG into gzip format or not.
02091  * @since 3.3
02092  *
02093  * @param   pXfoObj Pointer to XfoObj instance.
02094  * @param   newVal  If the value is 'true' is specified, enables to compress data into gzip format.
02095  */
02096 XFOINTERFACE_API void xfo_setSvgGzipCompression(CXfoObjPtr pXfoObj, long newVal);
02097 
02098 /**
02099  * Effective when outputting to SVG.
02100  * Gets the setting indicating whether to embed fonts in the outputted SVG.
02101  * @since 3.3
02102  *
02103  * @param   pXfoObj Pointer to XfoObj instance.
02104  * @return  whether embeds fonts or not.
02105  */
02106 XFOINTERFACE_API long xfo_getSvgEmbedAllFonts(CXfoObjPtr pXfoObj);
02107 
02108 /**
02109  * Effective when outputting to SVG.
02110  * Specifies whether to embed fonts in the outputted SVG.
02111  * @since 3.3
02112  *
02113  * @param   pXfoObj Pointer to XfoObj instance.
02114  * @param   newVal  If the value is 'true' is specified, embeds fonts.
02115  */
02116 XFOINTERFACE_API void xfo_setSvgEmbedAllFonts(CXfoObjPtr pXfoObj, long newVal);
02117 
02118 /**
02119  * Effective when outputting to SVG.
02120  * Gets the format for naming files when the outputted SVG becomes multiple.
02121  * @since 3.3
02122  *
02123  * @param   pXfoObj Pointer to XfoObj instance.
02124  * @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.
02125  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02126  * @return  Returns the 'pVal'.
02127  */
02128 XFOINTERFACE_API char* xfo_getSvgFormat(CXfoObjPtr pXfoObj, char* pVal, int size);
02129 
02130 /**
02131  * Effective when outputting to SVG.
02132  * Gets the format for naming files when the outputted SVG becomes multiple.
02133  * @since 3.3
02134  *
02135  * @param   pXfoObj Pointer to XfoObj instance.
02136  * @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.
02137  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02138  * @return  Returns the 'pVal'.
02139  */
02140 XFOINTERFACE_API wchar_t* xfo_getSvgFormatW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02141 
02142 /**
02143  * Effective when outputting to SVG.
02144  * Specifies the format for naming files when the outputted SVG becomes multiple.
02145  * @since 3.3
02146  *
02147  * @param   pXfoObj Pointer to XfoObj instance.
02148  * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
02149  */
02150 XFOINTERFACE_API void xfo_setSvgFormat(CXfoObjPtr pXfoObj, const char* newVal);
02151 
02152 /**
02153  * Effective when outputting to SVG.
02154  * Specifies the format for naming files when the outputted SVG becomes multiple.
02155  * @since 3.3
02156  *
02157  * @param   pXfoObj Pointer to XfoObj instance.
02158  * @param   newVal  Pointer to a null-terminated string to be used as the SVG file name format.
02159  */
02160 XFOINTERFACE_API void xfo_setSvgFormatW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
02161 
02162 /**
02163  * Effective when outputting to SVG.
02164  * Gets the font specified to be embedded in SVG.
02165  * @since 3.3
02166  *
02167  * @param   pXfoObj Pointer to XfoObj instance.
02168  * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
02169  *            the string is truncated and terminated with a NULL character.
02170  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02171  * @return  Returns the 'pVal'.
02172  */
02173 XFOINTERFACE_API char* xfo_getSvgEmbedFonts(CXfoObjPtr pXfoObj, char* pVal, int size);
02174 
02175 /**
02176  * Effective when outputting to SVG.
02177  * Gets the font specified to be embedded in SVG.
02178  * @since 3.3
02179  *
02180  * @param   pXfoObj Pointer to XfoObj instance.
02181  * @param   pVal        Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer,
02182  *            the string is truncated and terminated with a NULL character.
02183  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02184  * @return  Returns the 'pVal'.
02185  */
02186 XFOINTERFACE_API wchar_t* xfo_getSvgEmbedFontsW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02187 
02188 /**
02189  * Effective when outputting to SVG.
02190  * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
02191  * @since 3.3
02192  *
02193  * @param   pXfoObj Pointer to XfoObj instance.
02194  * @param   newVal  fonts specified to embed
02195  */
02196 XFOINTERFACE_API void xfo_setSvgEmbedFonts(CXfoObjPtr pXfoObj, const char* newVal);
02197 
02198 /**
02199  * Effective when outputting to SVG.
02200  * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts.
02201  * @since 3.3
02202  *
02203  * @param   pXfoObj Pointer to XfoObj instance.
02204  * @param   newVal  fonts specified to embed
02205  */
02206 XFOINTERFACE_API void xfo_setSvgEmbedFontsW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
02207 
02208 /**
02209  * Effective when outputting to SVG.
02210  * Gets the value of whether to issues the error when failing to embed fonts.
02211  * @since 3.3
02212  *
02213  * @param   pXfoObj Pointer to XfoObj instance.
02214  * @return  the value of whether to issues the error
02215  */
02216 XFOINTERFACE_API long xfo_getSvgErrorOnEmbedFault(CXfoObjPtr pXfoObj);
02217 
02218 /**
02219  * Effective when outputting to SVG.
02220  * An error is issued in case of failing to embed fonts.
02221  * @since 3.3
02222  *
02223  * @param   pXfoObj Pointer to XfoObj instance.
02224  * @param   newVal  If the value is 'true' is specified, an error is issued.
02225  */
02226 XFOINTERFACE_API void xfo_setSvgErrorOnEmbedFault(CXfoObjPtr pXfoObj, long newVal);
02227 
02228 /**
02229  * Effective when outputting to SVG.
02230  * Gets the value of how to compress the images embedded in SVG.
02231  * @since 3.3
02232  *
02233  * <table border="0" cellspacing="0" cellpadding="0">
02234  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
02235  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
02236  *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
02237  * </table>
02238  *
02239  * @param   pXfoObj Pointer to XfoObj instance.
02240  * @return  the value of how raster graphics are compressed and stored
02241  */
02242 XFOINTERFACE_API XfoIMAGECONVERSION xfo_getSvgImageConversion(CXfoObjPtr pXfoObj);
02243 
02244 /**
02245  * Effective when outputting to SVG.
02246  * Selects how to compress the images embedded in SVG to create from the following.
02247  * @since 3.3
02248  *
02249  * <table border="0" cellspacing="0" cellpadding="0">
02250  *  <tr><td>IMGCMPR_AUTO    </td><td>= 0 Auto conversion</td></tr>
02251  *  <tr><td>IMGCMPR_JPEG    </td><td>= 1 JPEG conversion</td></tr>
02252  *  <tr><td>IMGCMPR_PNG     </td><td>= 2 PNG conversion</td></tr>
02253  * </table>
02254  *
02255  * @param   pXfoObj Pointer to XfoObj instance.
02256  * @param   newVal  the value of how raster graphics are compressed and stored
02257  */
02258 XFOINTERFACE_API void xfo_setSvgImageConversion(CXfoObjPtr pXfoObj, XfoIMAGECONVERSION newVal);
02259 
02260 /**
02261  * Gets the value of the quality of JPEG format that is specified by xfo_setSvgImageConversion() stored in SVG.
02262  * @since 3.3
02263  *
02264  * @param   pXfoObj Pointer to XfoObj instance.
02265  * @return  the value of the quality
02266  */
02267 XFOINTERFACE_API int xfo_getSvgJPEGQuality(CXfoObjPtr pXfoObj);
02268 
02269 /**
02270  * Effective when outputting to SVG.
02271  * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100.
02272  * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.
02273  * The initial value is 80.
02274  * @since 3.3
02275  *
02276  * @param   pXfoObj Pointer to XfoObj instance.
02277  * @param   newVal  JPEG quality (1 to 100)
02278  */
02279 XFOINTERFACE_API void xfo_setSvgJPEGQuality(CXfoObjPtr pXfoObj, int newVal);
02280 
02281 /**
02282  * Effective when outputting to SVG.
02283  * Gets specification how to treat the referred image.
02284  * @since 3.3
02285  *
02286  * <table border="0" cellspacing="0" cellpadding="0">
02287  *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
02288  *  <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>
02289  *  <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>
02290  *  <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>
02291  * </table>
02292  *
02293  * @param   pXfoObj Pointer to XfoObj instance.
02294  * @return  specification how to treat the referred image.
02295  */
02296 XFOINTERFACE_API XfoIMAGEPROCTYPE xfo_getSvgImageProcessingType(CXfoObjPtr pXfoObj);
02297 
02298 /**
02299  * Effective when outputting to SVG.
02300  * Specifies how to treat the referred image.
02301  * @since 3.3
02302  *
02303  * <table border="0" cellspacing="0" cellpadding="0">
02304  *  <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr>
02305  *  <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>
02306  *  <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>
02307  *  <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>
02308  * </table>
02309  *
02310  * @param   pXfoObj Pointer to XfoObj instance.
02311  * @param   newVal  specification how to treat the referred image.
02312  */
02313 XFOINTERFACE_API void xfo_setSvgImageProcessingType(CXfoObjPtr pXfoObj, XfoIMAGEPROCTYPE newVal);
02314 
02315 /**
02316  * Effective when outputting to SVG.
02317  * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
02318  * @since 3.3
02319  *
02320  * @param   pXfoObj Pointer to XfoObj instance.
02321  * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
02322  *            the string is truncated and terminated with a NULL character.
02323  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02324  * @return  Returns the 'pVal'.
02325  */
02326 XFOINTERFACE_API char* xfo_getSvgImageCopyPath(CXfoObjPtr pXfoObj, char* pVal, int size);
02327 
02328 /**
02329  * Effective when outputting to SVG.
02330  * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
02331  * @since 3.3
02332  *
02333  * @param   pXfoObj Pointer to XfoObj instance.
02334  * @param   newVal  Pointer to a null-terminated string to be used as image copy path
02335  */
02336 XFOINTERFACE_API void xfo_setSvgImageCopyPath(CXfoObjPtr pXfoObj, const char* newVal);
02337 
02338 /**
02339  * Effective when outputting to SVG.
02340  * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
02341  * @since 3.3
02342  *
02343  * @param   pXfoObj Pointer to XfoObj instance.
02344  * @param   pVal        Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer,
02345  *            the string is truncated and terminated with a NULL character.
02346  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02347  * @return  Returns the 'pVal'.
02348  */
02349 XFOINTERFACE_API wchar_t* xfo_getSvgImageCopyPathW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02350 
02351 /**
02352  * Effective when outputting to SVG.
02353  * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by xfo_setSvgImageProcessingType.
02354  * @since 3.3
02355  *
02356  * @param   pXfoObj Pointer to XfoObj instance.
02357  * @param   newVal  Pointer to a null-terminated string to be used as image copy path
02358  */
02359 XFOINTERFACE_API void xfo_setSvgImageCopyPathW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
02360 
02361 /**
02362  * Effective when outputting to SVG.
02363  * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
02364  * @since 3.3
02365  *
02366  * @param   pXfoObj Pointer to XfoObj instance.
02367  * @return  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
02368  */
02369 XFOINTERFACE_API long xfo_getSvgSingleFile(CXfoObjPtr pXfoObj);
02370 
02371 /**
02372  * Effective when outputting to SVG.
02373  * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR>
02374  * 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>
02375  * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc.
02376  * @since 3.3
02377  *
02378  * @param   pXfoObj Pointer to XfoObj instance.
02379  * @param   newVal  specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages.
02380  */
02381 XFOINTERFACE_API void xfo_setSvgSingleFile(CXfoObjPtr pXfoObj, long newVal);
02382 
02383 #if !defined(_DOXYGEN)
02384 /**
02385  * @deprecated
02386  */
02387 XFOINTERFACE_API char* xfo_getSvgSingleFileMaxHeight(CXfoObjPtr pXfoObj, char* pVal, int size);
02388 
02389 /**
02390  * @deprecated
02391  */
02392 XFOINTERFACE_API wchar_t* xfo_getSvgSingleFileMaxHeightW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02393 
02394 /**
02395  * @deprecated
02396  */
02397 XFOINTERFACE_API void xfo_setSvgSingleFileMaxHeight(CXfoObjPtr pXfoObj, const char* newVal);
02398 
02399 /**
02400  * @deprecated
02401  */
02402 XFOINTERFACE_API void xfo_setSvgSingleFileMaxHeightW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
02403 
02404 /**
02405  * @deprecated
02406  */
02407 XFOINTERFACE_API int xfo_getSvgSingleFileMaxPages(CXfoObjPtr pXfoObj);
02408 
02409 /**
02410  * @deprecated
02411  */
02412 XFOINTERFACE_API void xfo_setSvgSingleFileMaxPages(CXfoObjPtr pXfoObj, int newVal);
02413 
02414 /**
02415  * @deprecated
02416  */
02417 XFOINTERFACE_API int xfo_getSvgImageDownsamplingDPI(CXfoObjPtr pXfoObj);
02418 
02419 /**
02420  * @deprecated
02421  */
02422 XFOINTERFACE_API void xfo_setSvgImageDownsamplingDPI(CXfoObjPtr pXfoObj, int dpi);
02423 
02424 /**
02425  * @deprecated
02426  */
02427 XFOINTERFACE_API int xfo_getSvgImageDownsamplingMethod(CXfoObjPtr pXfoObj);
02428 
02429 /**
02430  * @deprecated
02431  */
02432 XFOINTERFACE_API void xfo_setSvgImageDownsamplingMethod(CXfoObjPtr pXfoObj, int type);
02433 #endif
02434 
02435 /**
02436  * Effective when outputting to SVG.
02437  * Gets specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.
02438  * @since 3.3
02439  *
02440  * @param   pXfoObj Pointer to XfoObj instance.
02441  * @return  specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.
02442  */
02443 XFOINTERFACE_API long xfo_getSvgImageRename(CXfoObjPtr pXfoObj);
02444 
02445 /**
02446  * Effective when outputting to SVG.
02447  * When images are copied to the directory specified by xfo_setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed.
02448  *
02449  * @since 3.3
02450  *
02451  * @param   pXfoObj Pointer to XfoObj instance.
02452  * @param   newVal  specification whether to rename all file name to prefix specified by xfo_setSvgImagePrefix, or use original name.
02453  */
02454 XFOINTERFACE_API void xfo_setSvgImageRename(CXfoObjPtr pXfoObj, long newVal);
02455 
02456 /**
02457  * Effective when outputting to SVG.
02458  * Gets the prefix of the file name when images are copied to the directory specified by xfo_setSvgImageCopyPath and processed.
02459  * @since 3.3
02460  *
02461  * @param   pXfoObj Pointer to XfoObj instance.
02462  * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
02463  *            the string is truncated and terminated with a NULL character.
02464  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02465  * @return  Returns the 'pVal'.
02466  */
02467 XFOINTERFACE_API char* xfo_getSvgImagePrefix(CXfoObjPtr pXfoObj, char* pVal, int size);
02468 
02469 /**
02470  * Effective when outputting to SVG.
02471  * When images are copied to the directory specified by xfo_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.
02472  *
02473  * @since 3.3
02474  *
02475  * @param   pXfoObj Pointer to XfoObj instance.
02476  * @param   newVal  the prefix of the file name.
02477  */
02478 XFOINTERFACE_API void xfo_setSvgImagePrefix(CXfoObjPtr pXfoObj, const char* newVal);
02479 
02480 /**
02481  * Effective when outputting to SVG.
02482  * Gets the prefix of the file name when images are copied to the directory specified by xfo_setSvgImageCopyPath and processed.
02483  * @since 3.3
02484  *
02485  * @param   pXfoObj Pointer to XfoObj instance.
02486  * @param   pVal        Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer,
02487  *            the string is truncated and terminated with a NULL character.
02488  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02489  * @return  Returns the 'pVal'.
02490  */
02491 XFOINTERFACE_API wchar_t* xfo_getSvgImagePrefixW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02492 
02493 /**
02494  * Effective when outputting to SVG.
02495  * When images are copied to the directory specified by xfo_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.
02496  * @since 3.3
02497  *
02498  * @param   pXfoObj Pointer to XfoObj instance.
02499  * @param   newVal  the prefix of the file name.
02500  */
02501 XFOINTERFACE_API void xfo_setSvgImagePrefixW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
02502 
02503 /**
02504  * Effective when outputting to SVG.
02505  * Gets specification whether to add sequential number to the output SVG even if it has only one-page.
02506  * @since 3.3
02507  *
02508  * @param   pXfoObj Pointer to XfoObj instance.
02509  * @return  specification whether to add sequential number to the output SVG even if it has only one-page.
02510  */
02511 XFOINTERFACE_API long xfo_getSvgSinglePageNumber(CXfoObjPtr pXfoObj);
02512 
02513 /**
02514  * Effective when outputting to SVG.
02515  * 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.
02516  * @since 3.3
02517  *
02518  * @param   pXfoObj Pointer to XfoObj instance.
02519  * @param   newVal  specification whether to add sequential number to the output SVG even if it has only one-page.
02520  */
02521 XFOINTERFACE_API void xfo_setSvgSinglePageNumber(CXfoObjPtr pXfoObj, long newVal);
02522 
02523 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
02524 /**
02525  * Effective when outputting to SVG.
02526  * Gets the value of the rasterised-resolution of the transformed raster images.
02527  * @since 3.3
02528  *
02529  * @param   pXfoObj Pointer to XfoObj instance.
02530  * @return  Rasterised-resolution
02531  */
02532 XFOINTERFACE_API int xfo_getSvgRasterizeResolution(CXfoObjPtr pXfoObj);
02533 
02534 /**
02535  * Effective when outputting to SVG.
02536  * 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.
02537  * This setting is effective only with Windows version.
02538  * @since 3.3
02539  *
02540  * @param   pXfoObj Pointer to XfoObj instance.
02541  * @param   newVal  Rasterised-resolution (70 to 500)
02542  */
02543 XFOINTERFACE_API void xfo_setSvgRasterizeResolution(CXfoObjPtr pXfoObj, int newVal);
02544 #endif
02545 
02546 /**
02547  * Get specifies of the FlashPartiallyOutput.
02548  * @since 6.0
02549  *
02550  * @param   pXfoObj Pointer to XfoObj instance.
02551  * @return  specifies of FlashPartiallyOutput.
02552  */
02553 XFOINTERFACE_API long xfo_getFlashPartiallyOutput(CXfoObjPtr pXfoObj);
02554 
02555 /**
02556  * When an error occurs within the document, the flash file in process will be outputted.
02557  * Effective when outputting to Flash.
02558  * @since 6.0
02559  *
02560  * @param   pXfoObj Pointer to XfoObj instance.
02561  * @param   newVal  Specifies zero or nonzero.
02562  */
02563 XFOINTERFACE_API void xfo_setFlashPartiallyOutput(CXfoObjPtr pXfoObj, long newVal);
02564 
02565 /**
02566  * Get specifies of the FlashHidePageButton.
02567  * @since 6.0
02568  *
02569  * @param   pXfoObj Pointer to XfoObj instance.
02570  * @return  specifies of FlashHidePageButton.
02571  */
02572 XFOINTERFACE_API long xfo_getFlashHidePageButton(CXfoObjPtr pXfoObj);
02573 
02574 /**
02575  * Output a no page button. Effective when outputting to Flash.
02576  * @since 6.0
02577  *
02578  * @param   pXfoObj Pointer to XfoObj instance.
02579  * @param   newVal  If the value is 'true' is specified, output a no page button.
02580  */
02581 XFOINTERFACE_API void xfo_setFlashHidePageButton(CXfoObjPtr pXfoObj, long newVal);
02582 
02583 /**
02584  * Get the start volume of document to output.
02585  * @since 3.2
02586  *
02587  * @param   pXfoObj Pointer to XfoObj instance.
02588  * @return  start volume of output.
02589  */
02590 XFOINTERFACE_API long xfo_getStartVolume(CXfoObjPtr pXfoObj);
02591 
02592 /**
02593  * Specifies the start volume of document to output.
02594  * If the start volume is omitted or the specified value is 0 or less, the start volume is
02595  * considered from the first volume.
02596  * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
02597  * @since 3.2
02598  *
02599  * @param   pXfoObj Pointer to XfoObj instance.
02600  * @param   newVal  start volume of output.
02601  */
02602 XFOINTERFACE_API void xfo_setStartVolume(CXfoObjPtr pXfoObj, long newVal);
02603 
02604 /**
02605  * Get the end volume of document to output.
02606  * @since 3.2
02607  *
02608  * @param   pXfoObj Pointer to XfoObj instance.
02609  * @return  end volume of output.
02610  */
02611 XFOINTERFACE_API long xfo_getEndVolume(CXfoObjPtr pXfoObj);
02612 
02613 /**
02614  * Specifies the end volume of document to output.
02615  * If the end volume is omitted or the specified value exceeds the actual volume number, the end volume
02616  * is considered as the last volume.
02617  * If the setting is inconsistent, (for example, StartVolume=5 EndVolume=3) an error occurs.
02618  * @since 3.2
02619  *
02620  * @param   pXfoObj Pointer to XfoObj instance.
02621  * @param   newVal  end volume of output.
02622  */
02623 XFOINTERFACE_API void xfo_setEndVolume(CXfoObjPtr pXfoObj, long newVal);
02624 
02625 /**
02626  * Get multiple volume  of PDF output.
02627  * @since 3.2
02628  *
02629  * @param   pXfoObj Pointer to XfoObj instance.
02630  * @return  If zero is returned, multiple volume don't specified.
02631  *            If nonezero is returned, multiple volume specified.
02632  */
02633 XFOINTERFACE_API long xfo_getMultiVolume(CXfoObjPtr pXfoObj);
02634 
02635 /**
02636  * Gets the number of all the separate volumes when outputting PDF to multiple separate volumes.
02637  * @since 3.2
02638  *
02639  * @param   pXfoObj Pointer to XfoObj instance.
02640  * @return  Returns total volume count.
02641  */
02642 XFOINTERFACE_API long xfo_getTotalVolumeCount(CXfoObjPtr pXfoObj);
02643 
02644 /**
02645  * Gets the number of the actual separate volumes when outputting PDF to multiple separate volumes.
02646  * @since 3.2
02647  *
02648  * @param   pXfoObj Pointer to XfoObj instance.
02649  * @return  Returns output volume count.
02650  */
02651 XFOINTERFACE_API long xfo_getOutputVolumeCount(CXfoObjPtr pXfoObj);
02652 
02653 
02654 /**
02655  * Specifies multiple volume of PDF output.
02656  * @since 3.2
02657  *
02658  * @param   pXfoObj Pointer to XfoObj instance.
02659  * @param   newVal  Zpecifies zero or nonzero.
02660  */
02661 XFOINTERFACE_API void xfo_setMultiVolume(CXfoObjPtr pXfoObj, long newVal);
02662 
02663 /**
02664  * Gets the split-by-pages setting.
02665  * @since 6.1
02666  *
02667  * @param   pXfoObj Pointer to XfoObj instance.
02668  * @return  split-by-pages setting (0:No split 1:Split by each page)
02669  */
02670 XFOINTERFACE_API int xfo_getSplitPages(CXfoObjPtr pXfoObj);
02671 
02672 /**
02673  * Sets the split-by-pages setting.
02674  * @since 6.1
02675  *
02676  * @param   pXfoObj Pointer to XfoObj instance.
02677  * @param   newVal  split-by-pages setting (0:No split 1:Split by each page)
02678  */
02679 XFOINTERFACE_API void xfo_setSplitPages(CXfoObjPtr pXfoObj, int newVal);
02680 
02681 /**
02682  * Gets the initial page number.
02683  * @since 6.1
02684  *
02685  * @param   pXfoObj Pointer to XfoObj instance.
02686  * @return  initial page number
02687  */
02688 XFOINTERFACE_API int xfo_getInitialPageNumber(CXfoObjPtr pXfoObj);
02689 
02690 /**
02691  * Sets the initial page number.
02692  * @since 6.1
02693  *
02694  * @param   pXfoObj Pointer to XfoObj instance.
02695  * @param   newVal  initial page number
02696  */
02697 XFOINTERFACE_API void xfo_setInitialPageNumber(CXfoObjPtr pXfoObj, int newVal);
02698 
02699 /**
02700  * Gets the initial volume number.
02701  * @since 6.1
02702  *
02703  * @param   pXfoObj Pointer to XfoObj instance.
02704  * @return  initial volume number
02705  */
02706 XFOINTERFACE_API int xfo_getInitialVolumeNumber(CXfoObjPtr pXfoObj);
02707 
02708 /**
02709  * Sets the initial volume number.
02710  * @since 6.1
02711  *
02712  * @param   pXfoObj Pointer to XfoObj instance.
02713  * @param   newVal  initial volume number
02714  */
02715 XFOINTERFACE_API void xfo_setInitialVolumeNumber(CXfoObjPtr pXfoObj, int newVal);
02716 
02717 /**
02718  * Gets the partial volume mode.
02719  * @since 6.1
02720  *
02721  * @param   pXfoObj Pointer to XfoObj instance.
02722  * @return  partial volume mode
02723  */
02724 XFOINTERFACE_API long xfo_getPartialVolume(CXfoObjPtr pXfoObj);
02725 
02726 /**
02727  * Sets the partial volume mode.
02728  * @since 6.1
02729  *
02730  * @param   pXfoObj Pointer to XfoObj instance.
02731  * @param   newVal  partial volume mode
02732  */
02733 XFOINTERFACE_API void xfo_setPartialVolume(CXfoObjPtr pXfoObj, long newVal);
02734 
02735 
02736 /**
02737  * Get the error level to abort formatting process.
02738  *
02739  * @param   pXfoObj Pointer to XfoObj instance.
02740  * @return  Returns the error level.
02741  */
02742 XFOINTERFACE_API XfoIfErrorLevel xfo_getExitLevel(CXfoObjPtr pXfoObj);
02743 
02744 /**
02745  * Error level to abort formatting process. AH Formatter will stop formatting when the detected
02746  * error level is equal to ExitLevel property or higher. The default value is 2 (Warning).
02747  * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be
02748  * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered
02749  * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be
02750  * aborted unconditionally.
02751  * BTW : An error is not displayed no matter what value may be specified to be this property.
02752  *
02753  * <table border="0" cellspacing="0" cellpadding="0">
02754  *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
02755  *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
02756  *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
02757  *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
02758  * </table>
02759  *
02760  * @param   pXfoObj Pointer to XfoObj instance.
02761  * @param   newVal  error level to abort formatting process.
02762  */
02763 XFOINTERFACE_API void xfo_setExitLevel(CXfoObjPtr pXfoObj, XfoIfErrorLevel newVal);
02764 
02765 /**
02766  * Returns the error level of the error that occurred during the formatting process.
02767  *
02768  * <table border="0" cellspacing="0" cellpadding="0">
02769  *  <tr><td>ELVL_INFORMATION    </td><td>= 1 Information</td></tr>
02770  *  <tr><td>ELVL_WARNING        </td><td>= 2 Warning</td></tr>
02771  *  <tr><td>ELVL_RECOVERABLE    </td><td>= 3 Recoveable Error</td></tr>
02772  *  <tr><td>ELVL_FATAL          </td><td>= 4 Fatal Error</td></tr>
02773  * </table>
02774  *
02775  * @param   pXfoObj Pointer to XfoObj instance.
02776  * @return  Returns the error level.
02777  */
02778 XFOINTERFACE_API XfoIfErrorLevel xfo_getErrorLevel(CXfoObjPtr pXfoObj);
02779 
02780 /**
02781  * Returns the error code of the error that occurred during the formatting process.
02782  * Zero means no error. Non-zero indicates any error occurred.
02783  *
02784  * @param   pXfoObj Pointer to XfoObj instance.
02785  * @return  Returns the error code.
02786  */
02787 XFOINTERFACE_API XfoIfErrorCode xfo_getErrorCode(CXfoObjPtr pXfoObj);
02788 
02789 /**
02790  * Returns the error message of the error that occurred during the formatting process.
02791  *
02792  * @param   pXfoObj Pointer to XfoObj instance.
02793  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02794  *            the string is truncated and terminated with a NULL character.
02795  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02796  * @return  Returns the 'pVal'.
02797  */
02798 XFOINTERFACE_API char* xfo_getErrorMessage(CXfoObjPtr pXfoObj, char* pVal, int size);
02799 /**
02800  * Returns the error message of the error that occurred during the formatting process.
02801  *
02802  * @param   pXfoObj Pointer to XfoObj instance.
02803  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02804  *            the string is truncated and terminated with a NULL character.
02805  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02806  * @return  Returns the 'pVal'.
02807  */
02808 XFOINTERFACE_API wchar_t* xfo_getErrorMessageW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
02809 
02810 /**
02811  * Sets the substitution of font name. This substitution acts on the font names existing in FO.
02812  * The font name 'fontName' is replaced to 'aliasName'.
02813  *
02814  * @param   pXfoObj Pointer to XfoObj instance.
02815  * @param   src     Specifies the font name which is replaced.
02816  * @param   dst     Specifies the aliasName.
02817  */
02818 XFOINTERFACE_API void xfo_setFontAlias(CXfoObjPtr pXfoObj, const char* src, const char* dst);
02819 /**
02820  * Sets the substitution of font name. This substitution acts on the font names existing in FO.
02821  * The font name 'fontName' is replaced to 'aliasName'.
02822  *
02823  * @param   pXfoObj Pointer to XfoObj instance.
02824  * @param   src     Specifies the font name which is replaced.
02825  * @param   dst     Specifies the aliasName.
02826  */
02827 XFOINTERFACE_API void xfo_setFontAliasW(CXfoObjPtr pXfoObj, const wchar_t* src, const wchar_t* dst);
02828 
02829 /**
02830  * Clear all substitutions of font name.
02831  *
02832  * @param   pXfoObj Pointer to XfoObj instance.
02833  */
02834 XFOINTERFACE_API void xfo_clearFontAlias(CXfoObjPtr pXfoObj);
02835 /**
02836  * Clear all substitutions of font name.
02837  *
02838  * @param   pXfoObj Pointer to XfoObj instance.
02839  */
02840 
02841 /**
02842  * Erase the substitution of font name 'fontName'.
02843  *
02844  * @param   pXfoObj Pointer to XfoObj instance.
02845  * @param   src Specifies the font name which is replaced.
02846  */
02847 XFOINTERFACE_API void xfo_eraseFontAlias(CXfoObjPtr pXfoObj, const char* src);
02848 XFOINTERFACE_API void xfo_eraseFontAliasW(CXfoObjPtr pXfoObj, const wchar_t* src);
02849 
02850 /**
02851  * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName.
02852  *
02853  * @param   pXfoObj Pointer to XfoObj instance.
02854  * @return  Returns the error code. Zero means no error. Non-zero indicates any error occurred.
02855  */
02856 XFOINTERFACE_API XfoIfErrorCode xfo_execute(CXfoObjPtr pXfoObj);
02857 
02858 /**
02859  * Initialize formatting engine.
02860  *
02861  * @param   pXfoObj Pointer to XfoObj instance.
02862  */
02863 XFOINTERFACE_API void xfo_clear(CXfoObjPtr pXfoObj);
02864 
02865 /**
02866  * Specifies the callback fucntion.
02867  * The error that occurred during the formatting process can be received.
02868  *
02869  * @param   pXfoObj Pointer to XfoObj instance.
02870  * @param   proc        Address of the callback function.
02871  *  <br>Callback function has the following form:<pre>
02872  * void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
02873  * void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);</pre>
02874  */
02875 XFOINTERFACE_API void xfo_setOnMessageProc(CXfoObjPtr pXfoObj, XfoOnMessageProc* proc);
02876 
02877 /**
02878  * Specifies the callback fucntion.
02879  * The error that occurred during the formatting process can be received.
02880  *
02881  * @param   pXfoObj Pointer to XfoObj instance.
02882  * @param   proc        Address of the callback function.
02883  *  <br>Callback function has the following form:<pre>
02884  * void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
02885  * void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);</pre>
02886  */
02887 XFOINTERFACE_API void xfo_setOnMessageProcW(CXfoObjPtr pXfoObj, XfoOnMessageProcW* proc);
02888 
02889 /**
02890  * Specifies the callback fucntion.
02891  * The page number in the formatting process can be received.
02892  *
02893  * @param   pXfoObj Pointer to XfoObj instance.
02894  * @param   proc    Address of the callback function.
02895  *  <br>Callback function has the following form:<pre>
02896  * void XfoOnFormatPageProc(long pageNo);</pre>
02897  */
02898 XFOINTERFACE_API void xfo_setOnFormatPageProc(CXfoObjPtr pXfoObj, XfoOnFormatPageProc* proc);
02899 
02900 /**
02901  * Specifies the callback fucntion.
02902  * The error that occurred during the formatting process can be received.
02903  *
02904  * @param   pXfoObj Pointer to XfoObj instance.
02905  * @param   proc        Address of the callback function.
02906  *  <br>Callback function has the following form:<pre>
02907  * void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
02908  * void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);</pre>
02909  * @param   pAnyObj     Address of an any object.
02910  */
02911 XFOINTERFACE_API void xfo_setOnMessageProcEx(CXfoObjPtr pXfoObj, XfoOnMessageProcEx* proc, void* pAnyObj);
02912 
02913 /**
02914  * Specifies the callback fucntion.
02915  * The error that occurred during the formatting process can be received.
02916  *
02917  * @param   pXfoObj Pointer to XfoObj instance.
02918  * @param   proc        Address of the callback function.
02919  *  <br>Callback function has the following form:<pre>
02920  * void XfoOnMessageProc(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
02921  * void XfoOnMessageProcW(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);</pre>
02922  * @param   pAnyObj     Address of an any object.
02923  */
02924 XFOINTERFACE_API void xfo_setOnMessageProcExW(CXfoObjPtr pXfoObj, XfoOnMessageProcExW* proc, void* pAnyObj);
02925 
02926 /**
02927  * Specifies the callback fucntion.
02928  * The page number in the formatting process can be received.
02929  *
02930  * @param   pXfoObj Pointer to XfoObj instance.
02931  * @param   proc    Address of the callback function.
02932  *  <br>Callback function has the following form:<pre>
02933  * void XfoOnFormatPageProc(long pageNo);</pre>
02934  * @param   pAnyObj     Address of an any object.
02935  */
02936 XFOINTERFACE_API void xfo_setOnFormatPageProcEx(CXfoObjPtr pXfoObj, XfoOnFormatPageProcEx* proc, void* pAnyObj);
02937 
02938 /**
02939  * Set parameter name and value for xsl:param.
02940  *
02941  * @param   pXfoObj Pointer to XfoObj instance.
02942  * @param   paramName name.
02943  * @param   value   parameter value.
02944  */
02945 XFOINTERFACE_API void xfo_setXSLTParam(CXfoObjPtr pXfoObj, const char* paramName, const char* value);
02946 /**
02947  * Set parameter name and value for xsl:param.
02948  *
02949  * @param   pXfoObj Pointer to XfoObj instance.
02950  * @param   paramName name.
02951  * @param   value   parameter value.
02952  */
02953 XFOINTERFACE_API void xfo_setXSLTParamW(CXfoObjPtr pXfoObj, const wchar_t* paramName, const wchar_t* value);
02954 
02955 /**
02956  * Clear all parameter name and value for xsl:param.
02957  *
02958  * @param   pXfoObj Pointer to XfoObj instance.
02959  */
02960 XFOINTERFACE_API void xfo_clearXSLTParam(CXfoObjPtr pXfoObj);
02961 
02962 /**
02963  * Get the error output type.
02964  *
02965  * @param   pXfoObj Pointer to XfoObj instance.
02966  * @return  Error output type.
02967  */
02968 XFOINTERFACE_API XfoErrorStreamType xfo_getErrorStreamType(CXfoObjPtr pXfoObj);
02969 
02970 /**
02971  * Set the error output type.
02972  *
02973  * @param   pXfoObj Pointer to XfoObj instance.
02974  * @param   type        Error output type.
02975  *  <table border="0" cellspacing="0" cellpadding="0">
02976  *  <tr><td>OST_NONE    </td><td>: No error output</td></tr>
02977  *  <tr><td>OST_STDOUT  </td><td>: Error output to stdout</td></tr>
02978  *  <tr><td>OST_STDERR  </td><td>: Error output to stderr</td></tr>
02979  *  </table>
02980  */
02981 XFOINTERFACE_API void xfo_setErrorStreamType(CXfoObjPtr pXfoObj, XfoErrorStreamType type);
02982 
02983 /* Print Interface */
02984 /**
02985  * Get the printer name where the formatted result is outputted.
02986  *
02987  * @param   pXfoObj Pointer to XfoObj instance.
02988  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02989  *            the string is truncated and terminated with a NULL character.
02990  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
02991  * @return  Returns the 'pVal'.
02992  */
02993 XFOINTERFACE_API char* xfo_getPrinterName(CXfoObjPtr pXfoObj, char* pVal, int size);
02994 /**
02995  * Get the printer name where the formatted result is outputted.
02996  *
02997  * @param   pXfoObj Pointer to XfoObj instance.
02998  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
02999  *            the string is truncated and terminated with a NULL character.
03000  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03001  * @return  Returns the 'pVal'.
03002  */
03003 XFOINTERFACE_API wchar_t* xfo_getPrinterNameW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03004 
03005 /**
03006  * Specifies the output format or the printer name to output.
03007  * When a printer name is specified, the formatted result is outputted to that printer.
03008  * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer.
03009  * When "\@PDF" is specified, the formatted result is outputted to PDF.
03010  * When "\@SVG" is specified, the formatted result is outputted to SVG.
03011  * When "\@PS" is specified, the formatted result is outputted to PostScript.
03012  * When "\@INX" is specified, the formatted result is outputted to INX.
03013  * When "\@MIF" is specified, the formatted result is outputted to MIF.
03014  * When "\@TEXT" is specified, the formatted result is outputted to a text format file.
03015  * When "\@AreaTree" is specified, the AreaTree will be outputted.
03016  * When omitted, it is considered as "\@PDF" was specified.
03017  * It's impossible to output to the printer with any OS's other than Windows.
03018  *
03019  * @param   pXfoObj Pointer to XfoObj instance.
03020  * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
03021  */
03022 XFOINTERFACE_API void xfo_setPrinterName(CXfoObjPtr pXfoObj, const char* newVal);
03023 /**
03024  * Specifies the output format or the printer name to output.
03025  * When a printer name is specified, the formatted result is outputted to that printer.
03026  * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer.
03027  * When "\@PDF" is specified, the formatted result is outputted to PDF.
03028  * When "\@SVG" is specified, the formatted result is outputted to SVG.
03029  * When "\@PS" is specified, the formatted result is outputted to PostScript.
03030  * When "\@INX" is specified, the formatted result is outputted to INX.
03031  * When "\@MIF" is specified, the formatted result is outputted to MIF.
03032  * When "\@TEXT" is specified, the formatted result is outputted to a text format file.
03033  * When "\@AreaTree" is specified, the AreaTree will be outputted.
03034  * When omitted, it is considered as "\@PDF" was specified.
03035  * It's impossible to output to the printer with any OS's other than Windows.
03036  *
03037  * @param   pXfoObj Pointer to XfoObj instance.
03038  * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
03039  */
03040 XFOINTERFACE_API void xfo_setPrinterNameW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03041 
03042 /**
03043  * Get formatted total pages.
03044  *
03045  * @return  the value of formatted total pages.
03046  */
03047 XFOINTERFACE_API long xfo_getFormattedPages(CXfoObjPtr pXfoObj);
03048 
03049 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
03050 
03051 /**
03052  * Get the printer setting file URI.
03053  *
03054  * @param   pXfoObj Pointer to XfoObj instance.
03055  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03056  *            the string is truncated and terminated with a NULL character.
03057  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03058  * @return  Returns the 'pVal'.
03059  */
03060 XFOINTERFACE_API char* xfo_getPrinterSettingURI(CXfoObjPtr pXfoObj, char* pVal, int size);
03061 /**
03062  * Get the printer setting file URI.
03063  *
03064  * @param   pXfoObj Pointer to XfoObj instance.
03065  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03066  *            the string is truncated and terminated with a NULL character.
03067  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03068  * @return  Returns the 'pVal'.
03069  */
03070 XFOINTERFACE_API wchar_t* xfo_getPrinterSettingURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03071 
03072 
03073 /**
03074  * Specifies the printer setting file URI.
03075  * This setting is effective only with Windows version.
03076  *
03077  * @param   pXfoObj Pointer to XfoObj instance.
03078  * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
03079  */
03080 XFOINTERFACE_API void xfo_setPrinterSettingURI(CXfoObjPtr pXfoObj, const char* newVal);
03081 /**
03082  * Specifies the printer setting file URI.
03083  * This setting is effective only with Windows version.
03084  *
03085  * @param   pXfoObj Pointer to XfoObj instance.
03086  * @param   newVal  Pointer to a null-terminated string to be used as the printer name.
03087  */
03088 XFOINTERFACE_API void xfo_setPrinterSettingURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03089 
03090 /**
03091  * Get the number of copies. Effective when outputting to printer.
03092  *
03093  * @param   pXfoObj Pointer to XfoObj instance.
03094  * @return  Returns the number of copies.
03095  */
03096 XFOINTERFACE_API long xfo_getPrnCopies(CXfoObjPtr pXfoObj);
03097 
03098 /**
03099  * Specifies the number of copies. Effective when outputting to printer.
03100  * If nothing is specified, the value is considered as 1.
03101  * This setting is effective only with Windows version.
03102  *
03103  * @param   pXfoObj Pointer to XfoObj instance.
03104  * @param   newVal  the number of copies.
03105  */
03106 XFOINTERFACE_API void xfo_setPrnCopies(CXfoObjPtr pXfoObj, long newVal);
03107 
03108 /**
03109  * Get collation of multiple copies.
03110  *
03111  * @param   pXfoObj Pointer to XfoObj instance.
03112  * @return  If zero is returned, the same page is multi-copied continuously.
03113  *            If nonezero is returned, the pages specified from start to end are printed repeatedly.
03114  */
03115 XFOINTERFACE_API long xfo_getPrnCollate(CXfoObjPtr pXfoObj);
03116 
03117 /**
03118  * Specifies collation of multiple copies. Effective when outputting to printer and the number of
03119  * copies is plural. If it is not specified or the value zero is specified, the same page is
03120  * multi-copied continuously.
03121  * If nonezero is specified, the pages specified from start to end are printed repeatedly.
03122  * This setting is effective only with Windows version.
03123  *
03124  * @param   pXfoObj Pointer to XfoObj instance.
03125  * @param   newVal  Specifies zero or nonzero.
03126  */
03127 XFOINTERFACE_API void xfo_setPrnCollate(CXfoObjPtr pXfoObj, long newVal);
03128 
03129 /**
03130  * Get the setting of whether print dialog box is displayed or not when printing
03131  *
03132  * @param   pXfoObj Pointer to XfoObj instance.
03133  * @return  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
03134  */
03135 XFOINTERFACE_API long xfo_getBatchPrint(CXfoObjPtr pXfoObj);
03136 
03137 /**
03138  * When the value 'false' is specified, the print dialog box is displayed when printing.
03139  * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed.
03140  * This setting is effective only with Windows version.
03141  *
03142  * @param   pXfoObj Pointer to XfoObj instance.
03143  * @param   newVal  If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed.
03144  */
03145 XFOINTERFACE_API void xfo_setBatchPrint(CXfoObjPtr pXfoObj, long newVal);
03146 
03147 #if !defined(_DOXYGEN)
03148 /**
03149  * @deprecated
03150  * Get the text of XML document you will format.
03151  * @since 3.1
03152  *
03153  * @param   pXfoObj Pointer to XfoObj instance.
03154  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03155  *            the string is truncated and terminated with a NULL character.
03156  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03157  * @return  Returns the 'pVal'.
03158  */
03159 XFOINTERFACE_API char* xfo_getDocumentText(CXfoObjPtr pXfoObj, char* pVal, int size);
03160 
03161 /**
03162  * @deprecated
03163  * Get the text of XML document you will format.
03164  * @since 3.1
03165  *
03166  * @param   pXfoObj Pointer to XfoObj instance.
03167  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03168  *            the string is truncated and terminated with a NULL character.
03169  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03170  * @return  Returns the 'pVal'.
03171  */
03172 XFOINTERFACE_API wchar_t* xfo_getDocumentTextW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03173 #endif
03174 
03175 /**
03176  * @deprecated
03177  * Specifies the XML document you will format.
03178  * MSXML3/MSXML4 is required when formatting.
03179  * This setting is effective only with Windows version.
03180  * @since 3.1
03181  *
03182  * @param   pXfoObj Pointer to XfoObj instance.
03183  * @param   newVal  Pointer to a null-terminated string to be used as the text of XML document.
03184  */
03185 XFOINTERFACE_API void xfo_setDocumentText(CXfoObjPtr pXfoObj, const char* newVal);
03186 
03187 /**
03188  * @deprecated
03189  * Specifies the XML document you will format.
03190  * MSXML3/MSXML4 is required when formatting.
03191  * This setting is effective only with Windows version.
03192  * @since 3.1
03193  *
03194  * @param   pXfoObj Pointer to XfoObj instance.
03195  * @param   newVal  Pointer to a null-terminated string to be used as the text of XML document.
03196  */
03197 XFOINTERFACE_API void xfo_setDocumentTextW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03198 
03199 /**
03200  * @deprecated
03201  * Get the text of XSL stylesheet for formatting.
03202  * @since 3.1
03203  *
03204  * @param   pXfoObj Pointer to XfoObj instance.
03205  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03206  *            the string is truncated and terminated with a NULL character.
03207  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03208  * @return  Returns the 'pVal'.
03209  */
03210 XFOINTERFACE_API char* xfo_getStylesheetText(CXfoObjPtr pXfoObj, char* pVal, int size);
03211 
03212 /**
03213  * @deprecated
03214  * Get the text of XSL stylesheet for formatting.
03215  * @since 3.1
03216  *
03217  * @param   pXfoObj Pointer to XfoObj instance.
03218  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03219  *            the string is truncated and terminated with a NULL character.
03220  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03221  * @return  Returns the 'pVal'.
03222  */
03223 XFOINTERFACE_API wchar_t* xfo_getStylesheetTextW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03224 
03225 /**
03226  * @deprecated
03227  * Specifies the text of XSL stylesheet for formatting.
03228  * If the specified XML document is FO, or the XML file contains the processing instruction
03229  * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
03230  * Otherwise if there is no setting of this property, an error occurs.
03231  * MSXML3/MSXML4 is required when formatting.
03232  * This setting is effective only with Windows version.
03233  * @since 3.1
03234  *
03235  * @param   pXfoObj Pointer to XfoObj instance.
03236  * @param   newVal  Pointer to a null-terminated string to be used as the text of XSL stylesheet.
03237  */
03238 XFOINTERFACE_API void xfo_setStylesheetText(CXfoObjPtr pXfoObj, const char* newVal);
03239 
03240 /**
03241  * @deprecated
03242  * Specifies the text of XSL stylesheet for formatting.
03243  * If the specified XML document is FO, or the XML file contains the processing instruction
03244  * &lt;?xml-stylesheet ...?&gt; and the XSL stylesheet is specified, this setting is ignored.
03245  * Otherwise if there is no setting of this property, an error occurs.
03246  * MSXML3/MSXML4 is required when formatting.
03247  * This setting is effective only with Windows version.
03248  * @since 3.1
03249  *
03250  * @param   pXfoObj Pointer to XfoObj instance.
03251  * @param   newVal  Pointer to a null-terminated string to be used as the text of XSL stylesheet.
03252  */
03253 XFOINTERFACE_API void xfo_setStylesheetTextW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03254 
03255 #endif  /* _WIN32 */
03256 
03257 /**
03258  * Get the version string of AH Formatter.
03259  * @since 4.0MR4
03260  *
03261  * @param   pXfoObj Pointer to XfoObj instance.
03262  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03263  *            the string is truncated and terminated with a NULL character.
03264  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03265  * @return  Returns the 'pVal'.
03266  */
03267 XFOINTERFACE_API char* xfo_getVersion(CXfoObjPtr pXfoObj, char* pVal, int size);
03268 
03269 /**
03270  * Get the version string of AH Formatter.
03271  * @since 4.0MR4
03272  *
03273  * @param   pXfoObj Pointer to XfoObj instance.
03274  * @param   pVal        Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
03275  *            the string is truncated and terminated with a NULL character.
03276  * @param   size        Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
03277  * @return  Returns the 'pVal'.
03278  */
03279 XFOINTERFACE_API wchar_t* xfo_getVersionW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03280 
03281 /**
03282  * Get INX output mode.
03283  * @since 4.3
03284  *
03285  * @param   pXfoObj Pointer to XfoObj instance.
03286  * @return  output mode of INX.
03287  */
03288 XFOINTERFACE_API XfoINXOUTPUTMODE xfo_getInxOutputMode(CXfoObjPtr pXfoObj);
03289 
03290 /**
03291  * Set INX output mode.
03292  * @since 4.3
03293  *
03294  * @param   pXfoObj Pointer to XfoObj instance.
03295  * @param   newVal  Output mode of INX.
03296  */
03297 XFOINTERFACE_API void xfo_setInxOutputMode(CXfoObjPtr pXfoObj, XfoINXOUTPUTMODE newVal);
03298 
03299 /**
03300  * Get MIF output mode.
03301  * @since 4.3
03302  *
03303  * @param   pXfoObj Pointer to XfoObj instance.
03304  * @return  Output mode of MIF.
03305  */
03306 XFOINTERFACE_API XfoMIFOUTPUTMODE xfo_getMifOutputMode(CXfoObjPtr pXfoObj);
03307 
03308 /**
03309  * Set MIF output mode.
03310  * @since 4.3
03311  *
03312  * @param   pXfoObj Pointer to XfoObj instance.
03313  * @param   newVal  Output mode of MIF.
03314  */
03315 XFOINTERFACE_API void xfo_setMifOutputMode(CXfoObjPtr pXfoObj, XfoMIFOUTPUTMODE newVal);
03316 
03317 /**
03318  * Get MIF image processing mode
03319  * @since 5.2
03320  *
03321  * @param   pXfoObj Pointer to XfoObj instance.
03322  * @return  Image processing mode.
03323  */
03324 XFOINTERFACE_API XfoMIFIMAGEPROCMODE xfo_getMifIpMode(CXfoObjPtr pXfoObj);
03325 
03326 /**
03327  * Set MIF image processing mode
03328  * @since 5.2
03329  *
03330  * @param   pXfoObj Pointer to XfoObj instance.
03331  * @param   mode    Image processing mode.
03332  */
03333 XFOINTERFACE_API void xfo_setMifIpMode(CXfoObjPtr pXfoObj, XfoMIFIMAGEPROCMODE mode);
03334 
03335 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32))
03336 /**
03337  * Acquires the setting of the smoothing processing to text.
03338  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03339  *
03340  * @return  Specify whether to perform the smoothing processing to text.
03341  */
03342 XFOINTERFACE_API int xfo_getGdiTextAntialias(CXfoObjPtr pXfoObj);
03343 
03344 /**
03345  * Performs the smoothing processing to text.
03346  * Effective only when printing and outputting images.
03347  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03348  *
03349  * @param   pXfoObj Pointer to XfoObj instance.
03350  * @param   newVal  Smoothing value.
03351  */
03352 XFOINTERFACE_API void xfo_setGdiTextAntialias(CXfoObjPtr pXfoObj, int newVal);
03353 
03354 /**
03355  * Acquires the setting of the smoothing processing to borders.
03356  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03357  *
03358  * @param   pXfoObj Pointer to XfoObj instance.
03359  * @return  Specify whether to perform the smoothing processing to borders.
03360  */
03361 XFOINTERFACE_API int xfo_getGdiLineartSmoothing(CXfoObjPtr pXfoObj);
03362 
03363 /**
03364  * Performs the smoothing processing to borders.
03365  * Effective only when printing and outputting images.
03366  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03367  *
03368  * @param   pXfoObj Pointer to XfoObj instance.
03369  * @param   newVal  Smoothing value.
03370  */
03371 XFOINTERFACE_API void xfo_setGdiLineartSmoothing(CXfoObjPtr pXfoObj, int newVal);
03372 
03373 /**
03374  * Acquires the setting of the smoothing processing to images.
03375  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03376  *
03377  * @return  Specify whether to perform the smoothing processing to images.
03378  */
03379 XFOINTERFACE_API int xfo_getGdiImageSmoothing(CXfoObjPtr pXfoObj);
03380 
03381 /**
03382  * Performs the smoothing processing to images.
03383  * Effective only when printing and outputting images.
03384  * This setting is effective only with Windows XP or later / Windows Server2003 or later.
03385  *
03386  * @param   pXfoObj Pointer to XfoObj instance.
03387  * @param   newVal  Smoothing value.
03388  */
03389 XFOINTERFACE_API void xfo_setGdiImageSmoothing(CXfoObjPtr pXfoObj, int newVal);
03390 #endif
03391 
03392 /**
03393  * @deprecated
03394  * Get the watermark text on each page.
03395  *
03396  * @param   pXfoObj Pointer to XfoObj instance.
03397  * @param   pVal
03398  *          Pointer to the buffer that will receive the text.
03399  *          If the string is as long or longer than the buffer,
03400  *          the string is truncated and terminated with a NULL character.
03401  * @param   size
03402  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03403  *          If the text exceeds this limit, it is truncated.
03404  * @return  Returns the 'pVal'.
03405  */
03406 XFOINTERFACE_API char* xfo_getWatermarkText(CXfoObjPtr pXfoObj, char* pVal, int size);
03407 
03408 /**
03409  * @deprecated
03410  * Get the watermark text on each page.
03411  *
03412  * @param   pXfoObj Pointer to XfoObj instance.
03413  * @param   pVal
03414  *          Pointer to the buffer that will receive the text.
03415  *          If the string is as long or longer than the buffer,
03416  *          the string is truncated and terminated with a NULL character.
03417  * @param   size
03418  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03419  *          If the text exceeds this limit, it is truncated.
03420  * @return  Returns the 'pVal'.
03421  */
03422 XFOINTERFACE_API wchar_t* xfo_getWatermarkTextW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03423 
03424 /**
03425  * @deprecated
03426  * Displays the specified watermark text on each page.
03427  * Possible to make it multiple lines by delimiting with the line feed \n.
03428  * This setting is invalid with the evaluation version.
03429  *
03430  * @param   pXfoObj Pointer to XfoObj instance.
03431  * @param   newVal  Pointer to a null-terminated string.
03432  */
03433 XFOINTERFACE_API void xfo_setWatermarkText(CXfoObjPtr pXfoObj, const char* newVal);
03434 
03435 /**
03436  * @deprecated
03437  * Displays the specified watermark text on each page.
03438  * Possible to make it multiple lines by delimiting with the line feed \n.
03439  * This setting is invalid with the evaluation version.
03440  *
03441  * @param   pXfoObj Pointer to XfoObj instance.
03442  * @param   newVal  Pointer to a null-terminated string.
03443  */
03444 XFOINTERFACE_API void xfo_setWatermarkTextW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03445 
03446 /**
03447  * @deprecated
03448  * Get the font family of the watermark text.
03449  *
03450  * @param   pXfoObj Pointer to XfoObj instance.
03451  * @param   pVal
03452  *          Pointer to the buffer that will receive the text.
03453  *          If the string is as long or longer than the buffer,
03454  *          the string is truncated and terminated with a NULL character.
03455  * @param   size
03456  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03457  *          If the text exceeds this limit, it is truncated.
03458  * @return  Returns the 'pVal'.
03459  */
03460 XFOINTERFACE_API char* xfo_getWatermarkFontFamily(CXfoObjPtr pXfoObj, char* pVal, int size);
03461 
03462 /**
03463  * @deprecated
03464  * Get the font family of the watermark text.
03465  *
03466  * @param   pXfoObj Pointer to XfoObj instance.
03467  * @param   pVal
03468  *          Pointer to the buffer that will receive the text.
03469  *          If the string is as long or longer than the buffer,
03470  *          the string is truncated and terminated with a NULL character.
03471  * @param   size
03472  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03473  *          If the text exceeds this limit, it is truncated.
03474  * @return  Returns the 'pVal'.
03475  */
03476 XFOINTERFACE_API wchar_t* xfo_getWatermarkFontFamilyW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03477 
03478 /**
03479  * @deprecated
03480  * Specifies the font family to the character string which you set to watermark-text.
03481  *
03482  * @param   pXfoObj Pointer to XfoObj instance.
03483  * @param   newVal  Pointer to a null-terminated string.
03484  */
03485 XFOINTERFACE_API void xfo_setWatermarkFontFamily(CXfoObjPtr pXfoObj, const char* newVal);
03486 
03487 /**
03488  * @deprecated
03489  * Specifies the font family to the character string which you set to watermark-text.
03490  *
03491  * @param   pXfoObj Pointer to XfoObj instance.
03492  * @param   newVal  Pointer to a null-terminated string.
03493  */
03494 XFOINTERFACE_API void xfo_setWatermarkFontFamilyW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03495 
03496 /**
03497  * @deprecated
03498  * Get the font weight of the watermark text.
03499  *
03500  * @param   pXfoObj Pointer to XfoObj instance.
03501  * @param   pVal
03502  *          Pointer to the buffer that will receive the text.
03503  *          If the string is as long or longer than the buffer,
03504  *          the string is truncated and terminated with a NULL character.
03505  * @param   size
03506  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03507  *          If the text exceeds this limit, it is truncated.
03508  * @return  Returns the 'pVal'.
03509  */
03510 XFOINTERFACE_API char* xfo_getWatermarkFontWeight(CXfoObjPtr pXfoObj, char* pVal, int size);
03511 
03512 /**
03513  * @deprecated
03514  * Get the font weight of the watermark text.
03515  *
03516  * @param   pXfoObj Pointer to XfoObj instance.
03517  * @param   pVal
03518  *          Pointer to the buffer that will receive the text.
03519  *          If the string is as long or longer than the buffer,
03520  *          the string is truncated and terminated with a NULL character.
03521  * @param   size
03522  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03523  *          If the text exceeds this limit, it is truncated.
03524  * @return  Returns the 'pVal'.
03525  */
03526 XFOINTERFACE_API wchar_t* xfo_getWatermarkFontWeightW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03527 
03528 /**
03529  * @deprecated
03530  * Specifies the font weight to the character string which you set to watermark-text.
03531  * Possible to specify normal, bold or the numerical value from 100 to 900.
03532  *
03533  * @param   pXfoObj Pointer to XfoObj instance.
03534  * @param   newVal  Pointer to a null-terminated string.
03535  */
03536 XFOINTERFACE_API void xfo_setWatermarkFontWeight(CXfoObjPtr pXfoObj, const char* newVal);
03537 
03538 /**
03539  * @deprecated
03540  * Specifies the font weight to the character string which you set to watermark-text.
03541  * Possible to specify normal, bold or the numerical value from 100 to 900.
03542  *
03543  * @param   pXfoObj Pointer to XfoObj instance.
03544  * @param   newVal  Pointer to a null-terminated string.
03545  */
03546 XFOINTERFACE_API void xfo_setWatermarkFontWeightW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03547 
03548 /**
03549  * @deprecated
03550  * Get the font style of the watermark text.
03551  *
03552  * @param   pXfoObj Pointer to XfoObj instance.
03553  * @param   pVal
03554  *          Pointer to the buffer that will receive the text.
03555  *          If the string is as long or longer than the buffer,
03556  *          the string is truncated and terminated with a NULL character.
03557  * @param   size
03558  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03559  *          If the text exceeds this limit, it is truncated.
03560  * @return  Returns the 'pVal'.
03561  */
03562 XFOINTERFACE_API char* xfo_getWatermarkFontStyle(CXfoObjPtr pXfoObj, char* pVal, int size);
03563 
03564 /**
03565  * @deprecated
03566  * Get the font style of the watermark text.
03567  *
03568  * @param   pXfoObj Pointer to XfoObj instance.
03569  * @param   pVal
03570  *          Pointer to the buffer that will receive the text.
03571  *          If the string is as long or longer than the buffer,
03572  *          the string is truncated and terminated with a NULL character.
03573  * @param   size
03574  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03575  *          If the text exceeds this limit, it is truncated.
03576  * @return  Returns the 'pVal'.
03577  */
03578 XFOINTERFACE_API wchar_t* xfo_getWatermarkFontStyleW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03579 
03580 /**
03581  * @deprecated
03582  * Specifies the font style to the character string which you set to watermark-text.
03583  *
03584  * @param   pXfoObj Pointer to XfoObj instance.
03585  * @param   newVal  Pointer to a null-terminated string.
03586  */
03587 XFOINTERFACE_API void xfo_setWatermarkFontStyle(CXfoObjPtr pXfoObj, const char* newVal);
03588 
03589 /**
03590  * @deprecated
03591  * Specifies the font style to the character string which you set to watermark-text.
03592  *
03593  * @param   pXfoObj Pointer to XfoObj instance.
03594  * @param   newVal  Pointer to a null-terminated string.
03595  */
03596 XFOINTERFACE_API void xfo_setWatermarkFontStyleW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03597 
03598 /**
03599  * @deprecated
03600  * Get the opacity of the watermark text.
03601  *
03602  * @param   pXfoObj Pointer to XfoObj instance.
03603  * @param   pVal
03604  *          Pointer to the buffer that will receive the text.
03605  *          If the string is as long or longer than the buffer,
03606  *          the string is truncated and terminated with a NULL character.
03607  * @param   size
03608  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03609  *          If the text exceeds this limit, it is truncated.
03610  * @return  Returns the 'pVal'.
03611  */
03612 XFOINTERFACE_API char* xfo_getWatermarkOpacity(CXfoObjPtr pXfoObj, char* pVal, int size);
03613 
03614 /**
03615  * @deprecated
03616  * Get the opacity of the watermark text.
03617  *
03618  * @param   pXfoObj Pointer to XfoObj instance.
03619  * @param   pVal
03620  *          Pointer to the buffer that will receive the text.
03621  *          If the string is as long or longer than the buffer,
03622  *          the string is truncated and terminated with a NULL character.
03623  * @param   size
03624  *          Specifies the number of the 'pVal' buffer, including the NULL character.
03625  *          If the text exceeds this limit, it is truncated.
03626  * @return  Returns the 'pVal'.
03627  */
03628 XFOINTERFACE_API wchar_t* xfo_getWatermarkOpacityW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
03629 
03630 /**
03631  * @deprecated
03632  * Specifies the opacity to the character string which you set to watermark-text.
03633  *
03634  * @param   pXfoObj Pointer to XfoObj instance.
03635  * @param   newVal  Pointer to a null-terminated string.
03636  */
03637 XFOINTERFACE_API void xfo_setWatermarkOpacity(CXfoObjPtr pXfoObj, const char* newVal);
03638 
03639 /**
03640  * @deprecated
03641  * Specifies the opacity to the character string which you set to watermark-text.
03642  *
03643  * @param   pXfoObj Pointer to XfoObj instance.
03644  * @param   newVal  Pointer to a null-terminated string.
03645  */
03646 XFOINTERFACE_API void xfo_setWatermarkOpacityW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
03647 
03648 #ifdef __cplusplus
03649 }
03650 #endif  /* __cplusplus */
03651 
03652 #endif  /* XFOIFC_C_H__ */

Generated on 18 Mar 2016 for AHFormatter C/C++ Interface by Doxygen 1.3-rc2