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