00001 /** 00002 * @file dfvifc_c.h 00003 * @brief SBC C Interface 00004 * 00005 * @author Antenna House, Inc. 00006 * 00007 * Copyright (C) 2002-2009 Antenna House, Inc. All rights reserved. 00008 */ 00009 00010 #ifndef DFVIFC_C_H__ 00011 #define DFVIFC_C_H__ 00012 00013 #include <stddef.h> 00014 00015 #if !defined(_DOXYGEN) && defined(_MSC_VER) && defined(_WIN32) 00016 #ifdef DFVINTERFACE_EXPORTS 00017 #define DFVINTERFACE_API __declspec( dllexport ) 00018 #else 00019 #define DFVINTERFACE_API __declspec( dllimport ) 00020 #endif 00021 #else 00022 #define DFVINTERFACE_API 00023 #endif 00024 00025 /** 00026 * Error Code 00027 */ 00028 typedef long DfvIfErrorCode; /* 0 means no error */ 00029 00030 /** 00031 * Error Level 00032 */ 00033 typedef enum { 00034 ELVL_NORMAL = 0, /* no error */ 00035 ELVL_INFORMATION = 1, 00036 ELVL_WARNING = 2, 00037 ELVL_RECOVERABLE = 3, 00038 ELVL_FATAL = 4 00039 } DfvIfErrorLevel; 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 } DfvErrorStreamType; 00049 00050 /** 00051 * PDF version 00052 */ 00053 typedef enum { 00054 PDF_13, /* PDF 1.3 */ 00055 PDF_14, /* PDF 1.4 */ 00056 PDF_15, /* PDF 1.5 */ 00057 PDF_16, /* PDF 1.6 */ 00058 PDF_17, /* PDF 1.7 */ 00059 PDFA_1b_2005= 400 /* ISO 19005-1:2005 (based on PDF1.4) */ 00060 } DfvPDFVERSION; 00061 00062 /** 00063 * PDF encrypt level 00064 */ 00065 typedef enum { 00066 ENCLEVEL_40RC4 = 0, /* 40-bit RC4 */ 00067 ENCLEVEL_128RC4, /* 128-bit RC4 */ 00068 ENCLEVEL_128AES, /* 128-bit AES */ 00069 ENCLEVEL_256AES, /* 256-bit AES */ 00070 ENCLEVEL_40 = ENCLEVEL_40RC4, 00071 ENCLEVEL_128 = ENCLEVEL_128RC4 00072 } DfvPDFENCRYPTLEVEL; 00073 00074 /** 00075 * PDF print allow 00076 */ 00077 typedef enum { 00078 PRALLOW_NONE, /* not allowed */ 00079 PRALLOW_LOW, /* low resolution printing */ 00080 PRALLOW_HIGH /* high resolution printing */ 00081 } DfvPDFPRINTALLOW; 00082 00083 /** 00084 * PDF image compression 00085 */ 00086 typedef enum { 00087 IMGCMPR_AUTO, /* auto */ 00088 IMGCMPR_JPEG, /* JPEG */ 00089 IMGCMPR_ZLIB, /* ZLIB */ 00090 IMGCMPR_JPEG2K /* JPEG2000 */ 00091 } DfvPDFIMAGECOMPRESSION; 00092 00093 /** 00094 * PDF RGB conversion 00095 */ 00096 typedef enum { 00097 RGBCONV_NONE, /* no conversion */ 00098 RGBCONV_BLACK, /* black to devicegray */ 00099 RGBCONV_GRAY, /* gray to devicegray */ 00100 RGBCONV_ALL /* all rgb to devicegray */ 00101 } DfvPDFRGBCONVERSION; 00102 00103 /** 00104 * Embed font 00105 */ 00106 typedef enum { 00107 EMBALLFONT_PART, /* specified fonts */ 00108 EMBALLFONT_ALL, /* all fonts except Base14 fonts */ 00109 EMBALLFONT_BASE14 /* all fonts */ 00110 } DfvEMBEDALLFONT; 00111 00112 /** 00113 * Image downsampling 00114 */ 00115 typedef enum { 00116 IMGDOWNSAMPLING_NONE, /* no downsampling */ 00117 IMGDOWNSAMPLING_AVERAGE, /* average downsampling */ 00118 IMGDOWNSAMPLING_BICUBIC, /* bicubic downsampling */ 00119 IMGDOWNSAMPLING_SUBSAMPLING /* subsampling */ 00120 } DfvIMAGEDOWNSAMPLING; 00121 00122 /** 00123 * Monochrome compression 00124 */ 00125 typedef enum { 00126 MONOCMPR_CCITT4, /* CCITTFaxDecode group 4 filter,default value */ 00127 MONOCMPR_CCITT3, /* CCITTFaxDecode group 3 filter */ 00128 MONOCMPR_RUNLENGTH, /* RunLengthDecode filter */ 00129 MONOCMPR_ZLIB, /* FlateDecode filter */ 00130 MONOCMPR_OFF /* no filter */ 00131 } DfvMONOCHROMECOMPRESSION; 00132 00133 /** 00134 * SVG version 00135 */ 00136 typedef enum { 00137 SVG_11, /* SVG 1.1 */ 00138 SVG_Basic, /* SVG Basic */ 00139 SVG_Tiny /* SVG Tiny */ 00140 } DfvSVGVERSION; 00141 00142 /** 00143 * Image processing 00144 */ 00145 typedef enum { 00146 IMGPT_EMBED_ALL, /* embed all */ 00147 IMGPT_COPY_ALL, /* copy all */ 00148 IMGPT_LINK, /* link */ 00149 IMGPT_COPY /* copy */ 00150 } DfvIMAGEPROCTYPE; 00151 00152 /** 00153 * Image conversion 00154 */ 00155 typedef enum { 00156 IMGCNV_AUTO, /* auto */ 00157 IMGCNV_JPEG, /* jpeg conversion except png */ 00158 IMGCNV_PNG, /* png conversion except jpeg */ 00159 IMGCNV_JPEGALL /* jpeg-all conversion */ 00160 } DfvIMAGECONVERSION; 00161 00162 /** 00163 * INX output mode 00164 */ 00165 typedef enum { 00166 INXOM_TEXT, /* text area output mode */ 00167 INXOM_LINE, /* line area output */ 00168 INXOM_BLOCK /* block area output */ 00169 } DfvINXOUTPUTMODE; 00170 00171 /** 00172 * MIF output mode 00173 */ 00174 typedef enum { 00175 MIFOM_TEXT, /* text area output mode */ 00176 MIFOM_LINE, /* line area output */ 00177 MIFOM_BLOCK /* block area output */ 00178 } DfvMIFOUTPUTMODE; 00179 00180 /*************************************************************** 00181 * format information 00182 */ 00183 00184 #ifdef __cplusplus 00185 extern "C" { 00186 #endif 00187 00188 /** Pointer to DfvObj instance. */ 00189 typedef void* CDfvObjPtr; 00190 00191 /** 00192 * Error callback handler 00193 */ 00194 typedef void (DfvOnMessageProc)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 00195 typedef void (DfvOnMessageProcW)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage); 00196 typedef void (DfvOnFormatPageProc)(long pageNo); 00197 00198 typedef void (DfvOnMessageProcEx)(void* pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 00199 typedef void (DfvOnMessageProcExW)(void* pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage); 00200 typedef void (DfvOnFormatPageProcEx)(void* pAnyObj, long pageNo); 00201 00202 /** 00203 * Create instance of DfvObj 00204 * 00205 * @return Pointer to DfvObj instance. 00206 */ 00207 DFVINTERFACE_API CDfvObjPtr dfv_createDfvObject(); 00208 00209 /** 00210 * Release instance of DfvObj 00211 * 00212 * @param pDfvObj Pointer to DfvObj instance. 00213 */ 00214 DFVINTERFACE_API void dfv_releaseDfvObject(CDfvObjPtr pDfvObj); 00215 00216 /** 00217 * Get the URL of document you will format. 00218 * 00219 * @param pDfvObj Pointer to DfvObj instance. 00220 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00221 * the string is truncated and terminated with a NULL character. 00222 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00223 * @return Returns the 'pVal'. 00224 */ 00225 DFVINTERFACE_API char* dfv_getDocumentURI(CDfvObjPtr pDfvObj, char* pVal, int size); 00226 /** 00227 * Get the URL of document you will format. 00228 * 00229 * @param pDfvObj Pointer to DfvObj instance. 00230 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00231 * the string is truncated and terminated with a NULL character. 00232 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00233 * @return Returns the 'pVal'. 00234 */ 00235 DFVINTERFACE_API wchar_t* dfv_getDocumentURIW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00236 00237 /** 00238 * Specifies the URL of document you will format. 00239 * If it is omitted or "\@STDIN" is specified, document is loaded from stdin. 00240 * The document loaded from stdin are supposed to be FO files. 00241 * 00242 * @param pDfvObj Pointer to DfvObj instance. 00243 * @param newVal Pointer to a null-terminated string to be used as the URL of XSL document. 00244 */ 00245 DFVINTERFACE_API void dfv_setDocumentURI(CDfvObjPtr pDfvObj, const char* newVal); 00246 /** 00247 * Specifies the URL of document you will format. 00248 * If it is omitted or "\@STDIN" is specified, document is loaded from stdin. 00249 * The document loaded from stdin are supposed to be FO files. 00250 * 00251 * @param pDfvObj Pointer to DfvObj instance. 00252 * @param newVal Pointer to a null-terminated string to be used as the URL of XSL document. 00253 */ 00254 DFVINTERFACE_API void dfv_setDocumentURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00255 00256 /** 00257 * Get the path name of the output file. 00258 * 00259 * @param pDfvObj Pointer to DfvObj instance. 00260 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00261 * the string is truncated and terminated with a NULL character. 00262 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00263 * @return Returns the 'pVal'. 00264 */ 00265 DFVINTERFACE_API char* dfv_getOutputFilePath(CDfvObjPtr pDfvObj, char* pVal, int size); 00266 /** 00267 * Get the path name of the output file. 00268 * 00269 * @param pDfvObj Pointer to DfvObj instance. 00270 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00271 * the string is truncated and terminated with a NULL character. 00272 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00273 * @return Returns the 'pVal'. 00274 */ 00275 DFVINTERFACE_API wchar_t* dfv_getOutputFilePathW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00276 00277 /** 00278 * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout. 00279 * If both the printer name and this property are specified, the formatted result will be stored in 00280 * the file by the printer driver. 00281 * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. 00282 * If the property is not specified, it is considered as stdout. 00283 * 00284 * @param pDfvObj Pointer to DfvObj instance. 00285 * @param newVal Pointer to a null-terminated string to be used as the path name of the output file. 00286 */ 00287 DFVINTERFACE_API void dfv_setOutputFilePath(CDfvObjPtr pDfvObj, const char* newVal); 00288 /** 00289 * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout. 00290 * If both the printer name and this property are specified, the formatted result will be stored in 00291 * the file by the printer driver. 00292 * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. 00293 * If the property is not specified, it is considered as stdout. 00294 * 00295 * @param pDfvObj Pointer to DfvObj instance. 00296 * @param newVal Pointer to a null-terminated string to be used as the path name of the output file. 00297 */ 00298 DFVINTERFACE_API void dfv_setOutputFilePathW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00299 00300 /** 00301 * Get the path name of format Option setting file which describes Server Based Converter options. 00302 * 00303 * @param pDfvObj Pointer to DfvObj instance. 00304 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00305 * the string is truncated and terminated with a NULL character. 00306 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00307 * @param n Specifies to get n-th URI. 0 means first URI. 00308 * @return Returns the 'pVal'. 00309 */ 00310 DFVINTERFACE_API char* dfv_getOptionFileURI(CDfvObjPtr pDfvObj, char* pVal, int size, int n); 00311 /** 00312 * Get the path name of format Option setting file which describes Server Based Converter options. 00313 * 00314 * @param pDfvObj Pointer to DfvObj instance. 00315 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00316 * the string is truncated and terminated with a NULL character. 00317 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00318 * @param n Specifies to get n-th URI. 0 means first URI. 00319 * @return Returns the 'pVal'. 00320 */ 00321 DFVINTERFACE_API wchar_t* dfv_getOptionFileURIW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size, int n); 00322 00323 /** 00324 * Specifies the path name of format Option setting file which describes Server Based Converter options. 00325 * The set of former URIs is thrown away. 00326 * 00327 * @param pDfvObj Pointer to DfvObj instance. 00328 * @param newVal Pointer to a null-terminated string to be used as the path name of format Option setting file. 00329 */ 00330 DFVINTERFACE_API void dfv_setOptionFileURI(CDfvObjPtr pDfvObj, const char* newVal); 00331 /** 00332 * Specifies the path name of format Option setting file which describes Server Based Converter options. 00333 * The set of former URIs is thrown away. 00334 * 00335 * @param pDfvObj Pointer to DfvObj instance. 00336 * @param newVal Pointer to a null-terminated string to be used as the path name of format Option setting file. 00337 */ 00338 DFVINTERFACE_API void dfv_setOptionFileURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00339 00340 /** 00341 * Append the path name of format Option setting file which describes Server Based Converter options. 00342 * 00343 * 00344 * @param pDfvObj Pointer to DfvObj instance. 00345 * @param newVal Pointer to a null-terminated string to be used as the path name of format Option setting file. 00346 */ 00347 DFVINTERFACE_API void dfv_addOptionFileURI(CDfvObjPtr pDfvObj, const char* newVal); 00348 /** 00349 * Append the path name of format Option setting file which describes Server Based Converter options. 00350 * 00351 * 00352 * @param pDfvObj Pointer to DfvObj instance. 00353 * @param newVal Pointer to a null-terminated string to be used as the path name of format Option setting file. 00354 */ 00355 DFVINTERFACE_API void dfv_addOptionFileURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00356 00357 /** 00358 * Get the number of URIs of format Option setting file which describes Server Based Converter options. 00359 * 00360 * 00361 * @param pDfvObj Pointer to DfvObj instance. 00362 * @return Returns the number of URIs. 00363 */ 00364 DFVINTERFACE_API int dfv_getOptionFileCount(CDfvObjPtr pDfvObj); 00365 00366 /** 00367 * Get the start page number of document to output. 00368 * 00369 * @param pDfvObj Pointer to DfvObj instance. 00370 * @return start page number of output. 00371 */ 00372 DFVINTERFACE_API long dfv_getStartPage(CDfvObjPtr pDfvObj); 00373 00374 /** 00375 * Specifies the start page number of document to output. 00376 * If the start page is omitted or the specified value is 0 or less, the start page is 00377 * considered from the first page. 00378 * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs. 00379 * 00380 * @param pDfvObj Pointer to DfvObj instance. 00381 * @param newVal start page number of output. 00382 */ 00383 DFVINTERFACE_API void dfv_setStartPage(CDfvObjPtr pDfvObj, long newVal); 00384 00385 /** 00386 * Get the end page number of document to output. 00387 * 00388 * @param pDfvObj Pointer to DfvObj instance. 00389 * @return end page number of output. 00390 */ 00391 DFVINTERFACE_API long dfv_getEndPage(CDfvObjPtr pDfvObj); 00392 00393 /** 00394 * Specifies the end page number of document to output. 00395 * If the end page is omitted or the specified value exceeds the actual page number, the end page 00396 * is considered as the last page. 00397 * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs. 00398 * 00399 * @param pDfvObj Pointer to DfvObj instance. 00400 * @param newVal end page number of output. 00401 */ 00402 DFVINTERFACE_API void dfv_setEndPage(CDfvObjPtr pDfvObj, long newVal); 00403 00404 /** 00405 * Effective when outputting to PDF. 00406 * Specifies the owner password for PDF. The password must be within 32 bytes. 00407 * 00408 * 00409 * @param pDfvObj Pointer to DfvObj instance. 00410 * @param newVal Pointer to a null-terminated string to be used as the owner password. 00411 */ 00412 DFVINTERFACE_API void dfv_setPdfOwnerPassword(CDfvObjPtr pDfvObj, const char* newVal); 00413 00414 /** 00415 * Effective when outputting to PDF. 00416 * Specifies the owner password for PDF. The password must be within 32 bytes. 00417 * 00418 * 00419 * @param pDfvObj Pointer to DfvObj instance. 00420 * @param newVal Pointer to a null-terminated string to be used as the owner password. 00421 */ 00422 DFVINTERFACE_API void dfv_setPdfOwnerPasswordW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00423 00424 /** 00425 * Effective when outputting to PDF. 00426 * Specifies the user password for PDF. The password must be within 32 bytes. 00427 * 00428 * 00429 * @param pDfvObj Pointer to DfvObj instance. 00430 * @param newVal Pointer to a null-terminated string to be used as the user password. 00431 */ 00432 DFVINTERFACE_API void dfv_setPdfUserPassword(CDfvObjPtr pDfvObj, const char* newVal); 00433 00434 /** 00435 * Effective when outputting to PDF. 00436 * Specifies the user password for PDF. The password must be within 32 bytes. 00437 * 00438 * 00439 * @param pDfvObj Pointer to DfvObj instance. 00440 * @param newVal Pointer to a null-terminated string to be used as the user password. 00441 */ 00442 DFVINTERFACE_API void dfv_setPdfUserPasswordW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00443 00444 /** 00445 * Effective when outputting to PDF. 00446 * Disables printing the PDF file. 00447 * 00448 * 00449 * @param pDfvObj Pointer to DfvObj instance. 00450 * @param newVal If nonezero is specified, Disables printing the PDF file. 00451 */ 00452 DFVINTERFACE_API void dfv_setPdfNoPrinting(CDfvObjPtr pDfvObj, long newVal); 00453 00454 /** 00455 * Effective when outputting to PDF. 00456 * Get disables printing the PDF file. 00457 * 00458 * 00459 * @param pDfvObj Pointer to DfvObj instance. 00460 * @return If zero is returned, Enables printing the PDF file. 00461 * If nonezero is returned, Disables printing the PDF file. 00462 */ 00463 DFVINTERFACE_API long dfv_getPdfNoPrinting(CDfvObjPtr pDfvObj); 00464 00465 /** 00466 * Effective when outputting to PDF. 00467 * Disables making changes of the PDF file. 00468 * 00469 * 00470 * @param pDfvObj Pointer to DfvObj instance. 00471 * @param newVal If nonezero is specified, Disables making changes of the PDF file. 00472 */ 00473 DFVINTERFACE_API void dfv_setPdfNoChanging(CDfvObjPtr pDfvObj, long newVal); 00474 00475 /** 00476 * Effective when outputting to PDF. 00477 * Get disables making changes of the PDF file. 00478 * 00479 * 00480 * @param pDfvObj Pointer to DfvObj instance. 00481 * @return If zero is returned, Enables making changes of the PDF file. 00482 * If nonezero is returned, Disables making changes of the PDF file. 00483 */ 00484 DFVINTERFACE_API long dfv_getPdfNoChanging(CDfvObjPtr pDfvObj); 00485 00486 /** 00487 * Effective when outputting to PDF. 00488 * Disables copying the content of the PDF file. 00489 * 00490 * 00491 * @param pDfvObj Pointer to DfvObj instance. 00492 * @param newVal If nonezero is specified, Disables copying the content of the PDF file. 00493 */ 00494 DFVINTERFACE_API void dfv_setPdfNoContentCopying(CDfvObjPtr pDfvObj, long newVal); 00495 00496 /** 00497 * Effective when outputting to PDF. 00498 * Get disables copying the content of the PDF file. 00499 * 00500 * 00501 * @param pDfvObj Pointer to DfvObj instance. 00502 * @return If zero is returned, Enables copying the content of the PDF file. 00503 * If nonezero is returned, Disables copying the content of the PDF file. 00504 */ 00505 DFVINTERFACE_API long dfv_getPdfNoContentCopying(CDfvObjPtr pDfvObj); 00506 00507 /** 00508 * Effective when outputting to PDF. 00509 * Disables adding comments and form fields to the PDF file. 00510 * 00511 * 00512 * @param pDfvObj Pointer to DfvObj instance. 00513 * @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file. 00514 */ 00515 DFVINTERFACE_API void dfv_setPdfNoAddingOrChangingCommnets(CDfvObjPtr pDfvObj, long newVal); 00516 00517 /** 00518 * Effective when outputting to PDF. 00519 * Get disables adding comments and form fields to the PDF file. 00520 * 00521 * 00522 * @param pDfvObj Pointer to DfvObj instance. 00523 * @return If zero is returned, Enables adding comments and form fields to the PDF file. 00524 * If nonezero is returned, Disables adding comments and form fields to the PDF file. 00525 */ 00526 DFVINTERFACE_API long dfv_getPdfNoAddingOrChangingCommnets(CDfvObjPtr pDfvObj); 00527 00528 /** 00529 * Effective when outputting to PDF. 00530 * Disables adding comments and form fields to the PDF file. 00531 * 00532 * 00533 * @param pDfvObj Pointer to DfvObj instance. 00534 * @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file. 00535 */ 00536 DFVINTERFACE_API void dfv_setPdfNoAddingOrChangingComments(CDfvObjPtr pDfvObj, long newVal); 00537 00538 /** 00539 * Effective when outputting to PDF. 00540 * Get disables adding comments and form fields to the PDF file. 00541 * 00542 * 00543 * @param pDfvObj Pointer to DfvObj instance. 00544 * @return If zero is returned, Enables adding comments and form fields to the PDF file. 00545 * If nonezero is returned, Disables adding comments and form fields to the PDF file. 00546 */ 00547 DFVINTERFACE_API long dfv_getPdfNoAddingOrChangingComments(CDfvObjPtr pDfvObj); 00548 00549 /** 00550 * Effective when outputting to PDF. 00551 * Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5. 00552 * 00553 * 00554 * @param pDfvObj Pointer to DfvObj instance. 00555 * @param newVal Specifies the version of PDF. 00556 */ 00557 DFVINTERFACE_API void dfv_setPdfVersion(CDfvObjPtr pDfvObj, DfvPDFVERSION newVal); 00558 00559 /** 00560 * Effective when outputting to PDF. 00561 * Get the version of PDF. 00562 * 00563 * 00564 * @param pDfvObj Pointer to DfvObj instance. 00565 * @return the version of PDF. 00566 */ 00567 DFVINTERFACE_API DfvPDFVERSION dfv_getPdfVersion(CDfvObjPtr pDfvObj); 00568 00569 /** 00570 * Effective when outputting to PDF. 00571 * Disables filling in of form fields and signing of the PDF file. 00572 * This parameter is effective only when you specify PDF1.4 or later to PDF version. 00573 * 00574 * 00575 * @param pDfvObj Pointer to DfvObj instance. 00576 * @param newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file. 00577 */ 00578 DFVINTERFACE_API void dfv_setPdfNoFillForm(CDfvObjPtr pDfvObj, long newVal); 00579 00580 /** 00581 * Effective when outputting to PDF. 00582 * Get disables filling in of form fields and signing of the PDF file. 00583 * 00584 * 00585 * @param pDfvObj Pointer to DfvObj instance. 00586 * @return If zero is returned, Enables filling in of form fields and signing of the PDF file. 00587 * If nonezero is returned, Disables filling in of form fields and signing of the PDF file. 00588 */ 00589 DFVINTERFACE_API long dfv_getPdfNoFillForm(CDfvObjPtr pDfvObj); 00590 00591 /** 00592 * Effective when outputting to PDF. 00593 * Disables text access for screen reader devices of the PDF file. 00594 * This parameter is effective only when you specify 1.4 or later with PDF version. 00595 * 00596 * 00597 * @param pDfvObj Pointer to DfvObj instance. 00598 * @param newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file. 00599 */ 00600 DFVINTERFACE_API void dfv_setPdfNoAccessibility(CDfvObjPtr pDfvObj, long newVal); 00601 00602 /** 00603 * Effective when outputting to PDF. 00604 * Get disables text access for screen reader devices of the PDF file. 00605 * 00606 * 00607 * @param pDfvObj Pointer to DfvObj instance. 00608 * @return If zero is returned, Enables text access for screen reader devices of the PDF file. 00609 * If nonezero is returned, Disables text access for screen reader devices of the PDF file. 00610 */ 00611 DFVINTERFACE_API long dfv_getPdfNoAccessibility(CDfvObjPtr pDfvObj); 00612 00613 /** 00614 * Effective when outputting to PDF. 00615 * Disables inserting, deleting and rotating the PDF pages. 00616 * This parameter is effective only when you specify 1.4 or later with PDF version 00617 * 00618 * 00619 * @param pDfvObj Pointer to DfvObj instance. 00620 * @param newVal If nonezero is specified, Disables inserting, deleting and rotating the PDF pages. 00621 */ 00622 DFVINTERFACE_API void dfv_setPdfNoAssembleDoc(CDfvObjPtr pDfvObj, long newVal); 00623 00624 /** 00625 * Effective when outputting to PDF. 00626 * Get disables inserting, deleting and rotating the PDF pages. 00627 * 00628 * 00629 * @param pDfvObj Pointer to DfvObj instance. 00630 * @return If zero is returned, Enables inserting, deleting and rotating the PDF pages. 00631 * If nonezero is returned, Disables inserting, deleting and rotating the PDF pages. 00632 */ 00633 DFVINTERFACE_API long dfv_getPdfNoAssembleDoc(CDfvObjPtr pDfvObj); 00634 00635 /** 00636 * Effective when outputting to PDF. 00637 * Specifies the key length when encrypting the PDF file during outputting. 00638 * The key length can be specified as either 40 or 128 (bit). 00639 * This parameter is effective only when you specify PDF1.4 or later with PDF version 00640 * 00641 * 00642 * @param pDfvObj Pointer to DfvObj instance. 00643 * @param newVal Specifies the key length. 00644 */ 00645 DFVINTERFACE_API void dfv_setPdfEncryptLevel(CDfvObjPtr pDfvObj, DfvPDFENCRYPTLEVEL newVal); 00646 00647 /** 00648 * Effective when outputting to PDF. 00649 * Get the key length when encrypting the PDF file during outputting. 00650 * 00651 * 00652 * @param pDfvObj Pointer to DfvObj instance. 00653 * @return the key length. 00654 */ 00655 DFVINTERFACE_API DfvPDFENCRYPTLEVEL dfv_getPdfEncryptLevel(CDfvObjPtr pDfvObj); 00656 00657 /** 00658 * Effective when outputting to PDF. 00659 * Gets the value of whether to embed all embeddable fonts in PDF. 00660 * 00661 * 00662 * @param pDfvObj Pointer to DfvObj instance. 00663 * @return the value of whether to embed all embeddable fonts 00664 */ 00665 DFVINTERFACE_API long dfv_getPdfEmbedAllFonts(CDfvObjPtr pDfvObj); 00666 00667 /** 00668 * Effective when outputting to PDF. 00669 * Embeds all embeddable fonts in PDF to create. 00670 * 00671 * 00672 * @param pDfvObj Pointer to DfvObj instance. 00673 * @param newVal If the value is 'true' is specified, Embeds all embeddable fonts 00674 */ 00675 DFVINTERFACE_API void dfv_setPdfEmbedAllFonts(CDfvObjPtr pDfvObj, long newVal); 00676 00677 /** 00678 * Effective when outputting to PDF. 00679 * Gets the font specified to be embedded in PDF. 00680 * 00681 * 00682 * @param pDfvObj Pointer to DfvObj instance. 00683 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 00684 * the string is truncated and terminated with a NULL character. 00685 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00686 * @return Returns the 'pVal'. 00687 */ 00688 DFVINTERFACE_API char* dfv_getPdfEmbedFonts(CDfvObjPtr pDfvObj, char* pVal, int size); 00689 00690 /** 00691 * Effective when outputting to PDF. 00692 * Gets the font specified to be embedded in PDF. 00693 * 00694 * 00695 * @param pDfvObj Pointer to DfvObj instance. 00696 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 00697 * the string is truncated and terminated with a NULL character. 00698 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00699 * @return Returns the 'pVal'. 00700 */ 00701 DFVINTERFACE_API wchar_t* dfv_getPdfEmbedFontsW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00702 00703 /** 00704 * Effective when outputting to PDF. 00705 * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts. 00706 * 00707 * 00708 * @param pDfvObj Pointer to DfvObj instance. 00709 * @param newVal fonts specified to embed 00710 */ 00711 DFVINTERFACE_API void dfv_setPdfEmbedFonts(CDfvObjPtr pDfvObj, const char* newVal); 00712 00713 /** 00714 * Effective when outputting to PDF. 00715 * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts. 00716 * 00717 * 00718 * @param pDfvObj Pointer to DfvObj instance. 00719 * @param newVal fonts specified to embed 00720 */ 00721 DFVINTERFACE_API void dfv_setPdfEmbedFontsW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00722 00723 /** 00724 * Effective when outputting to PDF. 00725 * Gets the value of whether to issues the error when failing to embed fonts. 00726 * 00727 * 00728 * @param pDfvObj Pointer to DfvObj instance. 00729 * @return the value of whether to issues the error 00730 */ 00731 DFVINTERFACE_API long dfv_getPdfErrorOnEmbedFault(CDfvObjPtr pDfvObj); 00732 00733 /** 00734 * Effective when outputting to PDF. 00735 * An error is issued in case of failing to embed fonts. 00736 * 00737 * 00738 * @param pDfvObj Pointer to DfvObj instance. 00739 * @param newVal If the value is 'true' is specified, an error is issued. 00740 */ 00741 DFVINTERFACE_API void dfv_setPdfErrorOnEmbedFault(CDfvObjPtr pDfvObj, long newVal); 00742 00743 /** 00744 * Effective when outputting to PDF. 00745 * Gets the value of whether to issues the error when missing glyph. 00746 * 00747 * 00748 * @param pDfvObj Pointer to DfvObj instance. 00749 * @return the value of whether to issues the error 00750 */ 00751 DFVINTERFACE_API long dfv_getPdfErrorOnMissingGlyph(CDfvObjPtr pDfvObj); 00752 00753 /** 00754 * Effective when outputting to PDF. 00755 * An error is issued in case of missing glyph. 00756 * 00757 * 00758 * @param pDfvObj Pointer to DfvObj instance. 00759 * @param newVal If the value is 'true' is specified, an error is issued. 00760 */ 00761 DFVINTERFACE_API void dfv_setPdfErrorOnMissingGlyph(CDfvObjPtr pDfvObj, long newVal); 00762 00763 /** 00764 * Effective when outputting to PDF. 00765 * Gets the value of whether to print the resulting PDF file or not. 00766 * 00767 * 00768 * <table border="0" cellspacing="0" cellpadding="0"> 00769 * <tr><td>PRALLOW_NONE </td><td>= 0 Not Allowed</td></tr> 00770 * <tr><td>PRALLOW_LOW </td><td>= 1 Low Resolution Printing</td></tr> 00771 * <tr><td>PRALLOW_HIGH </td><td>= 2 High Resolution Printing</td></tr> 00772 * </table> 00773 * 00774 * @param pDfvObj Pointer to DfvObj instance. 00775 * @return the value of printing allowed 00776 */ 00777 DFVINTERFACE_API DfvPDFPRINTALLOW dfv_getPdfPrintingAllowed(CDfvObjPtr pDfvObj); 00778 00779 /** 00780 * Effective when outputting to PDF. 00781 * Spesifies whether to permit printing PDF to create with one of the following values. 00782 * This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion). 00783 * 00784 * 00785 * <table border="0" cellspacing="0" cellpadding="0"> 00786 * <tr><td>PRALLOW_NONE </td><td>= 0 Not Allowed</td></tr> 00787 * <tr><td>PRALLOW_LOW </td><td>= 1 Low Resolution Printing</td></tr> 00788 * <tr><td>PRALLOW_HIGH </td><td>= 2 High Resolution Printing</td></tr> 00789 * </table> 00790 * 00791 * @param pDfvObj Pointer to DfvObj instance. 00792 * @param newVal the value of printing allowed 00793 */ 00794 DFVINTERFACE_API void dfv_setPdfPrintingAllowed(CDfvObjPtr pDfvObj, DfvPDFPRINTALLOW newVal); 00795 00796 /** 00797 * Effective when outputting to PDF. 00798 * Gets the value of how to compress the color images embedded in PDF. 00799 * 00800 * 00801 * <table border="0" cellspacing="0" cellpadding="0"> 00802 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 00803 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 00804 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 00805 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 00806 * </table> 00807 * 00808 * @param pDfvObj Pointer to DfvObj instance. 00809 * @return the value of how raster graphics are compressed and stored 00810 */ 00811 DFVINTERFACE_API DfvPDFIMAGECOMPRESSION dfv_getPdfImageCompression(CDfvObjPtr pDfvObj); 00812 00813 /** 00814 * Effective when outputting to PDF. 00815 * 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> 00816 * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of dfv_setPdfJPEGQuality and dfv_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR> 00817 This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfMonochromeImageCompression for the monochrome image. 00818 * 00819 * 00820 * <table border="0" cellspacing="0" cellpadding="0"> 00821 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 00822 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 00823 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 00824 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 00825 * </table> 00826 * 00827 * @param pDfvObj Pointer to DfvObj instance. 00828 * @param newVal the value of how raster graphics are compressed and stored 00829 */ 00830 DFVINTERFACE_API void dfv_setPdfImageCompression(CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal); 00831 00832 /** 00833 * Gets the value of the quality of JPEG format that is specified by dfv_setPdfImageCompression() stored in PDF. 00834 * 00835 * 00836 * @param pDfvObj Pointer to DfvObj instance. 00837 * @return the value of the quality of JPEG format 00838 */ 00839 DFVINTERFACE_API int dfv_getPdfJPEGQuality(CDfvObjPtr pDfvObj); 00840 00841 /** 00842 * Effective when outputting to PDF. 00843 * 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> 00844 * CAUTION: It is not for changing the quality of a JPEG format image.<BR> 00845 * This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image. 00846 * 00847 * 00848 * @param pDfvObj Pointer to DfvObj instance. 00849 * @param newVal the value of the quality of JPEG format 00850 */ 00851 DFVINTERFACE_API void dfv_setPdfJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 00852 00853 /** 00854 * Effective when outputting to PDF. 00855 * 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. 00856 * 00857 * 00858 * @param pDfvObj Pointer to DfvObj instance. 00859 * @return the value of whether make the size of PDF smaller or not 00860 */ 00861 DFVINTERFACE_API long dfv_getPdfCompressContentStream(CDfvObjPtr pDfvObj); 00862 00863 /** 00864 * Effective when outputting to PDF. 00865 * Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not. 00866 * 00867 * 00868 * @param pDfvObj Pointer to DfvObj instance. 00869 * @param newVal If the value is 'true' is specified, make the PDF compress 00870 */ 00871 DFVINTERFACE_API void dfv_setPdfCompressContentStream(CDfvObjPtr pDfvObj, long newVal); 00872 00873 /** 00874 * Effective when outputting to PDF. 00875 * Gets the value of how to transform external link specified by the relative address in the PDF link. 00876 * 00877 * 00878 * @param pDfvObj Pointer to DfvObj instance. 00879 * @return the value of how to transform external link 00880 */ 00881 DFVINTERFACE_API long dfv_getPdfUseLaunchForRelativeURI(CDfvObjPtr pDfvObj); 00882 00883 /** 00884 * Effective when outputting to PDF. 00885 * 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. 00886 * 00887 * 00888 * @param pDfvObj Pointer to DfvObj instance. 00889 * @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' 00890 */ 00891 DFVINTERFACE_API void dfv_setPdfUseLaunchForRelativeURI(CDfvObjPtr pDfvObj, long newVal); 00892 00893 /** 00894 * Effective when outputting to PDF. 00895 * Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray. 00896 * 00897 * 00898 * <table border="0" cellspacing="0" cellpadding="0"> 00899 * <tr><td>RGBCONV_NONE </td><td>= 0 No Conversion</td></tr> 00900 * <tr><td>RGBCONV_BLACK </td><td>= 1 Black to DeviceGray</td></tr> 00901 * <tr><td>RGBCONV_GRAY </td><td>= 2 Gray to DeviceGray</td></tr> 00902 * <tr><td>RGBCONV_ALL </td><td>= 3 All RGB to DeviceGray</td></tr> 00903 * </table> 00904 * 00905 * @param pDfvObj Pointer to DfvObj instance. 00906 * @return the value of how to convert 00907 */ 00908 DFVINTERFACE_API DfvPDFRGBCONVERSION dfv_getPdfRGBConversion(CDfvObjPtr pDfvObj); 00909 00910 /** 00911 * Effective when outputting to PDF. 00912 * Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray. 00913 * 00914 * 00915 * <table border="0" cellspacing="0" cellpadding="0"> 00916 * <tr><td>RGBCONV_NONE </td><td>= 0 No Conversion</td></tr> 00917 * <tr><td>RGBCONV_BLACK </td><td>= 1 Black to DeviceGray</td></tr> 00918 * <tr><td>RGBCONV_GRAY </td><td>= 2 Gray to DeviceGray</td></tr> 00919 * <tr><td>RGBCONV_ALL </td><td>= 3 All RGB to DeviceGray</td></tr> 00920 * </table> 00921 * 00922 * @param pDfvObj Pointer to DfvObj instance. 00923 * @param newVal the value of how to convert 00924 */ 00925 DFVINTERFACE_API void dfv_setPdfRGBConversion(CDfvObjPtr pDfvObj, DfvPDFRGBCONVERSION newVal); 00926 00927 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 00928 00929 /** 00930 * Effective when outputting to PDF. 00931 * Gets the value of the rasterised-resolution of the transformed raster images. 00932 * 00933 * 00934 * @param pDfvObj Pointer to DfvObj instance. 00935 * @return Rasterised-resolution 00936 */ 00937 DFVINTERFACE_API int dfv_getPdfRasterizeResolution(CDfvObjPtr pDfvObj); 00938 00939 /** 00940 * Effective when outputting to PDF. 00941 * 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. 00942 * This setting is effective only with Windows version. 00943 * 00944 * 00945 * @param pDfvObj Pointer to DfvObj instance. 00946 * @param newVal Rasterised-resolution (70 to 500) 00947 */ 00948 DFVINTERFACE_API void dfv_setPdfRasterizeResolution(CDfvObjPtr pDfvObj, int newVal); 00949 00950 #endif 00951 00952 /** 00953 * Effective when outputting to PDF. 00954 * Gets the value of whether to output linearize PDF or not. 00955 * 00956 * 00957 * @param pDfvObj Pointer to DfvObj instance. 00958 * @return the value of whether to output linearize pdf or not. 00959 */ 00960 DFVINTERFACE_API long dfv_getPdfLinearize(CDfvObjPtr pDfvObj); 00961 00962 /** 00963 * Effective when outputting to PDF. 00964 * Specifies whether to output linearize PDF or not. 00965 * 00966 * 00967 * @param pDfvObj Pointer to DfvObj instance. 00968 * @param newVal If the value is 'true' is specified, output linearlize PDF. 00969 */ 00970 DFVINTERFACE_API void dfv_setPdfLinearize(CDfvObjPtr pDfvObj, long newVal); 00971 00972 /** 00973 * Effective when outputting to PDF. 00974 * Gets the value of whether to embed all embeddable fonts 00975 * 00976 * 00977 * <table border="0" cellspacing="0" cellpadding="0"> 00978 * <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr> 00979 * <tr><td>EMBALLFONT_ALL </td><td>= 1 All fonts except Base14 fonts</td></tr> 00980 * <tr><td>EMBALLFONT_BASE14 </td><td>= 2 All fonts</td></tr> 00981 * </table> 00982 * 00983 * @param pDfvObj Pointer to DfvObj instance. 00984 * @return the value of whether to embed all embeddable fonts 00985 */ 00986 DFVINTERFACE_API DfvEMBEDALLFONT dfv_getPdfEmbedAllFontsEx(CDfvObjPtr pDfvObj); 00987 00988 /** 00989 * Effective when outputting to PDF. 00990 * 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. 00991 * 00992 * 00993 * <table border="0" cellspacing="0" cellpadding="0"> 00994 * <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr> 00995 * <tr><td>EMBALLFONT_ALL </td><td>= 1 All fonts except Base14 fonts</td></tr> 00996 * <tr><td>EMBALLFONT_BASE14 </td><td>= 2 All fonts</td></tr> 00997 * </table> 00998 * 00999 *If the value is EMBALLFONT_PART, only fonts specified in dfv_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. 01000 * 01001 * @param pDfvObj Pointer to DfvObj instance. 01002 * @param newVal the value of whether to embed all embeddable fonts 01003 */ 01004 DFVINTERFACE_API void dfv_setPdfEmbedAllFontsEx(CDfvObjPtr pDfvObj, DfvEMBEDALLFONT newVal); 01005 01006 /** 01007 * Effective when outputting to PDF. 01008 * Gets the value of method to downsample the color image 01009 * 01010 * 01011 * @param pDfvObj Pointer to DfvObj instance. 01012 * @return the value of method to downsample the color image 01013 */ 01014 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfImageDownSampling(CDfvObjPtr pDfvObj); 01015 01016 /** 01017 * Effective when outputting to PDF. 01018 * Specifies the following either of method to downsample the color image that is put into PDF. 01019 * 01020 * 01021 * <table border="0" cellspacing="0" cellpadding="0"> 01022 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01023 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01024 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01025 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01026 * </table> 01027 * 01028 * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by dfv_setPdfImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfImageDownSamplingTarget. 01029 This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageDownSampling for the grayscale image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image. 01030 * 01031 * @param pDfvObj Pointer to DfvObj instance. 01032 * @param newVal the value of method to downsample the color image 01033 */ 01034 DFVINTERFACE_API void dfv_setPdfImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01035 01036 /** 01037 * Effective when outputting to PDF. 01038 * Gets resolution when the color image is downsampled. 01039 * 01040 * 01041 * @param pDfvObj Pointer to DfvObj instance. 01042 * @return the value of resolution. 01043 */ 01044 DFVINTERFACE_API int dfv_getPdfImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01045 01046 /** 01047 * Effective when outputting to PDF. 01048 * Set resolution when the color image is downsampled. 01049 * 01050 * 01051 * @param pDfvObj Pointer to DfvObj instance. 01052 * @param newVal the value of resolution. 01053 */ 01054 DFVINTERFACE_API void dfv_setPdfImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01055 01056 /** 01057 * Effective when outputting to PDF. 01058 * Gets resolution of the color image which performs a downsampling. 01059 * 01060 * 01061 * @param pDfvObj Pointer to DfvObj instance. 01062 * @return the value of resolution. 01063 */ 01064 DFVINTERFACE_API int dfv_getPdfImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01065 01066 /** 01067 * Effective when outputting to PDF. 01068 * Set resolution of the color image which performs a downsampling. 01069 * 01070 * 01071 * @param pDfvObj Pointer to DfvObj instance. 01072 * @param newVal the value of resolution. 01073 */ 01074 DFVINTERFACE_API void dfv_setPdfImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01075 01076 /** 01077 * Effective when outputting to PDF. 01078 * Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF. 01079 * 01080 * 01081 * 01082 * @param pDfvObj Pointer to DfvObj instance. 01083 * @return If nonezero is specified, it is embedded. If zero is specified, it is not embedded. 01084 */ 01085 DFVINTERFACE_API long dfv_getPdfPutImageColorProfile(CDfvObjPtr pDfvObj); 01086 01087 /** 01088 * Effective when outputting to PDF. 01089 * Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF. 01090 * 01091 * 01092 * @param pDfvObj Pointer to DfvObj instance. 01093 * @param newVal If nonezero is specified, it is embedded. If zero is specified, it is not embedded. 01094 */ 01095 DFVINTERFACE_API void dfv_setPdfPutImageColorProfile(CDfvObjPtr pDfvObj, long newVal); 01096 01097 /** 01098 * Effective when outputting to PDF. 01099 * Gets the value of how to compress the grayscale images embedded in PDF. 01100 * 01101 * 01102 * <table border="0" cellspacing="0" cellpadding="0"> 01103 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 01104 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 01105 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 01106 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 01107 * </table> 01108 * 01109 * @param pDfvObj Pointer to DfvObj instance. 01110 * @return the value of how raster graphics are compressed and stored 01111 */ 01112 DFVINTERFACE_API DfvPDFIMAGECOMPRESSION dfv_getPdfGrayscaleImageCompression(CDfvObjPtr pDfvObj); 01113 01114 /** 01115 * Effective when outputting to PDF. 01116 * 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> 01117 * When IMGCMPR_AUTO is selected, the process is automatically done and creates the image data according to the setting of dfv_setPdfGrayscaleJPEGQuality and dfv_setPdfRasterizeResolution. Whichever has the smaller compressed size, JPEG or ZLIB, is selected. <BR> 01118 This is the setting for the grayscale image. Spesify dfv_setPdfImageCompression for the color image, and dfv_setPdfMonochromeImageCompression for the monochrome image. 01119 * 01120 * 01121 * <table border="0" cellspacing="0" cellpadding="0"> 01122 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 01123 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 01124 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 01125 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 01126 * </table> 01127 * 01128 * @param pDfvObj Pointer to DfvObj instance. 01129 * @param newVal the value of how raster graphics are compressed and stored 01130 */ 01131 DFVINTERFACE_API void dfv_setPdfGrayscaleImageCompression(CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal); 01132 01133 /** 01134 * Effective when outputting to PDF. 01135 * Gets the value of the quality of JPEG format that is specified by dfv_setPdfGrayscaleImageCompression stored in PDF. 01136 * 01137 * 01138 * @param pDfvObj Pointer to DfvObj instance. 01139 * @return the value of the quality of JPEG format 01140 */ 01141 DFVINTERFACE_API int dfv_getPdfGrayscaleJPEGQuality(CDfvObjPtr pDfvObj); 01142 01143 /** 01144 * Effective when outputting to PDF. 01145 * 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 dfv_setPdfGrayscaleImageCompression. The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger.<BR> 01146 * CAUTION: It is not for changing the quality of a JPEG format image.<BR> 01147 * This is the setting for the grayscale image. Spesify dfv_setPdfJPEGQuality for the color image. 01148 * 01149 * 01150 * @param pDfvObj Pointer to DfvObj instance. 01151 * @param newVal the value of the quality of JPEG format 01152 */ 01153 DFVINTERFACE_API void dfv_setPdfGrayscaleJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 01154 01155 /** 01156 * Effective when outputting to PDF. 01157 * Gets the value of method to downsample the grayscale image 01158 * 01159 * 01160 * @param pDfvObj Pointer to DfvObj instance. 01161 * @return the value of method to downsample the grayscale image 01162 */ 01163 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfGrayscaleImageDownSampling(CDfvObjPtr pDfvObj); 01164 01165 /** 01166 * Effective when outputting to PDF. 01167 * 01168 * 01169 * @param pDfvObj Pointer to DfvObj instance. 01170 * @param newVal 01171 */ 01172 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01173 01174 /** 01175 * Effective when outputting to PDF. 01176 * Gets resolution when the grayscale image is downsampled. 01177 * 01178 * 01179 * @param pDfvObj Pointer to DfvObj instance. 01180 * @return the value of resolution. 01181 */ 01182 DFVINTERFACE_API int dfv_getPdfGrayscaleImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01183 01184 /** 01185 * Effective when outputting to PDF. 01186 * Specifies the following either of method to downsample the grayscale image that is put into PDF. 01187 * 01188 * 01189 * <table border="0" cellspacing="0" cellpadding="0"> 01190 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01191 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01192 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01193 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01194 * </table> 01195 * 01196 * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by dfv_setPdfGrayscaleImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfGrayscaleImageDownSamplingTarget. 01197 This is the setting for the grayscale image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image. 01198 * 01199 * @param pDfvObj Pointer to DfvObj instance. 01200 * @param newVal the value of method to downsample the grayscale image 01201 */ 01202 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01203 01204 /** 01205 * Effective when outputting to PDF. 01206 * Gets resolution of the grayscale image which performs a downsampling. 01207 * 01208 * 01209 * @param pDfvObj Pointer to DfvObj instance. 01210 * @return the value of resolution. 01211 */ 01212 DFVINTERFACE_API int dfv_getPdfGrayscaleImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01213 01214 /** 01215 * Effective when outputting to PDF. 01216 * Set resolution of the grayscale image which performs a downsampling. 01217 * 01218 * 01219 * @param pDfvObj Pointer to DfvObj instance. 01220 * @param newVal the value of resolution. 01221 */ 01222 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01223 01224 /** 01225 * Effective when outputting to PDF. 01226 * Gets the value of how to compress the monochrome images embedded in PDF. 01227 * 01228 * 01229 * <table border="0" cellspacing="0" cellpadding="0"> 01230 * <tr><td>MONOCMPR_CCITT4 </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr> 01231 * <tr><td>MONOCMPR_CCITT3 </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr> 01232 * <tr><td>MONOCMPR_RUNLENGTH </td><td>= 2 RunLengthDecode filter</td></tr> 01233 * <tr><td>MONOCMPR_ZLIB </td><td>= 3 FlateDecode filter</td></tr> 01234 * <tr><td>MONOCMPR_OFF </td><td>= 4 no filter</td></tr> 01235 * </table> 01236 * 01237 * @param pDfvObj Pointer to DfvObj instance. 01238 * @return the value of how raster graphics are compressed and stored 01239 */ 01240 DFVINTERFACE_API DfvMONOCHROMECOMPRESSION dfv_getPdfMonochromeImageCompression(CDfvObjPtr pDfvObj); 01241 01242 /** 01243 * Effective when outputting to PDF. 01244 * 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> 01245 This is the setting for the monochrome image. Spesify dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfImageCompression for the color image. 01246 * 01247 * 01248 * <table border="0" cellspacing="0" cellpadding="0"> 01249 * <tr><td>MONOCMPR_CCITT4 </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr> 01250 * <tr><td>MONOCMPR_CCITT3 </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr> 01251 * <tr><td>MONOCMPR_RUNLENGTH </td><td>= 2 RunLengthDecode filter</td></tr> 01252 * <tr><td>MONOCMPR_ZLIB </td><td>= 3 FlateDecode filter</td></tr> 01253 * <tr><td>MONOCMPR_OFF </td><td>= 4 no filter</td></tr> 01254 * </table> 01255 * 01256 * @param pDfvObj Pointer to DfvObj instance. 01257 * @param newVal the value of how raster graphics are compressed and stored 01258 */ 01259 DFVINTERFACE_API void dfv_setPdfMonochromeImageCompression(CDfvObjPtr pDfvObj, DfvMONOCHROMECOMPRESSION newVal); 01260 01261 /** 01262 * Effective when outputting to PDF. 01263 * Gets the value of method to downsample the monochrome image 01264 * 01265 * 01266 * @param pDfvObj Pointer to DfvObj instance. 01267 * @return the value of method to downsample the monochrome image 01268 */ 01269 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfMonochromeImageDownSampling(CDfvObjPtr pDfvObj); 01270 01271 /** 01272 * Effective when outputting to PDF. 01273 * Specifies the following either of method to downsample the monochrome image that is put into PDF. 01274 * 01275 * 01276 * <table border="0" cellspacing="0" cellpadding="0"> 01277 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01278 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01279 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01280 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01281 * </table> 01282 * 01283 * When the value except IMGDOWNSAMPLING_NONE is specified, the image that has the resolution larger than the one specified by dfv_setPdfMonochromeImageDownSamplingDPI will be downsampled into the resolution specified by dfv_setPdfMonochromeImageDownSamplingTarget. 01284 This is the setting for the monochrome image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfGrayscaleImageDownSampling for the grayscale image. 01285 * 01286 * @param pDfvObj Pointer to DfvObj instance. 01287 * @param newVal the value of method to downsample the monochrome image 01288 */ 01289 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01290 01291 /** 01292 * Effective when outputting to PDF. 01293 * Gets resolution when the monochrome image is downsampled. 01294 * 01295 * 01296 * @param pDfvObj Pointer to DfvObj instance. 01297 * @return the value of resolution. 01298 */ 01299 DFVINTERFACE_API int dfv_getPdfMonochromeImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01300 01301 /** 01302 * Effective when outputting to PDF. 01303 * Set resolution when the monochrome image is downsampled. 01304 * 01305 * 01306 * @param pDfvObj Pointer to DfvObj instance. 01307 * @param newVal the value of resolution. 01308 */ 01309 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01310 01311 /** 01312 * Effective when outputting to PDF. 01313 * Gets resolution of the monochrome image which performs a downsampling. 01314 * 01315 * 01316 * @param pDfvObj Pointer to DfvObj instance. 01317 * @return the value of resolution. 01318 */ 01319 DFVINTERFACE_API int dfv_getPdfMonochromeImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01320 01321 /** 01322 * Effective when outputting to PDF. 01323 * Set resolution of the monochrome image which performs a downsampling. 01324 * 01325 * 01326 * @param pDfvObj Pointer to DfvObj instance. 01327 * @param newVal the value of resolution. 01328 */ 01329 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01330 01331 /** 01332 * Effective when outputting to PDF. 01333 * Gets the width of PDF to output. 01334 * 01335 * 01336 * @param pDfvObj Pointer to DfvObj instance. 01337 * @param pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, 01338 * the string is truncated and terminated with a NULL character. 01339 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01340 * @return Returns the 'pVal'. 01341 */ 01342 DFVINTERFACE_API char* dfv_getPdfOutputWidth(CDfvObjPtr pDfvObj, char* pVal, int size); 01343 01344 /** 01345 * Effective when outputting to PDF. 01346 * Gets the width of PDF to output. 01347 * 01348 * 01349 * @param pDfvObj Pointer to DfvObj instance. 01350 * @param pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, 01351 * the string is truncated and terminated with a NULL character. 01352 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01353 * @return Returns the 'pVal'. 01354 */ 01355 DFVINTERFACE_API wchar_t* dfv_getPdfOutputWidthW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01356 01357 /** 01358 * Effective when outputting to PDF. 01359 * Scales the width of PDF to output. A value with a unit or % value can be specified as length. 01360 * 01361 * 01362 * @param pDfvObj Pointer to DfvObj instance. 01363 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01364 */ 01365 DFVINTERFACE_API void dfv_setPdfOutputWidth(CDfvObjPtr pDfvObj, const char* newVal); 01366 01367 /** 01368 * Effective when outputting to PDF. 01369 * Scales the width of PDF to output. A value with a unit or % value can be specified as length. 01370 * 01371 * 01372 * @param pDfvObj Pointer to DfvObj instance. 01373 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01374 */ 01375 DFVINTERFACE_API void dfv_setPdfOutputWidthW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01376 01377 /** 01378 * Effective when outputting to PDF. 01379 * Gets the height of PDF to output. 01380 * 01381 * 01382 * @param pDfvObj Pointer to DfvObj instance. 01383 * @param pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, 01384 * the string is truncated and terminated with a NULL character. 01385 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01386 * @return Returns the 'pVal'. 01387 */ 01388 DFVINTERFACE_API char* dfv_getPdfOutputHeight(CDfvObjPtr pDfvObj, char* pVal, int size); 01389 01390 /** 01391 * Effective when outputting to PDF. 01392 * Gets the height of PDF to output. 01393 * 01394 * 01395 * @param pDfvObj Pointer to DfvObj instance. 01396 * @param pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, 01397 * the string is truncated and terminated with a NULL character. 01398 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01399 * @return Returns the 'pVal'. 01400 */ 01401 DFVINTERFACE_API wchar_t* dfv_getPdfOutputHeightW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01402 01403 /** 01404 * Effective when outputting to PDF. 01405 * Scales the height of PDF to output. A value with a unit or % value can be specified as length. 01406 * 01407 * 01408 * @param pDfvObj Pointer to DfvObj instance. 01409 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01410 */ 01411 DFVINTERFACE_API void dfv_setPdfOutputHeight(CDfvObjPtr pDfvObj, const char* newVal); 01412 01413 /** 01414 * Effective when outputting to PDF. 01415 * Scales the height of PDF to output. A value with a unit or % value can be specified as length. 01416 * 01417 * 01418 * @param pDfvObj Pointer to DfvObj instance. 01419 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01420 */ 01421 DFVINTERFACE_API void dfv_setPdfOutputHeightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01422 01423 /** 01424 * Effective when outputting to PDF. 01425 * Gets the value of whether to issue error or not when PDF/X is generating. 01426 * 01427 * 01428 * @param pDfvObj Pointer to DfvObj instance. 01429 * @return the value of whether to issue error. 01430 */ 01431 DFVINTERFACE_API long dfv_getPdfErrorOnPDFXFault(CDfvObjPtr pDfvObj); 01432 01433 /** 01434 * Effective when outputting to PDF. 01435 * An error is not issued when PDF/X is generating. 01436 * 01437 * 01438 * @param pDfvObj Pointer to DfvObj instance. 01439 * @param newVal If the value is 'true' is specified, no error is issued. 01440 */ 01441 DFVINTERFACE_API void dfv_setPdfErrorOnPDFXFault(CDfvObjPtr pDfvObj, long newVal); 01442 01443 /** 01444 * Effective when outputting to SVG. 01445 * Get the version of SVG. 01446 * 01447 * 01448 * @param pDfvObj Pointer to DfvObj instance. 01449 * @return the version of SVG. 01450 */ 01451 DFVINTERFACE_API DfvSVGVERSION dfv_getSvgVersion(CDfvObjPtr pDfvObj); 01452 01453 /** 01454 * Effective when outputting to SVG. 01455 * Enables specifying whether the version of SVG is 1.1, Basic or Tiny. 01456 * 01457 * 01458 * @param pDfvObj Pointer to DfvObj instance. 01459 * @param newVal Specifies the version of SVG. 01460 */ 01461 DFVINTERFACE_API void dfv_setSvgVersion(CDfvObjPtr pDfvObj, DfvSVGVERSION newVal); 01462 01463 /** 01464 * Effective when outputting to SVG. 01465 * Gets the setting indicating whether to compress the outputted SVG into gzip format or not. 01466 * 01467 * 01468 * @param pDfvObj Pointer to DfvObj instance. 01469 * @return whether gzip compression or not. 01470 */ 01471 DFVINTERFACE_API long dfv_getSvgGzipCompression(CDfvObjPtr pDfvObj); 01472 01473 /** 01474 * Effective when outputting to SVG. 01475 * Specifies whether to compress the outputted SVG into gzip format or not. 01476 * 01477 * 01478 * @param pDfvObj Pointer to DfvObj instance. 01479 * @param newVal If the value is 'true' is specified, enables to compress data into gzip format. 01480 */ 01481 DFVINTERFACE_API void dfv_setSvgGzipCompression(CDfvObjPtr pDfvObj, long newVal); 01482 01483 /** 01484 * Effective when outputting to SVG. 01485 * Gets the setting indicating whether to embed fonts in the outputted SVG. 01486 * 01487 * 01488 * @param pDfvObj Pointer to DfvObj instance. 01489 * @return whether embeds fonts or not. 01490 */ 01491 DFVINTERFACE_API long dfv_getSvgEmbedAllFonts(CDfvObjPtr pDfvObj); 01492 01493 /** 01494 * Effective when outputting to SVG. 01495 * Specifies whether to embed fonts in the outputted SVG. 01496 * 01497 * 01498 * @param pDfvObj Pointer to DfvObj instance. 01499 * @param newVal If the value is 'true' is specified, embeds fonts. 01500 */ 01501 DFVINTERFACE_API void dfv_setSvgEmbedAllFonts(CDfvObjPtr pDfvObj, long newVal); 01502 01503 /** 01504 * Effective when outputting to SVG. 01505 * Gets the format for naming files when the outputted SVG becomes multiple. 01506 * 01507 * 01508 * @param pDfvObj Pointer to DfvObj instance. 01509 * @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. 01510 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01511 * @return Returns the 'pVal'. 01512 */ 01513 DFVINTERFACE_API char* dfv_getSvgFormat(CDfvObjPtr pDfvObj, char* pVal, int size); 01514 01515 /** 01516 * Effective when outputting to SVG. 01517 * Gets the format for naming files when the outputted SVG becomes multiple. 01518 * 01519 * 01520 * @param pDfvObj Pointer to DfvObj instance. 01521 * @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. 01522 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01523 * @return Returns the 'pVal'. 01524 */ 01525 DFVINTERFACE_API wchar_t* dfv_getSvgFormatW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01526 01527 /** 01528 * Effective when outputting to SVG. 01529 * Specifies the format for naming files when the outputted SVG becomes multiple. 01530 * 01531 * 01532 * @param pDfvObj Pointer to DfvObj instance. 01533 * @param newVal Pointer to a null-terminated string to be used as the SVG file name format. 01534 */ 01535 DFVINTERFACE_API void dfv_setSvgFormat(CDfvObjPtr pDfvObj, const char* newVal); 01536 01537 /** 01538 * Effective when outputting to SVG. 01539 * Specifies the format for naming files when the outputted SVG becomes multiple. 01540 * 01541 * 01542 * @param pDfvObj Pointer to DfvObj instance. 01543 * @param newVal Pointer to a null-terminated string to be used as the SVG file name format. 01544 */ 01545 DFVINTERFACE_API void dfv_setSvgFormatW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01546 01547 /** 01548 * Effective when outputting to SVG. 01549 * Gets the font specified to be embedded in SVG. 01550 * 01551 * 01552 * @param pDfvObj Pointer to DfvObj instance. 01553 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 01554 * the string is truncated and terminated with a NULL character. 01555 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01556 * @return Returns the 'pVal'. 01557 */ 01558 DFVINTERFACE_API char* dfv_getSvgEmbedFonts(CDfvObjPtr pDfvObj, char* pVal, int size); 01559 01560 /** 01561 * Effective when outputting to SVG. 01562 * Gets the font specified to be embedded in SVG. 01563 * 01564 * 01565 * @param pDfvObj Pointer to DfvObj instance. 01566 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 01567 * the string is truncated and terminated with a NULL character. 01568 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01569 * @return Returns the 'pVal'. 01570 */ 01571 DFVINTERFACE_API wchar_t* dfv_getSvgEmbedFontsW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01572 01573 /** 01574 * Effective when outputting to SVG. 01575 * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts. 01576 * 01577 * 01578 * @param pDfvObj Pointer to DfvObj instance. 01579 * @param newVal fonts specified to embed 01580 */ 01581 DFVINTERFACE_API void dfv_setSvgEmbedFonts(CDfvObjPtr pDfvObj, const char* newVal); 01582 01583 /** 01584 * Effective when outputting to SVG. 01585 * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts. 01586 * 01587 * 01588 * @param pDfvObj Pointer to DfvObj instance. 01589 * @param newVal fonts specified to embed 01590 */ 01591 DFVINTERFACE_API void dfv_setSvgEmbedFontsW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01592 01593 /** 01594 * Effective when outputting to SVG. 01595 * Gets the value of whether to issues the error when failing to embed fonts. 01596 * 01597 * 01598 * @param pDfvObj Pointer to DfvObj instance. 01599 * @return the value of whether to issues the error 01600 */ 01601 DFVINTERFACE_API long dfv_getSvgErrorOnEmbedFault(CDfvObjPtr pDfvObj); 01602 01603 /** 01604 * Effective when outputting to SVG. 01605 * An error is issued in case of failing to embed fonts. 01606 * 01607 * 01608 * @param pDfvObj Pointer to DfvObj instance. 01609 * @param newVal If the value is 'true' is specified, an error is issued. 01610 */ 01611 DFVINTERFACE_API void dfv_setSvgErrorOnEmbedFault(CDfvObjPtr pDfvObj, long newVal); 01612 01613 /** 01614 * Effective when outputting to SVG. 01615 * Gets the value of how to compress the images embedded in SVG. 01616 * 01617 * 01618 * <table border="0" cellspacing="0" cellpadding="0"> 01619 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto conversion</td></tr> 01620 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG conversion</td></tr> 01621 * <tr><td>IMGCMPR_PNG </td><td>= 2 PNG conversion</td></tr> 01622 * </table> 01623 * 01624 * @param pDfvObj Pointer to DfvObj instance. 01625 * @return the value of how raster graphics are compressed and stored 01626 */ 01627 DFVINTERFACE_API DfvIMAGECONVERSION dfv_getSvgImageConversion(CDfvObjPtr pDfvObj); 01628 01629 /** 01630 * Effective when outputting to SVG. 01631 * Selects how to compress the images embedded in SVG to create from the following. 01632 * 01633 * 01634 * <table border="0" cellspacing="0" cellpadding="0"> 01635 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto conversion</td></tr> 01636 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG conversion</td></tr> 01637 * <tr><td>IMGCMPR_PNG </td><td>= 2 PNG conversion</td></tr> 01638 * </table> 01639 * 01640 * @param pDfvObj Pointer to DfvObj instance. 01641 * @param newVal the value of how raster graphics are compressed and stored 01642 */ 01643 DFVINTERFACE_API void dfv_setSvgImageConversion(CDfvObjPtr pDfvObj, DfvIMAGECONVERSION newVal); 01644 01645 /** 01646 * Gets the value of the quality of JPEG format that is specified by dfv_setSvgImageConversion() stored in SVG. 01647 * 01648 * 01649 * @param pDfvObj Pointer to DfvObj instance. 01650 * @return the value of the quality 01651 */ 01652 DFVINTERFACE_API int dfv_getSvgJPEGQuality(CDfvObjPtr pDfvObj); 01653 01654 /** 01655 * Effective when outputting to SVG. 01656 * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100. 01657 * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger. 01658 * The initial value is 80. 01659 * 01660 * 01661 * @param pDfvObj Pointer to DfvObj instance. 01662 * @param newVal JPEG quality (1 to 100) 01663 */ 01664 DFVINTERFACE_API void dfv_setSvgJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 01665 01666 /** 01667 * Effective when outputting to SVG. 01668 * Gets specification how to treat the referred image. 01669 * 01670 * 01671 * <table border="0" cellspacing="0" cellpadding="0"> 01672 * <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr> 01673 * <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> 01674 * <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> 01675 * <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> 01676 * </table> 01677 * 01678 * @param pDfvObj Pointer to DfvObj instance. 01679 * @return specification how to treat the referred image. 01680 */ 01681 DFVINTERFACE_API DfvIMAGEPROCTYPE dfv_getSvgImageProcessingType(CDfvObjPtr pDfvObj); 01682 01683 /** 01684 * Effective when outputting to SVG. 01685 * Specifies how to treat the referred image. 01686 * 01687 * 01688 * <table border="0" cellspacing="0" cellpadding="0"> 01689 * <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr> 01690 * <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> 01691 * <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> 01692 * <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> 01693 * </table> 01694 * 01695 * @param pDfvObj Pointer to DfvObj instance. 01696 * @param newVal specification how to treat the referred image. 01697 */ 01698 DFVINTERFACE_API void dfv_setSvgImageProcessingType(CDfvObjPtr pDfvObj, DfvIMAGEPROCTYPE newVal); 01699 01700 /** 01701 * Effective when outputting to SVG. 01702 * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01703 * 01704 * 01705 * @param pDfvObj Pointer to DfvObj instance. 01706 * @param pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, 01707 * the string is truncated and terminated with a NULL character. 01708 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01709 * @return Returns the 'pVal'. 01710 */ 01711 DFVINTERFACE_API char* dfv_getSvgImageCopyPath(CDfvObjPtr pDfvObj, char* pVal, int size); 01712 01713 /** 01714 * Effective when outputting to SVG. 01715 * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01716 * 01717 * 01718 * @param pDfvObj Pointer to DfvObj instance. 01719 * @param newVal Pointer to a null-terminated string to be used as image copy path 01720 */ 01721 DFVINTERFACE_API void dfv_setSvgImageCopyPath(CDfvObjPtr pDfvObj, const char* newVal); 01722 01723 /** 01724 * Effective when outputting to SVG. 01725 * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01726 * 01727 * 01728 * @param pDfvObj Pointer to DfvObj instance. 01729 * @param pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, 01730 * the string is truncated and terminated with a NULL character. 01731 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01732 * @return Returns the 'pVal'. 01733 */ 01734 DFVINTERFACE_API wchar_t* dfv_getSvgImageCopyPathW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01735 01736 /** 01737 * Effective when outputting to SVG. 01738 * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01739 * 01740 * 01741 * @param pDfvObj Pointer to DfvObj instance. 01742 * @param newVal Pointer to a null-terminated string to be used as image copy path 01743 */ 01744 DFVINTERFACE_API void dfv_setSvgImageCopyPathW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01745 01746 /** 01747 * Effective when outputting to SVG. 01748 * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR> 01749 * 01750 * 01751 * @param pDfvObj Pointer to DfvObj instance. 01752 * @return specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. 01753 */ 01754 DFVINTERFACE_API long dfv_getSvgSingleFile(CDfvObjPtr pDfvObj); 01755 01756 /** 01757 * Effective when outputting to SVG. 01758 * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR> 01759 * 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> 01760 * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc. 01761 * 01762 * 01763 * @param pDfvObj Pointer to DfvObj instance. 01764 * @param newVal specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. 01765 */ 01766 DFVINTERFACE_API void dfv_setSvgSingleFile(CDfvObjPtr pDfvObj, long newVal); 01767 01768 #if !defined(_DOXYGEN) 01769 01770 /** 01771 * Gets the value specified by setSvgSingleFileMaxPages. 01772 * Effective when outputting to SVG. 01773 * 01774 * @param pDfvObj Pointer to DfvObj instance. 01775 * @return the value specified by setSvgSingleFileMaxPages. 01776 */ 01777 DFVINTERFACE_API int dfv_getSvgSingleFileMaxPages(CDfvObjPtr pDfvObj); 01778 01779 /** 01780 * Specifies the maximum number of pages outputted when setSvgSingleFile = True is specified. . 01781 * When this parameter is omitted If this parameter is omitted, "5000" is considered as specified. 01782 * When either setSvgSingleFileMaxPages or setSvgSingleFileMaxHeight is specified, or both are specified, and the page exceeds either the maximum size (setSvgSingleFileMaxHeight) or the maximum number of pages (setSvgSingleFileMaxPages), Server Based Converter V1.2 will stop converting and abort the job as an error. Effective when outputting to SVG. 01783 * 01784 * @param pDfvObj Pointer to DfvObj instance. 01785 * @param newVal maximum number of pages 01786 */ 01787 DFVINTERFACE_API void dfv_setSvgSingleFileMaxPages(CDfvObjPtr pDfvObj, int newVal); 01788 01789 /** 01790 * Gets the value specified by setSvgImageDownsamplingDPI. 01791 * Effective when outputting to SVG. 01792 * 01793 * @param pDfvObj Pointer to DfvObj instance. 01794 * @return the value specified by setSvgImageDownsamplingDPI. 01795 */ 01796 DFVINTERFACE_API int dfv_getSvgImageDownsamplingDPI(CDfvObjPtr pDfvObj); 01797 01798 /** 01799 * Specifies the resolution of the down sampling when embedding an image with 1 or more integers. . 01800 * When the resolution of the original image is lower than specification, it's embedded with the lower resolution. Effective when outputting to SVG. 01801 * 01802 * @param pDfvObj Pointer to DfvObj instance. 01803 * @return newVal the resolution of the down sampling 01804 */ 01805 DFVINTERFACE_API void dfv_setSvgImageDownsamplingDPI(CDfvObjPtr pDfvObj, int dpi); 01806 01807 /** 01808 * Gets the value specified by setSvgImageDownsamplingMethod. 01809 * Effective when outputting to SVG. 01810 * 01811 * @param pDfvObj Pointer to DfvObj instance. 01812 * @return the value specified by setSvgImageDownsamplingMethod 01813 */ 01814 DFVINTERFACE_API int dfv_getSvgImageDownsamplingMethod(CDfvObjPtr pDfvObj); 01815 01816 /** 01817 * Specifies the way of compression when down sampled. 01818 * 01819 * S_SVG_IMGDOWNSAMPLING_AVERAGE : biliner 01820 * S_SVG_IMGDOWNSAMPLING_BICUBIC : bicubic 01821 * S_SVG_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor 01822 * If this parameter is omitted, "IMGDOWNSAMPLING_AVERAGE" is considered as specified. Effective when outputting to SVG. 01823 * 01824 * @param pDfvObj Pointer to DfvObj instance. 01825 * @param type the way of compression when down sampled 01826 */ 01827 DFVINTERFACE_API void dfv_setSvgImageDownsamplingMethod(CDfvObjPtr pDfvObj, int type); 01828 01829 #endif 01830 01831 /** 01832 * Effective when outputting to SVG. 01833 * Gets specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01834 * 01835 * 01836 * @param pDfvObj Pointer to DfvObj instance. 01837 * @return specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01838 */ 01839 DFVINTERFACE_API long dfv_getSvgImageRename(CDfvObjPtr pDfvObj); 01840 01841 /** 01842 * Effective when outputting to SVG. 01843 * When images are copied to the directory specified by dfv_setSvgImageCopyPath etc. and processed, specifies whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. When the file name overlaps, sequential number is added. When true is specified, all files are renamed. 01844 * 01845 * 01846 * 01847 * @param pDfvObj Pointer to DfvObj instance. 01848 * @param newVal specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01849 */ 01850 DFVINTERFACE_API void dfv_setSvgImageRename(CDfvObjPtr pDfvObj, long newVal); 01851 01852 /** 01853 * Effective when outputting to SVG. 01854 * Gets the prefix of the file name when images are copied to the directory specified by dfv_setSvgImageCopyPath and processed. 01855 * 01856 * 01857 * @param pDfvObj Pointer to DfvObj instance. 01858 * @param pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, 01859 * the string is truncated and terminated with a NULL character. 01860 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01861 * @return Returns the 'pVal'. 01862 */ 01863 DFVINTERFACE_API char* dfv_getSvgImagePrefix(CDfvObjPtr pDfvObj, char* pVal, int size); 01864 01865 /** 01866 * Effective when outputting to SVG. 01867 * When images are copied to the directory specified by dfv_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. 01868 * 01869 * 01870 * 01871 * @param pDfvObj Pointer to DfvObj instance. 01872 * @param newVal the prefix of the file name. 01873 */ 01874 DFVINTERFACE_API void dfv_setSvgImagePrefix(CDfvObjPtr pDfvObj, const char* newVal); 01875 01876 /** 01877 * Effective when outputting to SVG. 01878 * Gets the prefix of the file name when images are copied to the directory specified by dfv_setSvgImageCopyPath and processed. 01879 * 01880 * 01881 * @param pDfvObj Pointer to DfvObj instance. 01882 * @param pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, 01883 * the string is truncated and terminated with a NULL character. 01884 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01885 * @return Returns the 'pVal'. 01886 */ 01887 DFVINTERFACE_API wchar_t* dfv_getSvgImagePrefixW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01888 01889 /** 01890 * Effective when outputting to SVG. 01891 * When images are copied to the directory specified by dfv_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. 01892 * 01893 * 01894 * @param pDfvObj Pointer to DfvObj instance. 01895 * @param newVal the prefix of the file name. 01896 */ 01897 DFVINTERFACE_API void dfv_setSvgImagePrefixW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01898 01899 /** 01900 * Effective when outputting to SVG. 01901 * Gets specification whether to add sequential number to the output SVG even if it has only one-page. 01902 * 01903 * 01904 * @param pDfvObj Pointer to DfvObj instance. 01905 * @return specification whether to add sequential number to the output SVG even if it has only one-page. 01906 */ 01907 DFVINTERFACE_API long dfv_getSvgSinglePageNumber(CDfvObjPtr pDfvObj); 01908 01909 /** 01910 * Effective when outputting to SVG. 01911 * When dfv_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. 01912 * 01913 * 01914 * @param pDfvObj Pointer to DfvObj instance. 01915 * @param newVal specification whether to add sequential number to the output SVG even if it has only one-page. 01916 */ 01917 DFVINTERFACE_API void dfv_setSvgSinglePageNumber(CDfvObjPtr pDfvObj, long newVal); 01918 01919 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 01920 /** 01921 * Effective when outputting to SVG. 01922 * Gets the value of the rasterised-resolution of the transformed raster images. 01923 * 01924 * 01925 * @param pDfvObj Pointer to DfvObj instance. 01926 * @return Rasterised-resolution 01927 */ 01928 DFVINTERFACE_API int dfv_getSvgRasterizeResolution(CDfvObjPtr pDfvObj); 01929 01930 /** 01931 * Effective when outputting to SVG. 01932 * 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. 01933 * This setting is effective only with Windows version. 01934 * 01935 * 01936 * @param pDfvObj Pointer to DfvObj instance. 01937 * @param newVal Rasterised-resolution (70 to 500) 01938 */ 01939 DFVINTERFACE_API void dfv_setSvgRasterizeResolution(CDfvObjPtr pDfvObj, int newVal); 01940 #endif 01941 01942 /** 01943 * Specifies multiple volume of PDF output. 01944 * 01945 * 01946 * @param pDfvObj Pointer to DfvObj instance. 01947 * @param newVal Zpecifies zero or nonzero. 01948 */ 01949 DFVINTERFACE_API void dfv_setMultiVolume(CDfvObjPtr pDfvObj, long newVal); 01950 01951 /** 01952 * Get the error level to abort formatting process. 01953 * 01954 * @param pDfvObj Pointer to DfvObj instance. 01955 * @return Returns the error level. 01956 */ 01957 DFVINTERFACE_API DfvIfErrorLevel dfv_getExitLevel(CDfvObjPtr pDfvObj); 01958 01959 /** 01960 * Error level to abort formatting process. Server Based Converter will stop formatting when the detected 01961 * error level is equal to ExitLevel property or higher. The default value is 2 (Warning). 01962 * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be 01963 * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered 01964 * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be 01965 * aborted unconditionally. 01966 * BTW : An error is not displayed no matter what value may be specified to be this property. 01967 * 01968 * <table border="0" cellspacing="0" cellpadding="0"> 01969 * <tr><td>ELVL_INFORMATION </td><td>= 1 Information</td></tr> 01970 * <tr><td>ELVL_WARNING </td><td>= 2 Warning</td></tr> 01971 * <tr><td>ELVL_RECOVERABLE </td><td>= 3 Recoveable Error</td></tr> 01972 * <tr><td>ELVL_FATAL </td><td>= 4 Fatal Error</td></tr> 01973 * </table> 01974 * 01975 * @param pDfvObj Pointer to DfvObj instance. 01976 * @param newVal error level to abort formatting process. 01977 */ 01978 DFVINTERFACE_API void dfv_setExitLevel(CDfvObjPtr pDfvObj, DfvIfErrorLevel newVal); 01979 01980 /** 01981 * Returns the error level of the error that occurred during the formatting process. 01982 * 01983 * <table border="0" cellspacing="0" cellpadding="0"> 01984 * <tr><td>ELVL_INFORMATION </td><td>= 1 Information</td></tr> 01985 * <tr><td>ELVL_WARNING </td><td>= 2 Warning</td></tr> 01986 * <tr><td>ELVL_RECOVERABLE </td><td>= 3 Recoveable Error</td></tr> 01987 * <tr><td>ELVL_FATAL </td><td>= 4 Fatal Error</td></tr> 01988 * </table> 01989 * 01990 * @param pDfvObj Pointer to DfvObj instance. 01991 * @return Returns the error level. 01992 */ 01993 DFVINTERFACE_API DfvIfErrorLevel dfv_getErrorLevel(CDfvObjPtr pDfvObj); 01994 01995 /** 01996 * Returns the error code of the error that occurred during the formatting process. 01997 * Zero means no error. Non-zero indicates any error occurred. 01998 * 01999 * @param pDfvObj Pointer to DfvObj instance. 02000 * @return Returns the error code. 02001 */ 02002 DFVINTERFACE_API DfvIfErrorCode dfv_getErrorCode(CDfvObjPtr pDfvObj); 02003 02004 /** 02005 * Returns the error message of the error that occurred during the formatting process. 02006 * 02007 * @param pDfvObj Pointer to DfvObj instance. 02008 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02009 * the string is truncated and terminated with a NULL character. 02010 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02011 * @return Returns the 'pVal'. 02012 */ 02013 DFVINTERFACE_API char* dfv_getErrorMessage(CDfvObjPtr pDfvObj, char* pVal, int size); 02014 /** 02015 * Returns the error message of the error that occurred during the formatting process. 02016 * 02017 * @param pDfvObj Pointer to DfvObj instance. 02018 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02019 * the string is truncated and terminated with a NULL character. 02020 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02021 * @return Returns the 'pVal'. 02022 */ 02023 DFVINTERFACE_API wchar_t* dfv_getErrorMessageW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02024 02025 /** 02026 * Sets the substitution of font name. This substitution acts on the font names existing in FO. 02027 * The font name 'fontName' is replaced to 'aliasName'. 02028 * 02029 * @param pDfvObj Pointer to DfvObj instance. 02030 * @param src Specifies the font name which is replaced. 02031 * @param dst Specifies the aliasName. 02032 */ 02033 DFVINTERFACE_API void dfv_setFontAlias(CDfvObjPtr pDfvObj, const char* src, const char* dst); 02034 /** 02035 * Sets the substitution of font name. This substitution acts on the font names existing in FO. 02036 * The font name 'fontName' is replaced to 'aliasName'. 02037 * 02038 * @param pDfvObj Pointer to DfvObj instance. 02039 * @param src Specifies the font name which is replaced. 02040 * @param dst Specifies the aliasName. 02041 */ 02042 DFVINTERFACE_API void dfv_setFontAliasW(CDfvObjPtr pDfvObj, const wchar_t* src, const wchar_t* dst); 02043 02044 /** 02045 * Clear all substitutions of font name. 02046 * 02047 * @param pDfvObj Pointer to DfvObj instance. 02048 */ 02049 DFVINTERFACE_API void dfv_clearFontAlias(CDfvObjPtr pDfvObj); 02050 /** 02051 * Clear all substitutions of font name. 02052 * 02053 * @param pDfvObj Pointer to DfvObj instance. 02054 */ 02055 02056 /** 02057 * Erase the substitution of font name 'fontName'. 02058 * 02059 * @param pDfvObj Pointer to DfvObj instance. 02060 * @param src Specifies the font name which is replaced. 02061 */ 02062 DFVINTERFACE_API void dfv_eraseFontAlias(CDfvObjPtr pDfvObj, const char* src); 02063 DFVINTERFACE_API void dfv_eraseFontAliasW(CDfvObjPtr pDfvObj, const wchar_t* src); 02064 02065 /** 02066 * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName. 02067 * 02068 * @param pDfvObj Pointer to DfvObj instance. 02069 * @return Returns the error code. Zero means no error. Non-zero indicates any error occurred. 02070 */ 02071 DFVINTERFACE_API DfvIfErrorCode dfv_execute(CDfvObjPtr pDfvObj); 02072 02073 /** 02074 * Initialize formatting engine. 02075 * 02076 * @param pDfvObj Pointer to DfvObj instance. 02077 */ 02078 DFVINTERFACE_API void dfv_clear(CDfvObjPtr pDfvObj); 02079 02080 /** 02081 * Specifies the callback fucntion. 02082 * The error that occurred during the formatting process can be received. 02083 * 02084 * @param pDfvObj Pointer to DfvObj instance. 02085 * @param proc Address of the callback function. 02086 * <br>Callback function has the following form:<pre> 02087 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02088 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02089 */ 02090 DFVINTERFACE_API void dfv_setOnMessageProc(CDfvObjPtr pDfvObj, DfvOnMessageProc* proc); 02091 02092 /** 02093 * Specifies the callback fucntion. 02094 * The error that occurred during the formatting process can be received. 02095 * 02096 * @param pDfvObj Pointer to DfvObj instance. 02097 * @param proc Address of the callback function. 02098 * <br>Callback function has the following form:<pre> 02099 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02100 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02101 */ 02102 DFVINTERFACE_API void dfv_setOnMessageProcW(CDfvObjPtr pDfvObj, DfvOnMessageProcW* proc); 02103 02104 /** 02105 * Specifies the callback fucntion. 02106 * The page number in the formatting process can be received. 02107 * 02108 * @param pDfvObj Pointer to DfvObj instance. 02109 * @param proc Address of the callback function. 02110 * <br>Callback function has the following form:<pre> 02111 * void DfvOnFormatPageProc(long pageNo);</pre> 02112 */ 02113 DFVINTERFACE_API void dfv_setOnFormatPageProc(CDfvObjPtr pDfvObj, DfvOnFormatPageProc* proc); 02114 02115 /** 02116 * Specifies the callback fucntion. 02117 * The error that occurred during the formatting process can be received. 02118 * 02119 * @param pDfvObj Pointer to DfvObj instance. 02120 * @param proc Address of the callback function. 02121 * <br>Callback function has the following form:<pre> 02122 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02123 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02124 * @param pAnyObj Address of an any object. 02125 */ 02126 DFVINTERFACE_API void dfv_setOnMessageProcEx(CDfvObjPtr pDfvObj, DfvOnMessageProcEx* proc, void* pAnyObj); 02127 02128 /** 02129 * Specifies the callback fucntion. 02130 * The error that occurred during the formatting process can be received. 02131 * 02132 * @param pDfvObj Pointer to DfvObj instance. 02133 * @param proc Address of the callback function. 02134 * <br>Callback function has the following form:<pre> 02135 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02136 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02137 * @param pAnyObj Address of an any object. 02138 */ 02139 DFVINTERFACE_API void dfv_setOnMessageProcExW(CDfvObjPtr pDfvObj, DfvOnMessageProcExW* proc, void* pAnyObj); 02140 02141 /** 02142 * Specifies the callback fucntion. 02143 * The page number in the formatting process can be received. 02144 * 02145 * @param pDfvObj Pointer to DfvObj instance. 02146 * @param proc Address of the callback function. 02147 * <br>Callback function has the following form:<pre> 02148 * void DfvOnFormatPageProc(long pageNo);</pre> 02149 * @param pAnyObj Address of an any object. 02150 */ 02151 DFVINTERFACE_API void dfv_setOnFormatPageProcEx(CDfvObjPtr pDfvObj, DfvOnFormatPageProcEx* proc, void* pAnyObj); 02152 02153 /* Print Interface */ 02154 /** 02155 * Get the printer name where the formatted result is outputted. 02156 * 02157 * @param pDfvObj Pointer to DfvObj instance. 02158 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02159 * the string is truncated and terminated with a NULL character. 02160 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02161 * @return Returns the 'pVal'. 02162 */ 02163 DFVINTERFACE_API char* dfv_getPrinterName(CDfvObjPtr pDfvObj, char* pVal, int size); 02164 /** 02165 * Get the printer name where the formatted result is outputted. 02166 * 02167 * @param pDfvObj Pointer to DfvObj instance. 02168 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02169 * the string is truncated and terminated with a NULL character. 02170 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02171 * @return Returns the 'pVal'. 02172 */ 02173 DFVINTERFACE_API wchar_t* dfv_getPrinterNameW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02174 02175 /** 02176 * Specifies the output format or the printer name to output. 02177 * When a printer name is specified, the formatted result is outputted to that printer. 02178 * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. 02179 * When "\@PDF" is specified, the formatted result is outputted to PDF. 02180 * When "\@SVG" is specified, the formatted result is outputted to SVG. 02181 * When "\@PS" is specified, the formatted result is outputted to PostScript. 02182 * When "\@INX" is specified, the formatted result is outputted to INX. 02183 * When "\@MIF" is specified, the formatted result is outputted to MIF. 02184 * When "\@TEXT" is specified, the formatted result is outputted to a text format file. 02185 * When "\@AreaTree" is specified, the AreaTree will be outputted. 02186 * When omitted, it is considered as "\@PDF" was specified. 02187 * It's impossible to output to the printer with any OS's other than Windows. 02188 * 02189 * @param pDfvObj Pointer to DfvObj instance. 02190 * @param newVal Pointer to a null-terminated string to be used as the printer name. 02191 */ 02192 DFVINTERFACE_API void dfv_setPrinterName(CDfvObjPtr pDfvObj, const char* newVal); 02193 /** 02194 * Specifies the output format or the printer name to output. 02195 * When a printer name is specified, the formatted result is outputted to that printer. 02196 * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. 02197 * When "\@PDF" is specified, the formatted result is outputted to PDF. 02198 * When "\@SVG" is specified, the formatted result is outputted to SVG. 02199 * When "\@PS" is specified, the formatted result is outputted to PostScript. 02200 * When "\@INX" is specified, the formatted result is outputted to INX. 02201 * When "\@MIF" is specified, the formatted result is outputted to MIF. 02202 * When "\@TEXT" is specified, the formatted result is outputted to a text format file. 02203 * When "\@AreaTree" is specified, the AreaTree will be outputted. 02204 * When omitted, it is considered as "\@PDF" was specified. 02205 * It's impossible to output to the printer with any OS's other than Windows. 02206 * 02207 * @param pDfvObj Pointer to DfvObj instance. 02208 * @param newVal Pointer to a null-terminated string to be used as the printer name. 02209 */ 02210 DFVINTERFACE_API void dfv_setPrinterNameW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02211 02212 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 02213 02214 /** 02215 * Get the number of copies. Effective when outputting to printer. 02216 * 02217 * @param pDfvObj Pointer to DfvObj instance. 02218 * @return Returns the number of copies. 02219 */ 02220 DFVINTERFACE_API long dfv_getPrnCopies(CDfvObjPtr pDfvObj); 02221 02222 /** 02223 * Specifies the number of copies. Effective when outputting to printer. 02224 * If nothing is specified, the value is considered as 1. 02225 * This setting is effective only with Windows version. 02226 * 02227 * @param pDfvObj Pointer to DfvObj instance. 02228 * @param newVal the number of copies. 02229 */ 02230 DFVINTERFACE_API void dfv_setPrnCopies(CDfvObjPtr pDfvObj, long newVal); 02231 02232 /** 02233 * Get collation of multiple copies. 02234 * 02235 * @param pDfvObj Pointer to DfvObj instance. 02236 * @return If zero is returned, the same page is multi-copied continuously. 02237 * If nonezero is returned, the pages specified from start to end are printed repeatedly. 02238 */ 02239 DFVINTERFACE_API long dfv_getPrnCollate(CDfvObjPtr pDfvObj); 02240 02241 /** 02242 * Specifies collation of multiple copies. Effective when outputting to printer and the number of 02243 * copies is plural. If it is not specified or the value zero is specified, the same page is 02244 * multi-copied continuously. 02245 * If nonezero is specified, the pages specified from start to end are printed repeatedly. 02246 * This setting is effective only with Windows version. 02247 * 02248 * @param pDfvObj Pointer to DfvObj instance. 02249 * @param newVal Zpecifies zero or nonzero. 02250 */ 02251 DFVINTERFACE_API void dfv_setPrnCollate(CDfvObjPtr pDfvObj, long newVal); 02252 02253 /** 02254 * Get the setting of whether print dialog box is displayed or not when printing 02255 * 02256 * @param pDfvObj Pointer to DfvObj instance. 02257 * @return If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed. 02258 */ 02259 DFVINTERFACE_API long dfv_getBatchPrint(CDfvObjPtr pDfvObj); 02260 02261 /** 02262 * When the value 'false' is specified, the print dialog box is displayed when printing. 02263 * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed. 02264 * This setting is effective only with Windows version. 02265 * 02266 * @param pDfvObj Pointer to DfvObj instance. 02267 * @param newVal If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed. 02268 */ 02269 DFVINTERFACE_API void dfv_setBatchPrint(CDfvObjPtr pDfvObj, long newVal); 02270 02271 #endif /* _WIN32 */ 02272 02273 /** 02274 * Get the version string of Server Based Converter. 02275 * 02276 * 02277 * @param pDfvObj Pointer to DfvObj instance. 02278 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02279 * the string is truncated and terminated with a NULL character. 02280 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02281 * @return Returns the 'pVal'. 02282 */ 02283 DFVINTERFACE_API char* dfv_getVersion(CDfvObjPtr pDfvObj, char* pVal, int size); 02284 02285 /** 02286 * Get the version string of Server Based Converter. 02287 * 02288 * 02289 * @param pDfvObj Pointer to DfvObj instance. 02290 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02291 * the string is truncated and terminated with a NULL character. 02292 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02293 * @return Returns the 'pVal'. 02294 */ 02295 DFVINTERFACE_API wchar_t* dfv_getVersionW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02296 02297 /** 02298 * Get INX output mode. 02299 * 02300 * @param pDfvObj Pointer to DfvObj instance. 02301 * @return output mode of INX. 02302 */ 02303 DFVINTERFACE_API DfvINXOUTPUTMODE dfv_getInxOutputMode(CDfvObjPtr pDfvObj); 02304 02305 /** 02306 * Set INX output mode. 02307 * 02308 * @param pDfvObj Pointer to DfvObj instance. 02309 * @param newVal mode of INX. 02310 */ 02311 DFVINTERFACE_API void dfv_setInxOutputMode(CDfvObjPtr pDfvObj, DfvINXOUTPUTMODE newVal); 02312 02313 /** 02314 * Get the specification that omit blank pages. return Specification that omit blank pages 02315 */ 02316 DFVINTERFACE_API int dfv_getOmitBlankPages(CDfvObjPtr pDfvObj); 02317 02318 /** 02319 * Disregard any empty pages. 02320 * Effective only when the original file is MS Word or MS Excel. 02321 * Specifies to disregard any empty pages at the beginning of document. 02322 * By using this parameter with setEndPage = 1 parameter, 02323 * it is possible to acquire the output of the first page which has actual contents. 02324 * Other operation is not guaranteed. 02325 * 02326 * @param pDfvObj Pointer to DfvObj instance. 02327 * @param newVal If the value is 'true' is specified, omit blank pages 02328 */ 02329 DFVINTERFACE_API void dfv_setOmitBlankPages(CDfvObjPtr pDfvObj, int newVal); 02330 02331 02332 /** 02333 * Get specifies of the FlashPartiallyOutput. 02334 * @since 2.1 02335 * 02336 * @param pDfvObj Pointer to DfvObj instance. 02337 * @return specifies of FlashPartiallyOutput. 02338 */ 02339 DFVINTERFACE_API long dfv_getFlashPartiallyOutput(CDfvObjPtr pDfvObj); 02340 02341 /** 02342 * When an error occurs within the document, the flash file in process will be outputted. 02343 * Effective when outputting to Flash. 02344 * @since 2.1 02345 * 02346 * @param pDfvObj Pointer to DfvObj instance. 02347 * @param newVal If the value is 'true' is specified, output the flash file. 02348 */ 02349 DFVINTERFACE_API void dfv_setFlashPartiallyOutput(CDfvObjPtr pDfvObj, long newVal); 02350 02351 /** 02352 * Get specifies of the FlashHidePageButton. 02353 * @since 3.0 02354 * 02355 * @param pDfvObj Pointer to DfvObj instance. 02356 * @return specifies of FlashHidePageButton. 02357 */ 02358 DFVINTERFACE_API long dfv_getFlashHidePageButton(CDfvObjPtr pDfvObj); 02359 02360 /** 02361 * Output a no page button. Effective when outputting to Flash. 02362 * @since 3.0 02363 * 02364 * @param pDfvObj Pointer to DfvObj instance. 02365 * @param newVal If the value is 'true' is specified, output a no page button. 02366 */ 02367 DFVINTERFACE_API void dfv_setFlashHidePageButton(CDfvObjPtr pDfvObj, long newVal); 02368 02369 /** 02370 * Get the setting of the FlashSplitPage. 02371 * 02372 * @param pDfvObj Pointer to DfvObj instance. 02373 * @return 02374 * Specify FlashSplitPage. 02375 */ 02376 DFVINTERFACE_API long dfv_getFlashSplitPage(CDfvObjPtr pDfvObj); 02377 02378 /** 02379 * Outputs Flash file per page and saves as every single file..<BR> 02380 * Effective when outputting to Flash. 02381 * 02382 * @param pDfvObj Pointer to DfvObj instance. 02383 * @param newVal 02384 * If 'true' is specified, do not output Flash file per page. 02385 */ 02386 DFVINTERFACE_API void dfv_setFlashSplitPage(CDfvObjPtr pDfvObj, long newVal); 02387 02388 /** 02389 * Get the setting of FlashOutputAction. 02390 * 02391 * @param pDfvObj Pointer to DfvObj instance. 02392 * @return 02393 * Specify FlashOutputAction. 02394 */ 02395 DFVINTERFACE_API long dfv_getFlashOutputAction(CDfvObjPtr pDfvObj); 02396 02397 /** 02398 * Do not output features of ActionScript1.0, such as stop action per page, the page navigation button, linking, etc..<BR> 02399 * Effective when outputting to Flash. 02400 * 02401 * @param pDfvObj Pointer to DfvObj instance. 02402 * @param newVal 02403 * If 'true' is specified, do not output Flash file per page. 02404 */ 02405 DFVINTERFACE_API void dfv_setFlashOutputAction(CDfvObjPtr pDfvObj, long newVal); 02406 02407 /** 02408 * Get the setting of FlashImageLimitSize. 02409 * 02410 * @param pDfvObj Pointer to DfvObj instance. 02411 * @return 02412 * Specify FlashImageLimitSize. 02413 */ 02414 DFVINTERFACE_API int dfv_getFlashImageLimitSize(CDfvObjPtr pDfvObj); 02415 02416 /** 02417 * Specifies the number of maximum pixels of images outputted to the Flash file by the integral value. 02418 * When the width or the height of the output image exceeds the specified value, 02419 * it is reduced to the specified value when outputting the flash file. 02420 * When this parameter is omitted, 1000 is applied. <BR> 02421 * The image size that can be embedded in Flash is limited to the value of width x height with 2 raised to the 24th power (16,777,216) 02422 * by the number of pixels. Please note that when embedded image exceeds this size, 02423 * it may not be displayed with Flash Player.<BR> 02424 * Effective when outputting to Flash. 02425 * 02426 * @param pDfvObj Pointer to DfvObj instance. 02427 * @param newVal 02428 * If 'true' is specified, do not output Flash file per page. 02429 */ 02430 DFVINTERFACE_API void dfv_setFlashImageLimitSize(CDfvObjPtr pDfvObj, int newVal); 02431 02432 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 02433 02434 /** 02435 * It print at size of paper. 02436 * Default is false. 02437 * Effective when outputting to printer, and only Windows version. 02438 * 02439 * @param pDfvObj Pointer to DfvObj instance. 02440 * @param newVal If the value is 'true' is specified, print at size of paper. 02441 */ 02442 DFVINTERFACE_API void dfv_setPrnFitPaper(CDfvObjPtr pDfvObj, int newVal); 02443 02444 /** 02445 * Specifies the scaling ratio of the PDF to output. 02446 * A value with a unit or % value can be specified as length. 02447 * Effective when outputting to PDF. 02448 * 02449 * @param pDfvObj Pointer to DfvObj instance. 02450 * @param newVal the scaling ratio of the PDF 02451 */ 02452 DFVINTERFACE_API void dfv_setPdfOutputScale(CDfvObjPtr pDfvObj, const char* newVal); 02453 02454 /** 02455 * Specifies the scaling ratio of the PDF to output. 02456 * A value with a unit or % value can be specified as length. 02457 * Effective when outputting to PDF. 02458 * 02459 * @param pDfvObj Pointer to DfvObj instance. 02460 * @param newVal the scaling ratio of the PDF 02461 */ 02462 DFVINTERFACE_API void dfv_setPdfOutputScaleW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02463 02464 /** 02465 * Get the image resolution when outputting JPEG and PNG. 02466 * This setting is effective only with Windows version. 02467 * Effective when outputting to image, and only Windows version. 02468 * 02469 * @param pDfvObj Pointer to DfvObj instance. 02470 * @return Image resolution 02471 */ 02472 DFVINTERFACE_API int dfv_getRasterDPI(CDfvObjPtr pDfvObj); 02473 02474 /** 02475 * Effective when outputting to image, and only Windows version. 02476 * 02477 * @param pDfvObj Pointer to DfvObj instance. 02478 * @param newVal Image resolution (50 to 500) 02479 */ 02480 DFVINTERFACE_API void dfv_setRasterDPI(CDfvObjPtr pDfvObj, int newVal); 02481 02482 /** 02483 * Get the image scale when outputting JPEG and PNG. 02484 * Effective when outputting to image, and only Windows version. 02485 * 02486 * @param pDfvObj Pointer to DfvObj instance. 02487 * @param pVal 02488 * Pointer to the buffer that will receive the text. 02489 * If the string is as long or longer than the buffer, 02490 * the string is truncated and terminated with a NULL character. 02491 * @param size 02492 * Specifies the number of the 'pVal' buffer, including the NULL character. 02493 * If the text exceeds this limit, it is truncated. 02494 * @return Returns the 'pVal'. 02495 */ 02496 DFVINTERFACE_API char* dfv_getRasterScale(CDfvObjPtr pDfvObj, char* pVal, int size); 02497 02498 /** 02499 * Get the image scale when outputting JPEG and PNG. 02500 * Effective when outputting to image, and only Windows version. 02501 * 02502 * @param pDfvObj Pointer to DfvObj instance. 02503 * @param pVal 02504 * Pointer to the buffer that will receive the text. 02505 * If the string is as long or longer than the buffer, 02506 * the string is truncated and terminated with a NULL character. 02507 * @param size 02508 * Specifies the number of the 'pVal' buffer, including the NULL character. 02509 * If the text exceeds this limit, it is truncated. 02510 * @return Returns the 'pVal'. 02511 */ 02512 DFVINTERFACE_API wchar_t* dfv_getRasterScaleW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02513 02514 /** 02515 * Sets the image scale when outputting JPEG and PNG. 02516 * A numerical value, "%", or "px" (pixel) is available as the unit. 02517 * Specify the percentage for a numerical value and "%", and specify the width of image for pixel. 02518 * Effective when outputting to image, and only Windows version. 02519 * 02520 * @param pDfvObj Pointer to DfvObj instance. 02521 * @param newVal Image scale 02522 */ 02523 DFVINTERFACE_API void dfv_setRasterScale(CDfvObjPtr pDfvObj, const char* newVal); 02524 02525 /** 02526 * Sets the image scale when outputting JPEG and PNG. 02527 * A numerical value, "%", or "px" (pixel) is available as the unit. 02528 * Specify the percentage for a numerical value and "%", and specify the width of image for pixel. 02529 * Effective when outputting to image, and only Windows version. 02530 * 02531 * @param pDfvObj Pointer to DfvObj instance. 02532 * @param newVal Image scale 02533 */ 02534 DFVINTERFACE_API void dfv_setRasterScaleW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02535 02536 /** 02537 * Get the maximum image height when outputting JPEG and PNG.<BR> 02538 * Effective when outputting to image, and only Windows version. 02539 * 02540 * @param pDfvObj Pointer to DfvObj instance. 02541 * @return Maximum image height 02542 */ 02543 DFVINTERFACE_API int dfv_getRasterHeight(CDfvObjPtr pDfvObj); 02544 02545 /** 02546 * Sets the maximum image height decided by setRasterScale when outputting JPEG and PNG.<BR> 02547 * "px" (pixel) is available as the unit. 02548 * Effective when outputting to image, and only Windows version. 02549 * 02550 * @param pDfvObj Pointer to DfvObj instance. 02551 * @param newVal Maximum image height 02552 */ 02553 DFVINTERFACE_API void dfv_setRasterHeight(CDfvObjPtr pDfvObj, int newVal); 02554 02555 /** 02556 * Get the file name naming format when outputting PNG and JPEG.<BR> 02557 * Effective when outputting to image, and only Windows version. 02558 * 02559 * @param pDfvObj Pointer to DfvObj instance. 02560 * @param pVal 02561 * Pointer to the buffer that will receive the text. 02562 * If the string is as long or longer than the buffer, 02563 * the string is truncated and terminated with a NULL character. 02564 * @param size 02565 * Specifies the number of the 'pVal' buffer, including the NULL character. 02566 * If the text exceeds this limit, it is truncated. 02567 * @return Returns the 'pVal'. 02568 */ 02569 DFVINTERFACE_API char* dfv_getRasterFormat(CDfvObjPtr pDfvObj, char* pVal, int size); 02570 02571 /** 02572 * Get the file name naming format when outputting PNG and JPEG.<BR> 02573 * Effective when outputting to image, and only Windows version. 02574 * 02575 * @param pDfvObj Pointer to DfvObj instance. 02576 * @param pVal 02577 * Pointer to the buffer that will receive the text. 02578 * If the string is as long or longer than the buffer, 02579 * the string is truncated and terminated with a NULL character. 02580 * @param size 02581 * Specifies the number of the 'pVal' buffer, including the NULL character. 02582 * If the text exceeds this limit, it is truncated. 02583 * @return Returns the 'pVal'. 02584 */ 02585 DFVINTERFACE_API wchar_t* dfv_getRasterFormatW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02586 02587 /** 02588 * Specifies the file name naming format when outputting PNG and JPEG.<BR> 02589 * Effective when outputting to image, and only Windows version. 02590 * 02591 * @param pDfvObj Pointer to DfvObj instance. 02592 * @param newVal format for naming files 02593 */ 02594 DFVINTERFACE_API void dfv_setRasterFormat(CDfvObjPtr pDfvObj, const char* newVal); 02595 02596 /** 02597 * Specifies the file name naming format when outputting PNG and JPEG.<BR> 02598 * Effective when outputting to image, and only Windows version. 02599 * 02600 * @param pDfvObj Pointer to DfvObj instance. 02601 * @param newVal format for naming files 02602 */ 02603 DFVINTERFACE_API void dfv_setRasterFormatW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02604 02605 /** 02606 * Get the conversion accuracy when outputting JPEG.<BR> 02607 * Effective when outputting to image, and only Windows version. 02608 * 02609 * @param pDfvObj Pointer to DfvObj instance. 02610 * @return JPEG quality 02611 */ 02612 DFVINTERFACE_API int dfv_getRasterJpegQuality(CDfvObjPtr pDfvObj); 02613 02614 /** 02615 * Specifies the conversion accuracy by the value with the range of 1-100(%) when outputting JPEG.<BR> 02616 * When this parameter is omitted, it is regarded as 80%. 02617 * Effective when outputting to image, and only Windows version. 02618 * 02619 * @param pDfvObj Pointer to DfvObj instance. 02620 * @param newVal JPEG quality 02621 */ 02622 DFVINTERFACE_API void dfv_setRasterJpegQuality(CDfvObjPtr pDfvObj, int newVal); 02623 02624 /** 02625 * Gets specification whether to use GdiPlus .<BR> 02626 * Effective when outputting to image, and only Windows version. 02627 * 02628 * @param pDfvObj Pointer to DfvObj instance. 02629 * return Specification whether to use GdiPlus. 02630 */ 02631 DFVINTERFACE_API long dfv_getRasterUseGdiPlus(CDfvObjPtr pDfvObj); 02632 02633 /** 02634 * GdiPlus is used when the file is converted to Jpeg or PNG.<BR> 02635 * This setting is effective only with Windows XP or later / Windows Server2003. 02636 * Effective when outputting to image, and only Windows version. 02637 * 02638 * @param pDfvObj Pointer to DfvObj instance. 02639 * @param newVal Specifies whether to use GdiPlus. 02640 */ 02641 DFVINTERFACE_API void dfv_setRasterUseGdiPlus(CDfvObjPtr pDfvObj, long newVal); 02642 02643 /** 02644 * Gets specification whether to convert to monochrome image, when outputting JPEG and PNG.<BR> 02645 * Effective when outputting to image, and only Windows version. 02646 * 02647 * @param pDfvObj Pointer to DfvObj instance. 02648 * return Specification whether to convert to monochrome. 02649 */ 02650 DFVINTERFACE_API long dfv_getRasterMonochrome(CDfvObjPtr pDfvObj); 02651 02652 /** 02653 * Specifies whether to convert to monochrome image, when outputting JPEG and PNG.<BR> 02654 * Effective when outputting to image, and only Windows version. 02655 * 02656 * @param pDfvObj Pointer to DfvObj instance. 02657 * @param newVal Specifies whether to convert to monochrome. 02658 */ 02659 DFVINTERFACE_API void dfv_setRasterMonochrome(CDfvObjPtr pDfvObj, long newVal); 02660 02661 /** 02662 * @deprecated 02663 * Get the path name of the RGB profile file. 02664 * 02665 * @param pDfvObj Pointer to DfvObj instance. 02666 * @param pVal 02667 * Pointer to the buffer that will receive the text. 02668 * If the string is as long or longer than the buffer, 02669 * the string is truncated and terminated with a NULL character. 02670 * @param size 02671 * Specifies the number of the 'pVal' buffer, including the NULL character. 02672 * If the text exceeds this limit, it is truncated. 02673 * @return Returns the 'pVal'. 02674 */ 02675 DFVINTERFACE_API char* dfv_getRasterRGBProfile(CDfvObjPtr pDfvObj, char* pVal, int size); 02676 02677 /** 02678 * @deprecated 02679 * Get the path name of the RGB profile file. 02680 * 02681 * @param pDfvObj Pointer to DfvObj instance. 02682 * @param pVal 02683 * Pointer to the buffer that will receive the text. 02684 * If the string is as long or longer than the buffer, 02685 * the string is truncated and terminated with a NULL character. 02686 * @param size 02687 * Specifies the number of the 'pVal' buffer, including the NULL character. 02688 * If the text exceeds this limit, it is truncated. 02689 * @return Returns the 'pVal'. 02690 */ 02691 DFVINTERFACE_API wchar_t* dfv_getRasterRGBProfileW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02692 02693 /** 02694 * @deprecated 02695 * Set the path name of the RGB profile file. 02696 * 02697 * @param pDfvObj Pointer to DfvObj instance. 02698 * @param newVal Pointer to a null-terminated string. 02699 */ 02700 DFVINTERFACE_API void dfv_setRasterRGBProfile(CDfvObjPtr pDfvObj, const char* newVal); 02701 02702 /** 02703 * @deprecated 02704 * Set the path name of the RGB profile file. 02705 * 02706 * @param pDfvObj Pointer to DfvObj instance. 02707 * @param newVal Pointer to a null-terminated string. 02708 */ 02709 DFVINTERFACE_API void dfv_setRasterRGBProfileW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02710 02711 /** 02712 * @deprecated 02713 * Get the path name of the CMYK profile file. 02714 * 02715 * @param pDfvObj Pointer to DfvObj instance. 02716 * @param pVal 02717 * Pointer to the buffer that will receive the text. 02718 * If the string is as long or longer than the buffer, 02719 * the string is truncated and terminated with a NULL character. 02720 * @param size 02721 * Specifies the number of the 'pVal' buffer, including the NULL character. 02722 * If the text exceeds this limit, it is truncated. 02723 * @return Returns the 'pVal'. 02724 */ 02725 DFVINTERFACE_API char* dfv_getRasterCMYKProfile(CDfvObjPtr pDfvObj, char* pVal, int size); 02726 02727 /** 02728 * @deprecated 02729 * Get the path name of the CMYK profile file. 02730 * 02731 * @param pDfvObj Pointer to DfvObj instance. 02732 * @param pVal 02733 * Pointer to the buffer that will receive the text. 02734 * If the string is as long or longer than the buffer, 02735 * the string is truncated and terminated with a NULL character. 02736 * @param size 02737 * Specifies the number of the 'pVal' buffer, including the NULL character. 02738 * If the text exceeds this limit, it is truncated. 02739 * @return Returns the 'pVal'. 02740 */ 02741 DFVINTERFACE_API wchar_t* dfv_getRasterCMYKProfileW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02742 02743 /** 02744 * @deprecated 02745 * Set the path name of the CMYK profile file. 02746 * 02747 * @param pDfvObj Pointer to DfvObj instance. 02748 * @param newVal Pointer to a null-terminated string. 02749 */ 02750 DFVINTERFACE_API void dfv_setRasterCMYKProfile(CDfvObjPtr pDfvObj, const char* newVal); 02751 02752 /** 02753 * @deprecated 02754 * Set the path name of the CMYK profile file. 02755 * 02756 * @param pDfvObj Pointer to DfvObj instance. 02757 * @param newVal Pointer to a null-terminated string. 02758 */ 02759 DFVINTERFACE_API void dfv_setRasterCMYKProfileW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02760 02761 /** 02762 * Get the setting of whether to convert images to grayscale 256 tones. 02763 * 02764 * @param pDfvObj Pointer to DfvObj instance. 02765 * @return 02766 * Specify whether to convert images to grayscale 256 tones. 02767 */ 02768 DFVINTERFACE_API long dfv_getRasterGrayscale(CDfvObjPtr pDfvObj); 02769 02770 /** 02771 * Outputs grayscale 256 tones..<BR> 02772 * Effective when outputting to image, and only Windows version. 02773 * 02774 * @param pDfvObj Pointer to DfvObj instance. 02775 * @param newVal 02776 * If "true" is specified, convert images to grayscale 256 tones. 02777 */ 02778 DFVINTERFACE_API void dfv_setRasterGrayscale(CDfvObjPtr pDfvObj, long newVal); 02779 02780 /** 02781 * Get the setting of whether to convert images to 256 colors. 02782 * 02783 * @param pDfvObj Pointer to DfvObj instance. 02784 * @return 02785 * Specify whether to convert images to 256 colors. 02786 */ 02787 DFVINTERFACE_API long dfv_getRaster256Color(CDfvObjPtr pDfvObj); 02788 02789 /** 02790 * Outputs 256 colors..<BR> 02791 * Effective when outputting to image, and only Windows version. 02792 * 02793 * @param pDfvObj Pointer to DfvObj instance. 02794 * @param newVal 02795 * If "true" is specified, convert images to 256 colors. 02796 */ 02797 DFVINTERFACE_API void dfv_setRaster256Color(CDfvObjPtr pDfvObj, long newVal); 02798 02799 /** 02800 * @deprecated 02801 * Get the compression method when outputting TIFF / MTIFF. 02802 * 02803 * @param pDfvObj Pointer to DfvObj instance. 02804 * @param pVal 02805 * Pointer to the buffer that will receive the text. 02806 * If the string is as long or longer than the buffer, 02807 * the string is truncated and terminated with a NULL character. 02808 * @param size 02809 * Specifies the number of the 'pVal' buffer, including the NULL character. 02810 * If the text exceeds this limit, it is truncated. 02811 * @return Returns the 'pVal'. 02812 */ 02813 DFVINTERFACE_API char* dfv_getRasterCompression(CDfvObjPtr pDfvObj, char* pVal, int size); 02814 02815 /** 02816 * @deprecated 02817 * Get the compression method when outputting TIFF / MTIFF. 02818 * 02819 * @param pDfvObj Pointer to DfvObj instance. 02820 * @param pVal 02821 * Pointer to the buffer that will receive the text. 02822 * If the string is as long or longer than the buffer, 02823 * the string is truncated and terminated with a NULL character. 02824 * @param size 02825 * Specifies the number of the 'pVal' buffer, including the NULL character. 02826 * If the text exceeds this limit, it is truncated. 02827 * @return Returns the 'pVal'. 02828 */ 02829 DFVINTERFACE_API wchar_t* dfv_getRasterCompressionW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02830 02831 /** 02832 * @deprecated 02833 * Specifies the compression method when outputting TIFF / MTIFF.<BR> 02834 * The compression method.<BR> 02835 * none : None<BR> 02836 * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR> 02837 * dct : DCTDecode<BR> 02838 * flate : FlateDecode<BR> 02839 * runlength : Run Length compression<BR> 02840 * ccitt3 : CCITT Group3<BR> 02841 * ccitt4 : CCITT Group4<BR> 02842 * 02843 * @param pDfvObj Pointer to DfvObj instance. 02844 * @param newVal Pointer to a null-terminated string. 02845 */ 02846 DFVINTERFACE_API void dfv_setRasterCompression(CDfvObjPtr pDfvObj, const char* newVal); 02847 02848 /** 02849 * @deprecated 02850 * Specifies the compression method when outputting TIFF / MTIFF.<BR> 02851 * The compression method.<BR> 02852 * none : None<BR> 02853 * lzw : ZLIB compression(When this parameter is omitted, lzw is applied.)<BR> 02854 * dct : DCTDecode<BR> 02855 * flate : FlateDecode<BR> 02856 * runlength : Run Length compression<BR> 02857 * ccitt3 : CCITT Group3<BR> 02858 * ccitt4 : CCITT Group4<BR> 02859 * 02860 * @param pDfvObj Pointer to DfvObj instance. 02861 * @param newVal Pointer to a null-terminated string. 02862 */ 02863 DFVINTERFACE_API void dfv_setRasterCompressionW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02864 02865 #endif // #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 02866 02867 /** 02868 * Specifies the height of the paper when inputting text. 02869 * Effective when inputting text. 02870 * 02871 * @param pDfvObj Pointer to DfvObj instance. 02872 * @param newVal the height of paper 02873 */ 02874 DFVINTERFACE_API void dfv_setTextPaperHeight(CDfvObjPtr pDfvObj, const char* newVal); 02875 02876 /** 02877 * Specifies the height of the paper when inputting text. 02878 * Effective when inputting text. 02879 * 02880 * @param pDfvObj Pointer to DfvObj instance. 02881 * @param newVal the height of paper 02882 */ 02883 DFVINTERFACE_API void dfv_setTextPaperHeightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02884 02885 /** 02886 * Specifies the width of the paper when inputting text. 02887 * Effective when inputting text. 02888 * 02889 * @param pDfvObj Pointer to DfvObj instance. 02890 * @param newVal the width of paper 02891 */ 02892 DFVINTERFACE_API void dfv_setTextPaperWidth(CDfvObjPtr pDfvObj, const char* newVal); 02893 02894 /** 02895 * Specifies the width of the paper when inputting text. 02896 * Effective when inputting text. 02897 * 02898 * @param pDfvObj Pointer to DfvObj instance. 02899 * @param newVal the width of paper 02900 */ 02901 DFVINTERFACE_API void dfv_setTextPaperWidthW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02902 02903 /** 02904 * Specifies the left margin of the paper when inputting text. 02905 * Effective when inputting text. 02906 * 02907 * @param pDfvObj Pointer to DfvObj instance. 02908 * @param newVal the left margin of the paper 02909 */ 02910 DFVINTERFACE_API void dfv_setTextMarginLeft(CDfvObjPtr pDfvObj, const char* newVal); 02911 02912 /** 02913 * Specifies the left margin of the paper when inputting text. 02914 * Effective when inputting text. 02915 * 02916 * @param pDfvObj Pointer to DfvObj instance. 02917 * @param newVal the left margin of the paper 02918 */ 02919 DFVINTERFACE_API void dfv_setTextMarginLeftW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02920 02921 /** 02922 * Specifies the right margin of the paper when inputting text. 02923 * Effective when inputting text. 02924 * 02925 * @param pDfvObj Pointer to DfvObj instance. 02926 * @param newVal the top margin of the paper 02927 */ 02928 DFVINTERFACE_API void dfv_setTextMarginTop(CDfvObjPtr pDfvObj, const char* newVal); 02929 02930 /** 02931 * Specifies the right margin of the paper when inputting text. 02932 * Effective when inputting text. 02933 * 02934 * @param pDfvObj Pointer to DfvObj instance. 02935 * @param newVal the top margin of the paper 02936 */ 02937 DFVINTERFACE_API void dfv_setTextMarginTopW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02938 02939 /** 02940 * Specifies the right margin of the paper when inputting text. 02941 * Effective when inputting text. 02942 * 02943 * @param pDfvObj Pointer to DfvObj instance. 02944 * @param newVal the right margin of the paper 02945 */ 02946 DFVINTERFACE_API void dfv_setTextMarginRight(CDfvObjPtr pDfvObj, const char* newVal); 02947 02948 /** 02949 * Specifies the right margin of the paper when inputting text. 02950 * Effective when inputting text. 02951 * 02952 * @param pDfvObj Pointer to DfvObj instance. 02953 * @param newVal the right margin of the paper 02954 */ 02955 DFVINTERFACE_API void dfv_setTextMarginRightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02956 02957 /** 02958 * Specifies the right margin of the paper when inputting text. 02959 * Effective when inputting text. 02960 * 02961 * @param pDfvObj Pointer to DfvObj instance. 02962 * @param newVal the bottom margin of the paper 02963 */ 02964 DFVINTERFACE_API void dfv_setTextMarginBottom(CDfvObjPtr pDfvObj, const char* newVal); 02965 02966 /** 02967 * Specifies the right margin of the paper when inputting text. 02968 * Effective when inputting text. 02969 * 02970 * @param pDfvObj Pointer to DfvObj instance. 02971 * @param newVal the bottom margin of the paper 02972 */ 02973 DFVINTERFACE_API void dfv_setTextMarginBottomW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02974 02975 /** 02976 * Specifies the font family name when inputting text. 02977 * Effective when inputting text. 02978 * 02979 * @param pDfvObj Pointer to DfvObj instance. 02980 * @param newVal font family name 02981 */ 02982 DFVINTERFACE_API void dfv_setTextFontFamily(CDfvObjPtr pDfvObj, const char* newVal); 02983 02984 /** 02985 * Specifies the font family name when inputting text. 02986 * Effective when inputting text. 02987 * 02988 * @param pDfvObj Pointer to DfvObj instance. 02989 * @param newVal font family name 02990 */ 02991 DFVINTERFACE_API void dfv_setTextFontFamilyW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02992 02993 /** 02994 * Specifies the font size when inputting text. 02995 * Effective when inputting text. 02996 * 02997 * @param pDfvObj Pointer to DfvObj instance. 02998 * @param newVal font size 02999 */ 03000 DFVINTERFACE_API void dfv_setTextFontSize(CDfvObjPtr pDfvObj, const char* newVal); 03001 03002 /** 03003 * Specifies the font size when inputting text. 03004 * Effective when inputting text. 03005 * 03006 * @param pDfvObj Pointer to DfvObj instance. 03007 * @param newVal font size 03008 */ 03009 DFVINTERFACE_API void dfv_setTextFontSizeW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03010 03011 /** 03012 * Specifies the value of whether show page number or not when inputting text. 03013 * Effective when inputting text. 03014 * 03015 * @param pDfvObj Pointer to DfvObj instance. 03016 * @param newVal the value of whether show page number or not 03017 */ 03018 DFVINTERFACE_API void dfv_setTextShowPageNumber(CDfvObjPtr pDfvObj, int newVal); 03019 03020 /** 03021 * Specifies the value of whether show page number or not when inputting text. 03022 * Effective when inputting text. 03023 * 03024 * @param pDfvObj Pointer to DfvObj instance. 03025 * @param newVal the value of whether show page number or not 03026 */ 03027 DFVINTERFACE_API void dfv_setTextShowLineNumber(CDfvObjPtr pDfvObj, int newVal); 03028 03029 /** 03030 * Specifies the offset value of range from body area when showing line number and inputting text. 03031 * Effective when inputting text. 03032 * 03033 * @param pDfvObj Pointer to DfvObj instance. 03034 * @param newVal the offset value 03035 */ 03036 DFVINTERFACE_API void dfv_setTextLineNumberOffset(CDfvObjPtr pDfvObj, const char* newVal); 03037 03038 /** 03039 * Specifies the offset value of range from body area when showing line number and inputting text. 03040 * Effective when inputting text. 03041 * 03042 * @param pDfvObj Pointer to DfvObj instance. 03043 * @param newVal the offset value 03044 */ 03045 DFVINTERFACE_API void dfv_setTextLineNumberOffsetW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03046 03047 /** 03048 * Specifies the line number format when showing line number and inputting text. 03049 * Effective when inputting text. 03050 * 03051 * @param pDfvObj Pointer to DfvObj instance. 03052 * @param newVal line number format 03053 */ 03054 DFVINTERFACE_API void dfv_setTextLineNumberFormat(CDfvObjPtr pDfvObj, const char* newVal); 03055 03056 /** 03057 * Specifies the line number format when showing line number and inputting text. 03058 * Effective when inputting text. 03059 * 03060 * @param pDfvObj Pointer to DfvObj instance. 03061 * @param newVal line number format 03062 */ 03063 DFVINTERFACE_API void dfv_setTextLineNumberFormatW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03064 03065 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 03066 /** 03067 * Acquires the setting of the smoothing processing to text.<BR> 03068 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03069 * 03070 * @param pDfvObj Pointer to DfvObj instance. 03071 * @return 03072 * Specify whether to perform the smoothing processing to text. 03073 */ 03074 DFVINTERFACE_API int dfv_getGdiTextAntialias(CDfvObjPtr pDfvObj); 03075 03076 /** 03077 * Performs the smoothing processing to text.<BR> 03078 * Effective only when printing and outputting images.<BR> 03079 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03080 * 03081 * @param pDfvObj Pointer to DfvObj instance. 03082 * @param newVal 03083 * Performs the smoothing processing when true is specified. 03084 */ 03085 DFVINTERFACE_API void dfv_setGdiTextAntialias(CDfvObjPtr pDfvObj, int newVal); 03086 03087 /** 03088 * Acquires the setting of the smoothing processing to borders.<BR> 03089 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03090 * 03091 * @param pDfvObj Pointer to DfvObj instance. 03092 * @return 03093 * Specify whether to perform the smoothing processing to borders. 03094 */ 03095 DFVINTERFACE_API int dfv_getGdiLineartSmoothing(CDfvObjPtr pDfvObj); 03096 03097 /** 03098 * Performs the smoothing processing to borders.<BR> 03099 * Effective only when printing and outputting images.<BR> 03100 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03101 * 03102 * @param pDfvObj Pointer to DfvObj instance. 03103 * @param newVal 03104 * Performs the smoothing processing when true is specified. 03105 */ 03106 DFVINTERFACE_API void dfv_setGdiLineartSmoothing(CDfvObjPtr pDfvObj, int newVal); 03107 03108 /** 03109 * Acquires the setting of the smoothing processing to images.<BR> 03110 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03111 * 03112 * @param pDfvObj Pointer to DfvObj instance. 03113 * @return 03114 * Specify whether to perform the smoothing processing to images. 03115 */ 03116 DFVINTERFACE_API int dfv_getGdiImageSmoothing(CDfvObjPtr pDfvObj); 03117 03118 /** 03119 * Performs the smoothing processing to images.<BR> 03120 * Effective only when printing and outputting images.<BR> 03121 * This setting is effective only with Windows XP or later / Windows Server2003 or later. 03122 * 03123 * @param pDfvObj Pointer to DfvObj instance. 03124 * @param newVal 03125 * Performs the smoothing processing when true is specified. 03126 */ 03127 DFVINTERFACE_API void dfv_setGdiImageSmoothing(CDfvObjPtr pDfvObj, int newVal); 03128 #endif 03129 03130 /** 03131 * @deprecated 03132 * Get the watermark text on each page. 03133 * 03134 * @param pDfvObj Pointer to DfvObj instance. 03135 * @param pVal 03136 * Pointer to the buffer that will receive the text. 03137 * If the string is as long or longer than the buffer, 03138 * the string is truncated and terminated with a NULL character. 03139 * @param size 03140 * Specifies the number of the 'pVal' buffer, including the NULL character. 03141 * If the text exceeds this limit, it is truncated. 03142 * @return Returns the 'pVal'. 03143 */ 03144 DFVINTERFACE_API char* dfv_getWatermarkText(CDfvObjPtr pDfvObj, char* pVal, int size); 03145 03146 /** 03147 * @deprecated 03148 * Get the watermark text on each page. 03149 * 03150 * @param pDfvObj Pointer to DfvObj instance. 03151 * @param pVal 03152 * Pointer to the buffer that will receive the text. 03153 * If the string is as long or longer than the buffer, 03154 * the string is truncated and terminated with a NULL character. 03155 * @param size 03156 * Specifies the number of the 'pVal' buffer, including the NULL character. 03157 * If the text exceeds this limit, it is truncated. 03158 * @return Returns the 'pVal'. 03159 */ 03160 DFVINTERFACE_API wchar_t* dfv_getWatermarkTextW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03161 03162 /** 03163 * @deprecated 03164 * Displays the specified watermark text on each page. 03165 * Possible to make it multiple lines by delimiting with the line feed \n. 03166 * This setting is invalid with the evaluation version. 03167 * 03168 * @param pDfvObj Pointer to DfvObj instance. 03169 * @param newVal Pointer to a null-terminated string. 03170 */ 03171 DFVINTERFACE_API void dfv_setWatermarkText(CDfvObjPtr pDfvObj, const char* newVal); 03172 03173 /** 03174 * @deprecated 03175 * Displays the specified watermark text on each page. 03176 * Possible to make it multiple lines by delimiting with the line feed \n. 03177 * This setting is invalid with the evaluation version. 03178 * 03179 * @param pDfvObj Pointer to DfvObj instance. 03180 * @param newVal Pointer to a null-terminated string. 03181 */ 03182 DFVINTERFACE_API void dfv_setWatermarkTextW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03183 03184 /** 03185 * @deprecated 03186 * Get the font family of the watermark text. 03187 * 03188 * @param pDfvObj Pointer to DfvObj instance. 03189 * @param pVal 03190 * Pointer to the buffer that will receive the text. 03191 * If the string is as long or longer than the buffer, 03192 * the string is truncated and terminated with a NULL character. 03193 * @param size 03194 * Specifies the number of the 'pVal' buffer, including the NULL character. 03195 * If the text exceeds this limit, it is truncated. 03196 * @return Returns the 'pVal'. 03197 */ 03198 DFVINTERFACE_API char* dfv_getWatermarkFontFamily(CDfvObjPtr pDfvObj, char* pVal, int size); 03199 03200 /** 03201 * @deprecated 03202 * Get the font family of the watermark text. 03203 * 03204 * @param pDfvObj Pointer to DfvObj instance. 03205 * @param pVal 03206 * Pointer to the buffer that will receive the text. 03207 * If the string is as long or longer than the buffer, 03208 * the string is truncated and terminated with a NULL character. 03209 * @param size 03210 * Specifies the number of the 'pVal' buffer, including the NULL character. 03211 * If the text exceeds this limit, it is truncated. 03212 * @return Returns the 'pVal'. 03213 */ 03214 DFVINTERFACE_API wchar_t* dfv_getWatermarkFontFamilyW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03215 03216 /** 03217 * @deprecated 03218 * Specifies the font family to the character string which you set to watermark-text. 03219 * 03220 * @param pDfvObj Pointer to DfvObj instance. 03221 * @param newVal Pointer to a null-terminated string. 03222 */ 03223 DFVINTERFACE_API void dfv_setWatermarkFontFamily(CDfvObjPtr pDfvObj, const char* newVal); 03224 03225 /** 03226 * @deprecated 03227 * Specifies the font family to the character string which you set to watermark-text. 03228 * 03229 * @param pDfvObj Pointer to DfvObj instance. 03230 * @param newVal Pointer to a null-terminated string. 03231 */ 03232 DFVINTERFACE_API void dfv_setWatermarkFontFamilyW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03233 03234 /** 03235 * @deprecated 03236 * Get the font weight of the watermark text. 03237 * 03238 * @param pDfvObj Pointer to DfvObj instance. 03239 * @param pVal 03240 * Pointer to the buffer that will receive the text. 03241 * If the string is as long or longer than the buffer, 03242 * the string is truncated and terminated with a NULL character. 03243 * @param size 03244 * Specifies the number of the 'pVal' buffer, including the NULL character. 03245 * If the text exceeds this limit, it is truncated. 03246 * @return Returns the 'pVal'. 03247 */ 03248 DFVINTERFACE_API char* dfv_getWatermarkFontWeight(CDfvObjPtr pDfvObj, char* pVal, int size); 03249 03250 /** 03251 * @deprecated 03252 * Get the font weight of the watermark text. 03253 * 03254 * @param pDfvObj Pointer to DfvObj instance. 03255 * @param pVal 03256 * Pointer to the buffer that will receive the text. 03257 * If the string is as long or longer than the buffer, 03258 * the string is truncated and terminated with a NULL character. 03259 * @param size 03260 * Specifies the number of the 'pVal' buffer, including the NULL character. 03261 * If the text exceeds this limit, it is truncated. 03262 * @return Returns the 'pVal'. 03263 */ 03264 DFVINTERFACE_API wchar_t* dfv_getWatermarkFontWeightW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03265 03266 /** 03267 * @deprecated 03268 * Specifies the font weight to the character string which you set to watermark-text. 03269 * Possible to specify normal, bold or the numerical value from 100 to 900. 03270 * 03271 * @param pDfvObj Pointer to DfvObj instance. 03272 * @param newVal Pointer to a null-terminated string. 03273 */ 03274 DFVINTERFACE_API void dfv_setWatermarkFontWeight(CDfvObjPtr pDfvObj, const char* newVal); 03275 03276 /** 03277 * @deprecated 03278 * Specifies the font weight to the character string which you set to watermark-text. 03279 * Possible to specify normal, bold or the numerical value from 100 to 900. 03280 * 03281 * @param pDfvObj Pointer to DfvObj instance. 03282 * @param newVal Pointer to a null-terminated string. 03283 */ 03284 DFVINTERFACE_API void dfv_setWatermarkFontWeightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03285 03286 /** 03287 * @deprecated 03288 * Get the font style of the watermark text. 03289 * 03290 * @param pDfvObj Pointer to DfvObj instance. 03291 * @param pVal 03292 * Pointer to the buffer that will receive the text. 03293 * If the string is as long or longer than the buffer, 03294 * the string is truncated and terminated with a NULL character. 03295 * @param size 03296 * Specifies the number of the 'pVal' buffer, including the NULL character. 03297 * If the text exceeds this limit, it is truncated. 03298 * @return Returns the 'pVal'. 03299 */ 03300 DFVINTERFACE_API char* dfv_getWatermarkFontStyle(CDfvObjPtr pDfvObj, char* pVal, int size); 03301 03302 /** 03303 * @deprecated 03304 * Get the font style of the watermark text. 03305 * 03306 * @param pDfvObj Pointer to DfvObj instance. 03307 * @param pVal 03308 * Pointer to the buffer that will receive the text. 03309 * If the string is as long or longer than the buffer, 03310 * the string is truncated and terminated with a NULL character. 03311 * @param size 03312 * Specifies the number of the 'pVal' buffer, including the NULL character. 03313 * If the text exceeds this limit, it is truncated. 03314 * @return Returns the 'pVal'. 03315 */ 03316 DFVINTERFACE_API wchar_t* dfv_getWatermarkFontStyleW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03317 03318 /** 03319 * @deprecated 03320 * Specifies the font style to the character string which you set to watermark-text. 03321 * 03322 * @param pDfvObj Pointer to DfvObj instance. 03323 * @param newVal Pointer to a null-terminated string. 03324 */ 03325 DFVINTERFACE_API void dfv_setWatermarkFontStyle(CDfvObjPtr pDfvObj, const char* newVal); 03326 03327 /** 03328 * @deprecated 03329 * Specifies the font style to the character string which you set to watermark-text. 03330 * 03331 * @param pDfvObj Pointer to DfvObj instance. 03332 * @param newVal Pointer to a null-terminated string. 03333 */ 03334 DFVINTERFACE_API void dfv_setWatermarkFontStyleW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03335 03336 /** 03337 * @deprecated 03338 * Get the opacity of the watermark text. 03339 * 03340 * @param pDfvObj Pointer to DfvObj instance. 03341 * @param pVal 03342 * Pointer to the buffer that will receive the text. 03343 * If the string is as long or longer than the buffer, 03344 * the string is truncated and terminated with a NULL character. 03345 * @param size 03346 * Specifies the number of the 'pVal' buffer, including the NULL character. 03347 * If the text exceeds this limit, it is truncated. 03348 * @return Returns the 'pVal'. 03349 */ 03350 DFVINTERFACE_API char* dfv_getWatermarkOpacity(CDfvObjPtr pDfvObj, char* pVal, int size); 03351 03352 /** 03353 * @deprecated 03354 * Get the opacity of the watermark text. 03355 * 03356 * @param pDfvObj Pointer to DfvObj instance. 03357 * @param pVal 03358 * Pointer to the buffer that will receive the text. 03359 * If the string is as long or longer than the buffer, 03360 * the string is truncated and terminated with a NULL character. 03361 * @param size 03362 * Specifies the number of the 'pVal' buffer, including the NULL character. 03363 * If the text exceeds this limit, it is truncated. 03364 * @return Returns the 'pVal'. 03365 */ 03366 DFVINTERFACE_API wchar_t* dfv_getWatermarkOpacityW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03367 03368 /** 03369 * @deprecated 03370 * Specifies the opacity to the character string which you set to watermark-text. 03371 * 03372 * @param pDfvObj Pointer to DfvObj instance. 03373 * @param newVal Pointer to a null-terminated string. 03374 */ 03375 DFVINTERFACE_API void dfv_setWatermarkOpacity(CDfvObjPtr pDfvObj, const char* newVal); 03376 03377 /** 03378 * @deprecated 03379 * Specifies the opacity to the character string which you set to watermark-text. 03380 * 03381 * @param pDfvObj Pointer to DfvObj instance. 03382 * @param newVal Pointer to a null-terminated string. 03383 */ 03384 DFVINTERFACE_API void dfv_setWatermarkOpacityW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03385 03386 /** 03387 * Gets the setting of continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets. 03388 * @param pDfvObj Pointer to DfvObj instance. 03389 * @return 03390 * If true, inserts continuous page numbers across all worksheets/number of pages as a total of all worksheets. 03391 */ 03392 DFVINTERFACE_API int dfv_getContinuePageNumber(CDfvObjPtr pDfvObj); 03393 03394 /** 03395 * Sets continuous page numbers across worksheets in Excel header footer/number of pages as a total of all worksheets. 03396 * 03397 * @param pDfvObj Pointer to DfvObj instance. 03398 * @param newVal 03399 * If true, sets continuous page numbers across all worksheets/number of pages as a total of all worksheets. 03400 */ 03401 DFVINTERFACE_API void dfv_setContinuePageNumber(CDfvObjPtr pDfvObj, int newVal); 03402 03403 /** 03404 * Get the color profile file name. 03405 * 03406 * @param pDfvObj Pointer to DfvObj instance. 03407 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 03408 * the string is truncated and terminated with a NULL character. 03409 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 03410 * @return Returns the 'pVal'. 03411 */ 03412 03413 DFVINTERFACE_API char* dfv_getPdfColorProfile(CDfvObjPtr pDfvObj, char* pVal, int size); 03414 /** 03415 * Get the color profile file name. 03416 * 03417 * @param pDfvObj Pointer to DfvObj instance. 03418 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 03419 * the string is truncated and terminated with a NULL character. 03420 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 03421 * @return Returns the 'pVal'. 03422 */ 03423 DFVINTERFACE_API wchar_t* dfv_getPdfColorProfileW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03424 03425 /** 03426 * Set the color profile file name. 03427 * When PDF/A-1b:2005 is specified to PdfVersion, the specification of the color profile is indispensable. Specify the color profile with its full path. This parameter is invalid with any PDF other than PDF/A-1b:2005. 03428 * 03429 * @param pDfvObj Pointer to DfvObj instance. 03430 * @param newVal Pointer to a null-terminated string to be used as the color profile file name. 03431 */ 03432 DFVINTERFACE_API void dfv_setPdfColorProfile(CDfvObjPtr pDfvObj, const char* newVal); 03433 03434 /** 03435 * Set the color profile file name. 03436 * When PDF/A-1b:2005 is specified to PdfVersion, the specification of the color profile is indispensable. Specify the color profile with its full path. This parameter is invalid with any PDF other than PDF/A-1b:2005. 03437 * 03438 * @param pDfvObj Pointer to DfvObj instance. 03439 * @param newVal Pointer to a null-terminated string to be used as the color profile file name. 03440 */ 03441 DFVINTERFACE_API void dfv_setPdfColorProfileW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03442 03443 /** 03444 * Specifies the open password for document. 03445 * 03446 * @param pDfvObj Pointer to DfvObj instance. 03447 * @param newVal Pointer to a null-terminated string. 03448 */ 03449 DFVINTERFACE_API void dfv_setOpenPassword(CDfvObjPtr pDfvObj, const char* newVal); 03450 03451 /** 03452 * Specifies the open password for document. 03453 * 03454 * @param pDfvObj Pointer to DfvObj instance. 03455 * @param newVal Pointer to a null-terminated string. 03456 */ 03457 DFVINTERFACE_API void dfv_setOpenPasswordW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03458 03459 /** 03460 * Get the setting of Support for correct number of pages in Word. 03461 * 03462 * @param pDfvObj Pointer to DfvObj instance. 03463 * @return 03464 * If true, support for correct number of pages and dynamically updating table of contents in Word. 03465 */ 03466 DFVINTERFACE_API long dfv_getPageNumberCorrection(CDfvObjPtr pDfvObj); 03467 03468 /** 03469 * Set the setting of Support for correct number of pages in Word. 03470 * 03471 * @param pDfvObj Pointer to DfvObj instance. 03472 * @param newVal 03473 * If true, sets support for correct number of pages and dynamically updating table of contents in Word. 03474 */ 03475 DFVINTERFACE_API void dfv_setPageNumberCorrection(CDfvObjPtr pDfvObj, long newVal); 03476 03477 /** 03478 * Get the specification that output to the first sheet that was active. return Specification that output to the first sheet that was active 03479 */ 03480 DFVINTERFACE_API int dfv_getSheetOrderActiveFirst(CDfvObjPtr pDfvObj); 03481 03482 /** 03483 * Output to the first sheet that was active when you save in MS Excel. 03484 * 03485 * @param pDfvObj Pointer to DfvObj instance. 03486 * @param newVal If the value is 'true' is specified, first sheet that was active 03487 */ 03488 DFVINTERFACE_API void dfv_setSheetOrderActiveFirst(CDfvObjPtr pDfvObj, int newVal); 03489 03490 /** 03491 * Get the sheet order and select. 03492 * 03493 * @param pDfvObj Pointer to DfvObj instance. 03494 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 03495 * the string is truncated and terminated with a NULL character. 03496 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 03497 * @return Returns the 'pVal'. 03498 */ 03499 03500 DFVINTERFACE_API char* dfv_getSheetOrderSelect(CDfvObjPtr pDfvObj, char* pVal, int size); 03501 /** 03502 * Get the sheet order and select. 03503 * 03504 * @param pDfvObj Pointer to DfvObj instance. 03505 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 03506 * the string is truncated and terminated with a NULL character. 03507 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 03508 * @return Returns the 'pVal'. 03509 */ 03510 DFVINTERFACE_API wchar_t* dfv_getSheetOrderSelectW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 03511 03512 /** 03513 * Set the sheet order and select. 03514 * 03515 * @param pDfvObj Pointer to DfvObj instance. 03516 * @param newVal Pointer to a null-terminated string to be used as the sheet order and select. 03517 */ 03518 DFVINTERFACE_API void dfv_setSheetOrderSelect(CDfvObjPtr pDfvObj, const char* newVal); 03519 03520 /** 03521 * Set the sheet order and select. 03522 * 03523 * @param pDfvObj Pointer to DfvObj instance. 03524 * @param newVal Pointer to a null-terminated string to be used as the sheet order and select. 03525 */ 03526 DFVINTERFACE_API void dfv_setSheetOrderSelectW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 03527 03528 03529 #ifdef __cplusplus 03530 } 03531 #endif /* __cplusplus */ 03532 03533 #endif /* DFVIFC_C_H__ */