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 PDFX_1a_2001= 101, /* ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3) */ 00060 PDFX_3_2002 = 103, /* ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3) */ 00061 PDFX_1a_2003= 104, /* ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4) */ 00062 PDFX_2_2003 = 105, /* ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4) */ 00063 PDFX_3_2003 = 106, /* ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4) */ 00064 PDFA_1a_2005= 200, /* ISO 19005-1:2005 (based on PDF1.4) */ 00065 PDFA_1b_2005= 400 /* ISO 19005-1:2005 (based on PDF1.4) */ 00066 } DfvPDFVERSION; 00067 00068 /** 00069 * PDF encrypt level 00070 */ 00071 typedef enum { 00072 ENCLEVEL_40, /* 40-bit RC4 */ 00073 ENCLEVEL_128 /* 128-bit RC4 */ 00074 } DfvPDFENCRYPTLEVEL; 00075 00076 /** 00077 * PDF print allow 00078 */ 00079 typedef enum { 00080 PRALLOW_NONE, /* not allowed */ 00081 PRALLOW_LOW, /* low resolution printing */ 00082 PRALLOW_HIGH /* high resolution printing */ 00083 } DfvPDFPRINTALLOW; 00084 00085 /** 00086 * PDF image compression 00087 */ 00088 typedef enum { 00089 IMGCMPR_AUTO, /* auto */ 00090 IMGCMPR_JPEG, /* JPEG */ 00091 IMGCMPR_ZLIB, /* ZLIB */ 00092 IMGCMPR_JPEG2K /* JPEG2000 */ 00093 } DfvPDFIMAGECOMPRESSION; 00094 00095 /** 00096 * PDF RGB conversion 00097 */ 00098 typedef enum { 00099 RGBCONV_NONE, /* no conversion */ 00100 RGBCONV_BLACK, /* black to devicegray */ 00101 RGBCONV_GRAY, /* gray to devicegray */ 00102 RGBCONV_ALL /* all rgb to devicegray */ 00103 } DfvPDFRGBCONVERSION; 00104 00105 /** 00106 * Embed font 00107 */ 00108 typedef enum { 00109 EMBALLFONT_PART, /* specified fonts */ 00110 EMBALLFONT_ALL, /* all fonts except Base14 fonts */ 00111 EMBALLFONT_BASE14 /* all fonts */ 00112 } DfvEMBEDALLFONT; 00113 00114 /** 00115 * Image downsampling 00116 */ 00117 typedef enum { 00118 IMGDOWNSAMPLING_NONE, /* no downsampling */ 00119 IMGDOWNSAMPLING_AVERAGE, /* average downsampling */ 00120 IMGDOWNSAMPLING_BICUBIC, /* bicubic downsampling */ 00121 IMGDOWNSAMPLING_SUBSAMPLING /* subsampling */ 00122 } DfvIMAGEDOWNSAMPLING; 00123 00124 /** 00125 * Monochrome compression 00126 */ 00127 typedef enum { 00128 MONOCMPR_CCITT4, /* CCITTFaxDecode group 4 filter,default value */ 00129 MONOCMPR_CCITT3, /* CCITTFaxDecode group 3 filter */ 00130 MONOCMPR_RUNLENGTH, /* RunLengthDecode filter */ 00131 MONOCMPR_ZLIB, /* FlateDecode filter */ 00132 MONOCMPR_OFF /* no filter */ 00133 } DfvMONOCHROMECOMPRESSION; 00134 00135 /** 00136 * SVG version 00137 */ 00138 typedef enum { 00139 SVG_11, /* SVG 1.1 */ 00140 SVG_Basic, /* SVG Basic */ 00141 SVG_Tiny /* SVG Tiny */ 00142 } DfvSVGVERSION; 00143 00144 /** 00145 * Image processing 00146 */ 00147 typedef enum { 00148 IMGPT_EMBED_ALL, /* embed all */ 00149 IMGPT_COPY_ALL, /* copy all */ 00150 IMGPT_LINK, /* link */ 00151 IMGPT_COPY /* copy */ 00152 } DfvIMAGEPROCTYPE; 00153 00154 /** 00155 * Image conversion 00156 */ 00157 typedef enum { 00158 IMGCNV_AUTO, /* auto */ 00159 IMGCNV_JPEG, /* jpeg conversion except png */ 00160 IMGCNV_PNG, /* png conversion except jpeg */ 00161 IMGCNV_JPEGALL /* jpeg-all conversion */ 00162 } DfvIMAGECONVERSION; 00163 00164 /** 00165 * INX output mode 00166 */ 00167 typedef enum { 00168 INXOM_TEXT, /* text area output mode */ 00169 INXOM_LINE, /* line area output */ 00170 INXOM_BLOCK /* block area output */ 00171 } DfvINXOUTPUTMODE; 00172 00173 /** 00174 * MIF output mode 00175 */ 00176 typedef enum { 00177 MIFOM_TEXT, /* text area output mode */ 00178 MIFOM_LINE, /* line area output */ 00179 MIFOM_BLOCK /* block area output */ 00180 } DfvMIFOUTPUTMODE; 00181 00182 /*************************************************************** 00183 * format information 00184 */ 00185 00186 #ifdef __cplusplus 00187 extern "C" { 00188 #endif 00189 00190 /** Pointer to DfvObj instance. */ 00191 typedef void* CDfvObjPtr; 00192 00193 /** 00194 * Error callback handler 00195 */ 00196 typedef void (DfvOnMessageProc)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 00197 typedef void (DfvOnMessageProcW)(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage); 00198 typedef void (DfvOnFormatPageProc)(long pageNo); 00199 00200 typedef void (DfvOnMessageProcEx)(void* pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 00201 typedef void (DfvOnMessageProcExW)(void* pAnyObj, DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage); 00202 typedef void (DfvOnFormatPageProcEx)(void* pAnyObj, long pageNo); 00203 00204 /** 00205 * Create instance of DfvObj 00206 * 00207 * @return Pointer to DfvObj instance. 00208 */ 00209 DFVINTERFACE_API CDfvObjPtr dfv_createDfvObject(); 00210 00211 /** 00212 * Release instance of DfvObj 00213 * 00214 * @param pDfvObj Pointer to DfvObj instance. 00215 */ 00216 DFVINTERFACE_API void dfv_releaseDfvObject(CDfvObjPtr pDfvObj); 00217 00218 /** 00219 * Get the URL of XML document you will format. 00220 * 00221 * @param pDfvObj Pointer to DfvObj instance. 00222 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00223 * the string is truncated and terminated with a NULL character. 00224 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00225 * @return Returns the 'pVal'. 00226 */ 00227 DFVINTERFACE_API char* dfv_getDocumentURI(CDfvObjPtr pDfvObj, char* pVal, int size); 00228 /** 00229 * Get the URL of XML document you will format. 00230 * 00231 * @param pDfvObj Pointer to DfvObj instance. 00232 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00233 * the string is truncated and terminated with a NULL character. 00234 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00235 * @return Returns the 'pVal'. 00236 */ 00237 DFVINTERFACE_API wchar_t* dfv_getDocumentURIW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00238 00239 /** 00240 * Specifies the URL of XML document you will format. 00241 * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin. 00242 * The document loaded from stdin are supposed to be FO files. 00243 * 00244 * @param pDfvObj Pointer to DfvObj instance. 00245 * @param newVal Pointer to a null-terminated string to be used as the URL of XSL document. 00246 */ 00247 DFVINTERFACE_API void dfv_setDocumentURI(CDfvObjPtr pDfvObj, const char* newVal); 00248 /** 00249 * Specifies the URL of XML document you will format. 00250 * If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin. 00251 * The document loaded from stdin are supposed to be FO files. 00252 * 00253 * @param pDfvObj Pointer to DfvObj instance. 00254 * @param newVal Pointer to a null-terminated string to be used as the URL of XSL document. 00255 */ 00256 DFVINTERFACE_API void dfv_setDocumentURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00257 00258 /** 00259 * Get the path name of the output file. 00260 * 00261 * @param pDfvObj Pointer to DfvObj instance. 00262 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00263 * the string is truncated and terminated with a NULL character. 00264 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00265 * @return Returns the 'pVal'. 00266 */ 00267 DFVINTERFACE_API char* dfv_getOutputFilePath(CDfvObjPtr pDfvObj, char* pVal, int size); 00268 /** 00269 * Get the path name of the output file. 00270 * 00271 * @param pDfvObj Pointer to DfvObj instance. 00272 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00273 * the string is truncated and terminated with a NULL character. 00274 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00275 * @return Returns the 'pVal'. 00276 */ 00277 DFVINTERFACE_API wchar_t* dfv_getOutputFilePathW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00278 00279 /** 00280 * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout. 00281 * If both the printer name and this property are specified, the formatted result will be stored in 00282 * the file by the printer driver. 00283 * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. 00284 * If the property is not specified, it is considered as stdout. 00285 * 00286 * @param pDfvObj Pointer to DfvObj instance. 00287 * @param newVal Pointer to a null-terminated string to be used as the path name of the output file. 00288 */ 00289 DFVINTERFACE_API void dfv_setOutputFilePath(CDfvObjPtr pDfvObj, const char* newVal); 00290 /** 00291 * Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout. 00292 * If both the printer name and this property are specified, the formatted result will be stored in 00293 * the file by the printer driver. 00294 * When "\@PDF" is specified as output, the PDF is stored in the file specified by this property. 00295 * If the property is not specified, it is considered as stdout. 00296 * 00297 * @param pDfvObj Pointer to DfvObj instance. 00298 * @param newVal Pointer to a null-terminated string to be used as the path name of the output file. 00299 */ 00300 DFVINTERFACE_API void dfv_setOutputFilePathW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00301 00302 /** 00303 * Get the path name of XML-format Option setting file which describes Server Based Converter options. 00304 * 00305 * @param pDfvObj Pointer to DfvObj instance. 00306 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00307 * the string is truncated and terminated with a NULL character. 00308 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00309 * @param n Specifies to get n-th URI. 0 means first URI. 00310 * @return Returns the 'pVal'. 00311 */ 00312 DFVINTERFACE_API char* dfv_getOptionFileURI(CDfvObjPtr pDfvObj, char* pVal, int size, int n); 00313 /** 00314 * Get the path name of XML-format Option setting file which describes Server Based Converter options. 00315 * 00316 * @param pDfvObj Pointer to DfvObj instance. 00317 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 00318 * the string is truncated and terminated with a NULL character. 00319 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00320 * @param n Specifies to get n-th URI. 0 means first URI. 00321 * @return Returns the 'pVal'. 00322 */ 00323 DFVINTERFACE_API wchar_t* dfv_getOptionFileURIW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size, int n); 00324 00325 /** 00326 * Specifies the path name of XML-format Option setting file which describes Server Based Converter options. 00327 * The set of former URIs is thrown away. 00328 * 00329 * @param pDfvObj Pointer to DfvObj instance. 00330 * @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. 00331 */ 00332 DFVINTERFACE_API void dfv_setOptionFileURI(CDfvObjPtr pDfvObj, const char* newVal); 00333 /** 00334 * Specifies the path name of XML-format Option setting file which describes Server Based Converter options. 00335 * The set of former URIs is thrown away. 00336 * 00337 * @param pDfvObj Pointer to DfvObj instance. 00338 * @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. 00339 */ 00340 DFVINTERFACE_API void dfv_setOptionFileURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00341 00342 /** 00343 * Append the path name of XML-format Option setting file which describes Server Based Converter options. 00344 * 00345 * 00346 * @param pDfvObj Pointer to DfvObj instance. 00347 * @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. 00348 */ 00349 DFVINTERFACE_API void dfv_addOptionFileURI(CDfvObjPtr pDfvObj, const char* newVal); 00350 /** 00351 * Append the path name of XML-format Option setting file which describes Server Based Converter options. 00352 * 00353 * 00354 * @param pDfvObj Pointer to DfvObj instance. 00355 * @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file. 00356 */ 00357 DFVINTERFACE_API void dfv_addOptionFileURIW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00358 00359 /** 00360 * Get the number of URIs of XML-format Option setting file which describes Server Based Converter options. 00361 * 00362 * 00363 * @param pDfvObj Pointer to DfvObj instance. 00364 * @return Returns the number of URIs. 00365 */ 00366 DFVINTERFACE_API int dfv_getOptionFileCount(CDfvObjPtr pDfvObj); 00367 00368 /** 00369 * Get the start page number of document to output. 00370 * 00371 * @param pDfvObj Pointer to DfvObj instance. 00372 * @return start page number of output. 00373 */ 00374 DFVINTERFACE_API long dfv_getStartPage(CDfvObjPtr pDfvObj); 00375 00376 /** 00377 * Specifies the start page number of document to output. 00378 * If the start page is omitted or the specified value is 0 or less, the start page is 00379 * considered from the first page. 00380 * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs. 00381 * 00382 * @param pDfvObj Pointer to DfvObj instance. 00383 * @param newVal start page number of output. 00384 */ 00385 DFVINTERFACE_API void dfv_setStartPage(CDfvObjPtr pDfvObj, long newVal); 00386 00387 /** 00388 * Get the end page number of document to output. 00389 * 00390 * @param pDfvObj Pointer to DfvObj instance. 00391 * @return end page number of output. 00392 */ 00393 DFVINTERFACE_API long dfv_getEndPage(CDfvObjPtr pDfvObj); 00394 00395 /** 00396 * Specifies the end page number of document to output. 00397 * If the end page is omitted or the specified value exceeds the actual page number, the end page 00398 * is considered as the last page. 00399 * If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs. 00400 * 00401 * @param pDfvObj Pointer to DfvObj instance. 00402 * @param newVal end page number of output. 00403 */ 00404 DFVINTERFACE_API void dfv_setEndPage(CDfvObjPtr pDfvObj, long newVal); 00405 00406 /** 00407 * Effective when outputting to PDF. 00408 * Specifies the owner password for PDF. The password must be within 32 bytes. 00409 * 00410 * 00411 * @param pDfvObj Pointer to DfvObj instance. 00412 * @param newVal Pointer to a null-terminated string to be used as the owner password. 00413 */ 00414 DFVINTERFACE_API void dfv_setPdfOwnerPassword(CDfvObjPtr pDfvObj, const char* newVal); 00415 00416 /** 00417 * Effective when outputting to PDF. 00418 * Specifies the owner password for PDF. The password must be within 32 bytes. 00419 * 00420 * 00421 * @param pDfvObj Pointer to DfvObj instance. 00422 * @param newVal Pointer to a null-terminated string to be used as the owner password. 00423 */ 00424 DFVINTERFACE_API void dfv_setPdfOwnerPasswordW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00425 00426 /** 00427 * Effective when outputting to PDF. 00428 * Specifies the user password for PDF. The password must be within 32 bytes. 00429 * 00430 * 00431 * @param pDfvObj Pointer to DfvObj instance. 00432 * @param newVal Pointer to a null-terminated string to be used as the user password. 00433 */ 00434 DFVINTERFACE_API void dfv_setPdfUserPassword(CDfvObjPtr pDfvObj, const char* newVal); 00435 00436 /** 00437 * Effective when outputting to PDF. 00438 * Specifies the user password for PDF. The password must be within 32 bytes. 00439 * 00440 * 00441 * @param pDfvObj Pointer to DfvObj instance. 00442 * @param newVal Pointer to a null-terminated string to be used as the user password. 00443 */ 00444 DFVINTERFACE_API void dfv_setPdfUserPasswordW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00445 00446 /** 00447 * Effective when outputting to PDF. 00448 * Disables printing the PDF file. 00449 * 00450 * 00451 * @param pDfvObj Pointer to DfvObj instance. 00452 * @param newVal If nonezero is specified, Disables printing the PDF file. 00453 */ 00454 DFVINTERFACE_API void dfv_setPdfNoPrinting(CDfvObjPtr pDfvObj, long newVal); 00455 00456 /** 00457 * Effective when outputting to PDF. 00458 * Get disables printing the PDF file. 00459 * 00460 * 00461 * @param pDfvObj Pointer to DfvObj instance. 00462 * @return If zero is returned, Enables printing the PDF file. 00463 * If nonezero is returned, Disables printing the PDF file. 00464 */ 00465 DFVINTERFACE_API long dfv_getPdfNoPrinting(CDfvObjPtr pDfvObj); 00466 00467 /** 00468 * Effective when outputting to PDF. 00469 * Disables making changes of the PDF file. 00470 * 00471 * 00472 * @param pDfvObj Pointer to DfvObj instance. 00473 * @param newVal If nonezero is specified, Disables making changes of the PDF file. 00474 */ 00475 DFVINTERFACE_API void dfv_setPdfNoChanging(CDfvObjPtr pDfvObj, long newVal); 00476 00477 /** 00478 * Effective when outputting to PDF. 00479 * Get disables making changes of the PDF file. 00480 * 00481 * 00482 * @param pDfvObj Pointer to DfvObj instance. 00483 * @return If zero is returned, Enables making changes of the PDF file. 00484 * If nonezero is returned, Disables making changes of the PDF file. 00485 */ 00486 DFVINTERFACE_API long dfv_getPdfNoChanging(CDfvObjPtr pDfvObj); 00487 00488 /** 00489 * Effective when outputting to PDF. 00490 * Disables copying the content of the PDF file. 00491 * 00492 * 00493 * @param pDfvObj Pointer to DfvObj instance. 00494 * @param newVal If nonezero is specified, Disables copying the content of the PDF file. 00495 */ 00496 DFVINTERFACE_API void dfv_setPdfNoContentCopying(CDfvObjPtr pDfvObj, long newVal); 00497 00498 /** 00499 * Effective when outputting to PDF. 00500 * Get disables copying the content of the PDF file. 00501 * 00502 * 00503 * @param pDfvObj Pointer to DfvObj instance. 00504 * @return If zero is returned, Enables copying the content of the PDF file. 00505 * If nonezero is returned, Disables copying the content of the PDF file. 00506 */ 00507 DFVINTERFACE_API long dfv_getPdfNoContentCopying(CDfvObjPtr pDfvObj); 00508 00509 /** 00510 * Effective when outputting to PDF. 00511 * Disables adding comments and form fields to the PDF file. 00512 * 00513 * 00514 * @param pDfvObj Pointer to DfvObj instance. 00515 * @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file. 00516 */ 00517 DFVINTERFACE_API void dfv_setPdfNoAddingOrChangingCommnets(CDfvObjPtr pDfvObj, long newVal); 00518 00519 /** 00520 * Effective when outputting to PDF. 00521 * Get disables adding comments and form fields to the PDF file. 00522 * 00523 * 00524 * @param pDfvObj Pointer to DfvObj instance. 00525 * @return If zero is returned, Enables adding comments and form fields to the PDF file. 00526 * If nonezero is returned, Disables adding comments and form fields to the PDF file. 00527 */ 00528 DFVINTERFACE_API long dfv_getPdfNoAddingOrChangingCommnets(CDfvObjPtr pDfvObj); 00529 00530 /** 00531 * Effective when outputting to PDF. 00532 * Disables adding comments and form fields to the PDF file. 00533 * 00534 * 00535 * @param pDfvObj Pointer to DfvObj instance. 00536 * @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file. 00537 */ 00538 DFVINTERFACE_API void dfv_setPdfNoAddingOrChangingComments(CDfvObjPtr pDfvObj, long newVal); 00539 00540 /** 00541 * Effective when outputting to PDF. 00542 * Get disables adding comments and form fields to the PDF file. 00543 * 00544 * 00545 * @param pDfvObj Pointer to DfvObj instance. 00546 * @return If zero is returned, Enables adding comments and form fields to the PDF file. 00547 * If nonezero is returned, Disables adding comments and form fields to the PDF file. 00548 */ 00549 DFVINTERFACE_API long dfv_getPdfNoAddingOrChangingComments(CDfvObjPtr pDfvObj); 00550 00551 /** 00552 * Effective when outputting to PDF. 00553 * Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5. 00554 * 00555 * 00556 * @param pDfvObj Pointer to DfvObj instance. 00557 * @param newVal Specifies the version of PDF. 00558 */ 00559 DFVINTERFACE_API void dfv_setPdfVersion(CDfvObjPtr pDfvObj, DfvPDFVERSION newVal); 00560 00561 /** 00562 * Effective when outputting to PDF. 00563 * Get the version of PDF. 00564 * 00565 * 00566 * @param pDfvObj Pointer to DfvObj instance. 00567 * @return the version of PDF. 00568 */ 00569 DFVINTERFACE_API DfvPDFVERSION dfv_getPdfVersion(CDfvObjPtr pDfvObj); 00570 00571 /** 00572 * Effective when outputting to PDF. 00573 * Disables filling in of form fields and signing of the PDF file. 00574 * This parameter is effective only when you specify PDF1.4 or later to PDF version. 00575 * 00576 * 00577 * @param pDfvObj Pointer to DfvObj instance. 00578 * @param newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file. 00579 */ 00580 DFVINTERFACE_API void dfv_setPdfNoFillForm(CDfvObjPtr pDfvObj, long newVal); 00581 00582 /** 00583 * Effective when outputting to PDF. 00584 * Get disables filling in of form fields and signing of the PDF file. 00585 * 00586 * 00587 * @param pDfvObj Pointer to DfvObj instance. 00588 * @return If zero is returned, Enables filling in of form fields and signing of the PDF file. 00589 * If nonezero is returned, Disables filling in of form fields and signing of the PDF file. 00590 */ 00591 DFVINTERFACE_API long dfv_getPdfNoFillForm(CDfvObjPtr pDfvObj); 00592 00593 /** 00594 * Effective when outputting to PDF. 00595 * Disables text access for screen reader devices of the PDF file. 00596 * This parameter is effective only when you specify 1.4 or later with PDF version. 00597 * 00598 * 00599 * @param pDfvObj Pointer to DfvObj instance. 00600 * @param newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file. 00601 */ 00602 DFVINTERFACE_API void dfv_setPdfNoAccessibility(CDfvObjPtr pDfvObj, long newVal); 00603 00604 /** 00605 * Effective when outputting to PDF. 00606 * Get disables text access for screen reader devices of the PDF file. 00607 * 00608 * 00609 * @param pDfvObj Pointer to DfvObj instance. 00610 * @return If zero is returned, Enables text access for screen reader devices of the PDF file. 00611 * If nonezero is returned, Disables text access for screen reader devices of the PDF file. 00612 */ 00613 DFVINTERFACE_API long dfv_getPdfNoAccessibility(CDfvObjPtr pDfvObj); 00614 00615 /** 00616 * Effective when outputting to PDF. 00617 * Disables inserting, deleting and rotating the PDF pages. 00618 * This parameter is effective only when you specify 1.4 or later with PDF version 00619 * 00620 * 00621 * @param pDfvObj Pointer to DfvObj instance. 00622 * @param newVal If nonezero is specified, Disables inserting, deleting and rotating the PDF pages. 00623 */ 00624 DFVINTERFACE_API void dfv_setPdfNoAssembleDoc(CDfvObjPtr pDfvObj, long newVal); 00625 00626 /** 00627 * Effective when outputting to PDF. 00628 * Get disables inserting, deleting and rotating the PDF pages. 00629 * 00630 * 00631 * @param pDfvObj Pointer to DfvObj instance. 00632 * @return If zero is returned, Enables inserting, deleting and rotating the PDF pages. 00633 * If nonezero is returned, Disables inserting, deleting and rotating the PDF pages. 00634 */ 00635 DFVINTERFACE_API long dfv_getPdfNoAssembleDoc(CDfvObjPtr pDfvObj); 00636 00637 /** 00638 * Effective when outputting to PDF. 00639 * Specifies the key length when encrypting the PDF file during outputting. 00640 * The key length can be specified as either 40 or 128 (bit). 00641 * This parameter is effective only when you specify PDF1.4 or later with PDF version 00642 * 00643 * 00644 * @param pDfvObj Pointer to DfvObj instance. 00645 * @param newVal Specifies the key length. 00646 */ 00647 DFVINTERFACE_API void dfv_setPdfEncryptLevel(CDfvObjPtr pDfvObj, DfvPDFENCRYPTLEVEL newVal); 00648 00649 /** 00650 * Effective when outputting to PDF. 00651 * Get the key length when encrypting the PDF file during outputting. 00652 * 00653 * 00654 * @param pDfvObj Pointer to DfvObj instance. 00655 * @return the key length. 00656 */ 00657 DFVINTERFACE_API DfvPDFENCRYPTLEVEL dfv_getPdfEncryptLevel(CDfvObjPtr pDfvObj); 00658 00659 /** 00660 * Effective when outputting to PDF. 00661 * Gets the value of whether to embed all embeddable fonts in PDF. 00662 * 00663 * 00664 * @param pDfvObj Pointer to DfvObj instance. 00665 * @return the value of whether to embed all embeddable fonts 00666 */ 00667 DFVINTERFACE_API long dfv_getPdfEmbedAllFonts(CDfvObjPtr pDfvObj); 00668 00669 /** 00670 * Effective when outputting to PDF. 00671 * Embeds all embeddable fonts in PDF to create. 00672 * 00673 * 00674 * @param pDfvObj Pointer to DfvObj instance. 00675 * @param newVal If the value is 'true' is specified, Embeds all embeddable fonts 00676 */ 00677 DFVINTERFACE_API void dfv_setPdfEmbedAllFonts(CDfvObjPtr pDfvObj, long newVal); 00678 00679 /** 00680 * Effective when outputting to PDF. 00681 * Gets the font specified to be embedded in PDF. 00682 * 00683 * 00684 * @param pDfvObj Pointer to DfvObj instance. 00685 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 00686 * the string is truncated and terminated with a NULL character. 00687 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00688 * @return Returns the 'pVal'. 00689 */ 00690 DFVINTERFACE_API char* dfv_getPdfEmbedFonts(CDfvObjPtr pDfvObj, char* pVal, int size); 00691 00692 /** 00693 * Effective when outputting to PDF. 00694 * Gets the font specified to be embedded in PDF. 00695 * 00696 * 00697 * @param pDfvObj Pointer to DfvObj instance. 00698 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 00699 * the string is truncated and terminated with a NULL character. 00700 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 00701 * @return Returns the 'pVal'. 00702 */ 00703 DFVINTERFACE_API wchar_t* dfv_getPdfEmbedFontsW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 00704 00705 /** 00706 * Effective when outputting to PDF. 00707 * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts. 00708 * 00709 * 00710 * @param pDfvObj Pointer to DfvObj instance. 00711 * @param newVal fonts specified to embed 00712 */ 00713 DFVINTERFACE_API void dfv_setPdfEmbedFonts(CDfvObjPtr pDfvObj, const char* newVal); 00714 00715 /** 00716 * Effective when outputting to PDF. 00717 * Embeds the specified font in PDF to create. If you want to specify plural fonts, put commas between fonts. 00718 * 00719 * 00720 * @param pDfvObj Pointer to DfvObj instance. 00721 * @param newVal fonts specified to embed 00722 */ 00723 DFVINTERFACE_API void dfv_setPdfEmbedFontsW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 00724 00725 /** 00726 * Effective when outputting to PDF. 00727 * Gets the value of whether to issues the error when failing to embed fonts. 00728 * 00729 * 00730 * @param pDfvObj Pointer to DfvObj instance. 00731 * @return the value of whether to issues the error 00732 */ 00733 DFVINTERFACE_API long dfv_getPdfErrorOnEmbedFault(CDfvObjPtr pDfvObj); 00734 00735 /** 00736 * Effective when outputting to PDF. 00737 * An error is issued in case of failing to embed fonts. 00738 * 00739 * 00740 * @param pDfvObj Pointer to DfvObj instance. 00741 * @param newVal If the value is 'true' is specified, an error is issued. 00742 */ 00743 DFVINTERFACE_API void dfv_setPdfErrorOnEmbedFault(CDfvObjPtr pDfvObj, long newVal); 00744 00745 /** 00746 * Effective when outputting to PDF. 00747 * Gets the value of whether to issues the error when missing glyph. 00748 * 00749 * 00750 * @param pDfvObj Pointer to DfvObj instance. 00751 * @return the value of whether to issues the error 00752 */ 00753 DFVINTERFACE_API long dfv_getPdfErrorOnMissingGlyph(CDfvObjPtr pDfvObj); 00754 00755 /** 00756 * Effective when outputting to PDF. 00757 * An error is issued in case of missing glyph. 00758 * 00759 * 00760 * @param pDfvObj Pointer to DfvObj instance. 00761 * @param newVal If the value is 'true' is specified, an error is issued. 00762 */ 00763 DFVINTERFACE_API void dfv_setPdfErrorOnMissingGlyph(CDfvObjPtr pDfvObj, long newVal); 00764 00765 /** 00766 * Effective when outputting to PDF. 00767 * Gets the value of whether to print the resulting PDF file or not. 00768 * 00769 * 00770 * <table border="0" cellspacing="0" cellpadding="0"> 00771 * <tr><td>PRALLOW_NONE </td><td>= 0 Not Allowed</td></tr> 00772 * <tr><td>PRALLOW_LOW </td><td>= 1 Low Resolution Printing</td></tr> 00773 * <tr><td>PRALLOW_HIGH </td><td>= 2 High Resolution Printing</td></tr> 00774 * </table> 00775 * 00776 * @param pDfvObj Pointer to DfvObj instance. 00777 * @return the value of printing allowed 00778 */ 00779 DFVINTERFACE_API DfvPDFPRINTALLOW dfv_getPdfPrintingAllowed(CDfvObjPtr pDfvObj); 00780 00781 /** 00782 * Effective when outputting to PDF. 00783 * Spesifies whether to permit printing PDF to create with one of the following values. 00784 * This parameter is effective only when you specify PDF1.4 or later to PDF version (setPdfVersion). 00785 * 00786 * 00787 * <table border="0" cellspacing="0" cellpadding="0"> 00788 * <tr><td>PRALLOW_NONE </td><td>= 0 Not Allowed</td></tr> 00789 * <tr><td>PRALLOW_LOW </td><td>= 1 Low Resolution Printing</td></tr> 00790 * <tr><td>PRALLOW_HIGH </td><td>= 2 High Resolution Printing</td></tr> 00791 * </table> 00792 * 00793 * @param pDfvObj Pointer to DfvObj instance. 00794 * @param newVal the value of printing allowed 00795 */ 00796 DFVINTERFACE_API void dfv_setPdfPrintingAllowed(CDfvObjPtr pDfvObj, DfvPDFPRINTALLOW newVal); 00797 00798 /** 00799 * Effective when outputting to PDF. 00800 * Gets the value of how to compress the color images embedded in PDF. 00801 * 00802 * 00803 * <table border="0" cellspacing="0" cellpadding="0"> 00804 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 00805 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 00806 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 00807 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 00808 * </table> 00809 * 00810 * @param pDfvObj Pointer to DfvObj instance. 00811 * @return the value of how raster graphics are compressed and stored 00812 */ 00813 DFVINTERFACE_API DfvPDFIMAGECOMPRESSION dfv_getPdfImageCompression(CDfvObjPtr pDfvObj); 00814 00815 /** 00816 * Effective when outputting to PDF. 00817 * 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> 00818 * 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> 00819 This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfMonochromeImageCompression for the monochrome image. 00820 * 00821 * 00822 * <table border="0" cellspacing="0" cellpadding="0"> 00823 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 00824 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 00825 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 00826 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 00827 * </table> 00828 * 00829 * @param pDfvObj Pointer to DfvObj instance. 00830 * @param newVal the value of how raster graphics are compressed and stored 00831 */ 00832 DFVINTERFACE_API void dfv_setPdfImageCompression(CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal); 00833 00834 /** 00835 * Gets the value of the quality of JPEG format that is specified by dfv_setPdfImageCompression() stored in PDF. 00836 * 00837 * 00838 * @param pDfvObj Pointer to DfvObj instance. 00839 * @return the value of the quality of JPEG format 00840 */ 00841 DFVINTERFACE_API int dfv_getPdfJPEGQuality(CDfvObjPtr pDfvObj); 00842 00843 /** 00844 * Effective when outputting to PDF. 00845 * 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> 00846 * CAUTION: It is not for changing the quality of a JPEG format image.<BR> 00847 * This is the setting for the color image. Spesify setPdfGrayscaleJPEGQuality for the grayscale image. 00848 * 00849 * 00850 * @param pDfvObj Pointer to DfvObj instance. 00851 * @param newVal the value of the quality of JPEG format 00852 */ 00853 DFVINTERFACE_API void dfv_setPdfJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 00854 00855 /** 00856 * Effective when outputting to PDF. 00857 * 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. 00858 * 00859 * 00860 * @param pDfvObj Pointer to DfvObj instance. 00861 * @return the value of whether make the size of PDF smaller or not 00862 */ 00863 DFVINTERFACE_API long dfv_getPdfCompressContentStream(CDfvObjPtr pDfvObj); 00864 00865 /** 00866 * Effective when outputting to PDF. 00867 * Specifies whether the text and the line art in PDF are compressed in order to make the size of PDF smaller or not. 00868 * 00869 * 00870 * @param pDfvObj Pointer to DfvObj instance. 00871 * @param newVal If the value is 'true' is specified, make the PDF compress 00872 */ 00873 DFVINTERFACE_API void dfv_setPdfCompressContentStream(CDfvObjPtr pDfvObj, long newVal); 00874 00875 /** 00876 * Effective when outputting to PDF. 00877 * Gets the value of how to transform external link specified by the relative address in the PDF link. 00878 * 00879 * 00880 * @param pDfvObj Pointer to DfvObj instance. 00881 * @return the value of how to transform external link 00882 */ 00883 DFVINTERFACE_API long dfv_getPdfUseLaunchForRelativeURI(CDfvObjPtr pDfvObj); 00884 00885 /** 00886 * Effective when outputting to PDF. 00887 * 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. 00888 * 00889 * 00890 * @param pDfvObj Pointer to DfvObj instance. 00891 * @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' 00892 */ 00893 DFVINTERFACE_API void dfv_setPdfUseLaunchForRelativeURI(CDfvObjPtr pDfvObj, long newVal); 00894 00895 /** 00896 * Effective when outputting to PDF. 00897 * Gets the value of how to convert the RGB color space (DebiceRGB) to DeviceGray. 00898 * 00899 * 00900 * <table border="0" cellspacing="0" cellpadding="0"> 00901 * <tr><td>RGBCONV_NONE </td><td>= 0 No Conversion</td></tr> 00902 * <tr><td>RGBCONV_BLACK </td><td>= 1 Black to DeviceGray</td></tr> 00903 * <tr><td>RGBCONV_GRAY </td><td>= 2 Gray to DeviceGray</td></tr> 00904 * <tr><td>RGBCONV_ALL </td><td>= 3 All RGB to DeviceGray</td></tr> 00905 * </table> 00906 * 00907 * @param pDfvObj Pointer to DfvObj instance. 00908 * @return the value of how to convert 00909 */ 00910 DFVINTERFACE_API DfvPDFRGBCONVERSION dfv_getPdfRGBConversion(CDfvObjPtr pDfvObj); 00911 00912 /** 00913 * Effective when outputting to PDF. 00914 * Specifies how to convert the RGB color space (DeviceRGB) to DeviceGray. 00915 * 00916 * 00917 * <table border="0" cellspacing="0" cellpadding="0"> 00918 * <tr><td>RGBCONV_NONE </td><td>= 0 No Conversion</td></tr> 00919 * <tr><td>RGBCONV_BLACK </td><td>= 1 Black to DeviceGray</td></tr> 00920 * <tr><td>RGBCONV_GRAY </td><td>= 2 Gray to DeviceGray</td></tr> 00921 * <tr><td>RGBCONV_ALL </td><td>= 3 All RGB to DeviceGray</td></tr> 00922 * </table> 00923 * 00924 * @param pDfvObj Pointer to DfvObj instance. 00925 * @param newVal the value of how to convert 00926 */ 00927 DFVINTERFACE_API void dfv_setPdfRGBConversion(CDfvObjPtr pDfvObj, DfvPDFRGBCONVERSION newVal); 00928 00929 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 00930 00931 /** 00932 * Effective when outputting to PDF. 00933 * Gets the value of the rasterised-resolution of the transformed raster images. 00934 * 00935 * 00936 * @param pDfvObj Pointer to DfvObj instance. 00937 * @return Rasterised-resolution 00938 */ 00939 DFVINTERFACE_API int dfv_getPdfRasterizeResolution(CDfvObjPtr pDfvObj); 00940 00941 /** 00942 * Effective when outputting to PDF. 00943 * 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. 00944 * This setting is effective only with Windows version. 00945 * 00946 * 00947 * @param pDfvObj Pointer to DfvObj instance. 00948 * @param newVal Rasterised-resolution (70 to 500) 00949 */ 00950 DFVINTERFACE_API void dfv_setPdfRasterizeResolution(CDfvObjPtr pDfvObj, int newVal); 00951 00952 #endif 00953 00954 /** 00955 * Effective when outputting to PDF. 00956 * Gets the value of whether to output linearize PDF or not. 00957 * 00958 * 00959 * @param pDfvObj Pointer to DfvObj instance. 00960 * @return the value of whether to output linearize pdf or not. 00961 */ 00962 DFVINTERFACE_API long dfv_getPdfLinearize(CDfvObjPtr pDfvObj); 00963 00964 /** 00965 * Effective when outputting to PDF. 00966 * Specifies whether to output linearize PDF or not. 00967 * 00968 * 00969 * @param pDfvObj Pointer to DfvObj instance. 00970 * @param newVal If the value is 'true' is specified, output linearlize PDF. 00971 */ 00972 DFVINTERFACE_API void dfv_setPdfLinearize(CDfvObjPtr pDfvObj, long newVal); 00973 00974 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 00975 00976 /** 00977 * Effective when outputting to PDF. 00978 * Gets the value of whether to sign a signature to PDF or not. 00979 * 00980 * 00981 * @param pDfvObj Pointer to DfvObj instance. 00982 * @return the value of whether to sign a signature to PDF or not. 00983 */ 00984 DFVINTERFACE_API long dfv_getPdfSignature(CDfvObjPtr pDfvObj); 00985 00986 /** 00987 * Effective when outputting to PDF. 00988 * Specifies whether to sign a signature to PDF or not. 00989 * 00990 * 00991 * @param pDfvObj Pointer to DfvObj instance. 00992 * @param newVal If the value is 'true' is specified, sign a signature to PDF. 00993 */ 00994 DFVINTERFACE_API void dfv_setPdfSignature(CDfvObjPtr pDfvObj, long newVal); 00995 00996 /** 00997 * Effective when outputting to PDF. 00998 * Gets the value of a signature information name. 00999 * 01000 * 01001 * @param pDfvObj Pointer to DfvObj instance. 01002 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 01003 * the string is truncated and terminated with a NULL character. 01004 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01005 * @return the value of a signature information name. 01006 */ 01007 DFVINTERFACE_API char* dfv_getPdfSignatureName(CDfvObjPtr pDfvObj, char* pVal, int size); 01008 01009 /** 01010 * Effective when outputting to PDF. 01011 * Gets the value of a signature information name. 01012 * 01013 * 01014 * @param pDfvObj Pointer to DfvObj instance. 01015 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 01016 * the string is truncated and terminated with a NULL character. 01017 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01018 * @return the value of a signature information name. 01019 */ 01020 DFVINTERFACE_API wchar_t* dfv_getPdfSignatureNameW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01021 01022 /** 01023 * Effective when outputting to PDF. 01024 * Sets a signature information name. 01025 * 01026 * 01027 * @param pDfvObj Pointer to DfvObj instance. 01028 * @param newVal the value of a signature information name. 01029 */ 01030 DFVINTERFACE_API void dfv_setPdfSignatureName(CDfvObjPtr pDfvObj, const char* newVal); 01031 01032 /** 01033 * Effective when outputting to PDF. 01034 * Sets a signature information name. 01035 * 01036 * 01037 * @param pDfvObj Pointer to DfvObj instance. 01038 * @param newVal the value of a signature information name. 01039 */ 01040 DFVINTERFACE_API void dfv_setPdfSignatureNameW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01041 01042 /** 01043 * Effective when outputting to PDF. 01044 * Gets the value of a certificate information name. 01045 * 01046 * 01047 * @param pDfvObj Pointer to DfvObj instance. 01048 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 01049 * the string is truncated and terminated with a NULL character. 01050 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01051 * @return the value of a certificate information name. 01052 */ 01053 DFVINTERFACE_API char* dfv_getPdfCertificateName(CDfvObjPtr pDfvObj, char* pVal, int size); 01054 01055 /** 01056 * Effective when outputting to PDF. 01057 * Gets the value of a certificate information name. 01058 * 01059 * 01060 * @param pDfvObj Pointer to DfvObj instance. 01061 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 01062 * the string is truncated and terminated with a NULL character. 01063 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01064 * @return the value of a certificate information name. 01065 */ 01066 DFVINTERFACE_API wchar_t* dfv_getPdfCertificateNameW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01067 01068 /** 01069 * Effective when outputting to PDF. 01070 * Sets a certificate information name. 01071 * 01072 * 01073 * @param pDfvObj Pointer to DfvObj instance. 01074 * @param newVal the value of a certificate information name. 01075 */ 01076 DFVINTERFACE_API void dfv_setPdfCertificateName(CDfvObjPtr pDfvObj, const char* newVal); 01077 01078 /** 01079 * Effective when outputting to PDF. 01080 * Sets a certificate information name. 01081 * 01082 * 01083 * @param pDfvObj Pointer to DfvObj instance. 01084 * @param newVal the value of a certificate information name. 01085 */ 01086 DFVINTERFACE_API void dfv_setPdfCertificateNameW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01087 01088 #endif 01089 01090 /** 01091 * Effective when outputting to PDF. 01092 * Gets the value of whether to embed all embeddable fonts 01093 * 01094 * 01095 * <table border="0" cellspacing="0" cellpadding="0"> 01096 * <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr> 01097 * <tr><td>EMBALLFONT_ALL </td><td>= 1 All fonts except Base14 fonts</td></tr> 01098 * <tr><td>EMBALLFONT_BASE14 </td><td>= 2 All fonts</td></tr> 01099 * </table> 01100 * 01101 * @param pDfvObj Pointer to DfvObj instance. 01102 * @return the value of whether to embed all embeddable fonts 01103 */ 01104 DFVINTERFACE_API DfvEMBEDALLFONT dfv_getPdfEmbedAllFontsEx(CDfvObjPtr pDfvObj); 01105 01106 /** 01107 * Effective when outputting to PDF. 01108 * 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. 01109 * 01110 * 01111 * <table border="0" cellspacing="0" cellpadding="0"> 01112 * <tr><td>EMBALLFONT_PART </td><td>= 0 Specified fonts </td></tr> 01113 * <tr><td>EMBALLFONT_ALL </td><td>= 1 All fonts except Base14 fonts</td></tr> 01114 * <tr><td>EMBALLFONT_BASE14 </td><td>= 2 All fonts</td></tr> 01115 * </table> 01116 * 01117 *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. 01118 * 01119 * @param pDfvObj Pointer to DfvObj instance. 01120 * @param newVal the value of whether to embed all embeddable fonts 01121 */ 01122 DFVINTERFACE_API void dfv_setPdfEmbedAllFontsEx(CDfvObjPtr pDfvObj, DfvEMBEDALLFONT newVal); 01123 01124 /** 01125 * Effective when outputting to PDF. 01126 * Gets the value of method to downsample the color image 01127 * 01128 * 01129 * @param pDfvObj Pointer to DfvObj instance. 01130 * @return the value of method to downsample the color image 01131 */ 01132 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfImageDownSampling(CDfvObjPtr pDfvObj); 01133 01134 /** 01135 * Effective when outputting to PDF. 01136 * Specifies the following either of method to downsample the color image that is put into PDF. 01137 * 01138 * 01139 * <table border="0" cellspacing="0" cellpadding="0"> 01140 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01141 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01142 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01143 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01144 * </table> 01145 * 01146 * 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. 01147 This is the setting for the color image. Spesify dfv_setPdfGrayscaleImageDownSampling for the grayscale image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image. 01148 * 01149 * @param pDfvObj Pointer to DfvObj instance. 01150 * @param newVal the value of method to downsample the color image 01151 */ 01152 DFVINTERFACE_API void dfv_setPdfImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01153 01154 /** 01155 * Effective when outputting to PDF. 01156 * Gets resolution when the color image is downsampled. 01157 * 01158 * 01159 * @param pDfvObj Pointer to DfvObj instance. 01160 * @return the value of resolution. 01161 */ 01162 DFVINTERFACE_API int dfv_getPdfImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01163 01164 /** 01165 * Effective when outputting to PDF. 01166 * Set resolution when the color image is downsampled. 01167 * 01168 * 01169 * @param pDfvObj Pointer to DfvObj instance. 01170 * @param newVal the value of resolution. 01171 */ 01172 DFVINTERFACE_API void dfv_setPdfImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01173 01174 /** 01175 * Effective when outputting to PDF. 01176 * Gets resolution of the color image which performs a downsampling. 01177 * 01178 * 01179 * @param pDfvObj Pointer to DfvObj instance. 01180 * @return the value of resolution. 01181 */ 01182 DFVINTERFACE_API int dfv_getPdfImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01183 01184 /** 01185 * Effective when outputting to PDF. 01186 * Set resolution of the color image which performs a downsampling. 01187 * 01188 * 01189 * @param pDfvObj Pointer to DfvObj instance. 01190 * @param newVal the value of resolution. 01191 */ 01192 DFVINTERFACE_API void dfv_setPdfImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01193 01194 /** 01195 * Effective when outputting to PDF. 01196 * Gets specification whether to embed to PDF the color profile of the color image that will be embedded to PDF. 01197 * 01198 * 01199 * 01200 * @param pDfvObj Pointer to DfvObj instance. 01201 * @return If nonezero is specified, it is embedded. If zero is specified, it is not embedded. 01202 */ 01203 DFVINTERFACE_API long dfv_getPdfPutImageColorProfile(CDfvObjPtr pDfvObj); 01204 01205 /** 01206 * Effective when outputting to PDF. 01207 * Specifies whether to embed to PDF the color profile of the color image that will be embedded to PDF. 01208 * 01209 * 01210 * @param pDfvObj Pointer to DfvObj instance. 01211 * @param newVal If nonezero is specified, it is embedded. If zero is specified, it is not embedded. 01212 */ 01213 DFVINTERFACE_API void dfv_setPdfPutImageColorProfile(CDfvObjPtr pDfvObj, long newVal); 01214 01215 /** 01216 * Effective when outputting to PDF. 01217 * Gets the value of how to compress the grayscale images embedded in PDF. 01218 * 01219 * 01220 * <table border="0" cellspacing="0" cellpadding="0"> 01221 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 01222 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 01223 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 01224 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 01225 * </table> 01226 * 01227 * @param pDfvObj Pointer to DfvObj instance. 01228 * @return the value of how raster graphics are compressed and stored 01229 */ 01230 DFVINTERFACE_API DfvPDFIMAGECOMPRESSION dfv_getPdfGrayscaleImageCompression(CDfvObjPtr pDfvObj); 01231 01232 /** 01233 * Effective when outputting to PDF. 01234 * 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> 01235 * 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> 01236 This is the setting for the grayscale image. Spesify dfv_setPdfImageCompression for the color image, and dfv_setPdfMonochromeImageCompression for the monochrome image. 01237 * 01238 * 01239 * <table border="0" cellspacing="0" cellpadding="0"> 01240 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto</td></tr> 01241 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG compression</td></tr> 01242 * <tr><td>IMGCMPR_ZLIB </td><td>= 2 ZLIB compression</td></tr> 01243 * <tr><td>IMGCMPR_JPEG2K </td><td>= 3 JPEG2000 compression</td></tr> 01244 * </table> 01245 * 01246 * @param pDfvObj Pointer to DfvObj instance. 01247 * @param newVal the value of how raster graphics are compressed and stored 01248 */ 01249 DFVINTERFACE_API void dfv_setPdfGrayscaleImageCompression(CDfvObjPtr pDfvObj, DfvPDFIMAGECOMPRESSION newVal); 01250 01251 /** 01252 * Effective when outputting to PDF. 01253 * Gets the value of the quality of JPEG format that is specified by dfv_setPdfGrayscaleImageCompression stored in PDF. 01254 * 01255 * 01256 * @param pDfvObj Pointer to DfvObj instance. 01257 * @return the value of the quality of JPEG format 01258 */ 01259 DFVINTERFACE_API int dfv_getPdfGrayscaleJPEGQuality(CDfvObjPtr pDfvObj); 01260 01261 /** 01262 * Effective when outputting to PDF. 01263 * 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> 01264 * CAUTION: It is not for changing the quality of a JPEG format image.<BR> 01265 * This is the setting for the grayscale image. Spesify dfv_setPdfJPEGQuality for the color image. 01266 * 01267 * 01268 * @param pDfvObj Pointer to DfvObj instance. 01269 * @param newVal the value of the quality of JPEG format 01270 */ 01271 DFVINTERFACE_API void dfv_setPdfGrayscaleJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 01272 01273 /** 01274 * Effective when outputting to PDF. 01275 * Gets the value of method to downsample the grayscale image 01276 * 01277 * 01278 * @param pDfvObj Pointer to DfvObj instance. 01279 * @return the value of method to downsample the grayscale image 01280 */ 01281 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfGrayscaleImageDownSampling(CDfvObjPtr pDfvObj); 01282 01283 /** 01284 * Effective when outputting to PDF. 01285 * 01286 * 01287 * @param pDfvObj Pointer to DfvObj instance. 01288 * @param newVal 01289 */ 01290 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01291 01292 /** 01293 * Effective when outputting to PDF. 01294 * Gets resolution when the grayscale image is downsampled. 01295 * 01296 * 01297 * @param pDfvObj Pointer to DfvObj instance. 01298 * @return the value of resolution. 01299 */ 01300 DFVINTERFACE_API int dfv_getPdfGrayscaleImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01301 01302 /** 01303 * Effective when outputting to PDF. 01304 * Specifies the following either of method to downsample the grayscale image that is put into PDF. 01305 * 01306 * 01307 * <table border="0" cellspacing="0" cellpadding="0"> 01308 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01309 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01310 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01311 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01312 * </table> 01313 * 01314 * 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. 01315 This is the setting for the grayscale image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfMonochromeImageDownSampling for the monochrome image. 01316 * 01317 * @param pDfvObj Pointer to DfvObj instance. 01318 * @param newVal the value of method to downsample the grayscale image 01319 */ 01320 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01321 01322 /** 01323 * Effective when outputting to PDF. 01324 * Gets resolution of the grayscale image which performs a downsampling. 01325 * 01326 * 01327 * @param pDfvObj Pointer to DfvObj instance. 01328 * @return the value of resolution. 01329 */ 01330 DFVINTERFACE_API int dfv_getPdfGrayscaleImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01331 01332 /** 01333 * Effective when outputting to PDF. 01334 * Set resolution of the grayscale image which performs a downsampling. 01335 * 01336 * 01337 * @param pDfvObj Pointer to DfvObj instance. 01338 * @param newVal the value of resolution. 01339 */ 01340 DFVINTERFACE_API void dfv_setPdfGrayscaleImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01341 01342 /** 01343 * Effective when outputting to PDF. 01344 * Gets the value of how to compress the monochrome images embedded in PDF. 01345 * 01346 * 01347 * <table border="0" cellspacing="0" cellpadding="0"> 01348 * <tr><td>MONOCMPR_CCITT4 </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr> 01349 * <tr><td>MONOCMPR_CCITT3 </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr> 01350 * <tr><td>MONOCMPR_RUNLENGTH </td><td>= 2 RunLengthDecode filter</td></tr> 01351 * <tr><td>MONOCMPR_ZLIB </td><td>= 3 FlateDecode filter</td></tr> 01352 * <tr><td>MONOCMPR_OFF </td><td>= 4 no filter</td></tr> 01353 * </table> 01354 * 01355 * @param pDfvObj Pointer to DfvObj instance. 01356 * @return the value of how raster graphics are compressed and stored 01357 */ 01358 DFVINTERFACE_API DfvMONOCHROMECOMPRESSION dfv_getPdfMonochromeImageCompression(CDfvObjPtr pDfvObj); 01359 01360 /** 01361 * Effective when outputting to PDF. 01362 * 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> 01363 This is the setting for the monochrome image. Spesify dfv_setPdfGrayscaleImageCompression for the grayscale image, and dfv_setPdfImageCompression for the color image. 01364 * 01365 * 01366 * <table border="0" cellspacing="0" cellpadding="0"> 01367 * <tr><td>MONOCMPR_CCITT4 </td><td>= 0 CCITTFaxDecode group 4 filter,default value</td></tr> 01368 * <tr><td>MONOCMPR_CCITT3 </td><td>= 1 CCITTFaxDecode group 3 filter</td></tr> 01369 * <tr><td>MONOCMPR_RUNLENGTH </td><td>= 2 RunLengthDecode filter</td></tr> 01370 * <tr><td>MONOCMPR_ZLIB </td><td>= 3 FlateDecode filter</td></tr> 01371 * <tr><td>MONOCMPR_OFF </td><td>= 4 no filter</td></tr> 01372 * </table> 01373 * 01374 * @param pDfvObj Pointer to DfvObj instance. 01375 * @param newVal the value of how raster graphics are compressed and stored 01376 */ 01377 DFVINTERFACE_API void dfv_setPdfMonochromeImageCompression(CDfvObjPtr pDfvObj, DfvMONOCHROMECOMPRESSION newVal); 01378 01379 /** 01380 * Effective when outputting to PDF. 01381 * Gets the value of method to downsample the monochrome image 01382 * 01383 * 01384 * @param pDfvObj Pointer to DfvObj instance. 01385 * @return the value of method to downsample the monochrome image 01386 */ 01387 DFVINTERFACE_API DfvIMAGEDOWNSAMPLING dfv_getPdfMonochromeImageDownSampling(CDfvObjPtr pDfvObj); 01388 01389 /** 01390 * Effective when outputting to PDF. 01391 * Specifies the following either of method to downsample the monochrome image that is put into PDF. 01392 * 01393 * 01394 * <table border="0" cellspacing="0" cellpadding="0"> 01395 * <tr><td>IMGDOWNSAMPLING_NONE </td><td>= 0 No downsampling </td></tr> 01396 * <tr><td>IMGDOWNSAMPLING_AVERAGE </td><td>= 1 Average downsamplin</td></tr> 01397 * <tr><td>IMGDOWNSAMPLING_BICUBIC </td><td>= 2 Bicubic downsampling</td></tr> 01398 * <tr><td>IMGDOWNSAMPLING_SUBSAMPLING </td><td>= 3 Subsampling</td></tr> 01399 * </table> 01400 * 01401 * 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. 01402 This is the setting for the monochrome image. Spesify dfv_setPdfImageDownSampling for the color image, and dfv_setPdfGrayscaleImageDownSampling for the grayscale image. 01403 * 01404 * @param pDfvObj Pointer to DfvObj instance. 01405 * @param newVal the value of method to downsample the monochrome image 01406 */ 01407 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSampling(CDfvObjPtr pDfvObj, DfvIMAGEDOWNSAMPLING newVal); 01408 01409 /** 01410 * Effective when outputting to PDF. 01411 * Gets resolution when the monochrome image is downsampled. 01412 * 01413 * 01414 * @param pDfvObj Pointer to DfvObj instance. 01415 * @return the value of resolution. 01416 */ 01417 DFVINTERFACE_API int dfv_getPdfMonochromeImageDownSamplingTarget(CDfvObjPtr pDfvObj); 01418 01419 /** 01420 * Effective when outputting to PDF. 01421 * Set resolution when the monochrome image is downsampled. 01422 * 01423 * 01424 * @param pDfvObj Pointer to DfvObj instance. 01425 * @param newVal the value of resolution. 01426 */ 01427 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSamplingTarget(CDfvObjPtr pDfvObj, int newVal); 01428 01429 /** 01430 * Effective when outputting to PDF. 01431 * Gets resolution of the monochrome image which performs a downsampling. 01432 * 01433 * 01434 * @param pDfvObj Pointer to DfvObj instance. 01435 * @return the value of resolution. 01436 */ 01437 DFVINTERFACE_API int dfv_getPdfMonochromeImageDownSamplingDPI(CDfvObjPtr pDfvObj); 01438 01439 /** 01440 * Effective when outputting to PDF. 01441 * Set resolution of the monochrome image which performs a downsampling. 01442 * 01443 * 01444 * @param pDfvObj Pointer to DfvObj instance. 01445 * @param newVal the value of resolution. 01446 */ 01447 DFVINTERFACE_API void dfv_setPdfMonochromeImageDownSamplingDPI(CDfvObjPtr pDfvObj, int newVal); 01448 01449 /** 01450 * Effective when outputting to PDF. 01451 * Gets the width of PDF to output. 01452 * 01453 * 01454 * @param pDfvObj Pointer to DfvObj instance. 01455 * @param pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, 01456 * the string is truncated and terminated with a NULL character. 01457 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01458 * @return Returns the 'pVal'. 01459 */ 01460 DFVINTERFACE_API char* dfv_getPdfOutputWidth(CDfvObjPtr pDfvObj, char* pVal, int size); 01461 01462 /** 01463 * Effective when outputting to PDF. 01464 * Gets the width of PDF to output. 01465 * 01466 * 01467 * @param pDfvObj Pointer to DfvObj instance. 01468 * @param pVal Pointer to the buffer that will receive the width of PDF. If the string is as long or longer than the buffer, 01469 * the string is truncated and terminated with a NULL character. 01470 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01471 * @return Returns the 'pVal'. 01472 */ 01473 DFVINTERFACE_API wchar_t* dfv_getPdfOutputWidthW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01474 01475 /** 01476 * Effective when outputting to PDF. 01477 * Scales the width of PDF to output. A value with a unit or % value can be specified as length. 01478 * 01479 * 01480 * @param pDfvObj Pointer to DfvObj instance. 01481 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01482 */ 01483 DFVINTERFACE_API void dfv_setPdfOutputWidth(CDfvObjPtr pDfvObj, const char* newVal); 01484 01485 /** 01486 * Effective when outputting to PDF. 01487 * Scales the width of PDF to output. A value with a unit or % value can be specified as length. 01488 * 01489 * 01490 * @param pDfvObj Pointer to DfvObj instance. 01491 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01492 */ 01493 DFVINTERFACE_API void dfv_setPdfOutputWidthW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01494 01495 /** 01496 * Effective when outputting to PDF. 01497 * Gets the height of PDF to output. 01498 * 01499 * 01500 * @param pDfvObj Pointer to DfvObj instance. 01501 * @param pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, 01502 * the string is truncated and terminated with a NULL character. 01503 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01504 * @return Returns the 'pVal'. 01505 */ 01506 DFVINTERFACE_API char* dfv_getPdfOutputHeight(CDfvObjPtr pDfvObj, char* pVal, int size); 01507 01508 /** 01509 * Effective when outputting to PDF. 01510 * Gets the height of PDF to output. 01511 * 01512 * 01513 * @param pDfvObj Pointer to DfvObj instance. 01514 * @param pVal Pointer to the buffer that will receive the height of PDF. If the string is as long or longer than the buffer, 01515 * the string is truncated and terminated with a NULL character. 01516 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01517 * @return Returns the 'pVal'. 01518 */ 01519 DFVINTERFACE_API wchar_t* dfv_getPdfOutputHeightW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01520 01521 /** 01522 * Effective when outputting to PDF. 01523 * Scales the height of PDF to output. A value with a unit or % value can be specified as length. 01524 * 01525 * 01526 * @param pDfvObj Pointer to DfvObj instance. 01527 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01528 */ 01529 DFVINTERFACE_API void dfv_setPdfOutputHeight(CDfvObjPtr pDfvObj, const char* newVal); 01530 01531 /** 01532 * Effective when outputting to PDF. 01533 * Scales the height of PDF to output. A value with a unit or % value can be specified as length. 01534 * 01535 * 01536 * @param pDfvObj Pointer to DfvObj instance. 01537 * @param newVal Pointer to a null-terminated string to be used as the width of PDF to output. 01538 */ 01539 DFVINTERFACE_API void dfv_setPdfOutputHeightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01540 01541 /** 01542 * Effective when outputting to PDF. 01543 * Gets the value of whether to issue error or not when PDF/X is generating. 01544 * 01545 * 01546 * @param pDfvObj Pointer to DfvObj instance. 01547 * @return the value of whether to issue error. 01548 */ 01549 DFVINTERFACE_API long dfv_getPdfErrorOnPDFXFault(CDfvObjPtr pDfvObj); 01550 01551 /** 01552 * Effective when outputting to PDF. 01553 * An error is not issued when PDF/X is generating. 01554 * 01555 * 01556 * @param pDfvObj Pointer to DfvObj instance. 01557 * @param newVal If the value is 'true' is specified, no error is issued. 01558 */ 01559 DFVINTERFACE_API void dfv_setPdfErrorOnPDFXFault(CDfvObjPtr pDfvObj, long newVal); 01560 01561 /** 01562 * Effective when outputting to SVG. 01563 * Get the version of SVG. 01564 * 01565 * 01566 * @param pDfvObj Pointer to DfvObj instance. 01567 * @return the version of SVG. 01568 */ 01569 DFVINTERFACE_API DfvSVGVERSION dfv_getSvgVersion(CDfvObjPtr pDfvObj); 01570 01571 /** 01572 * Effective when outputting to SVG. 01573 * Enables specifying whether the version of SVG is 1.1, Basic or Tiny. 01574 * 01575 * 01576 * @param pDfvObj Pointer to DfvObj instance. 01577 * @param newVal Specifies the version of SVG. 01578 */ 01579 DFVINTERFACE_API void dfv_setSvgVersion(CDfvObjPtr pDfvObj, DfvSVGVERSION newVal); 01580 01581 /** 01582 * Effective when outputting to SVG. 01583 * Gets the setting indicating whether to compress the outputted SVG into gzip format or not. 01584 * 01585 * 01586 * @param pDfvObj Pointer to DfvObj instance. 01587 * @return whether gzip compression or not. 01588 */ 01589 DFVINTERFACE_API long dfv_getSvgGzipCompression(CDfvObjPtr pDfvObj); 01590 01591 /** 01592 * Effective when outputting to SVG. 01593 * Specifies whether to compress the outputted SVG into gzip format or not. 01594 * 01595 * 01596 * @param pDfvObj Pointer to DfvObj instance. 01597 * @param newVal If the value is 'true' is specified, enables to compress data into gzip format. 01598 */ 01599 DFVINTERFACE_API void dfv_setSvgGzipCompression(CDfvObjPtr pDfvObj, long newVal); 01600 01601 /** 01602 * Effective when outputting to SVG. 01603 * Gets the setting indicating whether to embed fonts in the outputted SVG. 01604 * 01605 * 01606 * @param pDfvObj Pointer to DfvObj instance. 01607 * @return whether embeds fonts or not. 01608 */ 01609 DFVINTERFACE_API long dfv_getSvgEmbedAllFonts(CDfvObjPtr pDfvObj); 01610 01611 /** 01612 * Effective when outputting to SVG. 01613 * Specifies whether to embed fonts in the outputted SVG. 01614 * 01615 * 01616 * @param pDfvObj Pointer to DfvObj instance. 01617 * @param newVal If the value is 'true' is specified, embeds fonts. 01618 */ 01619 DFVINTERFACE_API void dfv_setSvgEmbedAllFonts(CDfvObjPtr pDfvObj, long newVal); 01620 01621 /** 01622 * Effective when outputting to SVG. 01623 * Gets the format for naming files when the outputted SVG becomes multiple. 01624 * 01625 * 01626 * @param pDfvObj Pointer to DfvObj instance. 01627 * @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. 01628 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01629 * @return Returns the 'pVal'. 01630 */ 01631 DFVINTERFACE_API char* dfv_getSvgFormat(CDfvObjPtr pDfvObj, char* pVal, int size); 01632 01633 /** 01634 * Effective when outputting to SVG. 01635 * Gets the format for naming files when the outputted SVG becomes multiple. 01636 * 01637 * 01638 * @param pDfvObj Pointer to DfvObj instance. 01639 * @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. 01640 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01641 * @return Returns the 'pVal'. 01642 */ 01643 DFVINTERFACE_API wchar_t* dfv_getSvgFormatW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01644 01645 /** 01646 * Effective when outputting to SVG. 01647 * Specifies the format for naming files when the outputted SVG becomes multiple. 01648 * 01649 * 01650 * @param pDfvObj Pointer to DfvObj instance. 01651 * @param newVal Pointer to a null-terminated string to be used as the SVG file name format. 01652 */ 01653 DFVINTERFACE_API void dfv_setSvgFormat(CDfvObjPtr pDfvObj, const char* newVal); 01654 01655 /** 01656 * Effective when outputting to SVG. 01657 * Specifies the format for naming files when the outputted SVG becomes multiple. 01658 * 01659 * 01660 * @param pDfvObj Pointer to DfvObj instance. 01661 * @param newVal Pointer to a null-terminated string to be used as the SVG file name format. 01662 */ 01663 DFVINTERFACE_API void dfv_setSvgFormatW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01664 01665 /** 01666 * Effective when outputting to SVG. 01667 * Gets the font specified to be embedded in SVG. 01668 * 01669 * 01670 * @param pDfvObj Pointer to DfvObj instance. 01671 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 01672 * the string is truncated and terminated with a NULL character. 01673 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01674 * @return Returns the 'pVal'. 01675 */ 01676 DFVINTERFACE_API char* dfv_getSvgEmbedFonts(CDfvObjPtr pDfvObj, char* pVal, int size); 01677 01678 /** 01679 * Effective when outputting to SVG. 01680 * Gets the font specified to be embedded in SVG. 01681 * 01682 * 01683 * @param pDfvObj Pointer to DfvObj instance. 01684 * @param pVal Pointer to the buffer that will receive the fontnames. If the string is as long or longer than the buffer, 01685 * the string is truncated and terminated with a NULL character. 01686 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01687 * @return Returns the 'pVal'. 01688 */ 01689 DFVINTERFACE_API wchar_t* dfv_getSvgEmbedFontsW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01690 01691 /** 01692 * Effective when outputting to SVG. 01693 * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts. 01694 * 01695 * 01696 * @param pDfvObj Pointer to DfvObj instance. 01697 * @param newVal fonts specified to embed 01698 */ 01699 DFVINTERFACE_API void dfv_setSvgEmbedFonts(CDfvObjPtr pDfvObj, const char* newVal); 01700 01701 /** 01702 * Effective when outputting to SVG. 01703 * Embeds the specified font in SVG to create. If you want to specify plural fonts, put commas between fonts. 01704 * 01705 * 01706 * @param pDfvObj Pointer to DfvObj instance. 01707 * @param newVal fonts specified to embed 01708 */ 01709 DFVINTERFACE_API void dfv_setSvgEmbedFontsW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01710 01711 /** 01712 * Effective when outputting to SVG. 01713 * Gets the value of whether to issues the error when failing to embed fonts. 01714 * 01715 * 01716 * @param pDfvObj Pointer to DfvObj instance. 01717 * @return the value of whether to issues the error 01718 */ 01719 DFVINTERFACE_API long dfv_getSvgErrorOnEmbedFault(CDfvObjPtr pDfvObj); 01720 01721 /** 01722 * Effective when outputting to SVG. 01723 * An error is issued in case of failing to embed fonts. 01724 * 01725 * 01726 * @param pDfvObj Pointer to DfvObj instance. 01727 * @param newVal If the value is 'true' is specified, an error is issued. 01728 */ 01729 DFVINTERFACE_API void dfv_setSvgErrorOnEmbedFault(CDfvObjPtr pDfvObj, long newVal); 01730 01731 /** 01732 * Effective when outputting to SVG. 01733 * Gets the value of how to compress the images embedded in SVG. 01734 * 01735 * 01736 * <table border="0" cellspacing="0" cellpadding="0"> 01737 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto conversion</td></tr> 01738 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG conversion</td></tr> 01739 * <tr><td>IMGCMPR_PNG </td><td>= 2 PNG conversion</td></tr> 01740 * </table> 01741 * 01742 * @param pDfvObj Pointer to DfvObj instance. 01743 * @return the value of how raster graphics are compressed and stored 01744 */ 01745 DFVINTERFACE_API DfvIMAGECONVERSION dfv_getSvgImageConversion(CDfvObjPtr pDfvObj); 01746 01747 /** 01748 * Effective when outputting to SVG. 01749 * Selects how to compress the images embedded in SVG to create from the following. 01750 * 01751 * 01752 * <table border="0" cellspacing="0" cellpadding="0"> 01753 * <tr><td>IMGCMPR_AUTO </td><td>= 0 Auto conversion</td></tr> 01754 * <tr><td>IMGCMPR_JPEG </td><td>= 1 JPEG conversion</td></tr> 01755 * <tr><td>IMGCMPR_PNG </td><td>= 2 PNG conversion</td></tr> 01756 * </table> 01757 * 01758 * @param pDfvObj Pointer to DfvObj instance. 01759 * @param newVal the value of how raster graphics are compressed and stored 01760 */ 01761 DFVINTERFACE_API void dfv_setSvgImageConversion(CDfvObjPtr pDfvObj, DfvIMAGECONVERSION newVal); 01762 01763 /** 01764 * Gets the value of the quality of JPEG format that is specified by dfv_setSvgImageConversion() stored in SVG. 01765 * 01766 * 01767 * @param pDfvObj Pointer to DfvObj instance. 01768 * @return the value of the quality 01769 */ 01770 DFVINTERFACE_API int dfv_getSvgJPEGQuality(CDfvObjPtr pDfvObj); 01771 01772 /** 01773 * Effective when outputting to SVG. 01774 * Specifies the quality of the Raster graphics when stored in JPEG format using the range of 1-100. 01775 * The quality becomes higher in proportion to the increase in the number; however the file size also becomes larger. 01776 * The initial value is 80. 01777 * 01778 * 01779 * @param pDfvObj Pointer to DfvObj instance. 01780 * @param newVal JPEG quality (1 to 100) 01781 */ 01782 DFVINTERFACE_API void dfv_setSvgJPEGQuality(CDfvObjPtr pDfvObj, int newVal); 01783 01784 /** 01785 * Effective when outputting to SVG. 01786 * Gets specification how to treat the referred image. 01787 * 01788 * 01789 * <table border="0" cellspacing="0" cellpadding="0"> 01790 * <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr> 01791 * <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> 01792 * <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> 01793 * <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> 01794 * </table> 01795 * 01796 * @param pDfvObj Pointer to DfvObj instance. 01797 * @return specification how to treat the referred image. 01798 */ 01799 DFVINTERFACE_API DfvIMAGEPROCTYPE dfv_getSvgImageProcessingType(CDfvObjPtr pDfvObj); 01800 01801 /** 01802 * Effective when outputting to SVG. 01803 * Specifies how to treat the referred image. 01804 * 01805 * 01806 * <table border="0" cellspacing="0" cellpadding="0"> 01807 * <tr><td>IMGPT_EMBED_ALL </td><td>= 0 Embeds all images to SVG.</td></tr> 01808 * <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> 01809 * <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> 01810 * <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> 01811 * </table> 01812 * 01813 * @param pDfvObj Pointer to DfvObj instance. 01814 * @param newVal specification how to treat the referred image. 01815 */ 01816 DFVINTERFACE_API void dfv_setSvgImageProcessingType(CDfvObjPtr pDfvObj, DfvIMAGEPROCTYPE newVal); 01817 01818 /** 01819 * Effective when outputting to SVG. 01820 * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01821 * 01822 * 01823 * @param pDfvObj Pointer to DfvObj instance. 01824 * @param pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, 01825 * the string is truncated and terminated with a NULL character. 01826 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01827 * @return Returns the 'pVal'. 01828 */ 01829 DFVINTERFACE_API char* dfv_getSvgImageCopyPath(CDfvObjPtr pDfvObj, char* pVal, int size); 01830 01831 /** 01832 * Effective when outputting to SVG. 01833 * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01834 * 01835 * 01836 * @param pDfvObj Pointer to DfvObj instance. 01837 * @param newVal Pointer to a null-terminated string to be used as image copy path 01838 */ 01839 DFVINTERFACE_API void dfv_setSvgImageCopyPath(CDfvObjPtr pDfvObj, const char* newVal); 01840 01841 /** 01842 * Effective when outputting to SVG. 01843 * Gets the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01844 * 01845 * 01846 * @param pDfvObj Pointer to DfvObj instance. 01847 * @param pVal Pointer to the buffer that will receive the image copy path. If the string is as long or longer than the buffer, 01848 * the string is truncated and terminated with a NULL character. 01849 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01850 * @return Returns the 'pVal'. 01851 */ 01852 DFVINTERFACE_API wchar_t* dfv_getSvgImageCopyPathW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 01853 01854 /** 01855 * Effective when outputting to SVG. 01856 * Specifies the copy destination of image as specifying IMGPT_COPY_ALL or IMGPT_COPY by dfv_setSvgImageProcessingType. 01857 * 01858 * 01859 * @param pDfvObj Pointer to DfvObj instance. 01860 * @param newVal Pointer to a null-terminated string to be used as image copy path 01861 */ 01862 DFVINTERFACE_API void dfv_setSvgImageCopyPathW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 01863 01864 /** 01865 * Effective when outputting to SVG. 01866 * Gets specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR> 01867 * 01868 * 01869 * @param pDfvObj Pointer to DfvObj instance. 01870 * @return specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. 01871 */ 01872 DFVINTERFACE_API long dfv_getSvgSingleFile(CDfvObjPtr pDfvObj); 01873 01874 /** 01875 * Effective when outputting to SVG. 01876 * Specifies whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. <BR> 01877 * 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> 01878 * Effective only when outputting to the file. It is invalid in the output without the file name like the stream etc. 01879 * 01880 * 01881 * @param pDfvObj Pointer to DfvObj instance. 01882 * @param newVal specification whether to divide into multiple SVG or to output as one SVG when the formatted result extends to multiple pages. 01883 */ 01884 DFVINTERFACE_API void dfv_setSvgSingleFile(CDfvObjPtr pDfvObj, long newVal); 01885 01886 #if !defined(_DOXYGEN) 01887 01888 /** 01889 * Gets the value specified by setSvgSingleFileMaxPages. 01890 * Effective when outputting to SVG. 01891 * 01892 * @param pDfvObj Pointer to DfvObj instance. 01893 * @return the value specified by setSvgSingleFileMaxPages. 01894 */ 01895 DFVINTERFACE_API int dfv_getSvgSingleFileMaxPages(CDfvObjPtr pDfvObj); 01896 01897 /** 01898 * Specifies the maximum number of pages outputted when setSvgSingleFile = True is specified. . 01899 * When this parameter is omitted If this parameter is omitted, "5000" is considered as specified. 01900 * 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. 01901 * 01902 * @param pDfvObj Pointer to DfvObj instance. 01903 * @param newVal maximum number of pages 01904 */ 01905 DFVINTERFACE_API void dfv_setSvgSingleFileMaxPages(CDfvObjPtr pDfvObj, int newVal); 01906 01907 /** 01908 * Gets the value specified by setSvgImageDownsamplingDPI. 01909 * Effective when outputting to SVG. 01910 * 01911 * @param pDfvObj Pointer to DfvObj instance. 01912 * @return the value specified by setSvgImageDownsamplingDPI. 01913 */ 01914 DFVINTERFACE_API int dfv_getSvgImageDownsamplingDPI(CDfvObjPtr pDfvObj); 01915 01916 /** 01917 * Specifies the resolution of the down sampling when embedding an image with 1 or more integers. . 01918 * When the resolution of the original image is lower than specification, it's embedded with the lower resolution. Effective when outputting to SVG. 01919 * 01920 * @param pDfvObj Pointer to DfvObj instance. 01921 * @return newVal the resolution of the down sampling 01922 */ 01923 DFVINTERFACE_API void dfv_setSvgImageDownsamplingDPI(CDfvObjPtr pDfvObj, int dpi); 01924 01925 /** 01926 * Gets the value specified by setSvgImageDownsamplingMethod. 01927 * Effective when outputting to SVG. 01928 * 01929 * @param pDfvObj Pointer to DfvObj instance. 01930 * @return the value specified by setSvgImageDownsamplingMethod 01931 */ 01932 DFVINTERFACE_API int dfv_getSvgImageDownsamplingMethod(CDfvObjPtr pDfvObj); 01933 01934 /** 01935 * Specifies the way of compression when down sampled. 01936 * 01937 * S_SVG_IMGDOWNSAMPLING_AVERAGE : biliner 01938 * S_SVG_IMGDOWNSAMPLING_BICUBIC : bicubic 01939 * S_SVG_IMGDOWNSAMPLING_SUBSAMPLING : nearest neighbor 01940 * If this parameter is omitted, "IMGDOWNSAMPLING_AVERAGE" is considered as specified. Effective when outputting to SVG. 01941 * 01942 * @param pDfvObj Pointer to DfvObj instance. 01943 * @param type the way of compression when down sampled 01944 */ 01945 DFVINTERFACE_API void dfv_setSvgImageDownsamplingMethod(CDfvObjPtr pDfvObj, int type); 01946 01947 #endif 01948 01949 /** 01950 * Effective when outputting to SVG. 01951 * Gets specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01952 * 01953 * 01954 * @param pDfvObj Pointer to DfvObj instance. 01955 * @return specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01956 */ 01957 DFVINTERFACE_API long dfv_getSvgImageRename(CDfvObjPtr pDfvObj); 01958 01959 /** 01960 * Effective when outputting to SVG. 01961 * 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. 01962 * 01963 * 01964 * 01965 * @param pDfvObj Pointer to DfvObj instance. 01966 * @param newVal specification whether to rename all file name to prefix specified by dfv_setSvgImagePrefix, or use original name. 01967 */ 01968 DFVINTERFACE_API void dfv_setSvgImageRename(CDfvObjPtr pDfvObj, long newVal); 01969 01970 /** 01971 * Effective when outputting to SVG. 01972 * Gets the prefix of the file name when images are copied to the directory specified by dfv_setSvgImageCopyPath and processed. 01973 * 01974 * 01975 * @param pDfvObj Pointer to DfvObj instance. 01976 * @param pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, 01977 * the string is truncated and terminated with a NULL character. 01978 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 01979 * @return Returns the 'pVal'. 01980 */ 01981 DFVINTERFACE_API char* dfv_getSvgImagePrefix(CDfvObjPtr pDfvObj, char* pVal, int size); 01982 01983 /** 01984 * Effective when outputting to SVG. 01985 * 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. 01986 * 01987 * 01988 * 01989 * @param pDfvObj Pointer to DfvObj instance. 01990 * @param newVal the prefix of the file name. 01991 */ 01992 DFVINTERFACE_API void dfv_setSvgImagePrefix(CDfvObjPtr pDfvObj, const char* newVal); 01993 01994 /** 01995 * Effective when outputting to SVG. 01996 * Gets the prefix of the file name when images are copied to the directory specified by dfv_setSvgImageCopyPath and processed. 01997 * 01998 * 01999 * @param pDfvObj Pointer to DfvObj instance. 02000 * @param pVal Pointer to the buffer that will receive the prefix. If the string is as long or longer than the buffer, 02001 * the string is truncated and terminated with a NULL character. 02002 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02003 * @return Returns the 'pVal'. 02004 */ 02005 DFVINTERFACE_API wchar_t* dfv_getSvgImagePrefixW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02006 02007 /** 02008 * Effective when outputting to SVG. 02009 * 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. 02010 * 02011 * 02012 * @param pDfvObj Pointer to DfvObj instance. 02013 * @param newVal the prefix of the file name. 02014 */ 02015 DFVINTERFACE_API void dfv_setSvgImagePrefixW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02016 02017 /** 02018 * Effective when outputting to SVG. 02019 * Gets specification whether to add sequential number to the output SVG even if it has only one-page. 02020 * 02021 * 02022 * @param pDfvObj Pointer to DfvObj instance. 02023 * @return specification whether to add sequential number to the output SVG even if it has only one-page. 02024 */ 02025 DFVINTERFACE_API long dfv_getSvgSinglePageNumber(CDfvObjPtr pDfvObj); 02026 02027 /** 02028 * Effective when outputting to SVG. 02029 * 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. 02030 * 02031 * 02032 * @param pDfvObj Pointer to DfvObj instance. 02033 * @param newVal specification whether to add sequential number to the output SVG even if it has only one-page. 02034 */ 02035 DFVINTERFACE_API void dfv_setSvgSinglePageNumber(CDfvObjPtr pDfvObj, long newVal); 02036 02037 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 02038 /** 02039 * Effective when outputting to SVG. 02040 * Gets the value of the rasterised-resolution of the transformed raster images. 02041 * 02042 * 02043 * @param pDfvObj Pointer to DfvObj instance. 02044 * @return Rasterised-resolution 02045 */ 02046 DFVINTERFACE_API int dfv_getSvgRasterizeResolution(CDfvObjPtr pDfvObj); 02047 02048 /** 02049 * Effective when outputting to SVG. 02050 * 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. 02051 * This setting is effective only with Windows version. 02052 * 02053 * 02054 * @param pDfvObj Pointer to DfvObj instance. 02055 * @param newVal Rasterised-resolution (70 to 500) 02056 */ 02057 DFVINTERFACE_API void dfv_setSvgRasterizeResolution(CDfvObjPtr pDfvObj, int newVal); 02058 #endif 02059 02060 /** 02061 * Specifies multiple volume of PDF output. 02062 * 02063 * 02064 * @param pDfvObj Pointer to DfvObj instance. 02065 * @param newVal Zpecifies zero or nonzero. 02066 */ 02067 DFVINTERFACE_API void dfv_setMultiVolume(CDfvObjPtr pDfvObj, long newVal); 02068 02069 /** 02070 * Get the error level to abort formatting process. 02071 * 02072 * @param pDfvObj Pointer to DfvObj instance. 02073 * @return Returns the error level. 02074 */ 02075 DFVINTERFACE_API DfvIfErrorLevel dfv_getExitLevel(CDfvObjPtr pDfvObj); 02076 02077 /** 02078 * Error level to abort formatting process. Server Based Converter will stop formatting when the detected 02079 * error level is equal to ExitLevel property or higher. The default value is 2 (Warning). 02080 * Thus if an error occurred and error level is 2 (Warning) or higher, formatting process will be 02081 * aborted. Please use the value from 1 to 4. When the value of 5 or more specified, it is considered 02082 * to be the value of 4. If a error-level:4 (fatal error) occurs, the formatting process will be 02083 * aborted unconditionally. 02084 * BTW : An error is not displayed no matter what value may be specified to be this property. 02085 * 02086 * <table border="0" cellspacing="0" cellpadding="0"> 02087 * <tr><td>ELVL_INFORMATION </td><td>= 1 Information</td></tr> 02088 * <tr><td>ELVL_WARNING </td><td>= 2 Warning</td></tr> 02089 * <tr><td>ELVL_RECOVERABLE </td><td>= 3 Recoveable Error</td></tr> 02090 * <tr><td>ELVL_FATAL </td><td>= 4 Fatal Error</td></tr> 02091 * </table> 02092 * 02093 * @param pDfvObj Pointer to DfvObj instance. 02094 * @param newVal error level to abort formatting process. 02095 */ 02096 DFVINTERFACE_API void dfv_setExitLevel(CDfvObjPtr pDfvObj, DfvIfErrorLevel newVal); 02097 02098 /** 02099 * Returns the error level of the error that occurred during the formatting process. 02100 * 02101 * <table border="0" cellspacing="0" cellpadding="0"> 02102 * <tr><td>ELVL_INFORMATION </td><td>= 1 Information</td></tr> 02103 * <tr><td>ELVL_WARNING </td><td>= 2 Warning</td></tr> 02104 * <tr><td>ELVL_RECOVERABLE </td><td>= 3 Recoveable Error</td></tr> 02105 * <tr><td>ELVL_FATAL </td><td>= 4 Fatal Error</td></tr> 02106 * </table> 02107 * 02108 * @param pDfvObj Pointer to DfvObj instance. 02109 * @return Returns the error level. 02110 */ 02111 DFVINTERFACE_API DfvIfErrorLevel dfv_getErrorLevel(CDfvObjPtr pDfvObj); 02112 02113 /** 02114 * Returns the error code of the error that occurred during the formatting process. 02115 * Zero means no error. Non-zero indicates any error occurred. 02116 * 02117 * @param pDfvObj Pointer to DfvObj instance. 02118 * @return Returns the error code. 02119 */ 02120 DFVINTERFACE_API DfvIfErrorCode dfv_getErrorCode(CDfvObjPtr pDfvObj); 02121 02122 /** 02123 * Returns the error message of the error that occurred during the formatting process. 02124 * 02125 * @param pDfvObj Pointer to DfvObj instance. 02126 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02127 * the string is truncated and terminated with a NULL character. 02128 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02129 * @return Returns the 'pVal'. 02130 */ 02131 DFVINTERFACE_API char* dfv_getErrorMessage(CDfvObjPtr pDfvObj, char* pVal, int size); 02132 /** 02133 * Returns the error message of the error that occurred during the formatting process. 02134 * 02135 * @param pDfvObj Pointer to DfvObj instance. 02136 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02137 * the string is truncated and terminated with a NULL character. 02138 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02139 * @return Returns the 'pVal'. 02140 */ 02141 DFVINTERFACE_API wchar_t* dfv_getErrorMessageW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02142 02143 /** 02144 * Sets the substitution of font name. This substitution acts on the font names existing in FO. 02145 * The font name 'fontName' is replaced to 'aliasName'. 02146 * 02147 * @param pDfvObj Pointer to DfvObj instance. 02148 * @param src Specifies the font name which is replaced. 02149 * @param dst Specifies the aliasName. 02150 */ 02151 DFVINTERFACE_API void dfv_setFontAlias(CDfvObjPtr pDfvObj, const char* src, const char* dst); 02152 /** 02153 * Sets the substitution of font name. This substitution acts on the font names existing in FO. 02154 * The font name 'fontName' is replaced to 'aliasName'. 02155 * 02156 * @param pDfvObj Pointer to DfvObj instance. 02157 * @param src Specifies the font name which is replaced. 02158 * @param dst Specifies the aliasName. 02159 */ 02160 DFVINTERFACE_API void dfv_setFontAliasW(CDfvObjPtr pDfvObj, const wchar_t* src, const wchar_t* dst); 02161 02162 /** 02163 * Clear all substitutions of font name. 02164 * 02165 * @param pDfvObj Pointer to DfvObj instance. 02166 */ 02167 DFVINTERFACE_API void dfv_clearFontAlias(CDfvObjPtr pDfvObj); 02168 /** 02169 * Clear all substitutions of font name. 02170 * 02171 * @param pDfvObj Pointer to DfvObj instance. 02172 */ 02173 02174 /** 02175 * Erase the substitution of font name 'fontName'. 02176 * 02177 * @param pDfvObj Pointer to DfvObj instance. 02178 * @param src Specifies the font name which is replaced. 02179 */ 02180 DFVINTERFACE_API void dfv_eraseFontAlias(CDfvObjPtr pDfvObj, const char* src); 02181 DFVINTERFACE_API void dfv_eraseFontAliasW(CDfvObjPtr pDfvObj, const wchar_t* src); 02182 02183 /** 02184 * Execute formatting and output to a PDF specified in OutputFilePath or printer specified in PrinterName. 02185 * 02186 * @param pDfvObj Pointer to DfvObj instance. 02187 * @return Returns the error code. Zero means no error. Non-zero indicates any error occurred. 02188 */ 02189 DFVINTERFACE_API DfvIfErrorCode dfv_execute(CDfvObjPtr pDfvObj); 02190 02191 /** 02192 * Initialize formatting engine. 02193 * 02194 * @param pDfvObj Pointer to DfvObj instance. 02195 */ 02196 DFVINTERFACE_API void dfv_clear(CDfvObjPtr pDfvObj); 02197 02198 /** 02199 * Specifies the callback fucntion. 02200 * The error that occurred during the formatting process can be received. 02201 * 02202 * @param pDfvObj Pointer to DfvObj instance. 02203 * @param proc Address of the callback function. 02204 * <br>Callback function has the following form:<pre> 02205 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02206 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02207 */ 02208 DFVINTERFACE_API void dfv_setOnMessageProc(CDfvObjPtr pDfvObj, DfvOnMessageProc* proc); 02209 02210 /** 02211 * Specifies the callback fucntion. 02212 * The error that occurred during the formatting process can be received. 02213 * 02214 * @param pDfvObj Pointer to DfvObj instance. 02215 * @param proc Address of the callback function. 02216 * <br>Callback function has the following form:<pre> 02217 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02218 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02219 */ 02220 DFVINTERFACE_API void dfv_setOnMessageProcW(CDfvObjPtr pDfvObj, DfvOnMessageProcW* proc); 02221 02222 /** 02223 * Specifies the callback fucntion. 02224 * The page number in the formatting process can be received. 02225 * 02226 * @param pDfvObj Pointer to DfvObj instance. 02227 * @param proc Address of the callback function. 02228 * <br>Callback function has the following form:<pre> 02229 * void DfvOnFormatPageProc(long pageNo);</pre> 02230 */ 02231 DFVINTERFACE_API void dfv_setOnFormatPageProc(CDfvObjPtr pDfvObj, DfvOnFormatPageProc* proc); 02232 02233 /** 02234 * Specifies the callback fucntion. 02235 * The error that occurred during the formatting process can be received. 02236 * 02237 * @param pDfvObj Pointer to DfvObj instance. 02238 * @param proc Address of the callback function. 02239 * <br>Callback function has the following form:<pre> 02240 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02241 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02242 * @param pAnyObj Address of an any object. 02243 */ 02244 DFVINTERFACE_API void dfv_setOnMessageProcEx(CDfvObjPtr pDfvObj, DfvOnMessageProcEx* proc, void* pAnyObj); 02245 02246 /** 02247 * Specifies the callback fucntion. 02248 * The error that occurred during the formatting process can be received. 02249 * 02250 * @param pDfvObj Pointer to DfvObj instance. 02251 * @param proc Address of the callback function. 02252 * <br>Callback function has the following form:<pre> 02253 * void DfvOnMessageProc(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const char* errMessage); 02254 * void DfvOnMessageProcW(DfvIfErrorLevel errLevel, DfvIfErrorCode errCode, const wchar_t* errMessage);</pre> 02255 * @param pAnyObj Address of an any object. 02256 */ 02257 DFVINTERFACE_API void dfv_setOnMessageProcExW(CDfvObjPtr pDfvObj, DfvOnMessageProcExW* proc, void* pAnyObj); 02258 02259 /** 02260 * Specifies the callback fucntion. 02261 * The page number in the formatting process can be received. 02262 * 02263 * @param pDfvObj Pointer to DfvObj instance. 02264 * @param proc Address of the callback function. 02265 * <br>Callback function has the following form:<pre> 02266 * void DfvOnFormatPageProc(long pageNo);</pre> 02267 * @param pAnyObj Address of an any object. 02268 */ 02269 DFVINTERFACE_API void dfv_setOnFormatPageProcEx(CDfvObjPtr pDfvObj, DfvOnFormatPageProcEx* proc, void* pAnyObj); 02270 02271 /* Print Interface */ 02272 /** 02273 * Get the printer name where the formatted result is outputted. 02274 * 02275 * @param pDfvObj Pointer to DfvObj instance. 02276 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02277 * the string is truncated and terminated with a NULL character. 02278 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02279 * @return Returns the 'pVal'. 02280 */ 02281 DFVINTERFACE_API char* dfv_getPrinterName(CDfvObjPtr pDfvObj, char* pVal, int size); 02282 /** 02283 * Get the printer name where the formatted result is outputted. 02284 * 02285 * @param pDfvObj Pointer to DfvObj instance. 02286 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02287 * the string is truncated and terminated with a NULL character. 02288 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02289 * @return Returns the 'pVal'. 02290 */ 02291 DFVINTERFACE_API wchar_t* dfv_getPrinterNameW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02292 02293 /** 02294 * Specifies the output format or the printer name to output. 02295 * When a printer name is specified, the formatted result is outputted to that printer. 02296 * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. 02297 * When "\@PDF" is specified, the formatted result is outputted to PDF. 02298 * When "\@SVG" is specified, the formatted result is outputted to SVG. 02299 * When "\@PS" is specified, the formatted result is outputted to PostScript. 02300 * When "\@INX" is specified, the formatted result is outputted to INX. 02301 * When "\@MIF" is specified, the formatted result is outputted to MIF. 02302 * When "\@TEXT" is specified, the formatted result is outputted to a text format file. 02303 * When "\@AreaTree" is specified, the AreaTree will be outputted. 02304 * When omitted, it is considered as "\@PDF" was specified. 02305 * It's impossible to output to the printer with any OS's other than Windows. 02306 * 02307 * @param pDfvObj Pointer to DfvObj instance. 02308 * @param newVal Pointer to a null-terminated string to be used as the printer name. 02309 */ 02310 DFVINTERFACE_API void dfv_setPrinterName(CDfvObjPtr pDfvObj, const char* newVal); 02311 /** 02312 * Specifies the output format or the printer name to output. 02313 * When a printer name is specified, the formatted result is outputted to that printer. 02314 * When "\@STDPRN" is specified, the formatted result is outputted to the currently used printer. 02315 * When "\@PDF" is specified, the formatted result is outputted to PDF. 02316 * When "\@SVG" is specified, the formatted result is outputted to SVG. 02317 * When "\@PS" is specified, the formatted result is outputted to PostScript. 02318 * When "\@INX" is specified, the formatted result is outputted to INX. 02319 * When "\@MIF" is specified, the formatted result is outputted to MIF. 02320 * When "\@TEXT" is specified, the formatted result is outputted to a text format file. 02321 * When "\@AreaTree" is specified, the AreaTree will be outputted. 02322 * When omitted, it is considered as "\@PDF" was specified. 02323 * It's impossible to output to the printer with any OS's other than Windows. 02324 * 02325 * @param pDfvObj Pointer to DfvObj instance. 02326 * @param newVal Pointer to a null-terminated string to be used as the printer name. 02327 */ 02328 DFVINTERFACE_API void dfv_setPrinterNameW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02329 02330 #if defined(_DOXYGEN) || (defined(_MSC_VER) && defined(_WIN32)) 02331 02332 /** 02333 * Get the number of copies. Effective when outputting to printer. 02334 * 02335 * @param pDfvObj Pointer to DfvObj instance. 02336 * @return Returns the number of copies. 02337 */ 02338 DFVINTERFACE_API long dfv_getPrnCopies(CDfvObjPtr pDfvObj); 02339 02340 /** 02341 * Specifies the number of copies. Effective when outputting to printer. 02342 * If nothing is specified, the value is considered as 1. 02343 * This setting is effective only with Windows version. 02344 * 02345 * @param pDfvObj Pointer to DfvObj instance. 02346 * @param newVal the number of copies. 02347 */ 02348 DFVINTERFACE_API void dfv_setPrnCopies(CDfvObjPtr pDfvObj, long newVal); 02349 02350 /** 02351 * Get collation of multiple copies. 02352 * 02353 * @param pDfvObj Pointer to DfvObj instance. 02354 * @return If zero is returned, the same page is multi-copied continuously. 02355 * If nonezero is returned, the pages specified from start to end are printed repeatedly. 02356 */ 02357 DFVINTERFACE_API long dfv_getPrnCollate(CDfvObjPtr pDfvObj); 02358 02359 /** 02360 * Specifies collation of multiple copies. Effective when outputting to printer and the number of 02361 * copies is plural. If it is not specified or the value zero is specified, the same page is 02362 * multi-copied continuously. 02363 * If nonezero is specified, the pages specified from start to end are printed repeatedly. 02364 * This setting is effective only with Windows version. 02365 * 02366 * @param pDfvObj Pointer to DfvObj instance. 02367 * @param newVal Zpecifies zero or nonzero. 02368 */ 02369 DFVINTERFACE_API void dfv_setPrnCollate(CDfvObjPtr pDfvObj, long newVal); 02370 02371 /** 02372 * Get the setting of whether print dialog box is displayed or not when printing 02373 * 02374 * @param pDfvObj Pointer to DfvObj instance. 02375 * @return If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed. 02376 */ 02377 DFVINTERFACE_API long dfv_getBatchPrint(CDfvObjPtr pDfvObj); 02378 02379 /** 02380 * When the value 'false' is specified, the print dialog box is displayed when printing. 02381 * If the setting is omitted or the value 'true' is specified, the print dialog is not displayed. 02382 * This setting is effective only with Windows version. 02383 * 02384 * @param pDfvObj Pointer to DfvObj instance. 02385 * @param newVal If zero, the print dialog box is displayed. If nonezero, the print dialog box is not displayed. 02386 */ 02387 DFVINTERFACE_API void dfv_setBatchPrint(CDfvObjPtr pDfvObj, long newVal); 02388 02389 #endif /* _WIN32 */ 02390 02391 /** 02392 * Get the version string of Server Based Converter. 02393 * 02394 * 02395 * @param pDfvObj Pointer to DfvObj instance. 02396 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02397 * the string is truncated and terminated with a NULL character. 02398 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02399 * @return Returns the 'pVal'. 02400 */ 02401 DFVINTERFACE_API char* dfv_getVersion(CDfvObjPtr pDfvObj, char* pVal, int size); 02402 02403 /** 02404 * Get the version string of Server Based Converter. 02405 * 02406 * 02407 * @param pDfvObj Pointer to DfvObj instance. 02408 * @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer, 02409 * the string is truncated and terminated with a NULL character. 02410 * @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated. 02411 * @return Returns the 'pVal'. 02412 */ 02413 DFVINTERFACE_API wchar_t* dfv_getVersionW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02414 02415 /** 02416 * Get INX output mode. 02417 * 02418 * @param pDfvObj Pointer to DfvObj instance. 02419 * @return output mode of INX. 02420 */ 02421 DFVINTERFACE_API DfvINXOUTPUTMODE dfv_getInxOutputMode(CDfvObjPtr pDfvObj); 02422 02423 /** 02424 * Set INX output mode. 02425 * 02426 * @param pDfvObj Pointer to DfvObj instance. 02427 * @param output mode of INX. 02428 */ 02429 DFVINTERFACE_API void dfv_setInxOutputMode(CDfvObjPtr pDfvObj, DfvINXOUTPUTMODE newVal); 02430 02431 /** 02432 * Get the specification that omit blank pages. return Specification that omit blank pages 02433 */ 02434 DFVINTERFACE_API int dfv_getOmitBlankPages(CDfvObjPtr pDfvObj); 02435 02436 /** 02437 * Disregard any empty pages. 02438 * Effective only when the original file is MS Word or MS Excel. 02439 * Specifies to disregard any empty pages at the beginning of document. 02440 * By using this parameter with setEndPage = 1 parameter, 02441 * it is possible to acquire the output of the first page which has actual contents. 02442 * Other operation is not guaranteed. 02443 * 02444 * @param pDfvObj Pointer to DfvObj instance. 02445 * @param newVal If the value is 'true' is specified, omit blank pages 02446 */ 02447 DFVINTERFACE_API void dfv_setOmitBlankPages(CDfvObjPtr pDfvObj, int newVal); 02448 02449 02450 /** 02451 * Get specifies of the FlashPartiallyOutput. 02452 * @since 2.1 02453 * 02454 * @param pXfoObj Pointer to XfoObj instance. 02455 * @return specifies of FlashPartiallyOutput. 02456 */ 02457 DFVINTERFACE_API long dfv_getFlashPartiallyOutput(CDfvObjPtr pDfvObj); 02458 02459 /** 02460 * When an error occurs within the document, the flash file in process will be outputted. 02461 * Effective when outputting to Flash. 02462 * @since 2.1 02463 * 02464 * @param pXfoObj Pointer to XfoObj instance. 02465 * @param newVal If the value is 'true' is specified, output the flash file. 02466 */ 02467 DFVINTERFACE_API void dfv_setFlashPartiallyOutput(CDfvObjPtr pDfvObj, long newVal); 02468 02469 /** 02470 * Get specifies of the FlashHidePageButton. 02471 * @since 3.0 02472 * 02473 * @param pXfoObj Pointer to XfoObj instance. 02474 * @return specifies of FlashHidePageButton. 02475 */ 02476 DFVINTERFACE_API long dfv_getFlashHidePageButton(CDfvObjPtr pDfvObj); 02477 02478 /** 02479 * Output a no page button. Effective when outputting to Flash. 02480 * @since 3.0 02481 * 02482 * @param pXfoObj Pointer to XfoObj instance. 02483 * @param newVal If the value is 'true' is specified, output a no page button. 02484 */ 02485 DFVINTERFACE_API void dfv_setFlashHidePageButton(CDfvObjPtr pDfvObj, long newVal); 02486 02487 #if defined(CCCTRL_CONTENTENGINE) && (defined(_MSC_VER) && defined(_WIN32)) 02488 02489 /** 02490 * It print at size of paper. 02491 * Default is false. 02492 * Effective when outputting to printer, and only Windows version. 02493 * 02494 * @param pDfvObj Pointer to DfvObj instance. 02495 * @param newVal If the value is 'true' is specified, print at size of paper. 02496 */ 02497 DFVINTERFACE_API void dfv_setPrnFitPaper(CDfvObjPtr pDfvObj, int newVal); 02498 02499 /** 02500 * Specifies the scaling ratio of the PDF to output. 02501 * A value with a unit or % value can be specified as length. 02502 * Effective when outputting to PDF. 02503 * 02504 * @param pDfvObj Pointer to DfvObj instance. 02505 * @param newVal the scaling ratio of the PDF 02506 */ 02507 DFVINTERFACE_API void dfv_setPdfOutputScale(CDfvObjPtr pDfvObj, const char* newVal); 02508 DFVINTERFACE_API void dfv_setPdfOutputScaleW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02509 02510 /** 02511 * Get the image resolution when outputting JPEG and PNG. 02512 * This setting is effective only with Windows version. 02513 * Effective when outputting to image, and only Windows version. 02514 * 02515 * @param pDfvObj Pointer to DfvObj instance. 02516 * @return Image resolution 02517 */ 02518 DFVINTERFACE_API int dfv_getRasterDPI(CDfvObjPtr pDfvObj); 02519 02520 /** 02521 * Effective when outputting to image, and only Windows version. 02522 * 02523 * @param pDfvObj Pointer to DfvObj instance. 02524 * @param newVal Image resolution (50 to 500) 02525 */ 02526 DFVINTERFACE_API void dfv_setRasterDPI(CDfvObjPtr pDfvObj, int newVal); 02527 02528 /** 02529 * Get the image scale when outputting JPEG and PNG. 02530 * Effective when outputting to image, and only Windows version. 02531 * 02532 * @param pDfvObj Pointer to DfvObj instance. 02533 * @return Image scale 02534 */ 02535 DFVINTERFACE_API char* dfv_getRasterScale(CDfvObjPtr pDfvObj, char* pVal, int size); 02536 DFVINTERFACE_API wchar_t* dfv_getRasterScaleW(CDfvObjPtr pDfvObj, wchar_t* pVal, int size); 02537 02538 /** 02539 * Sets the image scale when outputting JPEG and PNG.. 02540 * A numerical value, "%", or "px" (pixel) is available as the unit. 02541 * Specify the percentage for a numerical value and "%", and specify the width of image for pixel. 02542 * Effective when outputting to image, and only Windows version. 02543 * 02544 * @param pDfvObj Pointer to DfvObj instance. 02545 * @param newVal Image scale 02546 */ 02547 DFVINTERFACE_API void dfv_setRasterScale(CDfvObjPtr pDfvObj, const char* newVal); 02548 DFVINTERFACE_API void dfv_setRasterScaleW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02549 02550 #endif // #if defined(CCCTRL_CONTENTENGINE) && (defined(_MSC_VER) && defined(_WIN32)) 02551 02552 /** 02553 * Specifies the height of the paper when inputting text. 02554 * Effective when inputting text. 02555 * 02556 * @param pDfvObj Pointer to DfvObj instance. 02557 * @param newVal the height of paper 02558 */ 02559 DFVINTERFACE_API void dfv_setTextPaperHeight(CDfvObjPtr pDfvObj, const char* newVal); 02560 DFVINTERFACE_API void dfv_setTextPaperHeightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02561 02562 /** 02563 * Specifies the width of the paper when inputting text. 02564 * Effective when inputting text. 02565 * 02566 * @param pDfvObj Pointer to DfvObj instance. 02567 * @param newVal the width of paper 02568 */ 02569 DFVINTERFACE_API void dfv_setTextPaperWidth(CDfvObjPtr pDfvObj, const char* newVal); 02570 DFVINTERFACE_API void dfv_setTextPaperWidthW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02571 02572 /** 02573 * Specifies the left margin of the paper when inputting text. 02574 * Effective when inputting text. 02575 * 02576 * @param pDfvObj Pointer to DfvObj instance. 02577 * @param newVal the left margin of the paper 02578 */ 02579 DFVINTERFACE_API void dfv_setTextMarginLeft(CDfvObjPtr pDfvObj, const char* newVal); 02580 DFVINTERFACE_API void dfv_setTextMarginLeftW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02581 02582 /** 02583 * Specifies the right margin of the paper when inputting text. 02584 * Effective when inputting text. 02585 * 02586 * @param pDfvObj Pointer to DfvObj instance. 02587 * @param newVal the top margin of the paper 02588 */ 02589 DFVINTERFACE_API void dfv_setTextMarginTop(CDfvObjPtr pDfvObj, const char* newVal); 02590 DFVINTERFACE_API void dfv_setTextMarginTopW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02591 02592 /** 02593 * Specifies the right margin of the paper when inputting text. 02594 * Effective when inputting text. 02595 * 02596 * @param pDfvObj Pointer to DfvObj instance. 02597 * @param newVal the right margin of the paper 02598 */ 02599 DFVINTERFACE_API void dfv_setTextMarginRight(CDfvObjPtr pDfvObj, const char* newVal); 02600 DFVINTERFACE_API void dfv_setTextMarginRightW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02601 02602 /** 02603 * Specifies the right margin of the paper when inputting text. 02604 * Effective when inputting text. 02605 * 02606 * @param pDfvObj Pointer to DfvObj instance. 02607 * @param newVal the bottom margin of the paper 02608 */ 02609 DFVINTERFACE_API void dfv_setTextMarginBottom(CDfvObjPtr pDfvObj, const char* newVal); 02610 DFVINTERFACE_API void dfv_setTextMarginBottomW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02611 02612 /** 02613 * Specifies the font family name when inputting text. 02614 * Effective when inputting text. 02615 * 02616 * @param pDfvObj Pointer to DfvObj instance. 02617 * @param newVal font family name 02618 */ 02619 DFVINTERFACE_API void dfv_setTextFontFamily(CDfvObjPtr pDfvObj, const char* newVal); 02620 DFVINTERFACE_API void dfv_setTextFontFamilyW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02621 02622 /** 02623 * Specifies the font size when inputting text. 02624 * Effective when inputting text. 02625 * 02626 * @param pDfvObj Pointer to DfvObj instance. 02627 * @param newVal font size 02628 */ 02629 DFVINTERFACE_API void dfv_setTextFontSize(CDfvObjPtr pDfvObj, const char* newVal); 02630 DFVINTERFACE_API void dfv_setTextFontSizeW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02631 02632 /** 02633 * Specifies the value of whether show page number or not when inputting text. 02634 * Effective when inputting text. 02635 * 02636 * @param pDfvObj Pointer to DfvObj instance. 02637 * @param newVal the value of whether show page number or not 02638 */ 02639 DFVINTERFACE_API void dfv_setTextShowPageNumber(CDfvObjPtr pDfvObj, int newVal); 02640 02641 /** 02642 * Specifies the value of whether show page number or not when inputting text. 02643 * Effective when inputting text. 02644 * 02645 * @param pDfvObj Pointer to DfvObj instance. 02646 * @param newVal the value of whether show page number or not 02647 */ 02648 DFVINTERFACE_API void dfv_setTextShowLineNumber(CDfvObjPtr pDfvObj, int newVal); 02649 02650 /** 02651 * Specifies the offset value of range from body area when showing line number and inputting text. 02652 * Effective when inputting text. 02653 * 02654 * @param pDfvObj Pointer to DfvObj instance. 02655 * @param newVal the offset value 02656 */ 02657 DFVINTERFACE_API void dfv_setTextLineNumberOffset(CDfvObjPtr pDfvObj, const char* newVal); 02658 DFVINTERFACE_API void dfv_setTextLineNumberOffsetW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02659 02660 /** 02661 * Specifies the line number format when showing line number and inputting text. 02662 * Effective when inputting text. 02663 * 02664 * @param pDfvObj Pointer to DfvObj instance. 02665 * @param newVal line number format 02666 */ 02667 DFVINTERFACE_API void dfv_setTextLineNumberFormat(CDfvObjPtr pDfvObj, const char* newVal); 02668 DFVINTERFACE_API void dfv_setTextLineNumberFormatW(CDfvObjPtr pDfvObj, const wchar_t* newVal); 02669 02670 #ifdef __cplusplus 02671 } 02672 #endif /* __cplusplus */ 02673 02674 #endif /* DFVIFC_C_H__ */