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