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