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