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