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