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

Generated on 6 Apr 2020 for AHFormatter C/C++ Interface by Doxygen 1.3-rc2