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