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

xfoifc_c.h

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

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