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

Generated on 19 Sep 2025 for Antenna House Formatter C/C++ Interface by Doxygen 1.3-rc2